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:
SdkPojo
,ToCopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetTemplateRequest extends CloudFormationRequest 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
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetTemplateRequest.Builder
builder()
String
changeSetName()
The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
List<SdkField<?>>
sdkFields()
static Class<? extends GetTemplateRequest.Builder>
serializableBuilderClass()
String
stackName()
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:TemplateStage
templateStage()
For templates that include transforms, the stage of the template that CloudFormation returns.String
templateStageAsString()
For templates that include transforms, the stage of the template that CloudFormation returns.GetTemplateRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
stackName
public final String 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.
- Returns:
- 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.
-
-
-
changeSetName
public final String 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
.- Returns:
- 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
.
-
templateStage
public final TemplateStage 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, specifyProcessed
.If the template doesn't include transforms,
Original
andProcessed
return the same template. By default, CloudFormation specifiesProcessed
.If the service returns an enum value that is not available in the current SDK version,
templateStage
will returnTemplateStage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtemplateStageAsString()
.- Returns:
- 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, specifyProcessed
.If the template doesn't include transforms,
Original
andProcessed
return the same template. By default, CloudFormation specifiesProcessed
. - See Also:
TemplateStage
-
templateStageAsString
public final String templateStageAsString()
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, specifyProcessed
.If the template doesn't include transforms,
Original
andProcessed
return the same template. By default, CloudFormation specifiesProcessed
.If the service returns an enum value that is not available in the current SDK version,
templateStage
will returnTemplateStage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtemplateStageAsString()
.- Returns:
- 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, specifyProcessed
.If the template doesn't include transforms,
Original
andProcessed
return the same template. By default, CloudFormation specifiesProcessed
. - See Also:
TemplateStage
-
toBuilder
public GetTemplateRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>
- Specified by:
toBuilder
in classCloudFormationRequest
-
builder
public static GetTemplateRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetTemplateRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-