Interface GetTemplateSummaryRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudFormationRequest.Builder
,CopyableBuilder<GetTemplateSummaryRequest.Builder,GetTemplateSummaryRequest>
,SdkBuilder<GetTemplateSummaryRequest.Builder,GetTemplateSummaryRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- GetTemplateSummaryRequest
public static interface GetTemplateSummaryRequest.Builder extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<GetTemplateSummaryRequest.Builder,GetTemplateSummaryRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description 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.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.GetTemplateSummaryRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetTemplateSummaryRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetTemplateSummaryRequest.Builder
stackName(String stackName)
The name or the stack ID that's associated with the stack, which aren't always interchangeable.GetTemplateSummaryRequest.Builder
stackSetName(String stackSetName)
The name or unique ID of the stack set from which the stack was created.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.default GetTemplateSummaryRequest.Builder
templateSummaryConfig(Consumer<TemplateSummaryConfig.Builder> templateSummaryConfig)
Specifies options for theGetTemplateSummary
API action.GetTemplateSummaryRequest.Builder
templateSummaryConfig(TemplateSummaryConfig templateSummaryConfig)
Specifies options for theGetTemplateSummary
API action.GetTemplateSummaryRequest.Builder
templateURL(String templateURL)
Location of file containing the template body.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
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
, orTemplateURL
.- 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
, orTemplateURL
.- 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
, orTemplateURL
.- 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 withhttps://
.Conditional: You must specify only one of the following parameters:
StackName
,StackSetName
,TemplateBody
, orTemplateURL
.- 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
, orTemplateURL
.- 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
, orTemplateURL
.- 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
, orTemplateURL
.- 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
, orTemplateURL
.- 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. UseSELF
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. UseSELF
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. UseSELF
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. UseSELF
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 theGetTemplateSummary
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
This is a convenience method that creates an instance of theGetTemplateSummary
API action.TemplateSummaryConfig.Builder
avoiding the need to create one manually viaTemplateSummaryConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totemplateSummaryConfig(TemplateSummaryConfig)
.- Parameters:
templateSummaryConfig
- a consumer that will call methods onTemplateSummaryConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
templateSummaryConfig(TemplateSummaryConfig)
-
overrideConfiguration
GetTemplateSummaryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
GetTemplateSummaryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-