aws cloudcontrol get-resource

Returns information about the current state of the specified resource. AWS CLI reference

1 example 4 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To get the current state of a resource

The following get-resource example returns the current state of the AWS::Kinesis::Stream resource named ResourceExample.

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

--type-nameThe name of the resource type.

--identifierThe identifier for the resource.

Its output

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

For more information, see Reading a resource's current state in the Cloud Control API User Guide.

Options

4 in the AWS CLI reference

--identifierThe identifier for the resource.

--role-arnThe Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation.

--type-nameThe name of the resource type.

--type-version-idFor private resource types, the type version to use in this resource operation.