Skip to content

Instance

This class encapsulates and extends the ROS resource type DATASOURCE::ApiGateway::Instance, which is used to query the information about an instance.

Initializers 

import { datasource } from '@alicloud/ros-cdk-apigateway'
new datasource.Instance(scope: Construct, id: string, props: InstanceProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props InstanceProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import { datasource } from '@alicloud/ros-cdk-apigateway'
datasource.Instance.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrAclId @alicloud/ros-cdk-core.IResolvable Attribute AclId: Access control ID.
attrAclName @alicloud/ros-cdk-core.IResolvable Attribute AclName: Access control name.
attrAclStatus @alicloud/ros-cdk-core.IResolvable Attribute AclStatus: Access control type.
attrAclType @alicloud/ros-cdk-core.IResolvable Attribute AclType: Access control type.
attrClassicEgressAddress @alicloud/ros-cdk-core.IResolvable Attribute ClassicEgressAddress: Classic network exit address.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: Creation time.
attrEgressIpv6Enable @alicloud/ros-cdk-core.IResolvable Attribute EgressIpv6Enable: Does IPV6 Capability Support.
attrExpiredTime @alicloud/ros-cdk-core.IResolvable Attribute ExpiredTime: Instance expiration time.
attrHttpsPolicy @alicloud/ros-cdk-core.IResolvable Attribute HttpsPolicy: Https policy.
attrInstanceId @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: Instance id.
attrInstanceName @alicloud/ros-cdk-core.IResolvable Attribute InstanceName: Instance name.
attrInstanceRpsLimit @alicloud/ros-cdk-core.IResolvable Attribute InstanceRpsLimit: Instance rps limits.
attrInstanceSpec @alicloud/ros-cdk-core.IResolvable Attribute InstanceSpec: Instance type.
attrInstanceSpecAttributes @alicloud/ros-cdk-core.IResolvable Attribute InstanceSpecAttributes: Instance type.
attrInstanceType @alicloud/ros-cdk-core.IResolvable Attribute InstanceType: Instance type.
attrInternetEgressAddress @alicloud/ros-cdk-core.IResolvable Attribute InternetEgressAddress: Public network exit address.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The payment type of the resource.
attrSupportIpv6 @alicloud/ros-cdk-core.IResolvable Attribute SupportIpv6: Does ipv6 support.
attrUserVpcId @alicloud/ros-cdk-core.IResolvable Attribute UserVpcId: User's VpcID.
attrUserVswitchId @alicloud/ros-cdk-core.IResolvable Attribute UserVswitchId: DescribeInstances.
attrVipTypeList @alicloud/ros-cdk-core.IResolvable Attribute VipTypeList: Vip type.
attrVpcEgressAddress @alicloud/ros-cdk-core.IResolvable Attribute VpcEgressAddress: Intranet VPC exit network segment.
attrVpcIntranetEnable @alicloud/ros-cdk-core.IResolvable Attribute VpcIntranetEnable: Whether Vpc allows authorization.
attrVpcOwnerId @alicloud/ros-cdk-core.IResolvable Attribute VpcOwnerId: Vpc licensor ID.
attrVpcSlbIntranetEnable @alicloud/ros-cdk-core.IResolvable Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: Zone.
attrZoneLocalName @alicloud/ros-cdk-core.IResolvable Attribute ZoneLocalName: Available area.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAclIdRequired 

public readonly attrAclId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AclId: Access control ID.

attrAclNameRequired 

public readonly attrAclName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AclName: Access control name.

attrAclStatusRequired 

public readonly attrAclStatus: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AclStatus: Access control type.

attrAclTypeRequired 

public readonly attrAclType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AclType: Access control type.

attrClassicEgressAddressRequired 

public readonly attrClassicEgressAddress: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ClassicEgressAddress: Classic network exit address.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: Creation time.

attrEgressIpv6EnableRequired 

public readonly attrEgressIpv6Enable: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EgressIpv6Enable: Does IPV6 Capability Support.

attrExpiredTimeRequired 

public readonly attrExpiredTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExpiredTime: Instance expiration time.

attrHttpsPolicyRequired 

public readonly attrHttpsPolicy: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute HttpsPolicy: Https policy.

attrInstanceIdRequired 

public readonly attrInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceId: Instance id.

attrInstanceNameRequired 

public readonly attrInstanceName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceName: Instance name.

attrInstanceRpsLimitRequired 

public readonly attrInstanceRpsLimit: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceRpsLimit: Instance rps limits.

attrInstanceSpecRequired 

public readonly attrInstanceSpec: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceSpec: Instance type.

attrInstanceSpecAttributesRequired 

public readonly attrInstanceSpecAttributes: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceSpecAttributes: Instance type.

attrInstanceTypeRequired 

public readonly attrInstanceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceType: Instance type.

attrInternetEgressAddressRequired 

public readonly attrInternetEgressAddress: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InternetEgressAddress: Public network exit address.

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The payment type of the resource.

attrSupportIpv6Required 

public readonly attrSupportIpv6: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SupportIpv6: Does ipv6 support.

attrUserVpcIdRequired 

public readonly attrUserVpcId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute UserVpcId: User's VpcID.

attrUserVswitchIdRequired 

public readonly attrUserVswitchId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute UserVswitchId: DescribeInstances.

attrVipTypeListRequired 

public readonly attrVipTypeList: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VipTypeList: Vip type.

attrVpcEgressAddressRequired 

public readonly attrVpcEgressAddress: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcEgressAddress: Intranet VPC exit network segment.

attrVpcIntranetEnableRequired 

public readonly attrVpcIntranetEnable: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcIntranetEnable: Whether Vpc allows authorization.

attrVpcOwnerIdRequired 

public readonly attrVpcOwnerId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcOwnerId: Vpc licensor ID.

attrVpcSlbIntranetEnableRequired 

public readonly attrVpcSlbIntranetEnable: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports.

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ZoneId: Zone.

attrZoneLocalNameRequired 

public readonly attrZoneLocalName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ZoneLocalName: Available area.