Esempi di Cloud Control API con AWS CLI - Esempi di codice per SDK AWS
Azioni

Sono disponibili altri esempi per SDK AWS nel repository GitHub della documentazione degli esempi per SDK AWS.

Esempi di Cloud Control API con AWS CLI

Gli esempi di codice seguenti mostrano come eseguire operazioni e implementare scenari comuni utilizzando AWS Command Line Interface con Cloud Control API.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le operazioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

L’esempio di codice seguente mostra come utilizzare create-resource.

AWS CLI

Come creare una risorsa

L’esempio create-resource seguente crea una risorsa AWS::Kinesis::Stream, denominata ResourceExample, con un periodo di conservazione di 168 ore e un numero di shard pari a tre.

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

Output:

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

Per ulteriori informazioni, consulta Creazione di una risorsa nella Guida per l’utente di Cloud Control API.

  • Per informazioni dettagliate sull’API, consulta CreateResource nella documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare delete-resource.

AWS CLI

Come eliminare una risorsa

L’esempio delete-resource seguente elimina una risorsa AWS::Kinesis::Stream con l’identificatore ResourceExample dall’account AWS.

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

Output:

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

Per ulteriori informazioni, consulta Eliminazione di una risorsa nella Guida per l’utente di Cloud Control API.

  • Per informazioni dettagliate sull’API, consulta DeleteResource nella documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare get-resource-request-status.

AWS CLI

Come ottenere informazioni sullo stato di una richiesta di risorse

L’esempio get-resource-request-status seguente restituisce informazioni sullo stato della richiesta di risorse specificata.

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

Output:

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

Per ulteriori informazioni, consulta Gestione delle richieste di operazioni sulle risorse nella Guida per l’utente di Cloud Control API.

L’esempio di codice seguente mostra come utilizzare get-resource.

AWS CLI

Come ottenere lo stato attuale di una risorsa

L’esempio get-resource seguente restituisce lo stato corrente della risorsa AWS::Kinesis::Stream denominata ResourceExample.

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

Output:

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

Per ulteriori informazioni, consulta Lettura dello stato corrente di una risorsa nella Guida per l’utente di Cloud Control API.

  • Per informazioni dettagliate sull’API, consulta GetResource nella documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare list-resource-requests.

AWS CLI

Come elencare le richieste di operazioni per le risorse attive

L’esempio list-resource-requests seguente elenca le richieste di risorse per le operazioni CREATE e UPDATE non riuscite nell’account AWS.

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

Output:

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

Per ulteriori informazioni, consulta Gestione delle richieste di operazioni sulle risorse nella Guida per l’utente di Cloud Control API.

  • Per informazioni dettagliate sull’API, consulta ListResourceRequests in AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare list-resources.

AWS CLI

Come elencare le risorse di un determinato tipo

L’esempio list-resources seguente elenca le risorse AWS::Kinesis::Stream fornite nel tuo account AWS.

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

Output:

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

Per ulteriori informazioni, consulta Rilevamento delle risorse nella Guida per l’utente di Cloud Control API.

  • Per informazioni dettagliate sull’API, consulta ListResources nella documentazione di riferimento dei comandi della AWS CLI.

L’esempio di codice seguente mostra come utilizzare update-resource.

AWS CLI

Come aggiornare le proprietà di una risorsa esistente

L’esempio update-resource seguente aggiorna la policy di conservazione di una risorsa AWS::Logs::LogGroup denominata ExampleLogGroup a 90 giorni.

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

Output:

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

Per ulteriori informazioni, consulta Aggiornamento di una risorsa nella Guida per l’utente di Cloud Control API.

  • Per informazioni dettagliate sull’API, consulta UpdateResource nella documentazione di riferimento dei comandi della AWS CLI.