Network.AWS.CloudFormation.GetTemplateSummary

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.

Creating a Request

getTemplateSummary :: GetTemplateSummary

Creates a value of GetTemplateSummary with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gtsTemplateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName , StackSetName , TemplateBody , or TemplateURL .
• gtsTemplateURL - Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName , StackSetName , TemplateBody , or TemplateURL .
• gtsStackSetName - The name or unique ID of the stack set from which the stack was created. Conditional: You must specify only one of the following parameters: StackName , StackSetName , TemplateBody , or TemplateURL .
• gtsStackName - The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID. Conditional: You must specify only one of the following parameters: StackName , StackSetName , TemplateBody , or TemplateURL .

data GetTemplateSummary

The input for the GetTemplateSummary action.

See: getTemplateSummary smart constructor.

Instances

Eq GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

(==) :: GetTemplateSummary -> GetTemplateSummary -> Bool

(/=) :: GetTemplateSummary -> GetTemplateSummary -> Bool

Data GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

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

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

toConstr :: GetTemplateSummary -> Constr

dataTypeOf :: GetTemplateSummary -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetTemplateSummary -> GetTemplateSummary

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

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

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

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

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

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

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

Read GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

readsPrec :: Int -> ReadS GetTemplateSummary

readList :: ReadS [GetTemplateSummary]

readPrec :: ReadPrec GetTemplateSummary

readListPrec :: ReadPrec [GetTemplateSummary]

Show GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

showsPrec :: Int -> GetTemplateSummary -> ShowS

show :: GetTemplateSummary -> String

showList :: [GetTemplateSummary] -> ShowS

Generic GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Associated Types

type Rep GetTemplateSummary :: Type -> Type

Methods

from :: GetTemplateSummary -> Rep GetTemplateSummary x

to :: Rep GetTemplateSummary x -> GetTemplateSummary

Hashable GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

hashWithSalt :: Int -> GetTemplateSummary -> Int

hash :: GetTemplateSummary -> Int

AWSRequest GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Associated Types

type Rs GetTemplateSummary :: Type

Methods

request :: GetTemplateSummary -> Request GetTemplateSummary

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetTemplateSummary -> ClientResponse -> m (Response GetTemplateSummary)

ToHeaders GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

toHeaders :: GetTemplateSummary -> [Header]

ToPath GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

toPath :: GetTemplateSummary -> ByteString

ToQuery GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

toQuery :: GetTemplateSummary -> QueryString

NFData GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

rnf :: GetTemplateSummary -> ()

type Rep GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

