AWS SDK for C++  1.8.59
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::CloudFormation::Model::GetTemplateRequest Class Reference

#include <GetTemplateRequest.h>

+ Inheritance diagram for Aws::CloudFormation::Model::GetTemplateRequest:

Public Member Functions

 GetTemplateRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetStackName () const
 
bool StackNameHasBeenSet () const
 
void SetStackName (const Aws::String &value)
 
void SetStackName (Aws::String &&value)
 
void SetStackName (const char *value)
 
GetTemplateRequestWithStackName (const Aws::String &value)
 
GetTemplateRequestWithStackName (Aws::String &&value)
 
GetTemplateRequestWithStackName (const char *value)
 
const Aws::StringGetChangeSetName () const
 
bool ChangeSetNameHasBeenSet () const
 
void SetChangeSetName (const Aws::String &value)
 
void SetChangeSetName (Aws::String &&value)
 
void SetChangeSetName (const char *value)
 
GetTemplateRequestWithChangeSetName (const Aws::String &value)
 
GetTemplateRequestWithChangeSetName (Aws::String &&value)
 
GetTemplateRequestWithChangeSetName (const char *value)
 
const TemplateStageGetTemplateStage () const
 
bool TemplateStageHasBeenSet () const
 
void SetTemplateStage (const TemplateStage &value)
 
void SetTemplateStage (TemplateStage &&value)
 
GetTemplateRequestWithTemplateStage (const TemplateStage &value)
 
GetTemplateRequestWithTemplateStage (TemplateStage &&value)
 
- Public Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual ~CloudFormationRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

The input for a GetTemplate action.

See Also:

AWS API Reference

Definition at line 25 of file GetTemplateRequest.h.

Constructor & Destructor Documentation

◆ GetTemplateRequest()

Aws::CloudFormation::Model::GetTemplateRequest::GetTemplateRequest ( )

Member Function Documentation

◆ ChangeSetNameHasBeenSet()

bool Aws::CloudFormation::Model::GetTemplateRequest::ChangeSetNameHasBeenSet ( ) const
inline

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

Definition at line 128 of file GetTemplateRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudFormation::Model::GetTemplateRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetChangeSetName()

const Aws::String& Aws::CloudFormation::Model::GetTemplateRequest::GetChangeSetName ( ) const
inline

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

Definition at line 121 of file GetTemplateRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudFormation::Model::GetTemplateRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file GetTemplateRequest.h.

◆ GetStackName()

const Aws::String& Aws::CloudFormation::Model::GetTemplateRequest::GetStackName ( ) const
inline

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.

Definition at line 50 of file GetTemplateRequest.h.

◆ GetTemplateStage()

const TemplateStage& Aws::CloudFormation::Model::GetTemplateRequest::GetTemplateStage ( ) const
inline

For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.

Definition at line 182 of file GetTemplateRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudFormation::Model::GetTemplateRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetChangeSetName() [1/3]

void Aws::CloudFormation::Model::GetTemplateRequest::SetChangeSetName ( const Aws::String value)
inline

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

Definition at line 135 of file GetTemplateRequest.h.

◆ SetChangeSetName() [2/3]

void Aws::CloudFormation::Model::GetTemplateRequest::SetChangeSetName ( Aws::String &&  value)
inline

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

Definition at line 142 of file GetTemplateRequest.h.

◆ SetChangeSetName() [3/3]

void Aws::CloudFormation::Model::GetTemplateRequest::SetChangeSetName ( const char *  value)
inline

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

Definition at line 149 of file GetTemplateRequest.h.

◆ SetStackName() [1/3]

void Aws::CloudFormation::Model::GetTemplateRequest::SetStackName ( const Aws::String value)
inline

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.

Definition at line 68 of file GetTemplateRequest.h.

◆ SetStackName() [2/3]

void Aws::CloudFormation::Model::GetTemplateRequest::SetStackName ( Aws::String &&  value)
inline

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.

Definition at line 77 of file GetTemplateRequest.h.

◆ SetStackName() [3/3]

void Aws::CloudFormation::Model::GetTemplateRequest::SetStackName ( const char *  value)
inline

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.

Definition at line 86 of file GetTemplateRequest.h.

◆ SetTemplateStage() [1/2]

void Aws::CloudFormation::Model::GetTemplateRequest::SetTemplateStage ( const TemplateStage value)
inline

For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.

Definition at line 204 of file GetTemplateRequest.h.

◆ SetTemplateStage() [2/2]

void Aws::CloudFormation::Model::GetTemplateRequest::SetTemplateStage ( TemplateStage &&  value)
inline

For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.

Definition at line 215 of file GetTemplateRequest.h.

◆ StackNameHasBeenSet()

bool Aws::CloudFormation::Model::GetTemplateRequest::StackNameHasBeenSet ( ) const
inline

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.

Definition at line 59 of file GetTemplateRequest.h.

◆ TemplateStageHasBeenSet()

bool Aws::CloudFormation::Model::GetTemplateRequest::TemplateStageHasBeenSet ( ) const
inline

For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.

Definition at line 193 of file GetTemplateRequest.h.

◆ WithChangeSetName() [1/3]

GetTemplateRequest& Aws::CloudFormation::Model::GetTemplateRequest::WithChangeSetName ( const Aws::String value)
inline

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

Definition at line 156 of file GetTemplateRequest.h.

◆ WithChangeSetName() [2/3]

GetTemplateRequest& Aws::CloudFormation::Model::GetTemplateRequest::WithChangeSetName ( Aws::String &&  value)
inline

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

Definition at line 163 of file GetTemplateRequest.h.

◆ WithChangeSetName() [3/3]

GetTemplateRequest& Aws::CloudFormation::Model::GetTemplateRequest::WithChangeSetName ( const char *  value)
inline

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

Definition at line 170 of file GetTemplateRequest.h.

◆ WithStackName() [1/3]

GetTemplateRequest& Aws::CloudFormation::Model::GetTemplateRequest::WithStackName ( const Aws::String value)
inline

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.

Definition at line 95 of file GetTemplateRequest.h.

◆ WithStackName() [2/3]

GetTemplateRequest& Aws::CloudFormation::Model::GetTemplateRequest::WithStackName ( Aws::String &&  value)
inline

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.

Definition at line 104 of file GetTemplateRequest.h.

◆ WithStackName() [3/3]

GetTemplateRequest& Aws::CloudFormation::Model::GetTemplateRequest::WithStackName ( const char *  value)
inline

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.

Definition at line 113 of file GetTemplateRequest.h.

◆ WithTemplateStage() [1/2]

GetTemplateRequest& Aws::CloudFormation::Model::GetTemplateRequest::WithTemplateStage ( const TemplateStage value)
inline

For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.

Definition at line 226 of file GetTemplateRequest.h.

◆ WithTemplateStage() [2/2]

GetTemplateRequest& Aws::CloudFormation::Model::GetTemplateRequest::WithTemplateStage ( TemplateStage &&  value)
inline

For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.

Definition at line 237 of file GetTemplateRequest.h.


The documentation for this class was generated from the following file: