Skip to content

Instance

This class encapsulates and extends the ROS resource type ALIYUN::Memcache::InstanceALIYUN::MEMCACHE::Instance is used to create an ApsaraDB for Memcache (OCS) 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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
auto_renew typing.Union[str, ros_cdk_core.IResolvable] Property autoRenew: Specifies whether to enable auto renewal.
auto_renew_period typing.Union[str, ros_cdk_core.IResolvable] Property autoRenewPeriod: The period of the auto renewal.
auto_use_coupon typing.Union[str, ros_cdk_core.IResolvable] Property autoUseCoupon: Specifies whether to use a coupon.
backup_policy typing.Union[ros_cdk_core.IResolvable, BackupPolicyProperty] Property backupPolicy: Backup policy.
capacity typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property capacity: The storage capacity of the instance.
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: The billing method of the instance.
config typing.Union[str, ros_cdk_core.IResolvable] Property config: The parameter configuration of the instance, in a JSON string.
coupon_no typing.Union[str, ros_cdk_core.IResolvable] Property couponNo: The coupon number.
instance_class typing.Union[str, ros_cdk_core.IResolvable] Property instanceClass: The instance type.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The name of the instance.
network_type typing.Union[str, ros_cdk_core.IResolvable] Property networkType: The network type of the instance.
password typing.Union[str, ros_cdk_core.IResolvable] Property password: The password of the instance.
period typing.Union[str, ros_cdk_core.IResolvable] Property period: The subscription period.
private_ip_address typing.Union[str, ros_cdk_core.IResolvable] Property privateIpAddress: The internal IP address of the instance.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group ID.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC.
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 ID of the VSwitch.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The ID of the zone in which the instance is created.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

auto_renewOptional

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

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

Property autoRenewPeriod: The period of the auto renewal.

Unit: months. Valid values: 1 2 3 6 12 Note You must specify this parameter if the value of the AutoRenew parameter is true.

auto_use_couponOptional

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

Property backupPolicy: Backup policy.

capacityOptional

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

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

configOptional

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

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

Property couponNo: The coupon number.

Default value: youhuiquan_promotion_option_id_for_blank.

instance_classOptional

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

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

Property instanceName: The name of the instance.

The name can be 2 to 128 characters in length and must start with a letter. The following characters are not supported: at signs (@), forward slashes (/), colons (:), equal signs (=), double quotation marks ("), angle brackets (<>), braces ([]), curly brackets ({}) and spaces.

network_typeOptional

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

Property networkType: The network type of the instance.

Valid values: CLASSIC VPC Note Default value: CLASSIC.

passwordOptional

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

Property password: The password of the instance.

The password can be 8 to 32 characters in length and must contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! at signs (@), number signs (#), dollar signs ($), percent signs (%), carets (^), ampersands (&), asterisks (*), parentheses (()), underscores (_), plus signs (+), hyphens (-), and equal signs (=).

periodOptional

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

Property period: The subscription period.

You must specify this parameter if the value of the ChargeType parameter is PrePaid. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36. Note This parameter is invalid if the value of the ChargeType parameter is PostPaid.

private_ip_addressOptional

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

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

Property resourceGroupId: Resource group ID.

vpc_idOptional

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

Property vpcId: The ID of the VPC.

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

zone_idOptional

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

Property zoneId: The ID of the zone in which the instance is created.

You can call the DescribeRegions operation to query the latest region list.

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_memcache
ros_cdk_memcache.Instance.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_connection_domain ros_cdk_core.IResolvable Attribute ConnectionDomain: The internal endpoint of the instance.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The globally unique identifier (GUID) of the instance.
attr_instance_name ros_cdk_core.IResolvable Attribute InstanceName: The name of the instance.
attr_port ros_cdk_core.IResolvable Attribute Port: Port of created instance.
attr_qps ros_cdk_core.IResolvable Attribute QPS: QPS.

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_connection_domainRequired 

attr_connection_domain: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ConnectionDomain: The internal endpoint of the instance.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_instance_nameRequired 

attr_instance_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceName: The name of the instance.

attr_portRequired 

attr_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Port: Port of created instance.

attr_qpsRequired 

attr_qps: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute QPS: QPS.