Class ResourceChange
- java.lang.Object
-
- com.amazonaws.services.cloudformation.model.ResourceChange
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class ResourceChange extends Object implements Serializable, Cloneable
The
ResourceChange
structure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ResourceChange()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ResourceChange
clone()
boolean
equals(Object obj)
String
getAction()
The action that AWS CloudFormation takes on the resource, such asAdd
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).List<ResourceChangeDetail>
getDetails()
For theModify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.String
getLogicalResourceId()
The resource's logical ID, which is defined in the stack's template.String
getPhysicalResourceId()
The resource's physical ID (resource name).String
getReplacement()
For theModify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one.String
getResourceType()
The type of AWS CloudFormation resource, such asAWS::S3::Bucket
.List<String>
getScope()
For theModify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.int
hashCode()
void
setAction(ChangeAction action)
The action that AWS CloudFormation takes on the resource, such asAdd
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).void
setAction(String action)
The action that AWS CloudFormation takes on the resource, such asAdd
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).void
setDetails(Collection<ResourceChangeDetail> details)
For theModify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.void
setLogicalResourceId(String logicalResourceId)
The resource's logical ID, which is defined in the stack's template.void
setPhysicalResourceId(String physicalResourceId)
The resource's physical ID (resource name).void
setReplacement(Replacement replacement)
For theModify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one.void
setReplacement(String replacement)
For theModify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one.void
setResourceType(String resourceType)
The type of AWS CloudFormation resource, such asAWS::S3::Bucket
.void
setScope(Collection<String> scope)
For theModify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.String
toString()
Returns a string representation of this object; useful for testing and debugging.ResourceChange
withAction(ChangeAction action)
The action that AWS CloudFormation takes on the resource, such asAdd
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).ResourceChange
withAction(String action)
The action that AWS CloudFormation takes on the resource, such asAdd
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).ResourceChange
withDetails(ResourceChangeDetail... details)
For theModify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.ResourceChange
withDetails(Collection<ResourceChangeDetail> details)
For theModify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.ResourceChange
withLogicalResourceId(String logicalResourceId)
The resource's logical ID, which is defined in the stack's template.ResourceChange
withPhysicalResourceId(String physicalResourceId)
The resource's physical ID (resource name).ResourceChange
withReplacement(Replacement replacement)
For theModify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one.ResourceChange
withReplacement(String replacement)
For theModify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one.ResourceChange
withResourceType(String resourceType)
The type of AWS CloudFormation resource, such asAWS::S3::Bucket
.ResourceChange
withScope(ResourceAttribute... scope)
For theModify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.ResourceChange
withScope(String... scope)
For theModify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.ResourceChange
withScope(Collection<String> scope)
For theModify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.
-
-
-
Method Detail
-
setAction
public void setAction(String action)
The action that AWS CloudFormation takes on the resource, such as
Add
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).- Parameters:
action
- The action that AWS CloudFormation takes on the resource, such asAdd
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).- See Also:
ChangeAction
-
getAction
public String getAction()
The action that AWS CloudFormation takes on the resource, such as
Add
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).- Returns:
- The action that AWS CloudFormation takes on the resource, such as
Add
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource). - See Also:
ChangeAction
-
withAction
public ResourceChange withAction(String action)
The action that AWS CloudFormation takes on the resource, such as
Add
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).- Parameters:
action
- The action that AWS CloudFormation takes on the resource, such asAdd
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChangeAction
-
setAction
public void setAction(ChangeAction action)
The action that AWS CloudFormation takes on the resource, such as
Add
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).- Parameters:
action
- The action that AWS CloudFormation takes on the resource, such asAdd
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).- See Also:
ChangeAction
-
withAction
public ResourceChange withAction(ChangeAction action)
The action that AWS CloudFormation takes on the resource, such as
Add
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).- Parameters:
action
- The action that AWS CloudFormation takes on the resource, such asAdd
(adds a new resource),Modify
(changes a resource), orRemove
(deletes a resource).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChangeAction
-
setLogicalResourceId
public void setLogicalResourceId(String logicalResourceId)
The resource's logical ID, which is defined in the stack's template.
- Parameters:
logicalResourceId
- The resource's logical ID, which is defined in the stack's template.
-
getLogicalResourceId
public String getLogicalResourceId()
The resource's logical ID, which is defined in the stack's template.
- Returns:
- The resource's logical ID, which is defined in the stack's template.
-
withLogicalResourceId
public ResourceChange withLogicalResourceId(String logicalResourceId)
The resource's logical ID, which is defined in the stack's template.
- Parameters:
logicalResourceId
- The resource's logical ID, which is defined in the stack's template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPhysicalResourceId
public void setPhysicalResourceId(String physicalResourceId)
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
- Parameters:
physicalResourceId
- The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
-
getPhysicalResourceId
public String getPhysicalResourceId()
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
- Returns:
- The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
-
withPhysicalResourceId
public ResourceChange withPhysicalResourceId(String physicalResourceId)
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
- Parameters:
physicalResourceId
- The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setResourceType
public void setResourceType(String resourceType)
The type of AWS CloudFormation resource, such as
AWS::S3::Bucket
.- Parameters:
resourceType
- The type of AWS CloudFormation resource, such asAWS::S3::Bucket
.
-
getResourceType
public String getResourceType()
The type of AWS CloudFormation resource, such as
AWS::S3::Bucket
.- Returns:
- The type of AWS CloudFormation resource, such as
AWS::S3::Bucket
.
-
withResourceType
public ResourceChange withResourceType(String resourceType)
The type of AWS CloudFormation resource, such as
AWS::S3::Bucket
.- Parameters:
resourceType
- The type of AWS CloudFormation resource, such asAWS::S3::Bucket
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setReplacement
public void setReplacement(String replacement)
For the
Modify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditionally
.If you have multiple changes with different
RequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditionally
, and thenNever
.- Parameters:
replacement
- For theModify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditionally
.If you have multiple changes with different
RequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditionally
, and thenNever
.- See Also:
Replacement
-
getReplacement
public String getReplacement()
For the
Modify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditionally
.If you have multiple changes with different
RequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditionally
, and thenNever
.- Returns:
- For the
Modify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditionally
.If you have multiple changes with different
RequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditionally
, and thenNever
. - See Also:
Replacement
-
withReplacement
public ResourceChange withReplacement(String replacement)
For the
Modify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditionally
.If you have multiple changes with different
RequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditionally
, and thenNever
.- Parameters:
replacement
- For theModify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditionally
.If you have multiple changes with different
RequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditionally
, and thenNever
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Replacement
-
setReplacement
public void setReplacement(Replacement replacement)
For the
Modify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditionally
.If you have multiple changes with different
RequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditionally
, and thenNever
.- Parameters:
replacement
- For theModify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditionally
.If you have multiple changes with different
RequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditionally
, and thenNever
.- See Also:
Replacement
-
withReplacement
public ResourceChange withReplacement(Replacement replacement)
For the
Modify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditionally
.If you have multiple changes with different
RequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditionally
, and thenNever
.- Parameters:
replacement
- For theModify
action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of theRequiresRecreation
property in theResourceTargetDefinition
structure. For example, if theRequiresRecreation
field isAlways
and theEvaluation
field isStatic
,Replacement
isTrue
. If theRequiresRecreation
field isAlways
and theEvaluation
field isDynamic
,Replacement
isConditionally
.If you have multiple changes with different
RequiresRecreation
values, theReplacement
value depends on the change with the most impact. ARequiresRecreation
value ofAlways
has the most impact, followed byConditionally
, and thenNever
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
Replacement
-
getScope
public List<String> getScope()
For the
Modify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.- Returns:
- For the
Modify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
. - See Also:
ResourceAttribute
-
setScope
public void setScope(Collection<String> scope)
For the
Modify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.- Parameters:
scope
- For theModify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.- See Also:
ResourceAttribute
-
withScope
public ResourceChange withScope(String... scope)
For the
Modify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.NOTE: This method appends the values to the existing list (if any). Use
setScope(java.util.Collection)
orwithScope(java.util.Collection)
if you want to override the existing values.- Parameters:
scope
- For theModify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ResourceAttribute
-
withScope
public ResourceChange withScope(Collection<String> scope)
For the
Modify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.- Parameters:
scope
- For theModify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ResourceAttribute
-
withScope
public ResourceChange withScope(ResourceAttribute... scope)
For the
Modify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.- Parameters:
scope
- For theModify
action, indicates which resource attribute is triggering this update, such as a change in the resource attribute'sMetadata
,Properties
, orTags
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ResourceAttribute
-
getDetails
public List<ResourceChangeDetail> getDetails()
For the
Modify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.- Returns:
- For the
Modify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.
-
setDetails
public void setDetails(Collection<ResourceChangeDetail> details)
For the
Modify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.- Parameters:
details
- For theModify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.
-
withDetails
public ResourceChange withDetails(ResourceChangeDetail... details)
For the
Modify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.NOTE: This method appends the values to the existing list (if any). Use
setDetails(java.util.Collection)
orwithDetails(java.util.Collection)
if you want to override the existing values.- Parameters:
details
- For theModify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDetails
public ResourceChange withDetails(Collection<ResourceChangeDetail> details)
For the
Modify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.- Parameters:
details
- For theModify
action, a list ofResourceChangeDetail
structures that describes the changes that AWS CloudFormation will make to the resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ResourceChange clone()
-
-