Updated README.md to include information about conditionalCreateOnlyP…#148
Open
mawkabel wants to merge 1 commit intoaws-cloudformation:masterfrom
Open
Conversation
…roperties schema property
ammokhov
reviewed
May 9, 2024
Contributor
ammokhov
left a comment
ammokhov
left a comment
There was a problem hiding this comment.
Apologies for the late review.
I would add a bit more details
| * **`readOnlyProperties`**: A property in the `readOnlyProperties` list cannot be specified by the customer. | ||
| * **`writeOnlyProperties`**: A property in the `writeOnlyProperties` cannot be returned in a **READ** or **LIST** request, and can be used to express things like passwords, secrets or other sensitive data. | ||
| * **`createOnlyProperties`**: A property in the `createOnlyProperties` cannot be specified in an **UPDATE** request, and can only be specified in a **CREATE** request. Another way to think about this - these are properties which are 'write-once', such as the [`Engine`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engine) property for an [`AWS::RDS::DBInstance`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html) and if you wish to change such a property on a live resource, you should replace that resource by creating a new instance of the resource and terminating the old one. This is the behaviour CloudFormation follows for all properties documented as _'Update Requires: Replacement'_. An attempt to supply these properties to an **UPDATE** request will produce a runtime error from the handler. | ||
| * **`conditionalCreateOnlyProperties`**: A property in the `conditionalCreateOnlyProperties` can only be updated under certain conditions. For example, you can upgrade the engine version of an RDS DBInstance but you cannot downgrade it. When updating this property for a resource in a CloudFormation stack, the resource will be replaced if it cannot be updated. |
Contributor
There was a problem hiding this comment.
I think we need to mention that such properties behave like createOnlyProperties only when specific values are changed. Such scenarios MUST be handled by UpdateHandler throwing NotUpdatable exception
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of changes:
Added a section to the README.md about
conditionalCreateOnlyPropertiesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.