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

フォーカスモード

を使用した Cloud Control API の例 AWS CLI - AWS SDK コードの例

アクション

Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 AWS

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 AWS

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

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

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

アクション

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

AWS CLI

リソースを作成する方法

次のcreate-resource例では、ResourceExample という名前の AWS::Kinesis::Stream リソースを作成します。保持期間は 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 の詳細については、AWS CLI コマンドリファレンスの「CreateResource」を参照してください。

create-resource

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

AWS CLI

リソースを作成する方法

次のcreate-resource例では、ResourceExample という名前の AWS::Kinesis::Stream リソースを作成します。保持期間は 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 の詳細については、AWS CLI コマンドリファレンスの「CreateResource」を参照してください。

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

AWS CLI

リソースを削除する方法

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


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 の詳細については、「AWS CLI コマンドリファレンス」の「DeleteResource」を参照してください。

delete-resource

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

AWS CLI

リソースを削除する方法

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


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 の詳細については、「AWS CLI コマンドリファレンス」の「DeleteResource」を参照してください。

次の例では、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 の詳細については、「AWS CLI コマンドリファレンス」の「GetResourceRequestStatus」を参照してください。

get-resource-request-status

次の例では、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 の詳細については、「AWS CLI コマンドリファレンス」の「GetResourceRequestStatus」を参照してください。

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

AWS CLI

リソースの現在の状態を取得する方法

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


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 の詳細については、「AWS CLI コマンドリファレンス」の「GetResource」を参照してください。

get-resource

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

AWS CLI

リソースの現在の状態を取得する方法

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


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 の詳細については、「AWS CLI コマンドリファレンス」の「GetResource」を参照してください。

次の例では、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 の詳細については、「AWS CLI コマンドリファレンス」の「ListResourceRequests」を参照してください。

list-resource-requests

次の例では、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 の詳細については、「AWS CLI コマンドリファレンス」の「ListResourceRequests」を参照してください。

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

AWS CLI

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

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


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 の詳細については、「AWS CLI コマンドリファレンス」の「ListResources」を参照してください。

list-resources

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

AWS CLI

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

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


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 の詳細については、「AWS CLI コマンドリファレンス」の「ListResources」を参照してください。

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

AWS CLI

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

次のupdate-resource例では、LogGroup という名前の an AWS::Logs::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 の詳細については、「AWS CLI コマンドリファレンス」の「UpdateResource」を参照してください。

update-resource

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

AWS CLI

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

次のupdate-resource例では、LogGroup という名前の an AWS::Logs::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 の詳細については、「AWS CLI コマンドリファレンス」の「UpdateResource」を参照してください。

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

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

ドキュメントの表記規則

Amazon Chime

AWS Cloud Map

次のトピック

AWS Cloud Map

前のトピック:

Amazon Chime

ヘルプが必要ですか?

このページの内容

このページは役に立ちましたか?

フィードバックを送信

プライバシーサイト規約 Cookie の設定

Cookie の設定を選択する

Cookie の設定をカスタマイズする

Essential

Performance

Functional

Advertising

Cookie の設定を保存できません

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

トピック

アクション

create-resource

delete-resource

get-resource-request-status

get-resource

list-resource-requests

list-resources

update-resource

次のトピック

前のトピック:

ヘルプが必要ですか?

このページの内容

このページは役に立ちましたか?