AWS AWSCloudFormation documentation change
Summary
Updated documentation links and restructured request/response examples for custom resources using SNS. Changed references from type-specific request topics to a consolidated 'Request and response reference' page. Standardized 'RequestId' format in examples.
Security assessment
Changes focus on documentation organization and example consistency rather than addressing security vulnerabilities. No security advisories, vulnerability fixes, or new security controls are mentioned. Updates to RequestId formatting and link structure appear to be general documentation improvements.
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/template-custom-resources-sns.md b/AWSCloudFormation/latest/UserGuide/template-custom-resources-sns.md index fb7cf15e3..fc7e687bb 100644 --- a//AWSCloudFormation/latest/UserGuide/template-custom-resources-sns.md +++ b//AWSCloudFormation/latest/UserGuide/template-custom-resources-sns.md @@ -15 +15 @@ When you specify an Amazon SNS topic as the target of a custom resource, CloudFo -For an introduction to custom resources and how they work, see [Create custom provisioning logic with custom resources](./template-custom-resources.html). For information about Amazon SNS and how it works, see the [Amazon Simple Notification Service Developer Guide](https://docs.aws.amazon.com/sns/latest/dg/). +For an introduction to custom resources and how they work, see [How custom resources work](./template-custom-resources.html#how-custom-resources-work). For information about Amazon SNS and how it works, see the [Amazon Simple Notification Service Developer Guide](https://docs.aws.amazon.com/sns/latest/dg/). @@ -74 +74 @@ The following example shows a custom resource `Create` request which includes a - "ResponseURL" : "http://pre-signed-S3-url-for-response", + "RequestId" : "unique-request-id", @@ -76 +76 @@ The following example shows a custom resource `Create` request which includes a - "RequestId" : "unique id for this create request", + "ResponseURL" : "http://pre-signed-S3-url-for-response", @@ -86 +86 @@ The following example shows a custom resource `Create` request which includes a -For detailed information about the request object for `Create` requests, see the [Create request for CloudFormation custom resources](./crpg-ref-requesttypes-create.html) topic. +For detailed information about the request object for `Create` requests, see the [Request and response reference](./crpg-ref.html) topic. @@ -90 +90 @@ For detailed information about the request object for `Create` requests, see the -Depending on the response type, different response fields will be expected by CloudFormation. For information about the response fields for a particular request type, see the documentation for that request type in the [Custom resource request types](./crpg-ref-requesttypes.html) section. +Depending on the response type, different response fields will be expected by CloudFormation. For information about the response fields for a particular request type, see the documentation for that request type in the [Request and response reference](./crpg-ref.html) section. @@ -92 +92 @@ Depending on the response type, different response fields will be expected by Cl -In response to a create or update request, the custom resource provider can return data elements in the [Data](./crpg-ref-responses.html#crpg-ref-responses-data) field of the response. These are name value pairs, and the _names_ correspond to the ``Fn::GetAtt`` attributes used with the custom resource in the stack template. The _values_ are the data that's returned when the template developer calls ``Fn::GetAtt`` on the resource with the attribute name. +In response to a create or update request, the custom resource provider can return data elements in the `Data` field of the response. These are name value pairs, and the _names_ correspond to the ``Fn::GetAtt`` attributes used with the custom resource in the stack template. The _values_ are the data that's returned when the template developer calls ``Fn::GetAtt`` on the resource with the attribute name. @@ -98 +98 @@ The following is an example of a custom resource response: - "PhysicalResourceId" : "Tester1", + "RequestId" : "unique-request-id", @@ -100 +99,0 @@ The following is an example of a custom resource response: - "RequestId" : "unique id for this create request", @@ -101,0 +101 @@ The following is an example of a custom resource response: + "PhysicalResourceId" : "Tester1", @@ -108 +108 @@ The following is an example of a custom resource response: -For detailed information about the response object for `Create` requests, see the [Create request for CloudFormation custom resources](./crpg-ref-requesttypes-create.html) topic. +For detailed information about the response object for `Create` requests, see the [Request and response reference](./crpg-ref.html) topic. @@ -173 +173 @@ The following is an example of an `Update` request: - "ResponseURL" : "http://pre-signed-S3-url-for-response", + "RequestId" : "unique-request-id", @@ -175,2 +175 @@ The following is an example of an `Update` request: - "RequestId" : "uniqueid for this update request", - "LogicalResourceId" : "MySeleniumTester", + "ResponseURL" : "http://pre-signed-S3-url-for-response", @@ -177,0 +177 @@ The following is an example of an `Update` request: + "LogicalResourceId" : "MySeleniumTester", @@ -192 +192 @@ The following is an example of an `Update` request: -For detailed information about the request object for `Update` requests, see the [Update request for CloudFormation custom resources](./crpg-ref-requesttypes-update.html) topic. +For detailed information about the request object for `Update` requests, see the [Request and response reference](./crpg-ref.html) topic. @@ -197,0 +198 @@ For detailed information about the request object for `Update` requests, see the + "RequestId" : "unique-request-id", @@ -199 +199,0 @@ For detailed information about the request object for `Update` requests, see the - "RequestId" : "uniqueid for this update request", @@ -204 +204 @@ For detailed information about the request object for `Update` requests, see the -For detailed information about the response object for `Update` requests, see the [Update request for CloudFormation custom resources](./crpg-ref-requesttypes-update.html) topic. +For detailed information about the response object for `Update` requests, see the [Request and response reference](./crpg-ref.html) topic. @@ -223 +223 @@ Whenever you delete a stack or make an update that removes or replaces the custo - "ResponseURL" : "http://pre-signed-S3-url-for-response", + "RequestId" : "unique-request-id", @@ -225 +225 @@ Whenever you delete a stack or make an update that removes or replaces the custo - "RequestId" : "unique id for this delete request", + "ResponseURL" : "http://pre-signed-S3-url-for-response", @@ -237 +237 @@ Whenever you delete a stack or make an update that removes or replaces the custo -For detailed information about the request object for `Delete` requests, see the [Delete request for CloudFormation custom resources](./crpg-ref-requesttypes-delete.html) topic. +For detailed information about the request object for `Delete` requests, see the [Request and response reference](./crpg-ref.html) topic. @@ -246,0 +247 @@ The following is an example of a custom resource provider response to a `Delete` + "RequestId" : "unique-request-id", @@ -248 +248,0 @@ The following is an example of a custom resource provider response to a `Delete` - "RequestId" : "unique id for this delete request", @@ -253 +253 @@ The following is an example of a custom resource provider response to a `Delete` -For detailed information about the response object for `Delete` requests, see the [Delete request for CloudFormation custom resources](./crpg-ref-requesttypes-delete.html) topic. +For detailed information about the response object for `Delete` requests, see the [Request and response reference](./crpg-ref.html) topic. @@ -268 +268 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Custom resources +Request and response reference