Skip to content

InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-apigateway-instance

Initializer

import ros_cdk_apigateway
ros_cdk_apigateway.InstanceProps(
  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
)

Properties

Name Type 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: Specifies whether to enable auto-payment for renewals.
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: The subscription duration of the instance.
pricing_cycle typing.Union[str, ros_cdk_core.IResolvable] Property pricingCycle: The billing cycle of the subscription instance.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.

https_policyRequired

https_policy: typing.Union[str, IResolvable]
  • 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

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

Property instanceName: Instance name.


instance_specRequired

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

Property instanceSpec: Instance specification.

For example: api.s1.small


zone_idRequired

zone_id: typing.Union[str, IResolvable]
  • 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

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

Property autoPay: Specifies whether to enable auto-payment for renewals.

Valid values:

  • True: Auto-payment is enabled. Make sure that your account has a sufficient balance.
  • False: Manual payment is required. To pay for an order, log on to the console. In the upper-right corner, choose Billing > User Center. On the Order Management page, find the order and complete the payment. Default value: False.

charge_typeOptional

charge_type: typing.Union[str, IResolvable]
  • 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

deletion_force: typing.Union[bool, IResolvable]
  • 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

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

Property duration: The subscription duration of the instance.

Valid values:

  • If PricingCycle is set to Month, the valid values are 1 to 9.
  • If PricingCycle is set to Year, the valid values are 1 to 3.

This parameter is required and takes effect only if you set ChargeType to PrePaid.


pricing_cycleOptional

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

Property pricingCycle: The billing cycle of the subscription instance.

Valid values:

  • year
  • month

This parameter is required if you set ChargeType to PrePaid.


tagsOptional

tags: 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.