libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudFormation.DescribeStackResources

Description

Returns Amazon Web Services 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.

Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

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 CloudFormation User Guide.

A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

Synopsis

Creating a Request

data DescribeStackResources Source #

The input for DescribeStackResources action.

See: newDescribeStackResources smart constructor.

Constructors

DescribeStackResources' 

Fields

  • logicalResourceId :: Maybe Text

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

    Default: There is no default value.

  • physicalResourceId :: Maybe Text

    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.

  • stackName :: Maybe Text

    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.

Instances

Instances details
Eq DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

(==) :: DescribeStackResources -> DescribeStackResources -> Bool #

(/=) :: DescribeStackResources -> DescribeStackResources -> Bool #

Read DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

readsPrec :: Int -> ReadS DescribeStackResources #

readList :: ReadS [DescribeStackResources] #

readPrec :: ReadPrec DescribeStackResources #

readListPrec :: ReadPrec [DescribeStackResources] #

Show DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

showsPrec :: Int -> DescribeStackResources -> ShowS #

show :: DescribeStackResources -> String #

showList :: [DescribeStackResources] -> ShowS #

Generic DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Associated Types

type Rep DescribeStackResources :: Type -> Type #

Methods

from :: DescribeStackResources -> Rep DescribeStackResources x #

to :: Rep DescribeStackResources x -> DescribeStackResources #

NFData DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

rnf :: DescribeStackResources -> () #

Hashable DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

hashWithSalt :: Int -> DescribeStackResources -> Int #

hash :: DescribeStackResources -> Int #

AWSRequest DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Associated Types

type AWSResponse DescribeStackResources #

Methods

request :: DescribeStackResources -> Request DescribeStackResources #

response :: MonadResource m => Logger -> Service -> Proxy DescribeStackResources -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStackResources))) #

ToHeaders DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

toHeaders :: DescribeStackResources -> [Header] #

ToPath DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

toPath :: DescribeStackResources -> ByteString #

ToQuery DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

toQuery :: DescribeStackResources -> QueryString #

type Rep DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

type Rep DescribeStackResources = D1 ('MetaData "DescribeStackResources" "Amazonka.CloudFormation.DescribeStackResources" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DescribeStackResources'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logicalResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "physicalResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse DescribeStackResources Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

type AWSResponse DescribeStackResources = DescribeStackResourcesResponse

newDescribeStackResources :: DescribeStackResources Source #

Create a value of DescribeStackResources with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:logicalResourceId:DescribeStackResources', describeStackResources_logicalResourceId - The logical name of the resource as specified in the template.

Default: There is no default value.

$sel:physicalResourceId:DescribeStackResources', describeStackResources_physicalResourceId - 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.

$sel:stackName:DescribeStackResources', describeStackResources_stackName - 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.

Request Lenses

describeStackResources_logicalResourceId :: Lens' DescribeStackResources (Maybe Text) Source #

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

Default: There is no default value.

describeStackResources_physicalResourceId :: Lens' DescribeStackResources (Maybe Text) Source #

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.

describeStackResources_stackName :: 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

data DescribeStackResourcesResponse Source #

The output for a DescribeStackResources action.

See: newDescribeStackResourcesResponse smart constructor.

Constructors

DescribeStackResourcesResponse' 

Fields

Instances

Instances details
Eq DescribeStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

(==) :: DescribeStackResourcesResponse -> DescribeStackResourcesResponse -> Bool #

(/=) :: DescribeStackResourcesResponse -> DescribeStackResourcesResponse -> Bool #

Read DescribeStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

readsPrec :: Int -> ReadS DescribeStackResourcesResponse #

readList :: ReadS [DescribeStackResourcesResponse] #

readPrec :: ReadPrec DescribeStackResourcesResponse #

readListPrec :: ReadPrec [DescribeStackResourcesResponse] #

Show DescribeStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

showsPrec :: Int -> DescribeStackResourcesResponse -> ShowS #

show :: DescribeStackResourcesResponse -> String #

showList :: [DescribeStackResourcesResponse] -> ShowS #

Generic DescribeStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Associated Types

type Rep DescribeStackResourcesResponse :: Type -> Type #

Methods

from :: DescribeStackResourcesResponse -> Rep DescribeStackResourcesResponse x #

to :: Rep DescribeStackResourcesResponse x -> DescribeStackResourcesResponse #

NFData DescribeStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

Methods

rnf :: DescribeStackResourcesResponse -> () #

type Rep DescribeStackResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackResources

type Rep DescribeStackResourcesResponse = D1 ('MetaData "DescribeStackResourcesResponse" "Amazonka.CloudFormation.DescribeStackResources" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "DescribeStackResourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stackResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StackResource])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeStackResourcesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeStackResourcesResponse'

-> DescribeStackResourcesResponse 

Create a value of DescribeStackResourcesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:stackResources:DescribeStackResourcesResponse', describeStackResourcesResponse_stackResources - A list of StackResource structures.

$sel:httpStatus:DescribeStackResourcesResponse', describeStackResourcesResponse_httpStatus - The response's http status code.

Response Lenses

describeStackResourcesResponse_stackResources :: Lens' DescribeStackResourcesResponse (Maybe [StackResource]) Source #

A list of StackResource structures.

describeStackResourcesResponse_httpStatus :: Lens' DescribeStackResourcesResponse Int Source #

The response's http status code.