Skip to content

Get Resource

cloudcontrolapi_get_resource R Documentation

Returns information about the current state of the specified resource

Description

Returns information about the current state of the specified resource. For details, see Reading a resource's current state.

You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.

Usage

cloudcontrolapi_get_resource(TypeName, TypeVersionId, RoleArn,
  Identifier)

Arguments

TypeName

[required] The name of the resource type.

TypeVersionId

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

RoleArn

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

Identifier

[required] The identifier for the resource.

You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

Value

A list with the following syntax: 

list(
  TypeName = "string",
  ResourceDescription = list(
    Identifier = "string",
    Properties = "string"
  )
)

Request syntax

svc$get_resource(
  TypeName = "string",
  TypeVersionId = "string",
  RoleArn = "string",
  Identifier = "string"
)