Updated on 2022-02-22 GMT+08:00

DCS.Redis

Element Description

Distributed Cache Service (DCS) is an online, distributed, in-memory cache service. It is reliable, scalable, usable out of the box, and easy to manage. Compatible with Redis and Memcached, DCS supports three instance types: single-node, master/standby, and cluster. It can meet your requirements for high read/write performance and fast data access.

Element Properties

Table 1 Property Description

Property

Mandatory

Descripiton

vpcId

Yes

ID of the VPC to which the DCS instance belongs

Type: Cloud.VPC.VPC.Id

Value Description: Use the ID of an existing VPC or a new VPC. To use a new VPC ID, you need to define the VPC object in the template and establish the dependency. You are advised to drag the object to the VPC to automatically establish the dependency.

Value Constraint: The value must satisfy the UUID generation rule.

Suggestion: 1. Use the get_input function to set this field, and then the value can be automatically selected on the AOS console. 2. Use the get_reference function to obtain the VPC.VPC element created by the stack. 3. Obtain the ID of the created VPC from the VPC console.

capacity

Yes

Capacity of the DCS instance

Type: integer

Value Description: Customize the value.

Default: 2

Value Constraint: Currently, the value can only be 2, 4, 8, 16, 32, 64, 128, 256, 512, or 1024.

Suggestion: Use the default value.

description

No

Description of the DCS instance

Type: string

Value Description: Customize the value.

Value Constraint: {u'max_length': 1024}

name

No

Name of the DCS instance

Type: string

Value Description: Customize the value.

Value Constraint: The value must start with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.

securityGroupId

Yes

ID of the security group used by the DCS instance

Type: Cloud.VPC.SecurityGroup.Id

Value Description: Obtains the security group ID from the VPC service or connects to the VPC.SecurityGroup to automatically generate a security group ID.

Suggestion: 1. Use the get_input function to set this field, and then the value can be automatically selected on the AOS console. 2. Use the get_reference function to obtain the VPC.SecurityGroup element created by the stack. 3. Obtain the ID of the created security group from the VPC console.

availablityZone1

No

AZ1 to which the DCS instance belongs

Type: Cloud.ECS.AvailabilityZone.Name

Value Description: AZ1 to which the DCS instance belongs. The AZ can be automatically selected on the AOS console. You need to specify the AZ name, for example, ae-ad-1a. For details, see the Regions and Endpoints page.

Value Constraint: The value varies depending on regions.

Suggestion: Use the get_input function to set this field, and then the value can be automatically selected on the AOS console.

instanceMode

Yes

Type of the DCS instance

Type: string

Default: single

Value Constraint: Currently, the value can only be single, HA, or cluster.

Suggestion: Use the default value.

availablityZone2

No

AZ2 to which the DCS instance belongs. AZ2 is required for creating master/standby DCS instances.

Type: Cloud.ECS.AvailabilityZone.Name

Value Description: AZ2 to which the DCS instance belongs. The AZ can be automatically selected on the AOS console and must be different from AZ1. You need to specify the AZ name. For details, see the Regions and Endpoints page.

Value Constraint: The value varies depending on regions.

Suggestion: Use the get_input function to set this field, and then the value can be automatically selected on the AOS console.

instanceBackupPolicy

No

Backup plan of the DCS instance

Type: DCS.InstanceBackupPolicy

Value Description: Customize the value.

Default: {u'extendParam': {u'backupAt': [], u'beginAt': u'00', u'periodType': u'weekly'}, u'backupType': u'auto', u'saveDays': 1}

Suggestion: Use the default value.

maintainBegin

No

Start time of the maintenance time window

Type: string

Default: 02:00:00

Value Constraint: Currently, the value can only be 02:00, 06:00, 10:00, 14:00, 18:00, or 22:00.

Suggestion: Use the default value.

subnetId

Yes

Subnet ID of the DCS instance

Type: Cloud.VPC.Subnet.Id

Value Description: Use the ID of an existing subnet or a new subnet. To use a new subnet ID, you need to define the subnet object in the template and establish the dependency. You are advised to connect the VPC.Subnet to automatically establish the dependency.

Value Constraint: The subnet must correspond to the VPC.

Suggestion: 1. Use the get_input function to set this field, and then the value can be automatically selected on the AOS console. 2. Use the get_reference function to obtain the VPC.Subnet element created by the stack. 3. Obtain the ID of the created subnet from the VPC console.

maintainEnd

No

End time of the maintenance time window

Type: string

Default: 06:00:00

Value Constraint: Currently, the value can only be 06:00, 10:00, 14:00, 18:00, 22:00, or 02:00.

Suggestion: Use the default value.

password

Yes

Login password of the DCS instance

Type: password

Value Description: Customize the value.

Value Constraint: 1. The parameter must be written into inputs and set using the get_input function. 2. It must not be a weak password. Enter 6 to 32 characters. Only uppercase and lowercase letters, digits, and special characters `~!@#$%^&*()-_=+\|[{}]:'",<.>/? are allowed. The password must contain at least two types of characters.

Suggestion: You are advised to use the get_input function to obtain the value and avoid plaintext passwords to ensure security.

Relationships Between Elements

Table 2 Relationship description

Description

Target

Connected

VPC.Subnet

Connected

VPC.SecurityGroup

Inclusion

VPC.VPC

Return Value

Property

Type

Description

refIP

string

Access IP address of the DCS instance

refPort

integer

Access port of the DCS instance

refName

string

Name of the DCS instance

refID

string

ID of the DCS instance

chargeMode

string

Billing mode of the DCS instance

Blueprint Example

tosca_definitions_version: cloud_tosca_version_1_0
inputs:
  dcs-name:
    default: my-dcsinstance
  dcs-description:
    default: dcs service
  dcs-capacity:
    default: 2
  dcs-vpcId:
    default: fdcd13cf-579e-41d6-b2b5-01cda2f37719
  dcs-securityGroupId:
    default: 07f01d47-11fc-4b9b-bce3-f0f47350ad7a
  dcs-subnetId:
    default: 85786d98-06ed-4d33-a85c-572238649029
  dcs-password:
    default: "******"
  dcs-instanceMode:
    default: "single"
node_templates:
  my-dcs:
    type: Cloud.DCS.Redis
    properties:
      name: {get_input: dcs-name}
      description: {get_input: dcs-description}
      capacity: {get_input: dcs-capacity}
      vpcId: {get_input: dcs-vpcId}
      securityGroupId: {get_input: dcs-securityGroupId}
      subnetId: {get_input: dcs-subnetId}
      password: {get_input: dcs-password}
      instanceMode: {get_input: dcs-instanceMode}