Interface DescribeGeneratedTemplateResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CloudFormationResponse.Builder,CopyableBuilder<DescribeGeneratedTemplateResponse.Builder,DescribeGeneratedTemplateResponse>,SdkBuilder<DescribeGeneratedTemplateResponse.Builder,DescribeGeneratedTemplateResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- DescribeGeneratedTemplateResponse
public static interface DescribeGeneratedTemplateResponse.Builder extends CloudFormationResponse.Builder, SdkPojo, CopyableBuilder<DescribeGeneratedTemplateResponse.Builder,DescribeGeneratedTemplateResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DescribeGeneratedTemplateResponse.BuildercreationTime(Instant creationTime)The time the generated template was created.DescribeGeneratedTemplateResponse.BuildergeneratedTemplateId(String generatedTemplateId)The Amazon Resource Name (ARN) of the generated template.DescribeGeneratedTemplateResponse.BuildergeneratedTemplateName(String generatedTemplateName)The name of the generated template.DescribeGeneratedTemplateResponse.BuilderlastUpdatedTime(Instant lastUpdatedTime)The time the generated template was last updated.default DescribeGeneratedTemplateResponse.Builderprogress(Consumer<TemplateProgress.Builder> progress)An object describing the progress of the template generation.DescribeGeneratedTemplateResponse.Builderprogress(TemplateProgress progress)An object describing the progress of the template generation.DescribeGeneratedTemplateResponse.Builderresources(Collection<ResourceDetail> resources)A list of objects describing the details of the resources in the template generation.DescribeGeneratedTemplateResponse.Builderresources(Consumer<ResourceDetail.Builder>... resources)A list of objects describing the details of the resources in the template generation.DescribeGeneratedTemplateResponse.Builderresources(ResourceDetail... resources)A list of objects describing the details of the resources in the template generation.DescribeGeneratedTemplateResponse.BuilderstackId(String stackId)The stack ARN of the base stack if a base stack was provided when generating the template.DescribeGeneratedTemplateResponse.Builderstatus(String status)The status of the template generation.DescribeGeneratedTemplateResponse.Builderstatus(GeneratedTemplateStatus status)The status of the template generation.DescribeGeneratedTemplateResponse.BuilderstatusReason(String statusReason)The reason for the current template generation status.default DescribeGeneratedTemplateResponse.BuildertemplateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)The configuration details of the generated template, including theDeletionPolicyandUpdateReplacePolicy.DescribeGeneratedTemplateResponse.BuildertemplateConfiguration(TemplateConfiguration templateConfiguration)The configuration details of the generated template, including theDeletionPolicyandUpdateReplacePolicy.DescribeGeneratedTemplateResponse.BuildertotalWarnings(Integer totalWarnings)The number of warnings generated for this template.-
Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse.Builder
build, responseMetadata, responseMetadata
-
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
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
generatedTemplateId
DescribeGeneratedTemplateResponse.Builder generatedTemplateId(String generatedTemplateId)
The Amazon Resource Name (ARN) of the generated template. The format is
arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc.- Parameters:
generatedTemplateId- The Amazon Resource Name (ARN) of the generated template. The format isarn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
generatedTemplateName
DescribeGeneratedTemplateResponse.Builder generatedTemplateName(String generatedTemplateName)
The name of the generated template.
- Parameters:
generatedTemplateName- The name of the generated template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resources
DescribeGeneratedTemplateResponse.Builder resources(Collection<ResourceDetail> resources)
A list of objects describing the details of the resources in the template generation.
- Parameters:
resources- A list of objects describing the details of the resources in the template generation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resources
DescribeGeneratedTemplateResponse.Builder resources(ResourceDetail... resources)
A list of objects describing the details of the resources in the template generation.
- Parameters:
resources- A list of objects describing the details of the resources in the template generation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resources
DescribeGeneratedTemplateResponse.Builder resources(Consumer<ResourceDetail.Builder>... resources)
A list of objects describing the details of the resources in the template generation.
This is a convenience method that creates an instance of theResourceDetail.Builderavoiding the need to create one manually viaResourceDetail.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#resources(List.) - Parameters:
resources- a consumer that will call methods onResourceDetail.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#resources(java.util.Collection)
-
status
DescribeGeneratedTemplateResponse.Builder status(String status)
The status of the template generation. Supported values are:
-
CreatePending- the creation of the template is pending. -
CreateInProgress- the creation of the template is in progress. -
DeletePending- the deletion of the template is pending. -
DeleteInProgress- the deletion of the template is in progress. -
UpdatePending- the update of the template is pending. -
UpdateInProgress- the update of the template is in progress. -
Failed- the template operation failed. -
Complete- the template operation is complete.
- Parameters:
status- The status of the template generation. Supported values are:-
CreatePending- the creation of the template is pending. -
CreateInProgress- the creation of the template is in progress. -
DeletePending- the deletion of the template is pending. -
DeleteInProgress- the deletion of the template is in progress. -
UpdatePending- the update of the template is pending. -
UpdateInProgress- the update of the template is in progress. -
Failed- the template operation failed. -
Complete- the template operation is complete.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
GeneratedTemplateStatus,GeneratedTemplateStatus
-
-
status
DescribeGeneratedTemplateResponse.Builder status(GeneratedTemplateStatus status)
The status of the template generation. Supported values are:
-
CreatePending- the creation of the template is pending. -
CreateInProgress- the creation of the template is in progress. -
DeletePending- the deletion of the template is pending. -
DeleteInProgress- the deletion of the template is in progress. -
UpdatePending- the update of the template is pending. -
UpdateInProgress- the update of the template is in progress. -
Failed- the template operation failed. -
Complete- the template operation is complete.
- Parameters:
status- The status of the template generation. Supported values are:-
CreatePending- the creation of the template is pending. -
CreateInProgress- the creation of the template is in progress. -
DeletePending- the deletion of the template is pending. -
DeleteInProgress- the deletion of the template is in progress. -
UpdatePending- the update of the template is pending. -
UpdateInProgress- the update of the template is in progress. -
Failed- the template operation failed. -
Complete- the template operation is complete.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
GeneratedTemplateStatus,GeneratedTemplateStatus
-
-
statusReason
DescribeGeneratedTemplateResponse.Builder statusReason(String statusReason)
The reason for the current template generation status. This will provide more details if a failure happened.
- Parameters:
statusReason- The reason for the current template generation status. This will provide more details if a failure happened.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTime
DescribeGeneratedTemplateResponse.Builder creationTime(Instant creationTime)
The time the generated template was created.
- Parameters:
creationTime- The time the generated template was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedTime
DescribeGeneratedTemplateResponse.Builder lastUpdatedTime(Instant lastUpdatedTime)
The time the generated template was last updated.
- Parameters:
lastUpdatedTime- The time the generated template was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
progress
DescribeGeneratedTemplateResponse.Builder progress(TemplateProgress progress)
An object describing the progress of the template generation.
- Parameters:
progress- An object describing the progress of the template generation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
progress
default DescribeGeneratedTemplateResponse.Builder progress(Consumer<TemplateProgress.Builder> progress)
An object describing the progress of the template generation.
This is a convenience method that creates an instance of theTemplateProgress.Builderavoiding the need to create one manually viaTemplateProgress.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toprogress(TemplateProgress).- Parameters:
progress- a consumer that will call methods onTemplateProgress.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
progress(TemplateProgress)
-
stackId
DescribeGeneratedTemplateResponse.Builder stackId(String stackId)
The stack ARN of the base stack if a base stack was provided when generating the template.
- Parameters:
stackId- The stack ARN of the base stack if a base stack was provided when generating the template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateConfiguration
DescribeGeneratedTemplateResponse.Builder templateConfiguration(TemplateConfiguration templateConfiguration)
The configuration details of the generated template, including the
DeletionPolicyandUpdateReplacePolicy.- Parameters:
templateConfiguration- The configuration details of the generated template, including theDeletionPolicyandUpdateReplacePolicy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateConfiguration
default DescribeGeneratedTemplateResponse.Builder templateConfiguration(Consumer<TemplateConfiguration.Builder> templateConfiguration)
The configuration details of the generated template, including the
This is a convenience method that creates an instance of theDeletionPolicyandUpdateReplacePolicy.TemplateConfiguration.Builderavoiding the need to create one manually viaTemplateConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totemplateConfiguration(TemplateConfiguration).- Parameters:
templateConfiguration- a consumer that will call methods onTemplateConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
templateConfiguration(TemplateConfiguration)
-
totalWarnings
DescribeGeneratedTemplateResponse.Builder totalWarnings(Integer totalWarnings)
The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.
- Parameters:
totalWarnings- The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-