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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StackRefactorAction.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`StackRefactorActionType`	`action()`	The action that CloudFormation takes on the stack.
`String`	`actionAsString()`	The action that CloudFormation takes on the stack.
`static StackRefactorAction.Builder`	`builder()`
`String`	`description()`	A description to help you identify the refactor.
`StackRefactorDetection`	`detection()`	The detection type is one of the following:
`String`	`detectionAsString()`	The detection type is one of the following:
`String`	`detectionReason()`	The description of the detection type.
`StackRefactorActionEntity`	`entity()`	The type that will be evaluated in the `StackRefactorAction`.
`String`	`entityAsString()`	The type that will be evaluated in the `StackRefactorAction`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTagResources()`	For responses, this returns true if the service returned a value for the TagResources property.
`boolean`	`hasUntagResources()`	For responses, this returns true if the service returned a value for the UntagResources property.
`String`	`physicalResourceId()`	The name or unique identifier associated with the physical instance of the resource.
`String`	`resourceIdentifier()`	A key-value pair that identifies the target resource.
`ResourceMapping`	`resourceMapping()`	The mapping for the stack resource `Source` and stack resource `Destination`.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StackRefactorAction.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tagResources()`	Assigns one or more tags to specified resources.
`StackRefactorAction.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<String>`	`untagResources()`	Removes one or more tags to specified resources.

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
  - 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:
    
    StackRefactorActionType
  - 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:
    
    StackRefactorActionType
  - 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:
    
    StackRefactorActionEntity
  - 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:
    
    StackRefactorActionEntity
  - 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:
    
    StackRefactorDetection
  - 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:
    
    StackRefactorDetection
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StackRefactorAction.Builder,StackRefactorAction>
  - 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)
```
    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

Class StackRefactorAction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

action

actionAsString

entity

entityAsString

physicalResourceId

resourceIdentifier

description

detection

detectionAsString

detectionReason

hasTagResources

tagResources

hasUntagResources

untagResources

resourceMapping

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField