@Generated(value="software.amazon.awssdk:codegen") public final class GetTemplateRequest extends CloudFormationRequest implements ToCopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>
The input for a GetTemplate action.
Modifier and Type | Class and Description |
---|---|
static interface |
GetTemplateRequest.Builder |
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() |
overrideConfiguration
copy
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.
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.
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
.
StackName
.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()
.
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
.
TemplateStage
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()
.
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
.
TemplateStage
public GetTemplateRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>
toBuilder
in class CloudFormationRequest
public static GetTemplateRequest.Builder builder()
public static Class<? extends GetTemplateRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.