You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/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.

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)


1719
1720
1721
1722
1723
1724
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1719

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

#physical_resource_idString

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS 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)


1719
1720
1721
1722
1723
1724
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1719

class DescribeStackResourcesInput < Struct.new(
  :stack_name,
  :logical_resource_id,
  :physical_resource_id)
  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)


1719
1720
1721
1722
1723
1724
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1719

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