software.amazon.awssdk.services.cloudformation.model

Interface ResourceChange.Builder

All Superinterfaces:

CopyableBuilder<ResourceChange.Builder,ResourceChange>, SdkBuilder<ResourceChange.Builder,ResourceChange>

Enclosing class:

ResourceChange

public static interface ResourceChange.Builder
extends CopyableBuilder<ResourceChange.Builder,ResourceChange>

Method Summary

Modifier and Type	Method and Description
ResourceChange.Builder	action(ChangeAction action) The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).
ResourceChange.Builder	action(String action) The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).
ResourceChange.Builder	details(Collection<ResourceChangeDetail> details) For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.
ResourceChange.Builder	details(Consumer<ResourceChangeDetail.Builder>... details) For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.
ResourceChange.Builder	details(ResourceChangeDetail... details) For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.
ResourceChange.Builder	logicalResourceId(String logicalResourceId) The resource's logical ID, which is defined in the stack's template.
ResourceChange.Builder	physicalResourceId(String physicalResourceId) The resource's physical ID (resource name).
ResourceChange.Builder	replacement(Replacement replacement) For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one.
ResourceChange.Builder	replacement(String replacement) For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one.
ResourceChange.Builder	resourceType(String resourceType) The type of AWS CloudFormation resource, such as AWS::S3::Bucket.
ResourceChange.Builder	scope(Collection<String> scope) For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
ResourceChange.Builder	scope(String... scope) For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

action

ResourceChange.Builder action(String action)

The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).

Parameters:

action - The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).

Returns:

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

See Also:

ChangeAction, ChangeAction

action

ResourceChange.Builder action(ChangeAction action)

The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).

Parameters:

action - The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).

Returns:

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

See Also:

ChangeAction, ChangeAction

logicalResourceId

ResourceChange.Builder logicalResourceId(String logicalResourceId)

The resource's logical ID, which is defined in the stack's template.

Parameters:

logicalResourceId - The resource's logical ID, which is defined in the stack's template.

Returns:

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

physicalResourceId

ResourceChange.Builder physicalResourceId(String physicalResourceId)

The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

Parameters:

physicalResourceId - The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

Returns:

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

resourceType

ResourceChange.Builder resourceType(String resourceType)

The type of AWS CloudFormation resource, such as AWS::S3::Bucket.

Parameters:

resourceType - The type of AWS CloudFormation resource, such as AWS::S3::Bucket.

Returns:

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

replacement

ResourceChange.Builder replacement(String replacement)

For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.

If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.

Parameters:

replacement - For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.

If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.

Returns:

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

See Also:

Replacement, Replacement

replacement

ResourceChange.Builder replacement(Replacement replacement)

For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.

If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.

Parameters:

replacement - For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.

If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.

Returns:

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

See Also:

Replacement, Replacement

scope

ResourceChange.Builder scope(Collection<String> scope)

For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

Parameters:

scope - For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

Returns:

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

scope

ResourceChange.Builder scope(String... scope)

For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

Parameters:

scope - For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

Returns:

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

details

ResourceChange.Builder details(Collection<ResourceChangeDetail> details)

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.

Parameters:

details - For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.

Returns:

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

details

ResourceChange.Builder details(ResourceChangeDetail... details)

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.

Parameters:

details - For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.

Returns:

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

details

ResourceChange.Builder details(Consumer<ResourceChangeDetail.Builder>... details)

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #details(List).

Parameters:

details - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#details(List)