Class PropertyDifference

java.lang.Object
software.amazon.awssdk.services.cloudformation.model.PropertyDifference
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PropertyDifference.Builder,PropertyDifference>
@Generated("software.amazon.awssdk:codegen") public final class PropertyDifference extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PropertyDifference.Builder,PropertyDifference>

Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. For more information, see Detect unmanaged configuration changes to stacks and resources with drift detection.

See Also:

  • Method Details

    • propertyPath

      public final String propertyPath()

      The fully-qualified path to the resource property.

      Returns:
      The fully-qualified path to the resource property.

    • expectedValue

      public final String expectedValue()

      The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.

      Returns:
      The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.

    • actualValue

      public final String actualValue()

      The actual property value of the resource property.

      Returns:
      The actual property value of the resource property.

    • differenceType

      public final DifferenceType differenceType()

      The type of property difference.

      • ADD: A value has been added to a resource property that's an array or list data type.

      • REMOVE: The property has been removed from the current resource configuration.

      • NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).

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

      Returns:
      The type of property difference.

      • ADD: A value has been added to a resource property that's an array or list data type.

      • REMOVE: The property has been removed from the current resource configuration.

      • NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).

      See Also:

    • differenceTypeAsString

      public final String differenceTypeAsString()

      The type of property difference.

      • ADD: A value has been added to a resource property that's an array or list data type.

      • REMOVE: The property has been removed from the current resource configuration.

      • NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).

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

      Returns:
      The type of property difference.

      • ADD: A value has been added to a resource property that's an array or list data type.

      • REMOVE: The property has been removed from the current resource configuration.

      • NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).

      See Also:

    • toBuilder

      public PropertyDifference.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<PropertyDifference.Builder,PropertyDifference>
      Returns:
      a builder for type T

    • builder

      public static PropertyDifference.Builder builder()

    • serializableBuilderClass

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