type Rep GetTemplateSummary = D1 (MetaData "GetTemplateSummary" "Network.AWS.CloudFormation.GetTemplateSummary" "amazonka-cloudformation-1.6.1-9C1vgCDBA4sIHFUFfPs2gm" False) (C1 (MetaCons "GetTemplateSummary'" PrefixI True) ((S1 (MetaSel (Just "_gtsTemplateBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gtsTemplateURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gtsStackSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gtsStackName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

type Rs GetTemplateSummary

Defined in Network.AWS.CloudFormation.GetTemplateSummary

type Rs GetTemplateSummary = GetTemplateSummaryResponse

Request Lenses

gtsTemplateBody :: Lens' GetTemplateSummary (Maybe Text)

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName , StackSetName , TemplateBody , or TemplateURL .

gtsTemplateURL :: Lens' GetTemplateSummary (Maybe Text)

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: StackName , StackSetName , TemplateBody , or TemplateURL .

gtsStackSetName :: Lens' GetTemplateSummary (Maybe Text)

The name or unique ID of the stack set from which the stack was created. Conditional: You must specify only one of the following parameters: StackName , StackSetName , TemplateBody , or TemplateURL .

gtsStackName :: Lens' GetTemplateSummary (Maybe Text)

The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID. Conditional: You must specify only one of the following parameters: StackName , StackSetName , TemplateBody , or TemplateURL .

Destructuring the Response

getTemplateSummaryResponse

Arguments

:: Int

gtsrsResponseStatus

-> GetTemplateSummaryResponse

Creates a value of GetTemplateSummaryResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gtsrsDeclaredTransforms - A list of the transforms that are declared in the template.
• gtsrsVersion - The AWS template format version, which identifies the capabilities of the template.
• gtsrsCapabilitiesReason - The list of resources that generated the values in the Capabilities response element.
• gtsrsParameters - A list of parameter declarations that describe various properties for each parameter.
• gtsrsMetadata - The value that is defined for the Metadata property of the template.
• gtsrsDescription - The value that is defined in the Description property of the template.
• gtsrsCapabilities - The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .
• gtsrsResourceTypes - A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance , AWS::Dynamo::Table , and Custom::MyCustomInstance .
• gtsrsResponseStatus - -- | The response status code.

data GetTemplateSummaryResponse

The output for the GetTemplateSummary action.

See: getTemplateSummaryResponse smart constructor.

Instances

Eq GetTemplateSummaryResponse

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

(==) :: GetTemplateSummaryResponse -> GetTemplateSummaryResponse -> Bool

(/=) :: GetTemplateSummaryResponse -> GetTemplateSummaryResponse -> Bool

Data GetTemplateSummaryResponse

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

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

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

toConstr :: GetTemplateSummaryResponse -> Constr

dataTypeOf :: GetTemplateSummaryResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> GetTemplateSummaryResponse -> GetTemplateSummaryResponse

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

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

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

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

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

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

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

Read GetTemplateSummaryResponse

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

readsPrec :: Int -> ReadS GetTemplateSummaryResponse

readList :: ReadS [GetTemplateSummaryResponse]

readPrec :: ReadPrec GetTemplateSummaryResponse

readListPrec :: ReadPrec [GetTemplateSummaryResponse]

Show GetTemplateSummaryResponse

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

showsPrec :: Int -> GetTemplateSummaryResponse -> ShowS

show :: GetTemplateSummaryResponse -> String

showList :: [GetTemplateSummaryResponse] -> ShowS

Generic GetTemplateSummaryResponse

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Associated Types

type Rep GetTemplateSummaryResponse :: Type -> Type

Methods

from :: GetTemplateSummaryResponse -> Rep GetTemplateSummaryResponse x

to :: Rep GetTemplateSummaryResponse x -> GetTemplateSummaryResponse

NFData GetTemplateSummaryResponse

Defined in Network.AWS.CloudFormation.GetTemplateSummary

Methods

rnf :: GetTemplateSummaryResponse -> ()

type Rep GetTemplateSummaryResponse

Defined in Network.AWS.CloudFormation.GetTemplateSummary

type Rep GetTemplateSummaryResponse = D1 (MetaData "GetTemplateSummaryResponse" "Network.AWS.CloudFormation.GetTemplateSummary" "amazonka-cloudformation-1.6.1-9C1vgCDBA4sIHFUFfPs2gm" False) (C1 (MetaCons "GetTemplateSummaryResponse'" PrefixI True) (((S1 (MetaSel (Just "_gtsrsDeclaredTransforms") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_gtsrsVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gtsrsCapabilitiesReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gtsrsParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ParameterDeclaration])))) :*: ((S1 (MetaSel (Just "_gtsrsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gtsrsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gtsrsCapabilities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Capability])) :*: (S1 (MetaSel (Just "_gtsrsResourceTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_gtsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))))

Response Lenses

gtsrsDeclaredTransforms :: Lens' GetTemplateSummaryResponse [Text]

A list of the transforms that are declared in the template.

gtsrsVersion :: Lens' GetTemplateSummaryResponse (Maybe Text)

The AWS template format version, which identifies the capabilities of the template.

gtsrsCapabilitiesReason :: Lens' GetTemplateSummaryResponse (Maybe Text)

The list of resources that generated the values in the Capabilities response element.

gtsrsParameters :: Lens' GetTemplateSummaryResponse [ParameterDeclaration]

A list of parameter declarations that describe various properties for each parameter.

gtsrsMetadata :: Lens' GetTemplateSummaryResponse (Maybe Text)

The value that is defined for the Metadata property of the template.

gtsrsDescription :: Lens' GetTemplateSummaryResponse (Maybe Text)

The value that is defined in the Description property of the template.

gtsrsCapabilities :: Lens' GetTemplateSummaryResponse [Capability]

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .

gtsrsResourceTypes :: Lens' GetTemplateSummaryResponse [Text]

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance , AWS::Dynamo::Table , and Custom::MyCustomInstance .

gtsrsResponseStatus :: Lens' GetTemplateSummaryResponse Int

• - | The response status code.