Class StackRefactorAction

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

Describes the stack and the action that CloudFormation will perform on it if you execute the stack refactor.

See Also:

  • Method Details

    • action

      public final StackRefactorActionType action()

      The action that CloudFormation takes on the stack.

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

      Returns:
      The action that CloudFormation takes on the stack.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action that CloudFormation takes on the stack.

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

      Returns:
      The action that CloudFormation takes on the stack.
      See Also:

    • entity

      public final StackRefactorActionEntity entity()

      The type that will be evaluated in the StackRefactorAction. The following are potential Entity types:

      • Stack

      • Resource

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

      Returns:
      The type that will be evaluated in the StackRefactorAction. The following are potential Entity types:

      • Stack

      • Resource

      See Also:

    • entityAsString

      public final String entityAsString()

      The type that will be evaluated in the StackRefactorAction. The following are potential Entity types:

      • Stack

      • Resource

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

      Returns:
      The type that will be evaluated in the StackRefactorAction. The following are potential Entity types:

      • Stack

      • Resource

      See Also:

    • physicalResourceId

      public final String physicalResourceId()

      The name or unique identifier associated with the physical instance of the resource.

      Returns:
      The name or unique identifier associated with the physical instance of the resource.

    • resourceIdentifier

      public final String resourceIdentifier()

      A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

      Returns:
      A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

    • description

      public final String description()

      A description to help you identify the refactor.

      Returns:
      A description to help you identify the refactor.

    • detection

      public final StackRefactorDetection detection()

      The detection type is one of the following:

      • Auto: CloudFormation figured out the mapping on its own.

      • Manual: The customer provided the mapping in the ResourceMapping parameter.

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

      Returns:
      The detection type is one of the following:

      • Auto: CloudFormation figured out the mapping on its own.

      • Manual: The customer provided the mapping in the ResourceMapping parameter.

      See Also:

    • detectionAsString

      public final String detectionAsString()

      The detection type is one of the following:

      • Auto: CloudFormation figured out the mapping on its own.

      • Manual: The customer provided the mapping in the ResourceMapping parameter.

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

      Returns:
      The detection type is one of the following:

      • Auto: CloudFormation figured out the mapping on its own.

      • Manual: The customer provided the mapping in the ResourceMapping parameter.

      See Also:

    • detectionReason

      public final String detectionReason()

      The description of the detection type.

      Returns:
      The description of the detection type.

    • hasTagResources

      public final boolean hasTagResources()
      For responses, this returns true if the service returned a value for the TagResources 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.

    • tagResources

      public final List<Tag> tagResources()

      Assigns one or more tags to specified resources.

      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 hasTagResources() method.

      Returns:
      Assigns one or more tags to specified resources.

    • hasUntagResources

      public final boolean hasUntagResources()
      For responses, this returns true if the service returned a value for the UntagResources 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.

    • untagResources

      public final List<String> untagResources()

      Removes one or more tags to specified resources.

      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 hasUntagResources() method.

      Returns:
      Removes one or more tags to specified resources.

    • resourceMapping

      public final ResourceMapping resourceMapping()

      The mapping for the stack resource Source and stack resource Destination.

      Returns:
      The mapping for the stack resource Source and stack resource Destination.

    • toBuilder

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

    • builder

      public static StackRefactorAction.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.