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

Class ResourceTargetDefinition

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.ResourceTargetDefinition

All Implemented Interfaces:

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

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

The field that CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResourceTargetDefinition.Builder

Method Summary

Modifier and Type	Method	Description
String	afterValue()	The value of the property after the change is executed.
AfterValueFrom	afterValueFrom()	Indicates the source of the after value.
String	afterValueFromAsString()	Indicates the source of the after value.
ResourceAttribute	attribute()	Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
String	attributeAsString()	Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
AttributeChangeType	attributeChangeType()	The type of change to be made to the property if the change is executed.
String	attributeChangeTypeAsString()	The type of change to be made to the property if the change is executed.
String	beforeValue()	The value of the property before the change is executed.
BeforeValueFrom	beforeValueFrom()	Indicates the source of the before value.
String	beforeValueFromAsString()	Indicates the source of the before value.
static ResourceTargetDefinition.Builder	builder()
LiveResourceDrift	drift()	Detailed drift information for the resource property, including actual values, previous deployment values, and drift detection timestamps.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	If the Attribute value is Properties, the name of the property.
String	path()	The property path of the property.
RequiresRecreation	requiresRecreation()	If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated.
String	requiresRecreationAsString()	If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceTargetDefinition.Builder>	serializableBuilderClass()
ResourceTargetDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

attribute

public final ResourceAttribute attribute()

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

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

Returns:

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

See Also:

ResourceAttribute

attributeAsString

public final String attributeAsString()

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

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

Returns:

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

See Also:

ResourceAttribute

name

public final String name()

If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

Returns:

If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

requiresRecreation

public final RequiresRecreation requiresRecreation()

If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and property types reference in the CloudFormation User Guide.

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

Returns:

If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and property types reference in the CloudFormation User Guide.

See Also:

RequiresRecreation

requiresRecreationAsString

public final String requiresRecreationAsString()

If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and property types reference in the CloudFormation User Guide.

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

Returns:

If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the Amazon Web Services resource and property types reference in the CloudFormation User Guide.

See Also:

RequiresRecreation

path

public final String path()

The property path of the property.

Returns:

The property path of the property.

beforeValue

public final String beforeValue()

The value of the property before the change is executed. Large values can be truncated.

Returns:

The value of the property before the change is executed. Large values can be truncated.

afterValue

public final String afterValue()

The value of the property after the change is executed. Large values can be truncated.

Returns:

The value of the property after the change is executed. Large values can be truncated.

beforeValueFrom

public final BeforeValueFrom beforeValueFrom()

Indicates the source of the before value. Valid values:

• ACTUAL_STATE – The before value represents current actual state.

• PREVIOUS_DEPLOYMENT_STATE – The before value represents the previous CloudFormation deployment state.

Only present for drift-aware change sets.

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

Returns:

Indicates the source of the before value. Valid values:

• ACTUAL_STATE – The before value represents current actual state.

• PREVIOUS_DEPLOYMENT_STATE – The before value represents the previous CloudFormation deployment state.

Only present for drift-aware change sets.

See Also:

BeforeValueFrom

beforeValueFromAsString

public final String beforeValueFromAsString()

Indicates the source of the before value. Valid values:

• ACTUAL_STATE – The before value represents current actual state.

• PREVIOUS_DEPLOYMENT_STATE – The before value represents the previous CloudFormation deployment state.

Only present for drift-aware change sets.

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

Returns:

Indicates the source of the before value. Valid values:

• ACTUAL_STATE – The before value represents current actual state.

• PREVIOUS_DEPLOYMENT_STATE – The before value represents the previous CloudFormation deployment state.

Only present for drift-aware change sets.

See Also:

BeforeValueFrom

afterValueFrom

public final AfterValueFrom afterValueFrom()

Indicates the source of the after value. Valid value:

• TEMPLATE – The after value comes from the new template.

Only present for drift-aware change sets.

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

Returns:

Indicates the source of the after value. Valid value:

• TEMPLATE – The after value comes from the new template.

Only present for drift-aware change sets.

See Also:

AfterValueFrom

afterValueFromAsString

public final String afterValueFromAsString()

Indicates the source of the after value. Valid value:

• TEMPLATE – The after value comes from the new template.

Only present for drift-aware change sets.

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

Returns:

Indicates the source of the after value. Valid value:

• TEMPLATE – The after value comes from the new template.

Only present for drift-aware change sets.

See Also:

AfterValueFrom

drift

public final LiveResourceDrift drift()

Detailed drift information for the resource property, including actual values, previous deployment values, and drift detection timestamps.

Returns:

Detailed drift information for the resource property, including actual values, previous deployment values, and drift detection timestamps.

attributeChangeType

public final AttributeChangeType attributeChangeType()

The type of change to be made to the property if the change is executed.

• Add The item will be added.

• Remove The item will be removed.

• Modify The item will be modified.

• SyncWithActual The drift status of this item will be reset but the item will not be modified.

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

Returns:

The type of change to be made to the property if the change is executed.

• Add The item will be added.

• Remove The item will be removed.

• Modify The item will be modified.

• SyncWithActual The drift status of this item will be reset but the item will not be modified.

See Also:

AttributeChangeType

attributeChangeTypeAsString

public final String attributeChangeTypeAsString()

The type of change to be made to the property if the change is executed.

• Add The item will be added.

• Remove The item will be removed.

• Modify The item will be modified.

• SyncWithActual The drift status of this item will be reset but the item will not be modified.

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

Returns:

The type of change to be made to the property if the change is executed.

• Add The item will be added.

• Remove The item will be removed.

• Modify The item will be modified.

• SyncWithActual The drift status of this item will be reset but the item will not be modified.

See Also:

AttributeChangeType

toBuilder

public ResourceTargetDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceTargetDefinition.Builder,ResourceTargetDefinition>

builder

public static ResourceTargetDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends ResourceTargetDefinition.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo