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:

  • Method Details

    • 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:

    • 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:

    • 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 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 CloudFormation User Guide.
      See Also:

    • 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 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 CloudFormation User Guide.
      See Also:

    • 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.

    • 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.

      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.

      See Also:

    • 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.

      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.

      See Also:

    • toBuilder

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

    • 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)
      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.