Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns AWS resource descriptions for running and deleted stacks. If StackName
is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId
is specified, the associated resources of the stack that the resource belongs to are returned.
For deleted stacks, DescribeStackResources
returns resource information for up to 90 days after the stack has been deleted.
You must specify either StackName
or PhysicalResourceId
, but not both. In addition, you can specify LogicalResourceId
to filter the returned result. For more information about resources, the LogicalResourceId
and PhysicalResourceId
, go to the AWS CloudFormation User Guide .
- describeStackResources :: DescribeStackResources
- data DescribeStackResources
- dsrLogicalResourceId :: Lens' DescribeStackResources (Maybe Text)
- dsrPhysicalResourceId :: Lens' DescribeStackResources (Maybe Text)
- dsrStackName :: Lens' DescribeStackResources (Maybe Text)
- describeStackResourcesResponse :: Int -> DescribeStackResourcesResponse
- data DescribeStackResourcesResponse
- dsrsrsStackResources :: Lens' DescribeStackResourcesResponse [StackResource]
- dsrsrsResponseStatus :: Lens' DescribeStackResourcesResponse Int
Creating a Request
describeStackResources :: DescribeStackResources Source #
Creates a value of DescribeStackResources
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsrLogicalResourceId
- The logical name of the resource as specified in the template. Default: There is no default value.dsrPhysicalResourceId
- 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 theInstanceId
. You can pass the EC2InstanceId
toDescribeStackResources
to find which stack the instance belongs to and what other resources are part of the stack. Required: Conditional. If you do not specifyPhysicalResourceId
, you must specifyStackName
. Default: There is no default value.dsrStackName
- 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 specifyStackName
, you must specifyPhysicalResourceId
.
data DescribeStackResources Source #
The input for DescribeStackResources
action.
See: describeStackResources
smart constructor.
Request Lenses
dsrLogicalResourceId :: Lens' DescribeStackResources (Maybe Text) Source #
The logical name of the resource as specified in the template. Default: There is no default value.
dsrPhysicalResourceId :: Lens' DescribeStackResources (Maybe Text) Source #
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.
dsrStackName :: Lens' DescribeStackResources (Maybe Text) Source #
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
.
Destructuring the Response
describeStackResourcesResponse Source #
Creates a value of DescribeStackResourcesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsrsrsStackResources
- A list ofStackResource
structures.dsrsrsResponseStatus
- -- | The response status code.
data DescribeStackResourcesResponse Source #
The output for a DescribeStackResources
action.
See: describeStackResourcesResponse
smart constructor.
Response Lenses
dsrsrsStackResources :: Lens' DescribeStackResourcesResponse [StackResource] Source #
A list of StackResource
structures.
dsrsrsResponseStatus :: Lens' DescribeStackResourcesResponse Int Source #
- - | The response status code.