ALIYUN::REDIS::Instance

Syntax

{
  "Type": "ALIYUN::REDIS::Instance",
  "Properties": {
    "VpcId": String,
    "Capacity": Integer,
    "EvictionPolicy": String,
    "BackupPolicy": Map,
    "ZoneId": String,
    "InstanceClass": String,
    "InstanceMaintainTime": Map,
    "Tags": List,
    "VpcPasswordFree": Boolean,
    "VSwitchId": String,
    "SecurityGroupId": String,
    "EngineVersion": String,
    "SSLEnabled": String,
    "Password": String,
    "InstanceName": String,
    "DeletionForce": Boolean,
    "Connections": Map,
    "ChargeType": String,
    "Period": Integer,
    "AutoRenewDuration": Integer
  }
}

Properties

BackupPolicy syntax

"BackupPolicy": {
  "PreferredBackupPeriod": "String",
  "PreferredBackupTime": "String",
  "EnableBackupLog": "Integer"
}

BackupPolicy properties

InstanceMaintainTime syntax

"InstanceMaintainTime": {
  "MaintainStartTime": "String",
  "MaintainEndTime": "String"
}

InstanceMaintainTime properties

Tags syntax

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]  

Tags properties

Connections syntax

"Connections": {
  "VpcPrivateConnection": "Map",
  "ClassicInnerConnection": "Map",
  "DirectConnection": "Map",
  "PublicConnection": "Map"
}

Connections properties

VpcPrivateConnection syntax

"VpcPrivateConnection": {
  "ConnectionPort": Integer,
  "ConnectionString": String
}

VpcPrivateConnection properties

PublicConnection syntax

"PublicConnection": {
  "ConnectionPort": Integer,
  "ConnectionString": String
}

PublicConnection properties

DirectConnection syntax

"DirectConnection": {
  "ConnectionPort": Integer,
  "ConnectionString": String
}

DirectConnection properties

ClassicInnerConnection syntax

"ClassicInnerConnection": {
  "ConnectionPort": Integer,
  "ConnectionString": String
}

ClassicInnerConnection properties

Return values

Fn::GetAtt

• InstanceId: the ID of the instance.
• OrderId: the order ID of the instance.
• ConnectionDomain: the endpoint that is used to connect to the instance.
• Port: the service port of the ApsaraDB for Redis instance.
• InstanceName: the name of the instance.
• InstanceClass: the instance type.
• VpcId: the ID of the VPC.
• Capacity: the storage capacity of the instance.
• InstanceType: the database engine type of the instance.
• ChargeType: the billing method of the instance.
• PackageType: the type of the plan.
• Connections: the maximum number of connections that are supported by the instance.
• ArchitectureType: the architecture type.
• NodeType: the node type.
• HasRenewChangeOrder: indicates whether the instance has pending renewal or configuration upgrade orders within the current Alibaba Cloud account.
• ResourceGroupId: the ID of the resource group.
• QPS: the queries per second. The value is set to the expected maximum QPS.
• ZoneId: the ID of the zone to which the instance belongs.
• Bandwidth: the bandwidth of the instance. Unit: Mbit/s.
• EngineVersion: the database engine version of the instance.
• NetworkType: the network type of the instance.
• VSwitchId: the ID of the vSwitch.
• PrivateIp: the private IP address of the instance.
• PublicConnectionString: the public endpoint that is used to access the instance.
• VpcPrivateConnectionPort: the port that allows users to access the instance by using the VPC endpoint.
• ClassicInnerConnectionString: the classic network endpoint that is used to access the instance.
• VpcPrivateConnectionString: the VPC endpoint that is used to access the instance.
• PublicConnectionPort: the port that allows users to access the instance by using the public endpoint.
• DirectConnectionString: the private endpoint that is used to access the instance.
• DirectConnectionPort: the port that allows users to access the instance by using the private endpoint.
• ClassicInnerConnectionPort: the port that allows users to access the instance by using the classic network endpoint.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": {
     
    "en": "Alibaba Cloud ROS Sample Template: Create a Redis instance of a VPC network type."
  },
  "Parameters": {
    "InstanceClass": {
      "Type": "String",
      "Default": "redis.master.small.default",
      "Label": {
         
        "en": "Instance Type"
      }
    },
    "EvictionPolicy": {
      "Label": {
         
        "en": "Eviction Policy"
      },
      "AllowedValues": [
        "noeviction",
        "allkeys-lru",
        "volatile-lru",
        "allkeys-random",
        "volatile-random",
        "volatile-ttl"
      ],
      "Description": {
         
        "en": "Cache data eviction strategy: volatile-lru(Most recently used expired data), volatile-ttl(Being expiring data), volatile-random(Any expired data), allkeys-lru(Least recently used data), allkeys-random(Arbitrarily select data), and no-enviction(Do not delete any data)."
      },
      "Type": "String",
      "Default": "noeviction"
    },
    "InstanceName": {
      "Type": "String",
      "Description": {
          
        "en": "The instance name, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'."
      },
      "Label": {
         
        "en": "Instance Name"
      },
      "Default": "DefaultRedis"
    },
    "Password": {
      "NoEcho": true,
      "Type": "String",
      "Description": {
        "en": "Length 8-32 characters, can contain size letters, Numbers and special symbols, including:! @ # $ % ^  * ( ) _ + - =",
         
      },
      "Label": {
        "en": "Instance Password",
         
      },
      "ConstraintDescription": {
        "en": "8-32 characters, can contain size letters, Numbers and special symbols, including:! @ # $ % ^  * ( ) _ + - =",
         
      },
      "MinLength": "8",
      "MaxLength": "32"
    },
    "ZoneId": {
      "Type": "String",
      "Description": {
         
        "en": "Before you create an instance, confirm that the Availability Zone supports the specifications of Redis resources."
      },
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId",
      "Label": {
        "en": "Zone ID",
         
      }
    }
  },
  "Resources": {
    "EcsVpc": {
      "Type": "ALIYUN::ECS::VPC",
      "Properties": {
        "CidrBlock": "192.168.0.0/16"
      }
    },
    "EcsVSwitch": {
      "DependsOn": "EcsVpc",
      "Type": "ALIYUN::ECS::VSwitch",
      "Properties": {
        "VpcId": {
          "Ref": "EcsVpc"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "CidrBlock": "192.168.10.0/24"
      }
    },
    "RedisInstance": {
      "DependsOn": "EcsVSwitch",
      "Type": "ALIYUN::REDIS::Instance",
      "Properties": {
        "VpcId": {
          "Ref": "EcsVpc"
        },
        "VSwitchId": {
          "Ref": "EcsVSwitch"
        },
        "InstanceClass": {
          "Ref": "InstanceClass"
        },
        "EvictionPolicy": {
          "Ref": "EvictionPolicy"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "InstanceName": {
          "Ref": "InstanceName"
        },
        "Password": {
          "Ref": "Password"
        }
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Value": {
        "Fn::GetAtt": [
          "RedisInstance",
          "InstanceId"
        ]
      }
    }
  }
}

To view more examples, visit Instance.json and Instance.yml. In the examples, the ALIYUN::REDIS::Account, ALIYUN::REDIS::Instance, and ALIYUN::REDIS::Whitelist resource types are used.