Skip to content

Instance

  • Implements: @alicloud/ros-cdk-apigateway.datasource.IInstance

This class encapsulates and extends the ROS resource type DATASOURCE::ApiGateway::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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

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.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
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 string | @alicloud/ros-cdk-core.IResolvable Attribute AclId: Access control ID.
attrAclName string | @alicloud/ros-cdk-core.IResolvable Attribute AclName: Access control name.
attrAclStatus string | @alicloud/ros-cdk-core.IResolvable Attribute AclStatus: Access control type.
attrAclType string | @alicloud/ros-cdk-core.IResolvable Attribute AclType: Access control type.
attrClassicEgressAddress string | @alicloud/ros-cdk-core.IResolvable Attribute ClassicEgressAddress: Classic network exit address.
attrCreateTime string | @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: Creation time.
attrEgressIpv6Enable string | @alicloud/ros-cdk-core.IResolvable Attribute EgressIpv6Enable: Does IPV6 Capability Support.
attrExpiredTime string | @alicloud/ros-cdk-core.IResolvable Attribute ExpiredTime: Instance expiration time.
attrHttpsPolicy string | @alicloud/ros-cdk-core.IResolvable Attribute HttpsPolicy: Https policy.
attrInstanceId string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceId: Instance id.
attrInstanceName string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceName: Instance name.
attrInstanceRpsLimit string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceRpsLimit: Instance rps limits.
attrInstanceSpec string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceSpec: Instance type.
attrInstanceSpecAttributes string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceSpecAttributes: Instance type.
attrInstanceType string | @alicloud/ros-cdk-core.IResolvable Attribute InstanceType: Instance type.
attrInternetEgressAddress string | @alicloud/ros-cdk-core.IResolvable Attribute InternetEgressAddress: Public network exit address.
attrPaymentType string | @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The payment type of the resource.
attrSupportIpv6 string | @alicloud/ros-cdk-core.IResolvable Attribute SupportIpv6: Does ipv6 support.
attrUserVpcId string | @alicloud/ros-cdk-core.IResolvable Attribute UserVpcId: User's VpcID.
attrUserVswitchId string | @alicloud/ros-cdk-core.IResolvable Attribute UserVswitchId: DescribeInstances.
attrVipTypeList string | @alicloud/ros-cdk-core.IResolvable Attribute VipTypeList: Vip type.
attrVpcEgressAddress string | @alicloud/ros-cdk-core.IResolvable Attribute VpcEgressAddress: Intranet VPC exit network segment.
attrVpcIntranetEnable string | @alicloud/ros-cdk-core.IResolvable Attribute VpcIntranetEnable: Whether Vpc allows authorization.
attrVpcOwnerId string | @alicloud/ros-cdk-core.IResolvable Attribute VpcOwnerId: Vpc licensor ID.
attrVpcSlbIntranetEnable string | @alicloud/ros-cdk-core.IResolvable Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports.
attrZoneId string | @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: Zone.
attrZoneLocalName string | @alicloud/ros-cdk-core.IResolvable Attribute ZoneLocalName: Available area.
props InstanceProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/ros-cdk-core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


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: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AclId: Access control ID.


attrAclNameRequired

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

Attribute AclName: Access control name.


attrAclStatusRequired

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

Attribute AclStatus: Access control type.


attrAclTypeRequired

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

Attribute AclType: Access control type.


attrClassicEgressAddressRequired

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

Attribute ClassicEgressAddress: Classic network exit address.


attrCreateTimeRequired

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

Attribute CreateTime: Creation time.


attrEgressIpv6EnableRequired

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

Attribute EgressIpv6Enable: Does IPV6 Capability Support.


attrExpiredTimeRequired

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

Attribute ExpiredTime: Instance expiration time.


attrHttpsPolicyRequired

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

Attribute HttpsPolicy: Https policy.


attrInstanceIdRequired

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

Attribute InstanceId: Instance id.


attrInstanceNameRequired

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

Attribute InstanceName: Instance name.


attrInstanceRpsLimitRequired

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

Attribute InstanceRpsLimit: Instance rps limits.


attrInstanceSpecRequired

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

Attribute InstanceSpec: Instance type.


attrInstanceSpecAttributesRequired

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

Attribute InstanceSpecAttributes: Instance type.


attrInstanceTypeRequired

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

Attribute InstanceType: Instance type.


attrInternetEgressAddressRequired

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

Attribute InternetEgressAddress: Public network exit address.


attrPaymentTypeRequired

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

Attribute PaymentType: The payment type of the resource.


attrSupportIpv6Required

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

Attribute SupportIpv6: Does ipv6 support.


attrUserVpcIdRequired

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

Attribute UserVpcId: User's VpcID.


attrUserVswitchIdRequired

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

Attribute UserVswitchId: DescribeInstances.


attrVipTypeListRequired

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

Attribute VipTypeList: Vip type.


attrVpcEgressAddressRequired

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

Attribute VpcEgressAddress: Intranet VPC exit network segment.


attrVpcIntranetEnableRequired

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

Attribute VpcIntranetEnable: Whether Vpc allows authorization.


attrVpcOwnerIdRequired

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

Attribute VpcOwnerId: Vpc licensor ID.


attrVpcSlbIntranetEnableRequired

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

Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports.


attrZoneIdRequired

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

Attribute ZoneId: Zone.


attrZoneLocalNameRequired

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

Attribute ZoneLocalName: Available area.


propsRequired

public readonly props: InstanceProps;