Package software.amazon.awssdk.services.cloudformation.model

Interface GetTemplateSummaryRequest.Builder

    • Method Detail

      • templateBody

        GetTemplateSummaryRequest.Builder templateBody​(String templateBody)

        Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template anatomy in the CloudFormation User Guide.

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

        Parameters:
        templateBody - Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template anatomy in the CloudFormation User Guide.

        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)

        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. For more information about templates, see Template anatomy in the CloudFormation User Guide. 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 - 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. For more information about templates, see Template anatomy in the CloudFormation User Guide. 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 stack set 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 stack set 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 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.

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

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

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

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

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

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