Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer 

import ros_cdk_redis
ros_cdk_redis.InstanceProps(
  auto_renew_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  backup_policy: typing.Union[IResolvable, BackupPolicyProperty] = None,
  charge_type: typing.Union[str, IResolvable] = None,
  connections: typing.Union[IResolvable, ConnectionsProperty] = None,
  deletion_force: typing.Union[bool, IResolvable] = None,
  engine_version: typing.Union[str, IResolvable] = None,
  eviction_policy: typing.Union[str, IResolvable] = None,
  instance_class: typing.Union[str, IResolvable] = None,
  instance_maintain_time: typing.Union[IResolvable, InstanceMaintainTimeProperty] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  node_type: typing.Union[str, IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  product_type: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  secondary_zone_id: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  shard_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  ssl_enabled: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  tair_config: typing.Union[IResolvable, TairConfigProperty] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  vpc_password_free: typing.Union[bool, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
auto_renew_duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property autoRenewDuration: The auto-renewal period.
backup_policy typing.Union[ros_cdk_core.IResolvable, BackupPolicyProperty] Property backupPolicy: Backup policy.
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: The billing method of the ApsaraDB for Redis instance.
connections typing.Union[ros_cdk_core.IResolvable, ConnectionsProperty] Property connections: Connection address.
deletion_force typing.Union[bool, ros_cdk_core.IResolvable] Property deletionForce: Whether destroy instance when it is in recycle.
engine_version typing.Union[str, ros_cdk_core.IResolvable] Property engineVersion: Engine version.
eviction_policy typing.Union[str, ros_cdk_core.IResolvable] Property evictionPolicy: The eviction policy of cache data storage.
instance_class typing.Union[str, ros_cdk_core.IResolvable] Property instanceClass: Redis instance type.
instance_maintain_time typing.Union[ros_cdk_core.IResolvable, InstanceMaintainTimeProperty] Property instanceMaintainTime: Instance maintain time.
instance_name typing.Union[str, 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 '.', '-'.
node_type typing.Union[str, ros_cdk_core.IResolvable] Property nodeType: The type of node.
password typing.Union[str, 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 typing.Union[typing.Union[int, float], 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.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The unit of the subscription duration.
product_type typing.Union[str, ros_cdk_core.IResolvable] Property productType: Product type.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
secondary_zone_id typing.Union[str, ros_cdk_core.IResolvable] Property secondaryZoneId: The secondary zone ID of the instance.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: The IDs of security groups.
shard_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property shardCount: The number of data nodes in the instance.
ssl_enabled typing.Union[str, ros_cdk_core.IResolvable] Property sslEnabled: Modifies the SSL status.
tags typing.List[TagsProperty] Property tags: Tags to attach to redis.
tair_config typing.Union[ros_cdk_core.IResolvable, TairConfigProperty] Property tairConfig: Tair config.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The VPC id to create ecs instance.
vpc_password_free typing.Union[bool, ros_cdk_core.IResolvable] Property vpcPasswordFree: Specifies whether to enable password free for access within the VPC.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The vSwitch Id to create ecs instance.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone id of input region.

auto_renew_durationOptional 

auto_renew_duration: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

backup_policyOptional 

backup_policy: typing.Union[IResolvable, BackupPolicyProperty]

Property backupPolicy: Backup policy.

charge_typeOptional 

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

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

connectionsOptional 

connections: typing.Union[IResolvable, ConnectionsProperty]

Property connections: Connection address.

deletion_forceOptional 

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

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

Default is false

engine_versionOptional 

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

Property engineVersion: Engine version.

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

eviction_policyOptional 

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

Property evictionPolicy: The eviction policy of cache data storage.

instance_classOptional 

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

instance_maintain_timeOptional 

instance_maintain_time: typing.Union[IResolvable, InstanceMaintainTimeProperty]

Property instanceMaintainTime: Instance maintain time.

instance_nameOptional 

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

node_typeOptional 

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

Property nodeType: The type of node.

Valid value:

  • STAND_ALONE
  • MASTER_SLAVE
  • double
  • single

passwordOptional 

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

period: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

period_unitOptional 

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

product_typeOptional 

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

resource_group_idOptional 

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

Property resourceGroupId: Resource group id.

secondary_zone_idOptional 

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

Property secondaryZoneId: The secondary zone ID of the instance.

security_group_idOptional 

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

shard_countOptional 

shard_count: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

ssl_enabledOptional 

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

tags: typing.List[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.

tair_configOptional 

tair_config: typing.Union[IResolvable, TairConfigProperty]

Property tairConfig: Tair config.

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

vpc_idOptional 

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

Property vpcId: The VPC id to create ecs instance.

vpc_password_freeOptional 

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

v_switch_idOptional 

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

Property vSwitchId: The vSwitch Id to create ecs instance.

zone_idOptional 

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

Property zoneId: The zone id of input region.