Amazonka.CloudFormation.GetTemplate

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 doesn't exist, a ValidationError is returned.

Creating a Request

data GetTemplate

The input for a GetTemplate action.

See: newGetTemplate smart constructor.

Constructors

GetTemplate'

Fields

• changeSetName :: Maybe Text

  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.

• stackName :: Maybe Text

  The name or the unique stack ID that's associated with the stack, which aren't 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.

• templateStage :: Maybe 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.

Instances

ToHeaders GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

Methods

toHeaders :: GetTemplate -> [Header]

ToPath GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

Methods

toPath :: GetTemplate -> ByteString

ToQuery GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

Methods

toQuery :: GetTemplate -> QueryString

AWSRequest GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

Associated Types

type AWSResponse GetTemplate

Methods

request :: (Service -> Service) -> GetTemplate -> Request GetTemplate

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTemplate)))

Generic GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

Associated Types

type Rep GetTemplate :: Type -> Type

Methods

from :: GetTemplate -> Rep GetTemplate x

to :: Rep GetTemplate x -> GetTemplate

Read GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

Methods

readsPrec :: Int -> ReadS GetTemplate

readList :: ReadS [GetTemplate]

readPrec :: ReadPrec GetTemplate

readListPrec :: ReadPrec [GetTemplate]

Show GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

Methods

showsPrec :: Int -> GetTemplate -> ShowS

show :: GetTemplate -> String

showList :: [GetTemplate] -> ShowS

NFData GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

Methods

rnf :: GetTemplate -> ()

Eq GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

Methods

(==) :: GetTemplate -> GetTemplate -> Bool

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

Hashable GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

Methods

hashWithSalt :: Int -> GetTemplate -> Int

hash :: GetTemplate -> Int

type AWSResponse GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

type AWSResponse GetTemplate = GetTemplateResponse

type Rep GetTemplate

Defined in Amazonka.CloudFormation.GetTemplate

type Rep GetTemplate = D1 ('MetaData "GetTemplate" "Amazonka.CloudFormation.GetTemplate" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "GetTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateStage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateStage)))))

newGetTemplate :: GetTemplate

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:

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.

GetTemplate, getTemplate_stackName - The name or the unique stack ID that's associated with the stack, which aren't 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.

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

Request Lenses

getTemplate_changeSetName :: Lens' GetTemplate (Maybe Text)

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_stackName :: Lens' GetTemplate (Maybe Text)

The name or the unique stack ID that's associated with the stack, which aren't 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.

getTemplate_templateStage :: Lens' GetTemplate (Maybe 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.

Destructuring the Response

data GetTemplateResponse

The output for GetTemplate action.

See: newGetTemplateResponse smart constructor.

Constructors

GetTemplateResponse'

Fields

• stagesAvailable :: Maybe [TemplateStage]

  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.

• templateBody :: Maybe Text

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetTemplateResponse

Defined in Amazonka.CloudFormation.GetTemplate

Associated Types

type Rep GetTemplateResponse :: Type -> Type

Methods

from :: GetTemplateResponse -> Rep GetTemplateResponse x

to :: Rep GetTemplateResponse x -> GetTemplateResponse

Read GetTemplateResponse

Defined in Amazonka.CloudFormation.GetTemplate

Methods

readsPrec :: Int -> ReadS GetTemplateResponse

readList :: ReadS [GetTemplateResponse]

readPrec :: ReadPrec GetTemplateResponse

readListPrec :: ReadPrec [GetTemplateResponse]

Show GetTemplateResponse

Defined in Amazonka.CloudFormation.GetTemplate

Methods

showsPrec :: Int -> GetTemplateResponse -> ShowS

show :: GetTemplateResponse -> String

showList :: [GetTemplateResponse] -> ShowS

NFData GetTemplateResponse

Defined in Amazonka.CloudFormation.GetTemplate

Methods

rnf :: GetTemplateResponse -> ()

Eq GetTemplateResponse

Defined in Amazonka.CloudFormation.GetTemplate

Methods

(==) :: GetTemplateResponse -> GetTemplateResponse -> Bool

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

type Rep GetTemplateResponse

Defined in Amazonka.CloudFormation.GetTemplate

type Rep GetTemplateResponse = D1 ('MetaData "GetTemplateResponse" "Amazonka.CloudFormation.GetTemplate" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "GetTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stagesAvailable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TemplateStage])) :*: (S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetTemplateResponse

Arguments

:: Int

$sel:httpStatus:GetTemplateResponse'

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

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])

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)

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

The response's http status code.