Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::REDIS::Instance.

Initializers

import ros_cdk_redis
ros_cdk_redis.Instance(
  scope: Construct,
  id: str,
  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,
  deletion_protection: 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,
  read_only_count: typing.Union[typing.Union[int, float], 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,
  subscription_deletion_force: typing.Union[bool, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  tair_config: typing.Union[IResolvable, TairConfigProperty] = None,
  tls_protocol: typing.Union[str, IResolvable] = 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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

auto_renew_duration^Optional

• 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_policy^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, BackupPolicyProperty]

Property backupPolicy: Backup policy.

charge_type^Optional

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

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

connections^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, ConnectionsProperty]

Property connections: Connection address.

deletion_force^Optional

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

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

Default is false

deletion_protection^Optional

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

Property deletionProtection: Specifies whether to enable the release protection feature for the instance.

Default is false.

engine_version^Optional

• 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_policy^Optional

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

Property evictionPolicy: The eviction policy of cache data storage.

instance_class^Optional

• 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_time^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, InstanceMaintainTimeProperty]

Property instanceMaintainTime: Instance maintain time.

instance_name^Optional

• 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_type^Optional

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

Property nodeType: The type of node.

Valid value:

• STAND_ALONE
• MASTER_SLAVE
• double
• single

password^Optional

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

period^Optional

• 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_unit^Optional

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

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

product_type^Optional

• 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)

read_only_count^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property readOnlyCount: The number of read replicas in the primary zone.

Valid values: 1 to 9.

resource_group_id^Optional

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

Property resourceGroupId: Resource group id.

secondary_zone_id^Optional

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

Property secondaryZoneId: The secondary zone ID of the instance.

security_group_id^Optional

• 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_count^Optional

• 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_enabled^Optional

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

subscription_deletion_force^Optional

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

Property subscriptionDeletionForce: This option is only applicable to subscription instances.

For subscription instances, if this option is true, the instance will be converted to a postpaid instance before being deleted. If false, the forced deletion will not be performed. This operation will incur additional fees, so choose carefully.

tags^Optional

• Type: 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_config^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, TairConfigProperty]

Property tairConfig: Tair config.

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

tls_protocol^Optional

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

Property tlsProtocol: The TLS version of the instance.

vpc_id^Optional

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

Property vpcId: The VPC id to create ecs instance.

vpc_password_free^Optional

• 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_id^Optional

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

Property vSwitchId: The vSwitch Id to create ecs instance.

zone_id^Optional

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

Property zoneId: The zone id of input region.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_redis
ros_cdk_redis.Instance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_architecture_type^Required

attr_architecture_type: typing.Union[str, IResolvable]

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

Attribute ArchitectureType: The architecture.

attr_bandwidth^Required

attr_bandwidth: typing.Union[str, IResolvable]

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

Attribute Bandwidth: The bandwidth of the instance.

Unit: Mbit/s.

attr_capacity^Required

attr_capacity: typing.Union[str, IResolvable]

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

Attribute Capacity: The storage capacity of the instance.

Unit: MB.

attr_charge_type^Required

attr_charge_type: typing.Union[str, IResolvable]

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

Attribute ChargeType: The billing method of the instance.

attr_classic_inner_connection_port^Required

attr_classic_inner_connection_port: typing.Union[str, IResolvable]

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

Attribute ClassicInnerConnectionPort: The classic inner connection port of the instance.

attr_classic_inner_connection_string^Required

attr_classic_inner_connection_string: typing.Union[str, IResolvable]

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

Attribute ClassicInnerConnectionString: The classic inner connection string of the instance.

attr_connection_domain^Required

attr_connection_domain: typing.Union[str, IResolvable]

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

Attribute ConnectionDomain: Connection domain of created instance.

attr_connections^Required

attr_connections: typing.Union[str, IResolvable]

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

Attribute Connections: The maximum number of connections supported by the instance.

attr_direct_connection_port^Required

attr_direct_connection_port: typing.Union[str, IResolvable]

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

Attribute DirectConnectionPort: The direct connection port of the instance.

attr_direct_connection_string^Required

attr_direct_connection_string: typing.Union[str, IResolvable]

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

Attribute DirectConnectionString: The direct connection string of the instance.

attr_engine_version^Required

attr_engine_version: typing.Union[str, IResolvable]

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

Attribute EngineVersion: The engine version of the instance.

attr_has_renew_change_order^Required

attr_has_renew_change_order: typing.Union[str, IResolvable]

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

Attribute HasRenewChangeOrder: Indicates whether the Alibaba Cloud account has pending renewal or scaling orders.

attr_instance_class^Required

attr_instance_class: typing.Union[str, IResolvable]

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

Attribute InstanceClass: Redis instance type.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: Instance id of created redis instance.

attr_instance_name^Required

attr_instance_name: typing.Union[str, IResolvable]

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

Attribute InstanceName: Name of created redis instance.

attr_instance_type^Required

attr_instance_type: typing.Union[str, IResolvable]

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

Attribute InstanceType: The engine type of the instance.

attr_network_type^Required

attr_network_type: typing.Union[str, IResolvable]

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

Attribute NetworkType: The network type.

attr_node_type^Required

attr_node_type: typing.Union[str, IResolvable]

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

Attribute NodeType: The type of node.

attr_order_id^Required

attr_order_id: typing.Union[str, IResolvable]

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

Attribute OrderId: Order Id of created instance.

attr_package_type^Required

attr_package_type: typing.Union[str, IResolvable]

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

Attribute PackageType: The plan type.

attr_port^Required

attr_port: typing.Union[str, IResolvable]

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

Attribute Port: Port of created instance.

attr_private_ip^Required

attr_private_ip: typing.Union[str, IResolvable]

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

Attribute PrivateIp: The internal IP address of the instance.

attr_public_connection_port^Required

attr_public_connection_port: typing.Union[str, IResolvable]

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

Attribute PublicConnectionPort: The public connection port of the instance.

attr_public_connection_string^Required

attr_public_connection_string: typing.Union[str, IResolvable]

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

Attribute PublicConnectionString: The public connection string of the instance.

attr_qps^Required

attr_qps: typing.Union[str, IResolvable]

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

Attribute QPS: The queries per second (QPS) supported by the instance.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.

attr_vpc_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

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

Attribute VpcId: The ID of the VPC.

attr_vpc_private_connection_port^Required

attr_vpc_private_connection_port: typing.Union[str, IResolvable]

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

Attribute VpcPrivateConnectionPort: The vpc private connection port of the instance.

attr_vpc_private_connection_string^Required

attr_vpc_private_connection_string: typing.Union[str, IResolvable]

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

Attribute VpcPrivateConnectionString: The vpc private connection string of the instance.

attr_v_switch_id^Required

attr_v_switch_id: typing.Union[str, IResolvable]

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

Attribute VSwitchId: The ID of the vSwitch.

attr_zone_id^Required

attr_zone_id: typing.Union[str, IResolvable]

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

Attribute ZoneId: The ID of the zone.

props^Required

props: InstanceProps

• Type: InstanceProps