Instance

• Implements: IInstance

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

Initializers

import ros_cdk_memcache
ros_cdk_memcache.Instance(
  scope: Construct,
  id: str,
  auto_renew: typing.Union[str, IResolvable] = None,
  auto_renew_period: typing.Union[str, IResolvable] = None,
  auto_use_coupon: typing.Union[str, IResolvable] = None,
  backup_policy: typing.Union[IResolvable, BackupPolicyProperty] = None,
  capacity: typing.Union[typing.Union[int, float], IResolvable] = None,
  charge_type: typing.Union[str, IResolvable] = None,
  config: typing.Union[str, IResolvable] = None,
  coupon_no: typing.Union[str, IResolvable] = None,
  instance_class: typing.Union[str, IResolvable] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  network_type: typing.Union[str, IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  period: typing.Union[str, IResolvable] = None,
  private_ip_address: typing.Union[str, IResolvable] = None,
  resource_group_id: 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^Optional

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

Property autoRenew: Specifies whether to enable auto renewal.

Valid values: true false Note Default value: false.

auto_renew_period^Optional

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

auto_use_coupon^Optional

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

Property autoUseCoupon: Specifies whether to use a coupon.

Valid values: true false Note Default value: false.

backup_policy^Optional

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

Property backupPolicy: Backup policy.

capacity^Optional

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

charge_type^Optional

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

config^Optional

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

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

For more information, see Set parameters.

coupon_no^Optional

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

Property couponNo: The coupon code.

Default value: default.

instance_class^Optional

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

instance_name^Optional

• Type: typing.Union[str, 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 @\/:=”<>{[]}.

network_type^Optional

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

Property networkType: The network type of the instance.

Valid values: CLASSIC VPC Note Default value: CLASSIC.

password^Optional

• Type: typing.Union[str, 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 !@#$%^&*()_+-=.

period^Optional

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

private_ip_address^Optional

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

resource_group_id^Optional

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

Property resourceGroupId: Resource group ID.

vpc_id^Optional

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

Property vpcId: The ID of the VPC.

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 ID of the VSwitch.

zone_id^Optional

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

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_memcache
ros_cdk_memcache.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_connection_domain^Required

attr_connection_domain: typing.Union[str, IResolvable]

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

Attribute ConnectionDomain: The internal endpoint of the instance.

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: The globally unique identifier (GUID) of the instance.

attr_instance_name^Required

attr_instance_name: typing.Union[str, IResolvable]

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

Attribute InstanceName: The name of the instance.

attr_port^Required

attr_port: typing.Union[str, IResolvable]

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

Attribute Port: Port of created instance.

attr_qps^Required

attr_qps: typing.Union[str, IResolvable]

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

Attribute QPS: QPS.

props^Required

props: InstanceProps

• Type: InstanceProps