Skip to content

Instance

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
https_policy typing.Union[str, ros_cdk_core.IResolvable] Property httpsPolicy: HTTPS security policy.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: Instance name.
instance_spec typing.Union[str, ros_cdk_core.IResolvable] Property instanceSpec: Instance specification.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: Zone to which the instance belongs.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] Property autoPay: Indicates whether automatic payment is enabled.
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: The billing method of the router interface.
deletion_force typing.Union[bool, ros_cdk_core.IResolvable] Property deletionForce: Whether force delete the instance even if its status is START_FAILED.
duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property duration: Prepaid time period.
pricing_cycle typing.Union[str, ros_cdk_core.IResolvable] Property pricingCycle: Unit of the payment cycle.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

https_policyRequired

  • 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_nameRequired

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

Property instanceName: Instance name.

instance_specRequired

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

Property instanceSpec: Instance specification.

For example: api.s1.small

zone_idRequired

  • 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_payOptional

  • 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_typeOptional

  • 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_forceOptional

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

durationOptional

  • 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_cycleOptional

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

Property pricingCycle: Unit of the payment cycle.

It could be Month (default) or Year.

tagsOptional

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_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_egress_ipv6_enable ros_cdk_core.IResolvable Attribute EgressIpv6Enable: Whether enable egress IPV6.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: Instance ID.
attr_instance_type ros_cdk_core.IResolvable Attribute InstanceType: Instance type.
attr_internet_egress_address ros_cdk_core.IResolvable Attribute InternetEgressAddress: Internet egress dddress.
attr_support_ipv6 ros_cdk_core.IResolvable Attribute SupportIpv6: Whether support IPV6.
attr_vpc_egress_address ros_cdk_core.IResolvable Attribute VpcEgressAddress: VPC network egress address.
attr_vpc_intranet_enable ros_cdk_core.IResolvable Attribute VpcIntranetEnable: Whether enable VPC intranet.
attr_vpc_slb_intranet_enable ros_cdk_core.IResolvable Attribute VpcSlbIntranetEnable: Whether enable VPC SLB intranet.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_egress_ipv6_enableRequired 

attr_egress_ipv6_enable: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EgressIpv6Enable: Whether enable egress IPV6.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: Instance ID.

attr_instance_typeRequired 

attr_instance_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceType: Instance type.

attr_internet_egress_addressRequired 

attr_internet_egress_address: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InternetEgressAddress: Internet egress dddress.

attr_support_ipv6Required 

attr_support_ipv6: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SupportIpv6: Whether support IPV6.

attr_vpc_egress_addressRequired 

attr_vpc_egress_address: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcEgressAddress: VPC network egress address.

attr_vpc_intranet_enableRequired 

attr_vpc_intranet_enable: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcIntranetEnable: Whether enable VPC intranet.

attr_vpc_slb_intranet_enableRequired 

attr_vpc_slb_intranet_enable: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcSlbIntranetEnable: Whether enable VPC SLB intranet.