Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer

import { InstanceProps } from '@alicloud/ros-cdk-apigateway'
const instanceProps: InstanceProps = { ... }

Properties

Name Type Description
httpsPolicy string | @alicloud/ros-cdk-core.IResolvable Property httpsPolicy: HTTPS security policy.
instanceName string | @alicloud/ros-cdk-core.IResolvable Property instanceName: Instance name.
instanceSpec string | @alicloud/ros-cdk-core.IResolvable Property instanceSpec: Instance specification.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: Zone to which the instance belongs.
autoPay boolean | @alicloud/ros-cdk-core.IResolvable Property autoPay: Specifies whether to enable auto-payment for renewals.
chargeType string | @alicloud/ros-cdk-core.IResolvable Property chargeType: The billing method of the router interface.
deletionForce boolean | @alicloud/ros-cdk-core.IResolvable Property deletionForce: Whether force delete the instance even if its status is START_FAILED.
duration number | @alicloud/ros-cdk-core.IResolvable Property duration: The subscription duration of the instance.
pricingCycle string | @alicloud/ros-cdk-core.IResolvable Property pricingCycle: The billing cycle of the subscription instance.
tags TagsProperty[] Property tags: Tags to attach to instance.

httpsPolicyRequired

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

Property httpsPolicy: HTTPS security policy.

Valid values: HTTPS2_TLS1_0, HTTPS2_TLS1_2, HTTPS1_1_TLS1_0


instanceNameRequired

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

Property instanceName: Instance name.


instanceSpecRequired

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

Property instanceSpec: Instance specification.

For example: api.s1.small


zoneIdRequired

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/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.


autoPayOptional

public readonly autoPay: boolean | IResolvable;
  • Type: boolean | @alicloud/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.


chargeTypeOptional

public readonly chargeType: string | IResolvable;
  • Type: string | @alicloud/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.


deletionForceOptional

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

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

Default value is false.


durationOptional

public readonly duration: number | IResolvable;
  • Type: number | @alicloud/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.


pricingCycleOptional

public readonly pricingCycle: string | IResolvable;
  • Type: string | @alicloud/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

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