DATASOURCE::KMS::Instance 属性と戻り値 - ROS

DATASOURCE::KMS::Instance は、Key Management Service (KMS) インスタンスに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::KMS::Instance",
  "Properties": {
    "InstanceId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

InstanceId

String

はい

インスタンス ID。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時にデータソースリソースをリフレッシュするポリシー。

有効な値：

Never (デフォルト): スタックの更新時にデータソースリソースをリフレッシュしません。
Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

InstanceName: インスタンス名。
VpcId: インスタンスが存在する仮想プライベートクラウド (VPC) の ID。
VpcNum: インスタンスのアクセス管理クォータ。
InstanceId: インスタンス ID。
KeyNum: インスタンスに作成できるキーの数。
VswitchIds: インスタンスが接続されている vSwitch。
CreateTime: インスタンスが作成された時刻。
SecretNum: インスタンスに作成できるシークレットの数。
ZoneIds: インスタンスが存在するゾーン。
Spec: インスタンスのコンピューティングパフォーマンス。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description:
      en: The ID of the KMS instance.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::KMS::Instance
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  InstanceName:
    Description: The name of the KMS instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceName
  VpcId:
    Description: The virtual private cloud (VPC) with which the KMS instance is associated..
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VpcId
  VpcNum:
    Description: The number of managed accesses. The maximum number of VPCs that can access this KMS instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VpcNum
  InstanceId:
    Description: The ID of the KMS instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceId
  KeyNum:
    Description: The number of keys that can be created for the KMS instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - KeyNum
  VswitchIds:
    Description: The VSwitch in the VPC.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - VswitchIds
  CreateTime:
    Description: The time when the KMS instance is created.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  SecretNum:
    Description: The number of secrets that can be created for the KMS instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SecretNum
  ZoneIds:
    Description: The zone with which the KMS instance is associated.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ZoneIds
  Spec:
    Description: The computation performance level of the KMS instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Spec

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the KMS instance."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::KMS::Instance",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "InstanceName": {
      "Description": "KMS インスタンスの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceName"
        ]
      }
    },
    "VpcId": {
      "Description": "KMS インスタンスが関連付けられている仮想プライベートクラウド (VPC)。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "VpcNum": {
      "Description": "管理対象アクセスの数。この KMS インスタンスにアクセスできる VPC の最大数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcNum"
        ]
      }
    },
    "InstanceId": {
      "Description": "KMS インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceId"
        ]
      }
    },
    "KeyNum": {
      "Description": "KMS インスタンスに作成できるキーの数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "KeyNum"
        ]
      }
    },
    "VswitchIds": {
      "Description": "VPC 内の VSwitch。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VswitchIds"
        ]
      }
    },
    "CreateTime": {
      "Description": "KMS インスタンスが作成された時刻。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "SecretNum": {
      "Description": "KMS インスタンスに作成できるシークレットの数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecretNum"
        ]
      }
    },
    "ZoneIds": {
      "Description": "KMS インスタンスが関連付けられているゾーン。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneIds"
        ]
      }
    },
    "Spec": {
      "Description": "KMS インスタンスの計算パフォーマンスレベル。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Spec"
        ]
      }
    }
  }
}