ALIYUN::GPDB::InstancePublicConnection is used to allocate a public connection string to an instance.
Syntax
{
"Type": "ALIYUN::GPDB::DBInstance",
"Properties": {
"AddressType": String,
"DBInstanceId": String,
"ConnectionStringPrefix": String,
"Port": Integer
}
}Properties
Parameter | Type | Required | Update requires | Description | Constraints |
DBInstanceId | String | Yes | Replacement | The ID of the instance. | You can create an instance and get its instance ID by using ALIYUN::GPDB::DBInstance, ALIYUN::GPDB::ElasticDBInstance, or the AnalyticDB for PostgreSQL console. |
Port | Integer | Yes | Replacement | The port number. | None |
ConnectionStringPrefix | String | Yes | Replacement | The connection string prefix. | None |
AddressType | String | No | Replacement | The network type. | Valid values:
|
Response parameters
Fn::GetAtt
DBInstanceId: The ID of the instance.
ConnectionString: The public connection string.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Resources:
InstancePublicConnection:
Type: 'ALIYUN::GPDB::InstancePublicConnection'
Properties:
ConnectionStringPrefix: gp-2zef492q66we7h***-mytest
DBInstanceId: gp-2zef492q66we7h***
Port: 5432
Outputs:
DBInstanceId:
Value:
Fn::GetAtt:
- InstancePublicConnection
- DBInstanceId
ConnectionString:
Value:
Fn::GetAtt:
- InstancePublicConnection
- ConnectionString{
"ROSTemplateFormatVersion": "2015-09-01",
"Resources": {
"InstancePublicConnection": {
"Type": "ALIYUN::GPDB::InstancePublicConnection",
"Properties": {
"ConnectionStringPrefix": "gp-2zef492q66we7h***-mytest",
"DBInstanceId": "gp-2zef492q66we7h***",
"Port": 5432
}
}
},
"Outputs": {
"DBInstanceId": {
"Value": { "Fn::GetAtt": ["InstancePublicConnection", "DBInstanceId"] }
},
"ConnectionString": {
"Value": { "Fn::GetAtt": ["InstancePublicConnection", "ConnectionString"] }
}
}
}