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.
Actualizar un recurso con AWS Cloud Control API
Utilice el comando update-resource
para realizar actualizaciones en un recurso existente. Esto incluye los recursos que no se aprovisionaron originalmente con Cloud ControlAPI.
importante
Recomendamos encarecidamente no utilizar Cloud Control API para actualizar los recursos que otros servicios gestionan activamente. Si lo hace, pueden producirse resultados inesperados. Por ejemplo, no utilices Cloud Control API para actualizar los recursos que actualmente forman parte de una AWS CloudFormation pila.
Para actualizar un recurso existente, debe especificar el identificador del recurso. Para obtener más información acerca de la determinación del identificador de un recurso, consulte Uso del identificador principal de un recurso.
La actualización de un recurso implica cambiar los valores de las propiedades del recurso. Las propiedades de un recurso se definen en su esquema de tipos de recursos. Esto incluye si la propiedad es obligatoria, los valores válidos y otras restricciones de propiedad. Para obtener más información acerca de la visualización de definiciones de propiedades de los recursos, consulte Visualización de esquemas de tipos de recursos.
Redacción del documento de parche
Para actualizar un recurso, primero debes definir las actualizaciones como una lista de operaciones de parches incluida en un documento de JSON parches. Este documento de parche debe cumplir con el estándar definido en el parche RFC 6902: JavaScript Object Notation (JSON)
Cada operación de parche define una única actualización de una propiedad de recurso específica. Las siguientes propiedades son necesarias:
-
op
: tipo de operación. Cloud Control API admite todas las operaciones definidas en RFC 6902:add
,remove
,replace
move
copy
, y.test
-
path
: la ruta a la propiedad del recurso, en relación con la secciónproperties
del esquema de recursos.
En función de la operación, es posible que se requieran propiedades adicionales. Consulte RFC 6902 para obtener información específica.
Al utilizar el comando update-resource
, puede especificar el documento de parche en línea como una cadena o la ubicación de un archivo.
El siguiente ejemplo actualiza la política de retención de un AWS::Logs::LogGroup
recurso denominado 90 CloudControlApiLogGroup
días.
$
aws cloudcontrol update-resource --type-name AWS::Logs::LogGroup \ --identifier CloudControlApiLogGroup \ --patch-document '[{"op":"test","path":"RetentionInDays","value":90}]'
Cómo API actualiza Cloud Control los recursos
Para actualizar un recurso, Cloud Control API primero recupera el estado actual del recurso y, después, lo actualiza en un proceso de dos pasos:
-
Cloud Control API combina las operaciones de parche especificadas en la solicitud de actualización con el estado actual del recurso para generar el estado deseado del recurso una vez actualizado. Las operaciones se aplican secuencialmente en el orden en que aparecen en el documento de parche. Cada operación de la secuencia se aplica al estado actual del recurso; el estado del recurso resultante se convierte en el objetivo de la siguiente operación.
En este punto, se produce un error en toda la solicitud de actualización si:
-
Una operación de parche incluida en la solicitud no es válida.
-
Se produce un error en una operación de parche de tipo
op
test
.
En esos casos, se API produce un error en toda la solicitud de actualización y Cloud Control no actualiza el recurso.
-
-
APILuego, Cloud Control llama al controlador de actualizaciones del tipo de recurso para actualizar el recurso.
Si el controlador de actualizaciones falla en algún momento, Cloud Control API no restablece el recurso a su estado anterior.
Por ejemplo, consideremos el siguiente documento de parches, que se define para actualizar un AWS::Logs::LogGroup
recurso. El documento contiene dos operaciones de parche. La primera operación es de tipo test
y comprueba si la política de retención del recurso está establecida en 3653 días. Si ese es el caso, el recurso pasa la prueba y Cloud Control API pasa a la siguiente operación. Esta operación reemplaza el valor de la política de retención actual por 180 días. Si la política de retención del recurso se establece en un valor distinto de 3653 días, la primera test
operación fallará y Cloud Control API nunca ejecutará la segundareplace
.
[ { "op": "test", "path": "/RetentionInDays", "value":3653 }, { "op": "replace", "path": "/RetentionInDays", "value":180 } ]
Seguimiento del progreso de una solicitud de actualización de recurso
El comando update-resource
devuelve un objeto ProgressEvent
que puede utilizar para hacer un seguimiento del estado actual de la solicitud de operación de recurso. Para obtener más información, consulte Seguimiento del progreso de las solicitudes de operación de recursos.