Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer

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

Properties

Name Type Description
autoRenew string | @alicloud/ros-cdk-core.IResolvable Property autoRenew: Specifies whether to enable auto renewal.
autoRenewPeriod string | @alicloud/ros-cdk-core.IResolvable Property autoRenewPeriod: The auto-renewal duration, in months.
autoUseCoupon string | @alicloud/ros-cdk-core.IResolvable Property autoUseCoupon: Specifies whether to use a coupon.
backupPolicy @alicloud/ros-cdk-core.IResolvable | BackupPolicyProperty Property backupPolicy: Backup policy.
capacity number | @alicloud/ros-cdk-core.IResolvable Property capacity: The storage capacity of the instance.
chargeType string | @alicloud/ros-cdk-core.IResolvable Property chargeType: The billing method of the instance.
config string | @alicloud/ros-cdk-core.IResolvable Property config: The parameter configuration of the instance, in a JSON string.
couponNo string | @alicloud/ros-cdk-core.IResolvable Property couponNo: The coupon code.
instanceClass string | @alicloud/ros-cdk-core.IResolvable Property instanceClass: The instance type.
instanceName string | @alicloud/ros-cdk-core.IResolvable Property instanceName: The name of the instance.
networkType string | @alicloud/ros-cdk-core.IResolvable Property networkType: The network type of the instance.
password string | @alicloud/ros-cdk-core.IResolvable Property password: The password for the instance.
period string | @alicloud/ros-cdk-core.IResolvable Property period: The subscription duration, in months.
privateIpAddress string | @alicloud/ros-cdk-core.IResolvable Property privateIpAddress: The internal IP address of the instance.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group ID.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The ID of the VPC.
vpcPasswordFree boolean | @alicloud/ros-cdk-core.IResolvable Property vpcPasswordFree: Specifies whether to enable password free for access within the VPC.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of the VSwitch.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The ID of the primary zone for the instance.

autoRenewOptional

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

Property autoRenew: Specifies whether to enable auto renewal.

Valid values: true false Note Default value: false.


autoRenewPeriodOptional

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

Property autoRenewPeriod: The auto-renewal duration, in months.

Valid values: 1, 2, 3, 6, and 12.

This parameter is required when AutoRenew is set to true.


autoUseCouponOptional

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

Property autoUseCoupon: Specifies whether to use a coupon.

Valid values: true false Note Default value: false.


backupPolicyOptional

public readonly backupPolicy: IResolvable | BackupPolicyProperty;

Property backupPolicy: Backup policy.


capacityOptional

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

Property capacity: The storage capacity of the instance.

Unit: MB. Note You need to pass at least one of the Capacity and InstanceClass parameters when calling the CreateInstance operation.


chargeTypeOptional

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

Property chargeType: The billing method of the instance.

Valid values: PrePaid: subscription. PostPaid: pay-as-you-go. Note Default value: PostPaid.


configOptional

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

Property config: The parameter configuration of the instance, in a JSON string.

For more information, see Set parameters.


couponNoOptional

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

Property couponNo: The coupon code.

Default value: default.


instanceClassOptional

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

Property instanceClass: The instance type.

For more information, see Instance types. Note You need to pass at least one of the Capacity and InstanceClass parameters when calling the CreateInstance operation.


instanceNameOptional

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

Property instanceName: The name of the instance.

The name must be 2 to 80 characters long, start with a letter (uppercase or lowercase) or a Chinese character, and not contain spaces or the characters @\/:=”<>{[]}.


networkTypeOptional

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

Property networkType: The network type of the instance.

Valid values: CLASSIC VPC Note Default value: CLASSIC.


passwordOptional

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

Property password: The password for the instance.

The password must be 8 to 32 characters long and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The allowed special characters are !@#$%^&*()_+-=.


periodOptional

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

Property period: The subscription duration, in months.

Valid values: 1 to 9, 12, 24, 36, and 60.

This parameter is available and required only when ChargeType is set to PrePaid.


privateIpAddressOptional

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

Property privateIpAddress: The internal IP address of the instance.

Note The internal IP address must be located in the Classless Inter-Domain Routing (CIDR) block of the VSwitch to which the instance belongs.


resourceGroupIdOptional

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

Property resourceGroupId: Resource group ID.


vpcIdOptional

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

Property vpcId: The ID of the VPC.


vpcPasswordFreeOptional

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

Property vpcPasswordFree: Specifies whether to enable password free for access within the VPC.

If set to: - true: enables password free. - false: disables password free.


vSwitchIdOptional

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

Property vSwitchId: The ID of the VSwitch.


zoneIdOptional

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

Property zoneId: The ID of the primary zone for the instance.

You can call the DescribeZones operation to query available zones.

You can also specify a secondary zone by using the SecondaryZoneId parameter. The primary and replica nodes are then deployed in the specified primary and secondary zones to create a dual-zone architecture for in-city disaster recovery.