ALIYUN::POLARDB::DBClusterEndpointAddress を使用してパブリックエンドポイントを作成 - Resource Orchestration Service (ROS)

ALIYUN::POLARDB::DBClusterEndpointAddress は、Apsara PolarDB クラスタのパブリックエンドポイントを作成するために使用されます。パブリックエンドポイントは、プライマリエンドポイント、デフォルトクラスタエンドポイント、またはカスタムクラスタエンドポイントです。

構文

{
  "Type": "ALIYUN::POLARDB::DBClusterEndpointAddress",
  "Properties": {
    "DBClusterId": String,
    "ConnectionStringPrefix": String,
    "DBEndpointId": String,
    "NetType": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
DBClusterId	String	はい	いいえ	クラスタの ID です。	なし。
DBEndpointId	String	はい	いいえ	クラスタエンドポイントの ID です。	操作を呼び出して、クラスタエンドポイントの ID を照会できます。
ConnectionStringPrefix	String	いいえ	はい	クラスタエンドポイントのプレフィックスです。	プレフィックスは 6 文字以上で、小文字、数字、およびハイフン (-) を含めることができます。文字で始まり、ハイフン (-) で終わることはできません。
NetType	String	いいえ	いいえ	クラスタエンドポイントのネットワークタイプです。	有効な値: Public Private デフォルト値: Public。

レスポンスパラメータ

Fn::GetAtt

ConnectionString: クラスタの接続文字列。
Address: IP アドレス。

例

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "DBClusterEndpointAddress": {
      "Type": "ALIYUN::POLARDB::DBClusterEndpointAddress",
      "Properties": {
        "DBClusterId": {
          "Ref": "DBClusterId"
        },
        "ConnectionStringPrefix": {
          "Ref": "ConnectionStringPrefix"
        },
        "DBEndpointId": {
          "Ref": "DBEndpointId"
        },
        "NetType": {
          "Ref": "NetType"
        }
      }
    }
  },
  "Parameters": {
    "DBClusterId": {
      "Type": "String",
      "Description": "パブリック接続ポイントを作成する ApsaraDB for POLARDB クラスタの ID です。" // The ID of the ApsaraDB for POLARDB cluster for which a public connection point is to be created.
    },
    "ConnectionStringPrefix": {
      "AllowedPattern": "[a-z][-a-z0-9]{4,28}[a-z0-9]",
      "Type": "String",
      "Description": "接続文字列のプレフィックスです。プレフィックスは、以下のルールに準拠する必要があります。文字で始まり、小文字、数字、およびハイフン (-) で構成され、ダッシュで終わることはできません。長さは 6 ～ 30 文字です。" // The prefix of the connection string. The prefix must comply with the following rules: It must start with a letter and consist of lowercase letters, digits, and hyphens(-), cannot end with a dash. The length is 6~30 characters.
    },
    "DBEndpointId": {
      "Type": "String",
      "Description": "クラスタ接続ポイントの ID です。" // The ID of the cluster connection point.
    },
    "NetType": {
      "Default": "Public",
      "Type": "String",
      "Description": "接続文字列のネットワークタイプです。Public に設定すると、ROS はパブリックアドレスを作成、変更、および削除します。Private に設定すると、ROS はプライベートアドレスのみを変更します。デフォルトは Public です。" // The network type of the connection string. If set to Public, ROS will create, modify and delete Public address for you. If set to Private, ROS will only modify Private address for you. Default to Public.
      "AllowedValues": [
        "Public",
        "Private"
      ]
    }
  },
  "Outputs": {
    "ConnectionString": {
      "Description": "エンドポイントアドレスの接続文字列です。" // The connection string of the endpoint address.
      "Value": {
        "Fn::GetAtt": [
          "DBClusterEndpointAddress",
          "ConnectionString"
        ]
      }
    },
    "Address": {
      "Description": "エンドポイントアドレスの詳細です。" // The details of the endpoint address.
      "Value": {
        "Fn::GetAtt": [
          "DBClusterEndpointAddress",
          "Address"
        ]
      }
    }
  }
}

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  DBClusterEndpointAddress:
    Type: ALIYUN::POLARDB::DBClusterEndpointAddress
    Properties:
      DBClusterId:
        Ref: DBClusterId
      ConnectionStringPrefix:
        Ref: ConnectionStringPrefix
      DBEndpointId:
        Ref: DBEndpointId
      NetType:
        Ref: NetType
Parameters:
  DBClusterId:
    Type: String
    Description: パブリック接続ポイントを作成する ApsaraDB for POLARDB クラスタの ID です。 # The ID of the ApsaraDB for POLARDB cluster for which a public connection point is to be created.
  ConnectionStringPrefix:
    AllowedPattern: "[a-z][-a-z0-9]{4,28}[a-z0-9]"
    Type: String
    Description: 接続文字列のプレフィックスです。プレフィックスは、以下のルールに準拠する必要があります。文字で始まり、小文字、数字、およびハイフン (-) で構成され、ダッシュで終わることはできません。長さは 6 ～ 30 文字です。 # The prefix of the connection string. The prefix must comply with the following rules: It must start with a letter and consist of lowercase letters, digits, and hyphens (-), cannot end with a dash.The length is 6~30 characters.
  DBEndpointId:
    Type: String
    Description: クラスタ接続ポイントの ID です。 # The ID of the cluster connection point.
  NetType:
    Default: Public
    Type: String
    Description: 接続文字列のネットワークタイプです。Public に設定すると、ROS はパブリックアドレスを作成、変更、および削除します。Private に設定すると、ROS はプライベートアドレスのみを変更します。デフォルトは Public です。 # The network type of the connection string. If set to Public, ROS will create, modify and delete Public address for you. If set to Private, ROS will only modify Private address for you. Default to Public.
    AllowedValues:
    - Public
    - Private
Outputs:
  ConnectionString:
    Description: エンドポイントアドレスの接続文字列です。 # The connection string of the endpoint address.
    Value:
      Fn::GetAtt:
      - DBClusterEndpointAddress
      - ConnectionString
  Address:
    Description: エンドポイントアドレスの詳細です。 # The details of the endpoint address.
    Value:
      Fn::GetAtt:
      - DBClusterEndpointAddress
      - Address