amazonka-cloudformation-1.6.1: Amazon CloudFormation SDK.

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

Network.AWS.CloudFormation.DescribeStackResources

Contents

Description

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 .

Synopsis

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

data DescribeStackResources Source #

The input for DescribeStackResources action.

See: describeStackResources smart constructor.

Instances
Eq DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Data DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeStackResources -> c DescribeStackResources #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeStackResources #

toConstr :: DescribeStackResources -> Constr #

dataTypeOf :: DescribeStackResources -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeStackResources) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeStackResources) #

gmapT :: (forall b. Data b => b -> b) -> DescribeStackResources -> DescribeStackResources #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStackResources -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStackResources -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeStackResources -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeStackResources -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeStackResources -> m DescribeStackResources #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStackResources -> m DescribeStackResources #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStackResources -> m DescribeStackResources #

Read DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Show DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Generic DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Associated Types

type Rep DescribeStackResources :: Type -> Type #

Hashable DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

AWSRequest DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Associated Types

type Rs DescribeStackResources :: Type #

ToHeaders DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

ToPath DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

ToQuery DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

NFData DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Methods

rnf :: DescribeStackResources -> () #

type Rep DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

type Rep DescribeStackResources = D1 (MetaData "DescribeStackResources" "Network.AWS.CloudFormation.DescribeStackResources" "amazonka-cloudformation-1.6.1-9C1vgCDBA4sIHFUFfPs2gm" False) (C1 (MetaCons "DescribeStackResources'" PrefixI True) (S1 (MetaSel (Just "_dsrLogicalResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dsrPhysicalResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dsrStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))
type Rs DescribeStackResources Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

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:

data DescribeStackResourcesResponse Source #

The output for a DescribeStackResources action.

See: describeStackResourcesResponse smart constructor.

Instances
Eq DescribeStackResourcesResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Data DescribeStackResourcesResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeStackResourcesResponse -> c DescribeStackResourcesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeStackResourcesResponse #

toConstr :: DescribeStackResourcesResponse -> Constr #

dataTypeOf :: DescribeStackResourcesResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeStackResourcesResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeStackResourcesResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeStackResourcesResponse -> DescribeStackResourcesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStackResourcesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeStackResourcesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeStackResourcesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeStackResourcesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeStackResourcesResponse -> m DescribeStackResourcesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStackResourcesResponse -> m DescribeStackResourcesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeStackResourcesResponse -> m DescribeStackResourcesResponse #

Read DescribeStackResourcesResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Show DescribeStackResourcesResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Generic DescribeStackResourcesResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

Associated Types

type Rep DescribeStackResourcesResponse :: Type -> Type #

NFData DescribeStackResourcesResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

type Rep DescribeStackResourcesResponse Source # 
Instance details

Defined in Network.AWS.CloudFormation.DescribeStackResources

type Rep DescribeStackResourcesResponse = D1 (MetaData "DescribeStackResourcesResponse" "Network.AWS.CloudFormation.DescribeStackResources" "amazonka-cloudformation-1.6.1-9C1vgCDBA4sIHFUFfPs2gm" False) (C1 (MetaCons "DescribeStackResourcesResponse'" PrefixI True) (S1 (MetaSel (Just "_dsrsrsStackResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StackResource])) :*: S1 (MetaSel (Just "_dsrsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses