Package 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:
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.

  • Method Details

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

      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.

    • 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, specify Processed.

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

      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 CloudFormation returns. To get the user-submitted template, specify Original. To get the template after CloudFormation has processed all transforms, specify Processed.

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

      See Also:

    • 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, specify Processed.

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

      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 CloudFormation returns. To get the user-submitted template, specify Original. To get the template after CloudFormation has processed all transforms, specify Processed.

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

      See Also:

    • toBuilder

      public GetTemplateRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>
      Specified by:
      toBuilder in class CloudFormationRequest

    • builder

      public static GetTemplateRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo