Uso de los tipos de API recursos de Cloud Control - Control en la nube API

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Uso de los tipos de API recursos de Cloud Control

Para usar un tipo de recurso con AWS Cloud Control API, ese tipo de recurso debe estar presente y activado en tu Cuenta de AWS. Los tipos AWS de recursos admitidos son públicos y están siempre activados. También puede optar por activar los tipos de recursos públicos que ofrecen editores externos a través del registro de AWS CloudFormation extensiones.

El registro de extensiones es una función AWS CloudFormation que contiene información detallada sobre los tipos de recursos disponibles para su uso en la cuenta. Estos pueden incluir tipos de recursos publicados por terceros, además de los que publica AWS. Con el registro, puede administrar los tipos de recursos de su cuenta, incluidos los siguientes:

  • Vea los tipos de recursos disponibles y activados.

  • Registre tipos de recursos privados para su uso en la cuenta.

  • Active tipos de recursos de terceros.

  • Administre las versiones de los tipos de recursos, incluida la configuración de la versión predeterminada de un tipo de recurso en su cuenta.

  • Establezca las propiedades de configuración de la cuenta de un tipo de recurso, si las tiene.

También puedes usar el AWS CloudFormation registro para ver el esquema de un tipo de recurso, que contiene información importante sobre cómo usar el recurso con Cloud ControlAPI, como las definiciones de propiedades y los requisitos de permiso. Para obtener más información, consulte Visualización de esquemas de tipos de recursos.

El registro está disponible a través de la CloudFormation consola, además de CloudFormationAPI.

nota

Actualmente, no todos los tipos de recursos que figuran en el CloudFormation registro son compatibles con Cloud ControlAPI. Para obtener más información, consulte Determinar si un tipo de recurso es compatible con Cloud Control API.

Para obtener más información sobre las opciones de administración de los tipos de recursos, consulta Cómo usar el CloudFormation registro en la Guía del AWS CloudFormation usuario.

Administrar los tipos de recursos mediante AWS CloudFormation API

Además de acceder al registro de extensiones a través de la AWS CloudFormation consola, puede utilizar las operaciones incluidas en el AWS CloudFormation API para identificar y administrar los tipos de recursos de su cuenta. En la siguiente tabla se enumeran las API operaciones que puede utilizar para descubrir, activar y configurar los tipos de recursos disponibles en su cuenta.

CloudFormation APIoperación AWS CLI comando Descripción

DescribeType

describe-type

Devuelve información detallada sobre un tipo de recurso.

ListTypes

list-types

Devuelve información resumida sobre un tipo de recurso.

ActivateType

activate-type

Activa un tipo de recurso público de terceros, lo que lo pone a disposición para su uso en la cuenta.

DeactivateType

deactivate-type

Desactiva un tipo de recurso público de terceros en su cuenta.

ListTypeVersions

list-type-versions

Devuelve información resumida sobre las versiones de un tipo de recurso.

SetTypeDefaultVersion

set-type-default-version

Especifica la versión predeterminada de un tipo de recurso.

BatchDescribeTypeConfigurations

batch-describe-type-configurations

Devuelve datos de configuración de los tipos de recursos especificados.

SetTypeConfiguration

set-type-configuration

Especifica los datos de configuración de un tipo de recurso de su cuenta.

RegisterType

register-type

Registra un recurso privado de terceros, lo que lo pone a disposición para su uso en la cuenta.

DeregisterType

deregister-type

Anula el registro de un recurso privado de terceros y lo elimina del uso activo de su cuenta.

Determinar si un tipo de recurso es compatible con Cloud Control API

De forma predeterminada, los tipos de recursos publicados en el CloudFormation registro admiten automáticamente las operaciones de API recursos de Cloud Control. Esto incluye los tipos de recursos privados, además de los tipos de recursos públicos de terceros. Sin embargo, el AWS CloudFormation registro también contiene tipos de recursos heredados, clasificados como no aprovisionables. Actualmente, estos tipos de recursos no son compatibles con Cloud Control API y no puedes usarlos en las operaciones de recursos.

Para ver una lista de los tipos de recursos AWS públicos que actualmente admiten las operaciones de API recursos de Cloud Control, consultaTipos de recursos compatibles con Cloud Control API.

También puedes usar AWS Command Line Interface (AWS CLI) para generar una lista de los tipos de recursos compatibles o para determinar si un tipo de recurso específico es compatible con Cloud ControlAPI.

Generar una lista de recursos compatibles mediante el AWS CLI
  • Use el comando list-types con los siguientes parámetros:

    • type: especifique RESOURCE para seleccionar solo los tipos de recursos.

    • visibility: especifique PUBLIC para seleccionar recursos públicos o PRIVATE, para recursos privados.

    • provisioning-type: especifique FULLY_MUTABLE o IMMUTABLE para seleccionar solo aquellos tipos de recursos que se pueden aprovisionar.

    Por ejemplo, el siguiente comando selecciona los primeros 100 tipos de recursos públicos del CloudFormation registro que son totalmente mutables.

    $ aws cloudformation list-types \ --type RESOURCE --visibility PUBLIC \ --provisioning-type FULLY_MUTABLE --max-results 100
Determinar si un tipo de recurso específico es compatible con Cloud Control API mediante el AWS CLI
  • Use el comando describe-type para devolver detalles del tipo de recurso.

    Los tipos de recursos con una FULLY_MUTABLE o ProvisioningType varias operaciones de API recursos de Cloud Control son IMMUTABLE compatibles con ellas.

    El siguiente ejemplo devuelve los detalles del tipo de recurso AWS::Logs::LogGroup.

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

Visualización de esquemas de tipos de recursos

Durante las operaciones de creación y actualización de recursos, se especifican las propiedades de los recursos que se van a establecer y sus valores. Las propiedades de un recurso se definen en su esquema de tipos de recursos. Esto incluye el tipo de datos, si la propiedad es obligatoria, los valores válidos y otras restricciones de propiedad.

Puedes ver el esquema de un tipo de recurso mediante la CloudFormation consola o el AWS CLI. Además, la Guía del usuario de AWS CloudFormation contiene temas de referencia de cada tipo de recurso disponible que publica AWS . Para obtener información detallada sobre las propiedades de los tipos de recursos, además de ejemplos de uso, consulte los temas correspondientes en la sección Referencia de tipos de recursos y propiedades de AWS.

nota

No todos los tipos de recursos que aparecen en la Guía del AWS CloudFormation usuario están disponibles para su uso con Cloud ControlAPI. Para determinar si un tipo de recurso está disponible, consulteTipos de recursos compatibles con Cloud Control API.

Para obtener información detallada sobre el esquema de definición del tipo de recurso, que define cómo se puede crear un esquema de tipo de recurso, consulte el esquema de definición del tipo de recurso en la Guía del CloudFormation CLI usuario para el desarrollo de extensiones.

Para obtener información sobre cómo ver el estado actual de un recurso existente, que incluye sus valores de propiedad actuales, consulteLeer un recurso con AWS Cloud Control API.

Visualización de un esquema de tipo de recurso mediante la AWS CloudFormation consola

  1. Inicie sesión en AWS Management Console y abra la AWS CloudFormation consola en https://console.aws.amazon.com/cloudformation.

  2. En el panel CloudFormationde navegación, en Registro, selecciona Extensiones activadas.

  3. En la pestaña Tipos de recursos, seleccione el tipo de recurso cuyo esquema de recursos quiere ver.

    CloudFormation muestra la página de detalles del tipo de recurso. El esquema de recursos se muestra en la pestaña Esquema.

Visualización de un esquema de tipo de recurso mediante el AWS CLI

  • Ejecute describe-type.

    En el resultado devuelto, la estructura de Schema contiene el esquema de tipos de recursos.

    Por ejemplo, el siguiente comando devuelve información sobre el tipo de recurso AWS::Logs::LogGroup.

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

Visualización de los atributos de propiedad del recurso

Las propiedades de un tipo de recurso se definen en la sección properties del esquema de tipos de recursos. Esto incluye el tipo de datos de la propiedad, si la propiedad es obligatoria y cualquier restricción, como los valores permitidos o los patrones obligatorios.

Además, determinados atributos establecidos en el recurso determinan cuándo se puede especificar una propiedad o si se puede especificar. Esto incluye:

  • Las propiedades definidas como required deben especificarse en el estado deseado durante la creación del recurso.

  • Los usuarios pueden establecer las propiedades definidas como createOnlyProperties, pero solo durante la creación del recurso.

  • Los usuarios no pueden establecer las propiedades definidas como readOnlyProperties.

  • Los usuarios pueden especificar las propiedades definidas como writeOnlyProperties al crear o actualizar un recurso, pero no se pueden devolver durante una solicitud de lectura o lista.

Visualización de las operaciones de recursos compatibles

Puede determinar qué operaciones admiten un tipo de recurso consultando la sección handlers de su esquema de tipos de recursos. Si el tipo de recurso admite una operación, aparece en la sección handlers y contiene un elemento permissions que enumera los permisos que requiere el controlador.

Por ejemplo, a continuación se muestra la sección handlers del esquema del tipo de recurso correspondiente al tipo de recurso AWS::Logs::LogGroup. En esta sección se muestra que este tipo de recurso admite las cinco operaciones de recursos y se enumeran los permisos que requiere cada controlador.

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