AWS cloudformation-cli documentation change
Summary
Updated example placeholders (ACCOUNT_ID -> 123456789012) and YAML syntax formatting
Security assessment
Changes consist of replacing placeholder account IDs with 123456789012 and removing unnecessary quotes in YAML examples. These are documentation formatting improvements with no security implications or security-related content additions.
Diff
diff --git a/cloudformation-cli/latest/hooks-userguide/testing-hooks.md b/cloudformation-cli/latest/hooks-userguide/testing-hooks.md index 4bed3f427..6f042b24e 100644 --- a//cloudformation-cli/latest/hooks-userguide/testing-hooks.md +++ b//cloudformation-cli/latest/hooks-userguide/testing-hooks.md @@ -37 +37 @@ In the following example, create a template called `my-failed-bucket-stack.yml` - Type: 'AWS::S3::Bucket' + Type: AWS::S3::Bucket @@ -57 +57 @@ Use the `describe-stack-events` operation to see the Hook failure while creating - "StackId": "arn:aws:cloudformation:us-west-2:ACCOUNT_ID:stack/my-hook-stack/2c693970-f57e-11eb-a0fb-061a2a83f0b9", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-hook-stack/2c693970-f57e-11eb-a0fb-061a2a83f0b9", @@ -87 +87 @@ _Results_ : The Hook invocation failed the stack configuration and stopped the r - Type: 'AWS::S3::Bucket' + Type: AWS::S3::Bucket @@ -89 +89 @@ _Results_ : The Hook invocation failed the stack configuration and stopped the r - BucketName: !Sub 'encryptedbucket-${AWS::Region}-${AWS::AccountId}' + BucketName: !Sub encryptedbucket-${AWS::Region}-${AWS::AccountId} @@ -97 +97 @@ _Results_ : The Hook invocation failed the stack configuration and stopped the r - Type: 'AWS::KMS::Key' + Type: AWS::KMS::Key @@ -108 +108 @@ _Results_ : The Hook invocation failed the stack configuration and stopped the r - AWS: !Ref 'AWS::AccountId' + AWS: !Ref AWS::AccountId @@ -137 +137 @@ Use the `describe-stack-events` command to view the response. The following is a - "StackId": "arn:aws:cloudformation:us-west-2:ACCOUNT_ID:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779", @@ -141 +141 @@ Use the `describe-stack-events` command to view the response. The following is a - "PhysicalResourceId": "encryptedbucket-us-west-2-ACCOUNT_ID", + "PhysicalResourceId": "encryptedbucket-us-west-2-123456789012", @@ -145 +145 @@ Use the `describe-stack-events` command to view the response. The following is a - "ResourceProperties": "{\"BucketName\":\"encryptedbucket-us-west-2-071617338693\",\"BucketEncryption\":{\"ServerSideEncryptionConfiguration\":[{\"BucketKeyEnabled\":\"true\",\"ServerSideEncryptionByDefault\":{\"SSEAlgorithm\":\"aws:kms\",\"KMSMasterKeyID\":\"ENCRYPTION_KEY_ARN\"}}]}}", + "ResourceProperties": "{\"BucketName\":\"encryptedbucket-us-west-2-123456789012\",\"BucketEncryption\":{\"ServerSideEncryptionConfiguration\":[{\"BucketKeyEnabled\":\"true\",\"ServerSideEncryptionByDefault\":{\"SSEAlgorithm\":\"aws:kms\",\"KMSMasterKeyID\":\"ENCRYPTION_KEY_ARN\"}}]}}", @@ -149 +149 @@ Use the `describe-stack-events` command to view the response. The following is a - "StackId": "arn:aws:cloudformation:us-west-2:ACCOUNT_ID:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779", @@ -153 +153 @@ Use the `describe-stack-events` command to view the response. The following is a - "PhysicalResourceId": "encryptedbucket-us-west-2-ACCOUNT_ID", + "PhysicalResourceId": "encryptedbucket-us-west-2-123456789012", @@ -158 +158 @@ Use the `describe-stack-events` command to view the response. The following is a - "ResourceProperties": "{\"BucketName\":\"encryptedbucket-us-west-2-071617338693\",\"BucketEncryption\":{\"ServerSideEncryptionConfiguration\":[{\"BucketKeyEnabled\":\"true\",\"ServerSideEncryptionByDefault\":{\"SSEAlgorithm\":\"aws:kms\",\"KMSMasterKeyID\":\"ENCRYPTION_KEY_ARN\"}}]}}", + "ResourceProperties": "{\"BucketName\":\"encryptedbucket-us-west-2-123456789012\",\"BucketEncryption\":{\"ServerSideEncryptionConfiguration\":[{\"BucketKeyEnabled\":\"true\",\"ServerSideEncryptionByDefault\":{\"SSEAlgorithm\":\"aws:kms\",\"KMSMasterKeyID\":\"ENCRYPTION_KEY_ARN\"}}]}}", @@ -162 +162 @@ Use the `describe-stack-events` command to view the response. The following is a - "StackId": "arn:aws:cloudformation:us-west-2:ACCOUNT_ID:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779", @@ -193 +193 @@ _Results_ : CloudFormation successfully created the stack. The Hook's logic veri - Type: 'AWS::S3::Bucket' + Type: AWS::S3::Bucket @@ -195 +195 @@ _Results_ : CloudFormation successfully created the stack. The Hook's logic veri - BucketName: !Sub 'encryptedbucket-${AWS::Region}-${AWS::AccountId}' + BucketName: !Sub encryptedbucket-${AWS::Region}-${AWS::AccountId} @@ -222 +222 @@ Use the `describe-stack-events` operation to see the Hook failure while creating - "StackId": "arn:aws:cloudformation:us-west-2:ACCOUNT_ID:stack/my-hook-stack/2c693970-f57e-11eb-a0fb-061a2a83f0b9", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-hook-stack/2c693970-f57e-11eb-a0fb-061a2a83f0b9", @@ -252 +252 @@ _Results_ : The Hook invocation failed the stack configuration and stopped the r - Type: 'AWS::S3::Bucket' + Type: AWS::S3::Bucket @@ -254 +254 @@ _Results_ : The Hook invocation failed the stack configuration and stopped the r - BucketName: !Sub 'encryptedbucket-${AWS::Region}-${AWS::AccountId}' + BucketName: !Sub encryptedbucket-${AWS::Region}-${AWS::AccountId} @@ -262 +262 @@ _Results_ : The Hook invocation failed the stack configuration and stopped the r - Type: 'AWS::SQS::Queue' + Type: AWS::SQS::Queue @@ -264 +264 @@ _Results_ : The Hook invocation failed the stack configuration and stopped the r - QueueName: 'encryptedqueue-${AWS::Region}-${AWS::AccountId}' + QueueName: !Sub encryptedqueue-${AWS::Region}-${AWS::AccountId} @@ -267 +267 @@ _Results_ : The Hook invocation failed the stack configuration and stopped the r - Type: 'AWS::KMS::Key' + Type: AWS::KMS::Key @@ -278 +278 @@ _Results_ : The Hook invocation failed the stack configuration and stopped the r - AWS: !Ref 'AWS::AccountId' + AWS: !Ref AWS::AccountId @@ -308 +308 @@ Use the `describe-stack-events` command to view the response. The following is a - "StackId": "arn:aws:cloudformation:us-west-2:ACCOUNT_ID:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779", @@ -312 +312 @@ Use the `describe-stack-events` command to view the response. The following is a - "PhysicalResourceId": "encryptedbucket-us-west-2-ACCOUNT_ID", + "PhysicalResourceId": "encryptedbucket-us-west-2-123456789012", @@ -316 +316 @@ Use the `describe-stack-events` command to view the response. The following is a - "ResourceProperties": "{\"BucketName\":\"encryptedbucket-us-west-2-071617338693\",\"BucketEncryption\":{\"ServerSideEncryptionConfiguration\":[{\"BucketKeyEnabled\":\"true\",\"ServerSideEncryptionByDefault\":{\"SSEAlgorithm\":\"aws:kms\",\"KMSMasterKeyID\":\"ENCRYPTION_KEY_ARN\"}}]}}", + "ResourceProperties": "{\"BucketName\":\"encryptedbucket-us-west-2-123456789012\",\"BucketEncryption\":{\"ServerSideEncryptionConfiguration\":[{\"BucketKeyEnabled\":\"true\",\"ServerSideEncryptionByDefault\":{\"SSEAlgorithm\":\"aws:kms\",\"KMSMasterKeyID\":\"ENCRYPTION_KEY_ARN\"}}]}}", @@ -320 +320 @@ Use the `describe-stack-events` command to view the response. The following is a - "StackId": "arn:aws:cloudformation:us-west-2:ACCOUNT_ID:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779", @@ -324 +324 @@ Use the `describe-stack-events` command to view the response. The following is a - "PhysicalResourceId": "encryptedbucket-us-west-2-ACCOUNT_ID", + "PhysicalResourceId": "encryptedbucket-us-west-2-123456789012", @@ -329 +329 @@ Use the `describe-stack-events` command to view the response. The following is a - "ResourceProperties": "{\"BucketName\":\"encryptedbucket-us-west-2-071617338693\",\"BucketEncryption\":{\"ServerSideEncryptionConfiguration\":[{\"BucketKeyEnabled\":\"true\",\"ServerSideEncryptionByDefault\":{\"SSEAlgorithm\":\"aws:kms\",\"KMSMasterKeyID\":\"ENCRYPTION_KEY_ARN\"}}]}}", + "ResourceProperties": "{\"BucketName\":\"encryptedbucket-us-west-2-123456789012\",\"BucketEncryption\":{\"ServerSideEncryptionConfiguration\":[{\"BucketKeyEnabled\":\"true\",\"ServerSideEncryptionByDefault\":{\"SSEAlgorithm\":\"aws:kms\",\"KMSMasterKeyID\":\"ENCRYPTION_KEY_ARN\"}}]}}", @@ -333 +333 @@ Use the `describe-stack-events` command to view the response. The following is a - "StackId": "arn:aws:cloudformation:us-west-2:ACCOUNT_ID:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-encrypted-bucket-stack/82a97150-f57a-11eb-8eb2-06a6bdcc7779",