AWS CLI를 사용한 Cloud Control API 예제

리소스를 생성하는 방법

다음 create-resource 예제에서는 보존 기간이 168시간이고 샤드 수가 3인 ResourceExampleAWS::Kinesis::Stream 리소스를 생성합니다.

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 사용 설명서의 리소스 생성을 참조하세요.

리소스를 삭제하는 방법

다음 delete-resource 예제에서는 AWS 계정에서 식별자 ResourceExample가 있는 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 사용 설명서의 리소스 삭제를 참조하세요.

리소스 요청의 상태 정보를 가져오는 방법

다음 예는 샘플 요청에 지정된 작업에 대한 정보를 반환합니다.

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 사용 설명서의 리소스 작업 요청 관리를 참조하세요.

리소스의 현재 상태를 가져오는 방법

다음 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 사용 설명서의 리소스의 현재 상태 읽기를 참조하세요.

활성 리소스 작업 요청을 나열하는 방법

다음 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 사용 설명서의 리소스 작업 요청 관리를 참조하세요.

지정된 유형의 리소스를 나열하는 방법

다음 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 사용 설명서의 리소스 검색을 참조하세요.

기존 리소스의 속성을 업데이트하는 방법

다음 예제에서는 이라는 이름의 update-resourceAWS: :Logs: :LogGroup 리소스의 보존 정책을 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 사용 설명서의 리소스 업데이트를 참조하세요.