を使用した Cloud Control APIの例 AWS CLI

次のコード例は、Cloud Control AWS Command Line Interface でを使用してアクションを実行し、一般的なシナリオを実装する方法を示していますAPI。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には、完全なソースコードへのリンクが含まれています。このリンクには、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

アクション

次の例は、create-resource を使用する方法を説明しています。

AWS CLI

リソースを作成するには

次のcreate-resource例では、という名前の AWS::Kinesis::Stream リソースを作成します。 ResourceExample保持期間は 168 時間、シャード数は 3 です。


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

出力:


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

詳細については、「 Cloud Control ユーザーガイド」の「リソースの作成」を参照してください。 API

API 詳細については、「コマンドリファレンスCreateResource」の「」を参照してください。 AWS CLI

次のコード例は、delete-resource を使用する方法を示しています。

AWS CLI

リソースを削除するには

次のdelete-resource例では、識別子を持つ AWS::Kinesis::Stream リソースを AWS アカウント ResourceExample から削除します。


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

出力:


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

詳細については、「 Cloud Control ユーザーガイド」の「リソースの削除」を参照してください。 API

API 詳細については、「コマンドリファレンスDeleteResource」の「」を参照してください。 AWS CLI

次の例は、get-resource-request-status を使用する方法を説明しています。

AWS CLI

リソースリクエストのステータス情報を取得するには

次のget-resource-request-status例では、指定されたリソースリクエストに関するステータス情報を返します。


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

出力:


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

詳細については、「 Cloud Control ユーザーガイド」の「リソースオペレーションリクエストの管理」を参照してください。 API

API 詳細については、「コマンドリファレンスGetResourceRequestStatus」の「」を参照してください。 AWS CLI

次の例は、get-resource を使用する方法を説明しています。

AWS CLI

リソースの現在の状態を取得するには

次のget-resource例では、という名前の AWS::Kinesis::Stream リソースの現在の状態を返します ResourceExample。


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

出力:


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

詳細については、「 Cloud Control API ユーザーガイド」の「リソースの現在の状態の読み取り」を参照してください。

API 詳細については、「コマンドリファレンスGetResource」の「」を参照してください。 AWS CLI

次のコード例は、list-resource-requests を使用する方法を示しています。

AWS CLI

アクティブなリソースオペレーションリクエストを一覧表示するには

次のlist-resource-requests例では、 AWS アカウントで失敗した CREATEおよび UPDATEオペレーションのリソースリクエストを一覧表示します。


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

出力:


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

詳細については、「 Cloud Control ユーザーガイド」の「リソースオペレーションリクエストの管理」を参照してください。 API

API 詳細については、「コマンドリファレンスListResourceRequests」の「」を参照してください。 AWS CLI

次のコード例は、list-resources を使用する方法を示しています。

AWS CLI

特定のタイプのリソースを一覧表示するには

次のlist-resources例では、アカウントにプロビジョニングされた AWS::Kinesis::Stream リソースを一覧表示します AWS 。


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

出力:


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

詳細については、「 Cloud Control API ユーザーガイド」の「リソースの検出」を参照してください。

API 詳細については、「コマンドリファレンスListResources」の「」を参照してください。 AWS CLI

次の例は、update-resource を使用する方法を説明しています。

AWS CLI

既存のリソースのプロパティを更新するには

次のupdate-resource例では、という名前の AWS::Logs::LogGroup resource の保持ポリシー ExampleLogGroup を 90 日に更新します。


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

出力:


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

詳細については、「 Cloud Control API ユーザーガイド」の「リソースの更新」を参照してください。

API 詳細については、「コマンドリファレンスUpdateResource」の「」を参照してください。 AWS CLI

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Amazon Chime

AWS Cloud Map