Todos os produtos
Search
Central de documentação

Resource Orchestration Service:DATASOURCE::KMS::Instance

Última atualização: Jun 27, 2026

Consulta os detalhes de uma instância do Key Management Service (KMS).

Sintaxe

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

Propriedades

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

InstanceId

String

Sim

Sim

ID da instância do KMS.

Nenhuma.

RefreshOptions

String

Não

Sim

Política de atualização dos recursos da source de dados durante a atualização da pilha.

Valores válidos:

  • Never (padrão): não atualiza os recursos da source de dados durante a atualização da pilha.

  • Always: atualiza os recursos da source de dados sempre que a pilha for atualizada.

Valores de retorno

Fn::GetAtt

  • InstanceName: nome da instância do KMS.

  • VpcId: ID da Virtual Private Cloud (VPC) associada à instância do KMS.

  • VpcNum: número máximo de VPCs com acesso à instância do KMS.

  • InstanceId: ID da instância do KMS.

  • KeyNum: quantidade de chaves criáveis para a instância do KMS.

  • VswitchIds: vSwitches na VPC conectada à instância do KMS.

  • CreateTime: momento de criação da instância do KMS.

  • SecretNum: quantidade de segredos criáveis para a instância do KMS.

  • ZoneIds: zonas associadas à instância do KMS.

  • Spec: nível de desempenho computacional da instância do KMS.

Exemplos

  • YAML formato

    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 formato

    {
      "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"
            ]
          }
        }
      }
    }