ALIYUN::GPDB::Database - Resource Orchestration Service - Alibaba Cloud Documentation Center

The ALIYUN::GPDB::Database resource creates a database.

Syntax

{
  "Type": "ALIYUN::GPDB::Database",
  "Properties": {
    "DBInstanceId": String,
    "DatabaseName": String,
    "Owner": String,
    "CharacterSetName": String,
    "Collate": String,
    "Ctype": String,
    "Description": String
  }
}

Properties

Parameter	Type	Required	Editable	Description	Constraints
DatabaseName	String	Yes	No	The name of the database.	None
DBInstanceId	String	Yes	No	The instance ID.	None
Owner	String	Yes	No	The database owner.	None
CharacterSetName	String	No	No	The character set.	Default value: `UTF8`.
Collate	String	No	No	The collation, which defines rules for string comparison and sorting.	None
Ctype	String	No	No	The character type, which defines rules for character classification and case conversion.	None
Description	String	No	No	The description of the database.	None

Return values

Fn::GetAtt

ConnLimit: The maximum connection limit. A value of -1 indicates no limit.
CharacterSetName: The character set. The default value is UTF8.
TableSpace: The database tablespace.
Owner: The database owner.
Description: The description of the database.
DBInstanceId: The instance ID.
Size: The database size.
DatabaseName: The name of the database.
Collate: The collation, which defines rules for string comparison and sorting.
Ctype: The character type, which defines rules for character classification and case conversion.
AccessPrivilege: The access privilege.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  CharacterSetName:
    Type: String
    Description: 'The character set. Default value: UTF8.'
    Required: false
  Owner:
    Type: String
    Description: The database owner.
    Required: true
  Description:
    Type: String
    AssociationProperty: TextArea
    Description: The description of the database.
    Required: false
  DBInstanceId:
    Type: String
    Description: The ID of the AnalyticDB for PostgreSQL instance.
    Required: true
  DatabaseName:
    Type: String
    Description: The name of the database.
    Required: true
  Collate:
    Type: String
    Description: 'The collation, which defines rules for string comparison and sorting.'
    Required: false
  Ctype:
    Type: String
    Description: 'The character type, which defines rules for character classification and case conversion.'
    Required: false
Resources:
  ExtensionResource:
    Type: ALIYUN::GPDB::Database
    Properties:
      CharacterSetName:
        Ref: CharacterSetName
      Owner:
        Ref: Owner
      Description:
        Ref: Description
      DBInstanceId:
        Ref: DBInstanceId
      DatabaseName:
        Ref: DatabaseName
      Collate:
        Ref: Collate
      Ctype:
        Ref: Ctype
Outputs:
  ConnLimit:
    Description: 'The maximum connection limit. A value of -1 indicates no limit.'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - ConnLimit
  CharacterSetName:
    Description: 'The character set. The default value is UTF8.'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CharacterSetName
  TableSpace:
    Description: The database tablespace.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - TableSpace
  Owner:
    Description: The database owner.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Owner
  Description:
    Description: The description of the database.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Description
  DBInstanceId:
    Description: The instance ID.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DBInstanceId
  Size:
    Description: The database size.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Size
  DatabaseName:
    Description: The name of the database.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DatabaseName
  Collate:
    Description: 'The collation, which defines rules for string comparison and sorting.'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Collate
  Ctype:
    Description: 'The character type, which defines rules for character classification and case conversion.'
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Ctype
  AccessPrivilege:
    Description: The access privilege.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - AccessPrivilege

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "CharacterSetName": {
      "Type": "String",
      "Description": "The character set. Default value: UTF8.",
      "Required": false
    },
    "Owner": {
      "Type": "String",
      "Description": "The database owner.",
      "Required": true
    },
    "Description": {
      "Type": "String",
      "AssociationProperty": "TextArea",
      "Description": "The description of the database.",
      "Required": false
    },
    "DBInstanceId": {
      "Type": "String",
      "Description": "The ID of the AnalyticDB for PostgreSQL instance.",
      "Required": true
    },
    "DatabaseName": {
      "Type": "String",
      "Description": "The name of the database.",
      "Required": true
    },
    "Collate": {
      "Type": "String",
      "Description": "The collation, which defines rules for string comparison and sorting.",
      "Required": false
    },
    "Ctype": {
      "Type": "String",
      "Description": "The character type, which defines rules for character classification and case conversion.",
      "Required": false
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::GPDB::Database",
      "Properties": {
        "CharacterSetName": {
          "Ref": "CharacterSetName"
        },
        "Owner": {
          "Ref": "Owner"
        },
        "Description": {
          "Ref": "Description"
        },
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "DatabaseName": {
          "Ref": "DatabaseName"
        },
        "Collate": {
          "Ref": "Collate"
        },
        "Ctype": {
          "Ref": "Ctype"
        }
      }
    }
  },
  "Outputs": {
    "ConnLimit": {
      "Description": "The maximum connection limit. A value of -1 indicates no limit.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ConnLimit"
        ]
      }
    },
    "CharacterSetName": {
      "Description": "The character set. The default value is UTF8.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CharacterSetName"
        ]
      }
    },
    "TableSpace": {
      "Description": "The database tablespace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TableSpace"
        ]
      }
    },
    "Owner": {
      "Description": "The database owner.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Owner"
        ]
      }
    },
    "Description": {
      "Description": "The description of the database.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "The instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DBInstanceId"
        ]
      }
    },
    "Size": {
      "Description": "The database size.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Size"
        ]
      }
    },
    "DatabaseName": {
      "Description": "The name of the database.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DatabaseName"
        ]
      }
    },
    "Collate": {
      "Description": "The collation, which defines rules for string comparison and sorting.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Collate"
        ]
      }
    },
    "Ctype": {
      "Description": "The character type, which defines rules for character classification and case conversion.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Ctype"
        ]
      }
    },
    "AccessPrivilege": {
      "Description": "The access privilege.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "AccessPrivilege"
        ]
      }
    }
  }
}