software.amazon.awssdk.services.cloudformation.model

Class GetTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest

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

All Implemented Interfaces:

ToCopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>

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

The input for a GetTemplate action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetTemplateRequest.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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:
TemplateStage	templateStage() For templates that include transforms, the stage of the template that AWS CloudFormation returns.
String	templateStageAsString() 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.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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

If the service returns an enum value that is not available in the current SDK version, templateStage will return TemplateStage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateStageAsString().

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

templateStageAsString

public String templateStageAsString()

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.

If the service returns an enum value that is not available in the current SDK version, templateStage will return TemplateStage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateStageAsString().

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>

Specified by:

toBuilder in class CloudFormationRequest

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value