Class: Aws::CloudFormation::Types::DescribeStackResourcesInput

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

Overview

Note:

When making an API call, you may pass DescribeStackResourcesInput data as a hash:

{
  stack_name: "StackName",
  logical_resource_id: "LogicalResourceId",
  physical_resource_id: "PhysicalResourceId",
}

The input for DescribeStackResources action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#logical_resource_idString

The logical name of the resource as specified in the template.

Default: There is no default value.

Returns:

  • (String)

2896
2897
2898
2899
2900
2901
2902
# File 'lib/aws-sdk-cloudformation/types.rb', line 2896

class DescribeStackResourcesInput < Struct.new(
  :stack_name,
  :logical_resource_id,
  :physical_resource_id)
  SENSITIVE = []
  include Aws::Structure
end

#physical_resource_idString

The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, `PhysicalResourceId` corresponds to the `InstanceId`. You can pass the EC2 `InstanceId` to `DescribeStackResources` to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify `PhysicalResourceId`, you must specify `StackName`.

Default: There is no default value.

Returns:

  • (String)

2896
2897
2898
2899
2900
2901
2902
# File 'lib/aws-sdk-cloudformation/types.rb', line 2896

class DescribeStackResourcesInput < Struct.new(
  :stack_name,
  :logical_resource_id,
  :physical_resource_id)
  SENSITIVE = []
  include Aws::Structure
end

#stack_nameString

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify `StackName`, you must specify `PhysicalResourceId`.

Returns:

  • (String)

2896
2897
2898
2899
2900
2901
2902
# File 'lib/aws-sdk-cloudformation/types.rb', line 2896

class DescribeStackResourcesInput < Struct.new(
  :stack_name,
  :logical_resource_id,
  :physical_resource_id)
  SENSITIVE = []
  include Aws::Structure
end