Exemples d’utilisation de l’AWS CLI avec l’API Cloud Control

Pour créer une ressource

L’exemple create-resource suivant crée une ressource AWS::Kinesis::Stream, nommée ResourceExample, avec une période de conservation de 168 heures et trois partitions.

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

Sortie :

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

Pour plus d’informations, consultez Création d’une ressource dans le Guide de l’utilisateur de l’API Cloud Control.

Pour supprimer une ressource

L’exemple delete-resource suivant supprime une ressource AWS::Kinesis::Stream portant l’identifiant ResourceExample de votre compte AWS.

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

Sortie :

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

Pour plus d’informations, consultez Suppression d’une ressource dans le Guide de l’utilisateur de l’API Cloud Control.

Pour obtenir les informations de statut d’une demande de ressource

L’exemple get-resource-request-status suivant renvoie les informations de statut relatives à la demande de ressource spécifiée.

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

Sortie :

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

Pour plus d’informations, consultez Gestion des demandes d’opérations de ressources dans le Guide de l’utilisateur de l’API Cloud Control.

Pour obtenir l’état actuel d’une ressource

L’exemple get-resource suivant renvoie l’état actuel de la ressource AWS::Kinesis::Stream nommée ResourceExample.

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

Sortie :

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

Pour plus d’informations, consultez Lecture de l’état actuel d’une ressource dans le Guide de l’utilisateur de l’API Cloud Control.

Pour répertorier les demandes d’opérations de ressources actives

L’exemple list-resource-requests suivant répertorie les demandes de ressources pour les opérations CREATE et UPDATE qui ont échoué dans votre compte AWS.

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

Sortie :

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

Pour plus d’informations, consultez Gestion des demandes d’opérations de ressources dans le Guide de l’utilisateur de l’API Cloud Control.

Pour répertorier les ressources d’un type donné

L’exemple list-resources suivant répertorie les ressources AWS::Kinesis::Stream provisionnées dans votre compte AWS.

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

Sortie :

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

Pour plus d’informations, consultez Découverte des ressources dans le Guide de l’utilisateur de l’API Cloud Control.

Pour mettre à jour les propriétés d’une ressource existante

L’exemple update-resource suivant met à jour la politique de rétention d’une ressource AWS::Logs::LogGroup nommée ExampleLogGroup sur 90 jours.

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

Sortie :

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

Pour plus d’informations, consultez Mise à jour d’une ressource dans le Guide de l’utilisateur de l’API Cloud Control.