Class GetTemplateSummaryRequest

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.GetTemplateSummaryRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetTemplateSummaryRequest.Builder,GetTemplateSummaryRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetTemplateSummaryRequest extends CloudFormationRequest implements ToCopyableBuilder<GetTemplateSummaryRequest.Builder,GetTemplateSummaryRequest>

The input for the GetTemplateSummary action.

  • Method Details

    • templateBody

      public final String templateBody()

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

      Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

      Returns:
      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

      Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    • templateURL

      public final String templateURL()

      Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.

      Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

      Returns:
      Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https://.

      Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    • stackName

      public final String stackName()

      The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

      Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

      Returns:
      The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

      Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    • stackSetName

      public final String stackSetName()

      The name or unique ID of the stack set from which the stack was created.

      Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

      Returns:
      The name or unique ID of the stack set from which the stack was created.

      Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

    • callAs

      public final CallAs callAs()

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

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

      Returns:
      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      See Also:

    • callAsAsString

      public final String callAsAsString()

      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

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

      Returns:
      [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

      By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

      • If you are signed in to the management account, specify SELF.

      • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

        Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

      See Also:

    • templateSummaryConfig

      public final TemplateSummaryConfig templateSummaryConfig()

      Specifies options for the GetTemplateSummary API action.

      Returns:
      Specifies options for the GetTemplateSummary API action.

    • toBuilder

      public GetTemplateSummaryRequest.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<GetTemplateSummaryRequest.Builder,GetTemplateSummaryRequest>
      Specified by:
      toBuilder in class CloudFormationRequest
      Returns:
      a builder for type T

    • builder

      public static GetTemplateSummaryRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetTemplateSummaryRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.