search

awsdocs / aws-cloudformation-user-guide

The open source version of the AWS CloudFormation User Guide
Other
766 stars 1.31k forks source link

Clarify replacement behavior when adding/removing property that requires update #1276

Closed awsdiegorad closed 10 months ago

awsdiegorad commented 2 years ago

Please add clarification to the "Replacement" section stack update behavior documentation [1].

Please clarify that when adding/removing a property that requires replacement upon update, such as BucketName [2], the resource will be replaced, even if the actual value of the property does not change.

For example, the default value for the AtRestEncryptionEnabled property of an AWS::ElastiCache::ReplicationGroup resource is false [3], this property required replacement upon update.

If you were to create this resource without the property defined, then update this resource with the property defined and set to false, then the resource will be replaced.

Resources: [1] https://github.com/awsdocs/aws-cloudformation-user-guide/blob/main/doc_source/using-cfn-updating-stacks-update-behaviors.md [2] https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket.html#cfn-s3-bucket-name [3] https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-atrestencryptionenabled

joshbean commented 10 months ago

Closing this issue or pull request in advance of archiving this repo. For more information about the decision to archive this repo (and others in the "awsdocs" org), see the announcement on the AWS News Blog.