Usar tipos de recursos - Control API do Cloud Control

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Usar tipos de recursos

Para usar um tipo de recurso comAWS Cloud Control API, esse tipo de recurso deve estar presente e ativado em seuConta da AWS. CompatívelAWSos tipos de recursos são públicos e sempre ativados. Você pode optar por ativar os tipos de recursos públicos oferecidos por editores terceirizados também. Você faz isso e outras tarefas de gerenciamento de tipos de recursos, por meio doAWS CloudFormationRegistro de extensão.

ORegistro de extensãoé uma característica doAWS CloudFormationQue contém informações detalhadas sobre os tipos de recursos disponíveis para uso em sua conta. Eles podem incluir tipos de recursos publicados por terceiros, além daqueles publicados porAWS. Usando o registro, você pode gerenciar os tipos de recursos em sua conta, incluindo:

  • Visualize os tipos de recursos disponíveis e ativados.

  • Registrar tipos de recursos privados para uso em sua conta.

  • Ative tipos de recursos públicos de terceiros.

  • Gerencie o tipo de recursoversões, incluindo definir a versão padrão de um tipo de recurso em sua conta.

  • Defina propriedades de configuração no nível da conta de um tipo de recurso, se ele tiver algum.

Você também pode usar oAWS CloudFormationregistro para exibir o esquema de um tipo de recurso, que contém informações importantes sobre como usar o recurso com a Cloud Control API, como definições de propriedade e requisitos de permissão. Para obter mais informações, consulteExibindo esquemas de tipo de recurso.

O registro está disponível por meio do CloudFormation console, além da API do CloudFormation.

nota

Nem todos os tipos de recursos listados na CloudFormation o registro atualmente oferece suporte à Cloud Control API. Para obter mais informações, consulteDeterminando se um tipo de recurso suporta a Cloud Control API.

Para obter mais informações sobre opções de gerenciamento de tipos de recursos, consulteUsar o CloudFormation registronoAWS CloudFormationGuia do usuário do.

Gerenciando tipos de recursos usando oAWS CloudFormationAPI

Além de acessar o registro de extensão através doAWS CloudFormationconsole, você pode usar as operações incluídas noAWS CloudFormationAPI para identificar e gerenciar os tipos de recursos em sua conta. A tabela abaixo lista as operações de API que você pode usar para descobrir, ativar e configurar os tipos de recursos disponíveis em sua conta.

Operação da API do CloudFormation AWS CLI command Descrição

DescribeType

describe-type

Retorna informações detalhadas sobre um tipo de recurso.

ListTypes

list-types

Retorna informações resumidas sobre um tipo de recurso.

ActiveType

activar-type

Ativa um tipo de recurso público de terceiros, tornando-o disponível para uso em sua conta.

DeactivateType

desactivar-type

Desativa um tipo de recurso público de terceiros em sua conta.

ListTypeVersions

list-type-versions

Retorna informações resumidas sobre as versões de um tipo de recurso.

SetTypeDefaultVersion

set-type-default-version

Especifica a versão padrão de um tipo de recurso.

BatchDescribeTypeConfigurações

configurações do tipo describe-describe-

Retorna dados de configuração para os tipos de recursos especificados.

setTypeConfiguration

set-type-configuration

Especifica os dados de configuração de um tipo de recurso em sua conta.

RegisterType

register-type

Registra um recurso privado de terceiros, tornando-o disponível para uso em sua conta.

DeregisterType

canceler-type

Cancela o registro de um recurso privado de terceiros, removendo-o do uso ativo em sua conta.

Determinando se um tipo de recurso suporta a Cloud Control API

Por padrão, tipos de recursos publicados no CloudFormation o registro oferece suporte automático às operações de recursos da Cloud Control API. Isso inclui tipos de recursos privados, além de tipos de recursos públicos de terceiros. No entanto, oAWS CloudFormationo registro também contém tipos de recursos herdados, classificados comoNão provisionável. Atualmente, esses tipos de recursos não oferecem suporte à Cloud Control API e você não pode usá-los em operações de recursos.

Para uma lista doAWStipos de recursos públicos que atualmente suportam operações de recursos da Cloud Control API, consulteTipos de recursos compatíveis com a Cloud Control API.

Você também pode usar oAWS Command Line Interface(AWS CLI) para gerar uma lista de tipos de recursos compatíveis ou determinar se um tipo de recurso específico oferece suporte à Cloud Control API.

Gerando uma lista de recursos compatíveis usando oAWS CLI

  • Usar alist-typesComando, com os seguintes parâmetros:

    • type— EspecificarRESOURCEpara selecionar apenas tipos de recursos.

    • visibility— EspecificarPUBLICpara selecionar recursos públicos ouPRIVATEPara recursos privados.

    • provisioning-type— EspecificarFULLY_MUTABLEouIMMUTABLEpara selecionar somente os tipos de recursos que são provisionáveis.

    Por exemplo, o comando a seguir seleciona os primeiros 100 tipos de recursos públicos que são totalmente mutáveis a partir do CloudFormation Registro.

    aws cloudformation list-types --type RESOURCE --visibility PUBLIC --provisioning-type FULLY_MUTABLE --max-results 100

