Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::Instance, which is used to create a dedicated instance.

Initializers

import ros_cdk_apigateway
ros_cdk_apigateway.Instance(
  scope: Construct,
  id: str,
  https_policy: typing.Union[str, IResolvable],
  instance_name: typing.Union[str, IResolvable],
  instance_spec: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  auto_pay: typing.Union[bool, IResolvable] = None,
  charge_type: typing.Union[str, IResolvable] = None,
  deletion_force: typing.Union[bool, IResolvable] = None,
  duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

https_policy^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property httpsPolicy: HTTPS security policy.

Valid values: HTTPS2_TLS1_0, HTTPS2_TLS1_2, HTTPS1_1_TLS1_0

instance_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceName: Instance name.

instance_spec^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceSpec: Instance specification.

For example: api.s1.small

zone_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property zoneId: Zone to which the instance belongs.

For example: cn-beijing-MAZ2(f,g). Pleas call DescribeZones to get supported zone list.

auto_pay^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property autoPay: Indicates whether automatic payment is enabled.

Valid values: false: Automatic payment is disabled. You need to go to Orders to make the payment once an order is generated. true: Automatic payment is enabled. The payment is automatically made. Default true.

charge_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property chargeType: The billing method of the router interface.

Valid values: PrePaid (Subscription), PostPaid (default, Pay-As-You-Go). Default value: PostPaid.

deletion_force^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property deletionForce: Whether force delete the instance even if its status is START_FAILED.

Default value is false.

duration^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property duration: Prepaid time period.

It could be from 1 to 9 when PricingCycle is Month, or 1 to 3 when PricingCycle is Year. Default value is 3.

pricing_cycle^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property pricingCycle: Unit of the payment cycle.

It could be Month (default) or Year.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_apigateway
ros_cdk_apigateway.Instance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_arn^Required

attr_arn: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attr_egress_ipv6_enable^Required

attr_egress_ipv6_enable: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute EgressIpv6Enable: Whether enable egress IPV6.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute InstanceId: Instance ID.

attr_instance_type^Required

attr_instance_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute InstanceType: Instance type.

attr_internet_egress_address^Required

attr_internet_egress_address: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute InternetEgressAddress: Internet egress dddress.

attr_support_ipv6^Required

attr_support_ipv6: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute SupportIpv6: Whether support IPV6.

attr_vpc_egress_address^Required

attr_vpc_egress_address: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute VpcEgressAddress: VPC network egress address.

attr_vpc_intranet_enable^Required

attr_vpc_intranet_enable: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute VpcIntranetEnable: Whether enable VPC intranet.

attr_vpc_slb_intranet_enable^Required

attr_vpc_slb_intranet_enable: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute VpcSlbIntranetEnable: Whether enable VPC SLB intranet.

props^Required

props: InstanceProps

• Type: InstanceProps