Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer 

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

Properties

Name Type Description
autoRenewDuration number | @alicloud/ros-cdk-core.IResolvable Property autoRenewDuration: The auto-renewal period.
backupPolicy @alicloud/ros-cdk-core.IResolvable | BackupPolicyProperty Property backupPolicy: Backup policy.
chargeType string | @alicloud/ros-cdk-core.IResolvable Property chargeType: The billing method of the ApsaraDB for Redis instance.
connections @alicloud/ros-cdk-core.IResolvable | ConnectionsProperty Property connections: Connection address.
deletionForce boolean | @alicloud/ros-cdk-core.IResolvable Property deletionForce: Whether destroy instance when it is in recycle.
engineVersion string | @alicloud/ros-cdk-core.IResolvable Property engineVersion: Engine version.
evictionPolicy string | @alicloud/ros-cdk-core.IResolvable Property evictionPolicy: The eviction policy of cache data storage.
instanceClass string | @alicloud/ros-cdk-core.IResolvable Property instanceClass: Redis instance type.
instanceMaintainTime @alicloud/ros-cdk-core.IResolvable | InstanceMaintainTimeProperty Property instanceMaintainTime: Instance maintain time.
instanceName string | @alicloud/ros-cdk-core.IResolvable Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.
nodeType string | @alicloud/ros-cdk-core.IResolvable Property nodeType: The type of node.
password string | @alicloud/ros-cdk-core.IResolvable Property password: The password of redis instance.length 8 to 30 characters, need to contain both uppercase and lowercase letters and numbers.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The period of order, when choose Prepaid required.optional value 1-9, 12, 24, 36, 60 Unit in month.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: The unit of the subscription duration.
productType string | @alicloud/ros-cdk-core.IResolvable Property productType: Product type.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
secondaryZoneId string | @alicloud/ros-cdk-core.IResolvable Property secondaryZoneId: The secondary zone ID of the instance.
securityGroupId string | @alicloud/ros-cdk-core.IResolvable Property securityGroupId: The IDs of security groups.
shardCount number | @alicloud/ros-cdk-core.IResolvable Property shardCount: The number of data nodes in the instance.
sslEnabled string | @alicloud/ros-cdk-core.IResolvable Property sslEnabled: Modifies the SSL status.
tags TagsProperty[] Property tags: Tags to attach to redis.
tairConfig @alicloud/ros-cdk-core.IResolvable | TairConfigProperty Property tairConfig: Tair config.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The VPC id to create ecs instance.
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 vSwitch Id to create ecs instance.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The zone id of input region.

autoRenewDurationOptional 

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

Property autoRenewDuration: The auto-renewal period.

Valid values: 1 to 12. When the instance is about to expire, the instance is automatically renewed based on the number of months specified by this parameter. Note This parameter is valid only when ChargeType is set to PrePaid.

backupPolicyOptional 

public readonly backupPolicy: IResolvable | BackupPolicyProperty;

Property backupPolicy: Backup policy.

chargeTypeOptional 

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

Property chargeType: The billing method of the ApsaraDB for Redis instance.

connectionsOptional 

public readonly connections: IResolvable | ConnectionsProperty;

Property connections: Connection address.

deletionForceOptional 

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

Property deletionForce: Whether destroy instance when it is in recycle.

Default is false

engineVersionOptional 

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

Property engineVersion: Engine version.

Supported values: 2.8, 4.0, 5.0, 6.0 and 7.0

evictionPolicyOptional 

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

Property evictionPolicy: The eviction policy of cache data storage.

instanceClassOptional 

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

Property instanceClass: Redis instance type.

Refer the Redis instance type reference, such as 'redis.master.small.default', 'redis.master.4xlarge.default', 'redis.sharding.mid.default' etc

instanceMaintainTimeOptional 

public readonly instanceMaintainTime: IResolvable | InstanceMaintainTimeProperty;

Property instanceMaintainTime: Instance maintain time.

instanceNameOptional 

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

Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.

nodeTypeOptional 

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

Property nodeType: The type of node.

Valid value: - STAND_ALONE - MASTER_SLAVE - double - single

passwordOptional 

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

Property password: The password of redis instance.length 8 to 30 characters, need to contain both uppercase and lowercase letters and numbers.

periodOptional 

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

Property period: The period of order, when choose Prepaid required.optional value 1-9, 12, 24, 36, 60 Unit in month.

periodUnitOptional 

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

productTypeOptional 

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

Property productType: Product type.

Valid values:Local: Community Edition(Local) or Enhanced Edition(Local)Tair_rdb: Performance Enhanced(Cloud Disk)Tair_scm: Persistent Memory(Cloud Disk)Tair_essd: Capacity Storage(Cloud Disk)OnECS: Community Edition(Cloud Disk)

resourceGroupIdOptional 

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

Property resourceGroupId: Resource group id.

secondaryZoneIdOptional 

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

Property secondaryZoneId: The secondary zone ID of the instance.

securityGroupIdOptional 

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

Property securityGroupId: The IDs of security groups.

Separate multiple security group IDs with commas (,) and up to 10 can be set.

shardCountOptional 

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

Property shardCount: The number of data nodes in the instance.

Default value: 1. Valid values: 1: You can create an instance in the standard architecture that contains only a single data node. For more information about the standard architecture, see Cluster master-replica instances. 2 to 32: You can create an instance in the cluster architecturethat contains the specified number of data nodes. For more information about the cluster architecture, see Cluster master-replica instances.

sslEnabledOptional 

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

Property sslEnabled: Modifies the SSL status.

Valid values: Disable: disables SSL encryption. Enable: enables SSL encryption. Update: updates the SSL certificate.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags to attach to redis.

Max support 20 tags to add during create redis. Each tag with two properties Key and Value, and Key is required.

tairConfigOptional 

public readonly tairConfig: IResolvable | TairConfigProperty;

Property tairConfig: Tair config.

This parameter is available only if the InstanceClass parameter is start with tair.

vpcIdOptional 

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

Property vpcId: The VPC id to create ecs instance.

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 vSwitch Id to create ecs instance.

zoneIdOptional 

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

Property zoneId: The zone id of input region.