Determinar se um tipo de recurso específico oferece suporte à Cloud Control API usando oAWS CLI

  • Usar adescribe-typecomando para retornar detalhes do tipo de recurso.

    Tipos de recursos com umProvisioningTypeDe qualquer umFULLY_MUTABLEouIMMUTABLEsuporte às operações de recursos da Cloud Control API.

    O exemplo a seguir retorna detalhes doAWS::Logs::LogGroupTipo de recurso .

    aws cloudformation describe-type --type RESOURCE --type-name AWS::Logs::LogGroup

Exibindo esquemas de tipo de recurso

Durante as operações de criação e atualização de recursos, você especifica quais propriedades de recurso definir e seus valores. As propriedades de um recurso são definidas em seuEsquema de tipo de recurso. Isso inclui o tipo de dados, se a propriedade é obrigatória, valores válidos e outras restrições de propriedade.

Você pode exibir o esquema de um tipo de recurso usando o CloudFormation Console ou oAWS CLI. Além disso, oAWS CloudFormationGuia do usuário docontém tópicos de referência para cada tipo de recurso disponível queAWSpublica. para oinformações detalhadas sobre propriedades de tipo de recurso, além de exemplos de uso, consulte os tópicos correspondentes naAWSReferência de tipos de propriedades e recursos daseção.

nota

Nem todos os tipos de recursos listados naAWS CloudFormationGuia do usuário doestão disponíveis para uso com a Cloud Control API. Para determinar se um tipo de recurso está disponível, consulteTipos de recursos compatíveis com a Cloud Control API.

Para obter informações detalhadas sobre o esquema de definição de tipo de recurso, que define como o esquema de tipo de recurso pode ser criado, consulteEsquema de definição de tipo de recursonoGuia do usuário da CLI do CloudFormation para desenvolvimento de extensões.

Para obter informações sobre como exibir o estado atual de um recurso existente, que inclui seus valores de propriedade atuais, consulteRecursos de leitura.

Exibindo um esquema de tipo de recurso usando oAWS CloudFormationconsole

  1. Faça login no AWS Management Console e abra o console AWS CloudFormation em https://console.aws.amazon.com/cloudformation.

  2. NoCloudFormationpainel de navegação, emRegistro do, selecioneAtivar extensões.

  3. NoResource types, selecione o tipo de recurso do qual deseja exibir o esquema de recursos do.

    O CloudFormation exibe a página de detalhes do tipo de recurso. O esquema de recursos é exibido naEsquemaGuia.

Exibindo um esquema de tipo de recurso usando oAWS CLI

  • Execute describe-type.

    Na saída retornada, oSchemaestrutura contém o esquema de tipo de recurso.

    Por exemplo, o comando a seguir retorna informações sobre oAWS::Logs::LogGroupTipo de recurso .

    aws cloudformation describe-type --type RESOURCE --type-name AWS::Logs::LogGroup

Exibindo atributos de propriedade de recurso

As propriedades do tipo de recurso são definidas napropertiesseção do esquema de tipo de recurso. Isso inclui o tipo de dados da propriedade, se a propriedade é necessária e quaisquer restrições, como valores permitidos ou padrões obrigatórios.

Além disso, determinados atributos definidos no nível do recurso governam quando ou se uma propriedade pode ser especificada. Isso inclui:

  • Propriedades definidas comorequireddeve ser especificado no estado desejado durante a criação do recurso.

  • Propriedades definidas comocreateOnlyPropertiespode ser definido pelos usuários, mas somente durante a criação de recursos.

  • Propriedades definidas comoreadOnlyPropertiesnão pode ser definido pelos usuários.

  • Propriedades definidas comowriteOnlyPropertiespode ser especificado pelos usuários ao criar ou atualizar um recurso, mas não pode ser retornado durante uma solicitação de leitura ou lista.

Exibição de operações de recursos compatíveis

Você pode determinar quais operações um tipo de recurso suporta referindo-se aohandlersseção de seu esquema de tipo de recurso. Se o tipo de recurso suportar uma operação, ele será listado nahandlersseção, e contém umpermissionselemento que lista as permissões necessárias pelo manipulador.

Por exemplo, abaixo está ohandlersseção do esquema de tipo de recurso para oAWS::Logs::LogGroupTipo de recurso . Esta seção mostra que esse tipo de recurso oferece suporte a todas as cinco operações de recurso e lista as permissões necessárias por cada manipulador.

"handlers": { "create": { "permissions": [ "logs:DescribeLogGroups", "logs:CreateLogGroup", "logs:PutRetentionPolicy" ] }, "read": { "permissions": [ "logs:DescribeLogGroups" ] }, "update": { "permissions": [ "logs:DescribeLogGroups", "logs:AssociateKmsKey", "logs:DisassociateKmsKey", "logs:PutRetentionPolicy", "logs:DeleteRetentionPolicy" ] }, "delete": { "permissions": [ "logs:DescribeLogGroups", "logs:DeleteLogGroup" ] }, "list": { "permissions": [ "logs:DescribeLogGroups" ] } }