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: Indicates whether automatic payment is enabled.
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: Prepaid time period.
pricingCycle	string | @alicloud/ros-cdk-core.IResolvable	Property pricingCycle: Unit of the payment cycle.
tags	TagsProperty[]	Property tags: Tags to attach to instance.

---

httpsPolicy^Required

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

---

instanceName^Required

public readonly instanceName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceName: Instance name.

---

instanceSpec^Required

public readonly instanceSpec: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceSpec: Instance specification.

For example: api.s1.small

---

zoneId^Required

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.

---

autoPay^Optional

public readonly autoPay: boolean | IResolvable;

• Type: boolean | @alicloud/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.

---

chargeType^Optional

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.

---

deletionForce^Optional

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.

---

duration^Optional

public readonly duration: number | IResolvable;

• Type: number | @alicloud/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.

---

pricingCycle^Optional

public readonly pricingCycle: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property pricingCycle: Unit of the payment cycle.

It could be Month (default) or Year.

---

tags^Optional

public readonly tags: TagsProperty[];

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

---