Skip to content

PrepayInstance

This class encapsulates and extends the ROS resource type ALIYUN::REDIS::PrepayInstance, which is used to create a subscription ApsaraDB for Redis instance.

Initializers 

import ros_cdk_redis
ros_cdk_redis.PrepayInstance(
  scope: Construct,
  id: str,
  auto_pay: typing.Union[bool, IResolvable] = None,
  auto_renew_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  backup_policy: typing.Union[IResolvable, BackupPolicyProperty] = 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,
  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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] Property autoPay: Indicates whether automatic payment is enabled.
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.
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.
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtection: Specifies whether to enable the release protection feature for the instance.
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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

auto_payOptional

  • Type: typing.Union[bool, 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 is False

auto_renew_durationOptional

  • 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

Property backupPolicy: Backup policy.

connectionsOptional

Property connections: Connection address.

deletion_forceOptional

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

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

Default is false

deletion_protectionOptional

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

  • 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

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

Property evictionPolicy: The eviction policy of cache data storage.

instance_classOptional

  • 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

Property instanceMaintainTime: Instance maintain time.

instance_nameOptional

  • 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

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

Property nodeType: The type of node.

Valid value:

  • STAND_ALONE
  • MASTER_SLAVE
  • double
  • single

passwordOptional

  • 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

  • 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

  • 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

  • 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

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

Property resourceGroupId: Resource group id.

secondary_zone_idOptional

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

Property secondaryZoneId: The secondary zone ID of the instance.

security_group_idOptional

  • 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

  • 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

  • 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

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

Property tairConfig: Tair config.

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

vpc_idOptional

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

Property vpcId: The VPC id to create ecs instance.

vpc_password_freeOptional

  • 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

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

Property vSwitchId: The vSwitch Id to create ecs instance.

zone_idOptional

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

Property zoneId: The zone id of input region.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_architecture_type ros_cdk_core.IResolvable Attribute ArchitectureType: The architecture.
attr_bandwidth ros_cdk_core.IResolvable Attribute Bandwidth: The bandwidth of the instance.
attr_capacity ros_cdk_core.IResolvable Attribute Capacity: The storage capacity of the instance.
attr_charge_type ros_cdk_core.IResolvable Attribute ChargeType: The billing method of the instance.
attr_classic_inner_connection_port ros_cdk_core.IResolvable Attribute ClassicInnerConnectionPort: The classic inner connection port of the instance.
attr_classic_inner_connection_string ros_cdk_core.IResolvable Attribute ClassicInnerConnectionString: The classic inner connection string of the instance.
attr_connection_domain ros_cdk_core.IResolvable Attribute ConnectionDomain: Connection domain of created instance.
attr_connections ros_cdk_core.IResolvable Attribute Connections: The maximum number of connections supported by the instance.
attr_direct_connection_port ros_cdk_core.IResolvable Attribute DirectConnectionPort: The direct connection port of the instance.
attr_direct_connection_string ros_cdk_core.IResolvable Attribute DirectConnectionString: The direct connection string of the instance.
attr_engine_version ros_cdk_core.IResolvable Attribute EngineVersion: The engine version of the instance.
attr_has_renew_change_order ros_cdk_core.IResolvable Attribute HasRenewChangeOrder: Indicates whether the Alibaba Cloud account has pending renewal or scaling orders.
attr_instance_class ros_cdk_core.IResolvable Attribute InstanceClass: Redis instance type.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: Instance id of created redis instance.
attr_instance_name ros_cdk_core.IResolvable Attribute InstanceName: Name of created redis instance.
attr_instance_type ros_cdk_core.IResolvable Attribute InstanceType: The engine type of the instance.
attr_network_type ros_cdk_core.IResolvable Attribute NetworkType: The network type.
attr_node_type ros_cdk_core.IResolvable Attribute NodeType: The type of node.
attr_order_id ros_cdk_core.IResolvable Attribute OrderId: Order Id of created instance.
attr_package_type ros_cdk_core.IResolvable Attribute PackageType: The plan type.
attr_port ros_cdk_core.IResolvable Attribute Port: Port of created instance.
attr_private_ip ros_cdk_core.IResolvable Attribute PrivateIp: The internal IP address of the instance.
attr_public_connection_port ros_cdk_core.IResolvable Attribute PublicConnectionPort: The public connection port of the instance.
attr_public_connection_string ros_cdk_core.IResolvable Attribute PublicConnectionString: The public connection string of the instance.
attr_qps ros_cdk_core.IResolvable Attribute QPS: The queries per second (QPS) supported by the instance.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: The ID of the VPC.
attr_vpc_private_connection_port ros_cdk_core.IResolvable Attribute VpcPrivateConnectionPort: The vpc private connection port of the instance.
attr_vpc_private_connection_string ros_cdk_core.IResolvable Attribute VpcPrivateConnectionString: The vpc private connection string of the instance.
attr_v_switch_id ros_cdk_core.IResolvable Attribute VSwitchId: The ID of the vSwitch.
attr_zone_id ros_cdk_core.IResolvable Attribute ZoneId: The ID of the zone.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_architecture_typeRequired 

attr_architecture_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ArchitectureType: The architecture.

attr_bandwidthRequired 

attr_bandwidth: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Bandwidth: The bandwidth of the instance.

Unit: Mbit/s.

attr_capacityRequired 

attr_capacity: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Capacity: The storage capacity of the instance.

Unit: MB.

attr_charge_typeRequired 

attr_charge_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ChargeType: The billing method of the instance.

attr_classic_inner_connection_portRequired 

attr_classic_inner_connection_port: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_classic_inner_connection_stringRequired 

attr_classic_inner_connection_string: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_connection_domainRequired 

attr_connection_domain: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ConnectionDomain: Connection domain of created instance.

attr_connectionsRequired 

attr_connections: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_direct_connection_portRequired 

attr_direct_connection_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DirectConnectionPort: The direct connection port of the instance.

attr_direct_connection_stringRequired 

attr_direct_connection_string: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DirectConnectionString: The direct connection string of the instance.

attr_engine_versionRequired 

attr_engine_version: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EngineVersion: The engine version of the instance.

attr_has_renew_change_orderRequired 

attr_has_renew_change_order: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_instance_classRequired 

attr_instance_class: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceClass: Redis instance type.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: Instance id of created redis instance.

attr_instance_nameRequired 

attr_instance_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceName: Name of created redis instance.

attr_instance_typeRequired 

attr_instance_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceType: The engine type of the instance.

attr_network_typeRequired 

attr_network_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NetworkType: The network type.

attr_node_typeRequired 

attr_node_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NodeType: The type of node.

attr_order_idRequired 

attr_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OrderId: Order Id of created instance.

attr_package_typeRequired 

attr_package_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PackageType: The plan type.

attr_portRequired 

attr_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Port: Port of created instance.

attr_private_ipRequired 

attr_private_ip: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PrivateIp: The internal IP address of the instance.

attr_public_connection_portRequired 

attr_public_connection_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PublicConnectionPort: The public connection port of the instance.

attr_public_connection_stringRequired 

attr_public_connection_string: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PublicConnectionString: The public connection string of the instance.

attr_qpsRequired 

attr_qps: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: The ID of the VPC.

attr_vpc_private_connection_portRequired 

attr_vpc_private_connection_port: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_vpc_private_connection_stringRequired 

attr_vpc_private_connection_string: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_v_switch_idRequired 

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchId: The ID of the vSwitch.

attr_zone_idRequired 

attr_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneId: The ID of the zone.