资源类型DATASOURCE::KMS::Instance的语法、属性与返回值-资源编排-阿里云

DATASOURCE::KMS::Instance类型用于获取单个KMS实例详情。

语法

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

属性

属性名称

类型

必须

允许更新

描述

约束

InstanceId

String

是

KMS实例的ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

InstanceName：KMS实例名称。
VpcId：绑定KMS实例的VPC ID。
VpcNum：实例的访问管理总量。
InstanceId：KMS实例的ID。
KeyNum：实例支持创建的密钥数量。
VswitchIds：实例绑定的交换机列表。
CreateTime：KMS实例创建的时间。
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": "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"
        ]
      }
    }
  }
}