Package software.amazon.awssdk.services.cloudformation.model

Class GetTemplateRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cloudformation.model.GetTemplateRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>

@Generated("software.amazon.awssdk:codegen")
public class GetTemplateRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>

The input for a GetTemplate action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetTemplateRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static GetTemplateRequest.Builder	builder()
String	changeSetName()	The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template.
boolean	equals(Object obj)
int	hashCode()
static Class<? extends GetTemplateRequest.Builder>	serializableBuilderClass()
String	stackName()	The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
String	templateStage()	For templates that include transforms, the stage of the template that AWS CloudFormation returns.
GetTemplateRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

stackName

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

Returns:

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.

changeSetName

public String changeSetName()

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.

Returns:

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.

templateStage

public String templateStage()

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.

Returns:

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.

See Also:

TemplateStage

toBuilder

public GetTemplateRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>

Returns:

a builder for type T

builder

public static GetTemplateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetTemplateRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object