ALIYUN::REDIS::PrepayInstance

Syntax

{
  "Type": "ALIYUN::REDIS::PrepayInstance",
  "Properties": {
    "VpcId": String,
    "Capacity": Integer,
    "EvictionPolicy": String,
    "Period": Integer,
    "ZoneId": String,
    "InstanceClass": String,
    "VpcPasswordFree": Boolean,
    "VSwitchId": String,
    "SecurityGroupId": String,
    "EngineVersion": String,
    "Password": String,
    "SSLEnabled": String,
    "InstanceName": String,
    "BackupPolicy": Map,
    "Tags": List,
    "InstanceMaintainTime": Map,
    "DeletionForce": Boolean,
    "AutoPay": Boolean,
    "Connections": Map,
    "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 ID of the order.
• ConnectionDomain: the endpoint that is used to connect to the instance.
• Port: the port number of the instance.
• InstanceName: the name of the instance.
• InstanceClass: the specifications of the instance.
• VpcId: the ID of the VPC.
• Capacity: the storage capacity of the instance.
• InstanceType: the type of the database engine that the instance uses.
• 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 type of the architecture.
• NodeType: the type of the node.
• HasRenewChangeOrder: indicates whether the instance has pending renewal or resource scaling orders within the current Alibaba Cloud account.
• ResourceGroupId: the ID of the resource group.
• QPS: the queries per second (QPS). The value is set to the expected maximum QPS.
• ZoneId: the ID of the zone in which the instance is deployed.
• Bandwidth: the bandwidth of the instance. Unit: Mbit/s.
• EngineVersion: the version of the database engine that the instance uses.
• NetworkType: the network type of the instance.
• VSwitchId: the ID of the vSwitch.
• PrivateIp: the private IP address of the instance.
• PublicConnectionString: the prefix of the public endpoint that is used to access the instance.
• VpcPrivateConnectionPort: the port number that allows you to access the instance by using the VPC endpoint.
• ClassicInnerConnectionString: the prefix of the classic network endpoint that is used to access the instance.
• VpcPrivateConnectionString: the prefix of the VPC endpoint that is used to access the instance.
• PublicConnectionPort: the port number that allows you to access the instance by using the public endpoint.
• DirectConnectionString: the prefix of the private endpoint that is used to access the instance through the direct connection mode.
• DirectConnectionPort: the port number that allows you to access the instance by using the private endpoint through the direct connection mode.
• ClassicInnerConnectionPort: the port number that allows you to access the instance by using the classic network endpoint.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test Create Redis PrepayInstance",
  "Parameters": {
    "InstanceClass": {
      "Type": "String",
      "Description": "Instance Class"
    },
    "VpcName": {
      "Type": "String",
      "Default": "mytest"
    },
    "VSwitchName": {
      "Type": "String",
      "Default": "mytest"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId"
    },
    "EngineVersion": {
      "Type": "String",
      "Description": "AllowedValues: 2.8, 4.0, 5.0",
      "Default": "5.0"
    }
  },
  "Resources": {
    "Vpc": {
      "Type": "ALIYUN::ECS::VPC",
      "Properties": {
        "VpcName": {
          "Ref": "VpcName"
        },
        "CidrBlock": "192.168.0.0/16"
      }
    },
    "VSwitch": {
      "DependsOn": "Vpc",
      "Type": "ALIYUN::ECS::VSwitch",
      "Properties": {
        "VpcId": {
          "Ref": "Vpc"
        },
        "VSwitchName": {
          "Ref": "VSwitchName"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "CidrBlock": "192.168.10.0/24"
      }
    },
    "RedisPrepayInstance": {
      "Type": "ALIYUN::REDIS::PrepayInstance",
      "Properties": {
        "InstanceClass": {
          "Ref": "InstanceClass"
        },
        "EngineVersion": {
          "Ref": "EngineVersion"
        },
        "VpcId": {
          "Ref": "Vpc"
        },
        "VSwitchId": {
          "Ref": "VSwitch"
        }
      }
    }
  },
  "Outputs": {
    "OrderId": {
      "Value": {
        "Fn::GetAtt": [
          "RedisPrepayInstance",
          "OrderId"
        ]
      }
    }
  }
}

To view more examples, visit Instance.json and Instance.yml.