Class ResourceChange

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.ResourceChange

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ResourceChange.Builder,ResourceChange>

@Generated("software.amazon.awssdk:codegen")
public final class ResourceChange
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ResourceChange.Builder,ResourceChange>

The ResourceChange structure describes the resource and the action that CloudFormation will perform on it if you execute this change set.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResourceChange.Builder

Method Summary

Modifier and Type	Method	Description
final ChangeAction	action()	The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).
final String	actionAsString()	The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).
final String	afterContext()	An encoded JSON string containing the context of the resource after the change is executed.
final String	beforeContext()	An encoded JSON string containing the context of the resource before the change is executed.
static ResourceChange.Builder	builder()
final String	changeSetId()	The change set ID of the nested change set.
final List<ResourceChangeDetail>	details()	For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final boolean	hasDetails()	For responses, this returns true if the service returned a value for the Details property.
final int	hashCode()
final boolean	hasScope()	For responses, this returns true if the service returned a value for the Scope property.
final String	logicalResourceId()	The resource's logical ID, which is defined in the stack's template.
final ModuleInfo	moduleInfo()	Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.
final String	physicalResourceId()	The resource's physical ID (resource name).
final PolicyAction	policyAction()	The action that will be taken on the physical resource when the change set is executed.
final String	policyActionAsString()	The action that will be taken on the physical resource when the change set is executed.
final Replacement	replacement()	For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one.
final String	replacementAsString()	For the Modify action, indicates whether CloudFormation will replace the resource by creating a new one and deleting the old one.
final String	resourceType()	The type of CloudFormation resource, such as AWS::S3::Bucket.
final List<ResourceAttribute>	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.
final List<String>	scopeAsStrings()	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.
final List<SdkField<?>>	sdkFields()
static Class<? extends ResourceChange.Builder>	serializableBuilderClass()
ResourceChange.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

policyAction

public final PolicyAction policyAction()

The action that will be taken on the physical resource when the change set is executed.

• Delete The resource will be deleted.

• Retain The resource will be retained.

• Snapshot The resource will have a snapshot taken.

• ReplaceAndDelete The resource will be replaced and then deleted.

• ReplaceAndRetain The resource will be replaced and then retained.

• ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

If the service returns an enum value that is not available in the current SDK version, policyAction will return PolicyAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyActionAsString().

Returns:

The action that will be taken on the physical resource when the change set is executed.

• Delete The resource will be deleted.

• Retain The resource will be retained.

• Snapshot The resource will have a snapshot taken.

• ReplaceAndDelete The resource will be replaced and then deleted.

• ReplaceAndRetain The resource will be replaced and then retained.

• ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

See Also:

• PolicyAction

policyActionAsString

public final String policyActionAsString()

The action that will be taken on the physical resource when the change set is executed.

• Delete The resource will be deleted.

• Retain The resource will be retained.

• Snapshot The resource will have a snapshot taken.

• ReplaceAndDelete The resource will be replaced and then deleted.

• ReplaceAndRetain The resource will be replaced and then retained.

• ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

If the service returns an enum value that is not available in the current SDK version, policyAction will return PolicyAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyActionAsString().

Returns:

The action that will be taken on the physical resource when the change set is executed.

• Delete The resource will be deleted.

• Retain The resource will be retained.

• Snapshot The resource will have a snapshot taken.

• ReplaceAndDelete The resource will be replaced and then deleted.

• ReplaceAndRetain The resource will be replaced and then retained.

• ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

See Also:

• PolicyAction

action

public final ChangeAction action()

The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).

If the service returns an enum value that is not available in the current SDK version, action will return ChangeAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).

See Also:

• ChangeAction

actionAsString

public final String actionAsString()

The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).

If the service returns an enum value that is not available in the current SDK version, action will return ChangeAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).

See Also:

• ChangeAction

logicalResourceId

public final String logicalResourceId()

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

Returns:

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

physicalResourceId

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

Returns:

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

resourceType

public final String resourceType()

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

Returns:

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

replacement

public final Replacement replacement()

For the Modify action, indicates whether 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 Conditional.

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 Conditional, and then Never.

If the service returns an enum value that is not available in the current SDK version, replacement will return Replacement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from replacementAsString().

Returns:

For the Modify action, indicates whether 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 Conditional.

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 Conditional, and then Never.

See Also:

• Replacement

replacementAsString

public final String replacementAsString()

For the Modify action, indicates whether 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 Conditional.

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 Conditional, and then Never.

If the service returns an enum value that is not available in the current SDK version, replacement will return Replacement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from replacementAsString().

Returns:

For the Modify action, indicates whether 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 Conditional.

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 Conditional, and then Never.

See Also:

• Replacement

scope

public final List<ResourceAttribute> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasScope() method.

Returns:

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 .

hasScope

public final boolean hasScope()

For responses, this returns true if the service returned a value for the Scope property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

scopeAsStrings

public final List<String> scopeAsStrings()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasScope() method.

Returns:

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 .

hasDetails

public final boolean hasDetails()

For responses, this returns true if the service returned a value for the Details property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

details

public final List<ResourceChangeDetail> details()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDetails() method.

Returns:

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

changeSetId

public final String changeSetId()

The change set ID of the nested change set.

Returns:

The change set ID of the nested change set.

moduleInfo

public final ModuleInfo moduleInfo()

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

Returns:

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

beforeContext

public final String beforeContext()

An encoded JSON string containing the context of the resource before the change is executed.

Returns:

An encoded JSON string containing the context of the resource before the change is executed.

afterContext

public final String afterContext()

An encoded JSON string containing the context of the resource after the change is executed.

Returns:

An encoded JSON string containing the context of the resource after the change is executed.

toBuilder

public ResourceChange.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceChange.Builder,ResourceChange>

Returns:

a builder for type T

builder

public static ResourceChange.Builder builder()

serializableBuilderClass

public static Class<? extends ResourceChange.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.