ALIYUN::POLARDB::GlobalDatabaseNetwork - Resource Orchestration Service

ALIYUN::POLARDB::GlobalDatabaseNetwork is used to create a global database network (GDN).

Syntax

{
  "Type": "ALIYUN::POLARDB::GlobalDatabaseNetwork",
  "Properties": {
    "ResourceGroupId": String,
    "DbClusterId": String,
    "GdnDescription": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ResourceGroupId	String	No	Yes	The ID of the resource group.	None.
DbClusterId	String	Yes	No	The ID of the primary cluster.	None.
GdnDescription	String	No	Yes	The description of the GDN.	The description must meet the following requirements: The description cannot start with `http://` or `https://`. The description must start with a letter. The description can contain letters, digits, underscores (_), and hyphens (-). The description must be 2 to 126 characters in length.

Return values

Fn::GetAtt

Connections: the information about the connections to the GDN.
DbClusters: the clusters that are included in the GDN.
DbVersion: the version of the database engine.
CreateTime: the time when the GDN was created.
GdnId: the ID of the GDN.
DbType: the type of the database engine.
GdnDescription: the description of the GDN.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionResource:
    Type: ALIYUN::POLARDB::GlobalDatabaseNetwork
    Properties:
      DbClusterId: pc-bp1q76364ird*****
      GdnDescription: GDN-fortest
Outputs:
  Connections:
    Description: The information about the connection to the cluster.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Connections
  DbClusters:
    Description: The clusters that are included in the GDN.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DbClusters
  DbVersion:
    Description: The version of the database engine.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DbVersion
  CreateTime:
    Description: The time at which the GDN was created.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  GdnId:
    Description: The ID of the GDN.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - GdnId
  DbType:
    Description: The type of the database engine.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DbType
  GdnDescription:
    Description: The description of the GDN.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - GdnDescription

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::POLARDB::GlobalDatabaseNetwork",
      "Properties": {
        "DbClusterId": "pc-bp1q76364ird*****",
        "GdnDescription": "GDN-fortest"
      }
    }
  },
  "Outputs": {
    "Connections": {
      "Description": "The information about the connection to the cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Connections"
        ]
      }
    },
    "DbClusters": {
      "Description": "The clusters that are included in the GDN.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DbClusters"
        ]
      }
    },
    "DbVersion": {
      "Description": "The version of the database engine.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DbVersion"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time at which the GDN was created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "GdnId": {
      "Description": "The ID of the GDN.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "GdnId"
        ]
      }
    },
    "DbType": {
      "Description": "The type of the database engine.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DbType"
        ]
      }
    },
    "GdnDescription": {
      "Description": "The description of the GDN.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "GdnDescription"
        ]
      }
    }
  }
}