Interface GetTemplateSummaryRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudFormationRequest.Builder, CopyableBuilder<GetTemplateSummaryRequest.Builder,GetTemplateSummaryRequest>, SdkBuilder<GetTemplateSummaryRequest.Builder,GetTemplateSummaryRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetTemplateSummaryRequest
@Mutable @NotThreadSafe public static interface GetTemplateSummaryRequest.Builder extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<GetTemplateSummaryRequest.Builder,GetTemplateSummaryRequest>

  • Method Details

    • templateBody

      GetTemplateSummaryRequest.Builder templateBody(String templateBody)

      Structure that contains 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.

      Parameters:
      templateBody - Structure that contains 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:
      Returns a reference to this object so that method calls can be chained together.

    • templateURL

      GetTemplateSummaryRequest.Builder templateURL(String templateURL)

      The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) 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.

      Parameters:
      templateURL - The URL of a file that contains the template body. The URL must point to a template (max size: 1 MB) 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:
      Returns a reference to this object so that method calls can be chained together.

    • stackName

      GetTemplateSummaryRequest.Builder stackName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • stackSetName

      GetTemplateSummaryRequest.Builder stackSetName(String stackSetName)

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

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

      Parameters:
      stackSetName - The name or unique ID of the StackSet from which the stack was created.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • callAs

      GetTemplateSummaryRequest.Builder callAs(String 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 StackSets 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.

      Parameters:
      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 StackSets 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • callAs

      GetTemplateSummaryRequest.Builder callAs(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 StackSets 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.

      Parameters:
      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 StackSets 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • templateSummaryConfig

      GetTemplateSummaryRequest.Builder templateSummaryConfig(TemplateSummaryConfig templateSummaryConfig)

      Specifies options for the GetTemplateSummary API action.

      Parameters:
      templateSummaryConfig - Specifies options for the GetTemplateSummary API action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateSummaryConfig

      default GetTemplateSummaryRequest.Builder templateSummaryConfig(Consumer<TemplateSummaryConfig.Builder> templateSummaryConfig)

      Specifies options for the GetTemplateSummary API action.

      This is a convenience method that creates an instance of the TemplateSummaryConfig.Builder avoiding the need to create one manually via TemplateSummaryConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to templateSummaryConfig(TemplateSummaryConfig).

      Parameters:
      templateSummaryConfig - a consumer that will call methods on TemplateSummaryConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      GetTemplateSummaryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetTemplateSummaryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.