Beispiele für die Verwendung der AWS CLI mit Cloud Control API

So erstellen Sie eine Ressource

Im folgenden Beispiel für create-resource wird eine AWS::Kinesis::Stream-Ressource mit dem Namen ResourceExample mit einer Aufbewahrungszeit von 168 Stunden und einer Shard-Anzahl von drei erstellt.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Erstellen einer Ressource im Benutzerhandbuch zu Cloud Control API.

So löschen Sie eine Ressource

Im folgenden Beispiel für delete-resource wird eine AWS::Kinesis::Stream-Ressource mit der ID ResourceExample aus Ihrem AWS-Konto gelöscht.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Löschen einer Ressource im Benutzerhandbuch zu Cloud Control API.

So rufen Sie die Statusinformationen einer Ressourcenanforderung ab

Im folgenden Beispiel für get-resource-request-status werden Statusinformationen zur angegebenen Ressourcenanforderung abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von Ressourcenoperationsanforderungen im Benutzerhandbuch zu Cloud Control API.

So rufen Sie den aktuellen Status einer Ressource ab

Im folgenden Beispiel für get-resource wird der aktuelle Status der AWS::Kinesis::Stream-Ressource namens ResourceExample zurückgegeben.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Lesen des aktuellen Status einer Ressource im Benutzerhandbuch zu Cloud Control API.

So listen Sie die aktiven Ressourcenoperationsanforderungen auf

Im folgenden Beispiel für list-resource-requests werden die Ressourcenanforderungen für CREATE- und UPDATE-Operationen aufgelistet, die in Ihrem AWS-Konto fehlgeschlagen sind.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von Ressourcenoperationsanforderungen im Benutzerhandbuch zu Cloud Control API.

So listen Sie die Ressourcen eines bestimmten Typs auf

Im folgenden Beispiel für list-resources werden dieAWS::Kinesis::Stream-Ressourcen aufgelistet, die in Ihrem AWS-Konto bereitgestellt werden.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Ermitteln von Ressourcen im Benutzerhandbuch zu Cloud Control API.

So aktualisieren Sie die Eigenschaften einer vorhandenen Ressource

Im folgenden Beispiel für update-resource wird die Aufbewahrungsrichtlinie einerAWS::Logs::LogGroup-Ressource namens ExampleLogGroup auf 90 Tage aktualisiert.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Aktualisieren einer Ressource im Benutzerhandbuch zu Cloud Control API.