| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CloudFormation.GetTemplate
Description
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.
If the template does not exist, a ValidationError is returned.
Synopsis
- data GetTemplate = GetTemplate' {}
- newGetTemplate :: GetTemplate
- getTemplate_changeSetName :: Lens' GetTemplate (Maybe Text)
- getTemplate_templateStage :: Lens' GetTemplate (Maybe TemplateStage)
- getTemplate_stackName :: Lens' GetTemplate (Maybe Text)
- data GetTemplateResponse = GetTemplateResponse' {}
- newGetTemplateResponse :: Int -> GetTemplateResponse
- getTemplateResponse_stagesAvailable :: Lens' GetTemplateResponse (Maybe [TemplateStage])
- getTemplateResponse_templateBody :: Lens' GetTemplateResponse (Maybe Text)
- getTemplateResponse_httpStatus :: Lens' GetTemplateResponse Int
Creating a Request
data GetTemplate Source #
The input for a GetTemplate action.
See: newGetTemplate smart constructor.
Constructors
| GetTemplate' | |
Fields
| |
Instances
newGetTemplate :: GetTemplate Source #
Create a value of GetTemplate 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:changeSetName:GetTemplate', getTemplate_changeSetName - The name or Amazon Resource Name (ARN) of a change set for which
CloudFormation returns the associated template. If you specify a name,
you must also specify the StackName.
$sel:templateStage:GetTemplate', getTemplate_templateStage - For templates that include transforms, the stage of the template that
CloudFormation returns. To get the user-submitted template, specify
Original. To get the template after CloudFormation has processed all
transforms, specify Processed.
If the template doesn't include transforms, Original and Processed
return the same template. By default, CloudFormation specifies
Processed.
$sel:stackName:GetTemplate', getTemplate_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.
Request Lenses
getTemplate_changeSetName :: Lens' GetTemplate (Maybe Text) Source #
The name or Amazon Resource Name (ARN) of a change set for which
CloudFormation returns the associated template. If you specify a name,
you must also specify the StackName.
getTemplate_templateStage :: Lens' GetTemplate (Maybe TemplateStage) Source #
For templates that include transforms, the stage of the template that
CloudFormation returns. To get the user-submitted template, specify
Original. To get the template after CloudFormation has processed all
transforms, specify Processed.
If the template doesn't include transforms, Original and Processed
return the same template. By default, CloudFormation specifies
Processed.
getTemplate_stackName :: Lens' GetTemplate (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.
Destructuring the Response
data GetTemplateResponse Source #
The output for GetTemplate action.
See: newGetTemplateResponse smart constructor.
Constructors
| GetTemplateResponse' | |
Fields
| |
Instances
newGetTemplateResponse Source #
Arguments
| :: Int | |
| -> GetTemplateResponse |
Create a value of GetTemplateResponse 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:stagesAvailable:GetTemplateResponse', getTemplateResponse_stagesAvailable - The stage of the template that you can retrieve. For stacks, the
Original and Processed templates are always available. For change
sets, the Original template is always available. After CloudFormation
finishes creating the change set, the Processed template becomes
available.
$sel:templateBody:GetTemplateResponse', getTemplateResponse_templateBody - Structure containing the template body. (For more information, go to
Template Anatomy
in the CloudFormation User Guide.)
CloudFormation returns the same template that was used when the stack was created.
$sel:httpStatus:GetTemplateResponse', getTemplateResponse_httpStatus - The response's http status code.
Response Lenses
getTemplateResponse_stagesAvailable :: Lens' GetTemplateResponse (Maybe [TemplateStage]) Source #
The stage of the template that you can retrieve. For stacks, the
Original and Processed templates are always available. For change
sets, the Original template is always available. After CloudFormation
finishes creating the change set, the Processed template becomes
available.
getTemplateResponse_templateBody :: Lens' GetTemplateResponse (Maybe Text) Source #
Structure containing the template body. (For more information, go to Template Anatomy in the CloudFormation User Guide.)
CloudFormation returns the same template that was used when the stack was created.
getTemplateResponse_httpStatus :: Lens' GetTemplateResponse Int Source #
The response's http status code.