APIEjemplos de Cloud Control con AWS CLI

Para crear un recurso

En el siguiente create-resource ejemplo, se crea un recurso AWS: :Kinesis: :Stream, denominado ResourceExample, con un período de retención de 168 horas y un recuento de fragmentos de tres.

aws cloudcontrol create-resource \
    --type-name AWS::Kinesis::Stream \
    --desired-state "{\"Name\": \"ResourceExample\",\"RetentionPeriodHours\":168, \"ShardCount\":3}"

Salida:

{
    "ProgressEvent": {
        "EventTime": 1632506656.706,
        "TypeName": "AWS::Kinesis::Stream",
        "OperationStatus": "IN_PROGRESS",
        "Operation": "CREATE",
        "Identifier": "ResourceExample",
        "RequestToken": "20999d87-e304-4725-ad84-832dcbfd7fc5"
    }
}

Para obtener más información, consulta Cómo crear un recurso en la Guía del usuario de Cloud Control. API

Para eliminar un recurso

En el siguiente delete-resource ejemplo, se elimina un recurso AWS: :Kinesis: :Stream con el identificador ResourceExample de su cuenta. AWS

aws cloudcontrol delete-resource \
    --type-name AWS::Kinesis::Stream \
    --identifier ResourceExample

Salida:

{
    "ProgressEvent": {
        "TypeName": "AWS::Kinesis::Stream",
        "Identifier": "ResourceExample",
        "RequestToken": "e48f26ff-d0f9-4ab8-a878-120db1edf111",
        "Operation": "DELETE",
        "OperationStatus": "IN_PROGRESS",
        "EventTime": 1632950300.14
    }
}

Para obtener más información, consulta Eliminar un recurso en la Guía del usuario de Cloud Control. API

Para obtener la información de estado de una solicitud de recursos

En el siguiente get-resource-request-status ejemplo, se devuelve la información de estado de la solicitud de recursos especificada.

aws cloudcontrol get-resource-request-status \
    --request-token "e1a6b86e-46bd-41ac-bfba-001234567890"

Salida:

{
    "ProgressEvent": {
        "TypeName": "AWS::Kinesis::Stream",
        "Identifier": "Demo",
        "RequestToken": "e1a6b86e-46bd-41ac-bfba-001234567890",
        "Operation": "CREATE",
        "OperationStatus": "FAILED",
        "EventTime": 1632950268.481,
        "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.",
        "ErrorCode": "AlreadyExists"
    }
}

Para obtener más información, consulta Administrar las solicitudes de operaciones de recursos en la Guía del API usuario de Cloud Control.

Para obtener el estado actual de un recurso

El siguiente get-resource ejemplo devuelve el estado actual del recurso AWS: :Kinesis: :Stream denominado. ResourceExample

aws cloudcontrol get-resource \
    --type-name AWS::Kinesis::Stream \
    --identifier ResourceExample

Salida:

{
    "TypeName": "AWS::Kinesis::Stream",
    "ResourceDescription": {
        "Identifier": "ResourceExample",
        "Properties": "{\"Arn\":\"arn:aws:kinesis:us-west-2:099908667365:stream/ResourceExample\",\"RetentionPeriodHours\":168,\"Name\":\"ResourceExample\",\"ShardCount\":3}"
    }
}

Para obtener más información, consulta Cómo leer el estado actual de un recurso en la Guía del usuario de Cloud Control API.

Para enumerar las solicitudes de operación de recursos activas

En el siguiente list-resource-requests ejemplo, se enumeran las solicitudes de recursos CREATE y UPDATE las operaciones que han fallado en su AWS cuenta.

aws cloudcontrol list-resource-requests \
    --resource-request-status-filter Operations=CREATE,OperationStatuses=FAILED

Salida:

{
    "ResourceRequestStatusSummaries": [
        {
            "TypeName": "AWS::Kinesis::Stream",
            "Identifier": "Demo",
            "RequestToken": "e1a6b86e-46bd-41ac-bfba-633abcdfdbd7",
            "Operation": "CREATE",
            "OperationStatus": "FAILED",
            "EventTime": 1632950268.481,
            "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.",
            "ErrorCode": "AlreadyExists"
        }
    ]
}

Para obtener más información, consulta Administrar las solicitudes de operaciones de recursos en la Guía del API usuario de Cloud Control.

Para enumerar los recursos de un tipo determinado

En el siguiente list-resources ejemplo, se enumeran los recursos AWS: :Kinesis: :Stream aprovisionados en su cuenta. AWS

aws cloudcontrol list-resources \
    --type-name AWS::Kinesis::Stream

Salida:

{
    "TypeName": "AWS::Kinesis::Stream",
    "ResourceDescriptions": [
        {
            "Identifier": "MyKinesisStream",
            "Properties": "{\"Name\":\"MyKinesisStream\"}"
        },
        {
            "Identifier": "AnotherStream",
            "Properties": "{\"Name\":\"AnotherStream\"}"
        }
    ]
}

Para obtener más información, consulta Cómo descubrir recursos en la Guía del usuario de Cloud Control. API

Para actualizar las propiedades de un recurso existente

En el siguiente update-resource ejemplo, se actualiza la política de retención de un LogGroup recurso AWS: :Logs:: denominado ExampleLogGroup 90 días.

aws cloudcontrol update-resource \
    --type-name AWS::Logs::LogGroup \
    --identifier ExampleLogGroup \
    --patch-document "[{\"op\":\"replace\",\"path\":\"/RetentionInDays\",\"value\":90}]"

Salida:

{
    "ProgressEvent": {
        "EventTime": "2021-08-09T18:17:15.219Z",
        "TypeName": "AWS::Logs::LogGroup",
        "OperationStatus": "IN_PROGRESS",
        "Operation": "UPDATE",
        "Identifier": "ExampleLogGroup",
        "RequestToken": "5f40c577-3534-4b20-9599-0b0123456789"
    }
}

Para obtener más información, consulta Cómo actualizar un recurso en la Guía del API usuario de Cloud Control.