AWS AWSCloudFormation documentation change
Summary
Restructured and expanded documentation for CloudFormation pseudo parameters, adding syntax examples for Ref/Sub functions, formatting improvements, and clarification of parameter behaviors
Security assessment
Changes focus on documentation structure, syntax examples, and parameter descriptions without addressing security vulnerabilities or introducing security features. Updates to AWS::NotificationARNs and AWS::Partition documentation provide better clarity but don't indicate security fixes.
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.md b/AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.md index 072599295..ddbdd1215 100644 --- a//AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.md +++ b//AWSCloudFormation/latest/UserGuide/pseudo-parameter-reference.md @@ -0,0 +1,2 @@ +[](/pdfs/AWSCloudFormation/latest/UserGuide/cfn-ug.pdf#pseudo-parameter-reference "Open PDF") + @@ -3 +5,17 @@ -ExampleAWS::AccountIdAWS::NotificationARNsAWS::NoValueAWS::PartitionAWS::RegionAWS::StackIdAWS::StackNameAWS::URLSuffix +SyntaxExampleAvailable pseudo parameters + +# Get AWS values using pseudo parameters + +Pseudo parameters are predefined by CloudFormation and don't require declaration in your template. Use them with the `Ref` or `Sub` intrinsic functions to access contextual information about your AWS account, Region, and other contextual data, instead of hard-coding values in your template. + +## Syntax + +To use pseudo parameters with the `Ref` intrinsic function, the basic syntax is: + +### JSON + + + { "Ref" : "AWS::PseudoParameter" } + +### YAML + @@ -5 +23 @@ ExampleAWS::AccountIdAWS::NotificationARNsAWS::NoValueAWS::PartitionAWS::RegionA -# Pseudo parameters reference + !Ref AWS::PseudoParameter @@ -7 +25,11 @@ ExampleAWS::AccountIdAWS::NotificationARNsAWS::NoValueAWS::PartitionAWS::RegionA -Pseudo parameters are parameters that are predefined by AWS CloudFormation. You don't declare them in your template. Use them the same way as you would a parameter, as the argument for the `Ref` function. +To use pseudo parameters with the `Sub` intrinsic function, the basic syntax is: + +### JSON + + + { "Fn::Sub" : "${AWS::PseudoParameter}" } + +### YAML + + + !Sub '${AWS::PseudoParameter}' @@ -26,0 +55 @@ The following snippet assigns the value of the `AWS::Region` pseudo parameter to +## Available pseudo parameters @@ -28 +57 @@ The following snippet assigns the value of the `AWS::Region` pseudo parameter to -## `AWS::AccountId` +### `AWS::AccountId` @@ -32 +61 @@ Returns the AWS account ID of the account in which the stack is being created, s -## `AWS::NotificationARNs` +### `AWS::NotificationARNs` @@ -36 +65 @@ Returns the list of notification Amazon Resource Names (ARNs) for the current st -To get a single ARN from the list, use [Fn::Select](./intrinsic-function-reference-select.html). +To get a single ARN from the list, use `Fn::Select`. For more information, see the [Fn::Select](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-select.html) reference. @@ -38 +67 @@ To get a single ARN from the list, use [Fn::Select](./intrinsic-function-referen -### JSON +#### JSON @@ -56 +85 @@ To get a single ARN from the list, use [Fn::Select](./intrinsic-function-referen -### YAML +#### YAML @@ -78 +107 @@ To get a single ARN from the list, use [Fn::Select](./intrinsic-function-referen -## `AWS::NoValue` +### `AWS::NoValue` @@ -84 +113 @@ For example, you can use the `AWS::NoValue` parameter when you want to use a sna -### JSON +#### JSON @@ -107 +136 @@ For example, you can use the `AWS::NoValue` parameter when you want to use a sna -### YAML +#### YAML @@ -129 +158 @@ For example, you can use the `AWS::NoValue` parameter when you want to use a sna -## `AWS::Partition` +### `AWS::Partition` @@ -131 +160 @@ For example, you can use the `AWS::NoValue` parameter when you want to use a sna -Returns the partition that the resource is in. For standard AWS Regions, the partition is `aws`. For resources in other partitions, the partition is `aws-``partitionname`. For example, the partition for resources in the China (Beijing and Ningxia) Region is `aws-cn` and the partition for resources in the AWS GovCloud (US-West) region is `aws-us-gov`. +Returns the partition that the resource is in. For standard AWS Regions, the partition is `aws`. For resources in other partitions, the partition is `aws-``partitionname`. For example, the partition for resources in the China (Beijing and Ningxia) Regions is `aws-cn` and the partition for resources in the AWS GovCloud (US-West) Region is `aws-us-gov`. @@ -133 +162 @@ Returns the partition that the resource is in. For standard AWS Regions, the par -## `AWS::Region` +### `AWS::Region` @@ -137 +166 @@ Returns a string representing the Region in which the encompassing resource is b -## `AWS::StackId` +### `AWS::StackId` @@ -139 +168 @@ Returns a string representing the Region in which the encompassing resource is b -Returns the ID of the stack as specified with the `aws cloudformation create-stack` command, such as `arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123`. +Returns the ID of the stack as specified with the **create-stack** command, such as `arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123`. @@ -141 +170 @@ Returns the ID of the stack as specified with the `aws cloudformation create-sta -## `AWS::StackName` +### `AWS::StackName` @@ -143 +172 @@ Returns the ID of the stack as specified with the `aws cloudformation create-sta -Returns the name of the stack as specified with the `aws cloudformation create-stack` command, such as `teststack`. +Returns the name of the stack as specified with the **create-stack** command, such as `teststack`. @@ -145 +174 @@ Returns the name of the stack as specified with the `aws cloudformation create-s -## `AWS::URLSuffix` +### `AWS::URLSuffix` @@ -155 +184 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Intrinsic functions in policy attributes +Get Secrets Manager value @@ -157 +186 @@ Intrinsic functions in policy attributes -Transform reference +Get stack outputs