Class: Aws::CloudControlApi::Types::GetResourceInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudcontrolapi/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#identifier ⇒ String

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*.

[1]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html

Returns:

  • (String) 


401
402
403
404
405
406
407
408
 
# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 401

class GetResourceInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :identifier)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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*.

[1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html [2]: docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions

Returns:

  • (String) 


401
402
403
404
405
406
407
408
 
# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 401

class GetResourceInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :identifier)
  SENSITIVE = []
  include Aws::Structure
end

#type_name ⇒ String

The name of the resource type.

Returns:

  • (String) 


401
402
403
404
405
406
407
408
 
# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 401

class GetResourceInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :identifier)
  SENSITIVE = []
  include Aws::Structure
end

#type_version_id ⇒ String

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.

Returns:

  • (String) 


401
402
403
404
405
406
407
408
 
# File 'lib/aws-sdk-cloudcontrolapi/types.rb', line 401

class GetResourceInput < Struct.new(
  :type_name,
  :type_version_id,
  :role_arn,
  :identifier)
  SENSITIVE = []
  include Aws::Structure
end