id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
ams-ct-069 | ams-ct.pdf | 69 | command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 239 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Required parameters only: aws amscm create-rfc --title my-app-key --change-type-id ct-1d84keiri1jhg --change-type-version 1.0 --execution-parameters '{"Description":"KMS key for my-app","VpcId":"VPC_ID","Name":"my-app-key","StackTemplateId":"stm- enf1j068fhg34vugt","TimeoutInMinutes":60,"Parameters":{"Description":"KMS key for my- app"}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateKmsKeyAutoParams.json. aws amscm get-change-type-version --change-type-id "ct-1d84keiri1jhg" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateKmsKeyAutoParams.json 2. Modify and save the CreateKmsKeyAutoParams file. Examples follow. Grant a user or a role, permission to decrypt the created CMK. Example execution parameters: { "Description": "KMS key for my-app", "VpcId": "VPC_ID”, "Name": "my-app-key-decrypt", "StackTemplateId": "stm-enf1j068fhg34vugt", "TimeoutInMinutes": 60, "Parameters": { "IAMPrincipalsRequiringDecryptPermissions": [ "ARN:role/roleA", "ARN:user/userB", "ARN:role/instanceProfileA" ], "Description": "KMS key for my-app" } } Advanced Stack Components Version April 22, 2025 240 AMS Advanced Change Type Reference AMS Advanced Change Type Details For the resulting policy, see Grants Permissions to Decrypt with the CML for an IAM User or a Role. Grant a user or role, permission to encrypt using the created CMK. Example execution parameters: { "Description": "KMS key for my-app", "VpcId": "VPC_ID", "Name": "my-app-key-encrypt", "Tags": [ { "Key": "Name", "Value": "my-app-key" } ], "StackTemplateId": "stm-enf1j068fhg34vugt", "TimeoutInMinutes": 60, "Parameters": { "IAMPrincipalsRequiringEncryptPermissions": [ "ARN:role/roleA", "ARN:user/userB", "ARN:role/instanceProfileA" ], "Description": "KMS key for my-app" } } For the resulting policy, see Grants Permissions to Encrypt with the CML for an IAM User or a Role. Grant a user, role, or account, permission to create grants using the created CMK. Example execution parameters: { "Description": "KMS key for my-app", "VpcId": "VPC_ID", "Name": "my-app-key-create-grants", "StackTemplateId": "stm-enf1j068fhg34vugt", "TimeoutInMinutes": 60, "Parameters": { Advanced Stack Components Version April 22, 2025 241 AMS Advanced Change Type Reference AMS Advanced Change Type Details "IAMPrincipalsRequiringGrantsPermissions": [ "arn:aws:iam::999999999999:role/roleA", "888888888888" ], "Description": "KMS key for my-app" } } For the resulting policy, see Grants Permissions to Create Grants with the CMK for an IAM User, Role, or Account. Allow only AWS services that are integrated with AWS KMS to perform the GRANT operation. Example execution parameters: { "Description": "KMS key for my-app", "VpcId": "VPC_ID", "Name": "my-app-key-limit-to-services", "StackTemplateId": "stm-enf1j068fhg34vugt", "TimeoutInMinutes": 60, "Parameters": { "IAMPrincipalsRequiringGrantsPermissions": [ "arn:aws:iam::999999999999:role/roleA" ], "LimitGrantsToAWSResources": "true", "Description": "KMS key for my-app" } } For the resulting policy, see Allow only AWS services that are Integrated with AWS KMS to Perform the GRANT Operation. Enforce use of encryption context keys in cryptographic operations. Example execution parameters: { "Description": "KMS key for my-app", "VpcId": "VPC_ID", "Name": "my-app-key-encryption-keys", "StackTemplateId": "stm-enf1j068fhg34vugt", "TimeoutInMinutes": 60, "Parameters": { Advanced Stack Components Version April 22, 2025 242 AMS Advanced Change Type Reference AMS Advanced Change Type Details "EnforceEncryptionContextKeys": "true", "Description": "KMS key for my-app" } } For the resulting policy, see Enforce use of Encryption Context Keys in Cryptographic Operations. Enforce a specific list of encryption context keys in cryptographic operations. Example execution parameters: { "Description": "KMS key for my-app", "VpcId": "VPC_ID", "Name": "my-app-key-encryption-list", "StackTemplateId": "stm-enf1j068fhg34vugt", "TimeoutInMinutes": 60, "Parameters": { "AllowedEncryptionContextKeys": [ "Name", "Application" ], "Description": "KMS key for my-app" } } For the resulting policy, see Enforce a Specific List of Encryption Context Keys in Cryptographic Operations. Allow AWS services to access the created CMK. Example execution parameters: { "Description" : "KMS key for my-app", "VpcId" : "VPC_ID", "Name" : "my-app-key-allow-aws-service-access", "StackTemplateId" : "stm-enf1j068fhg34vugt", "TimeoutInMinutes" : 60, "Parameters" : { "AllowServiceRolesAccessKMSKeys": [ "ec2.us-east-1.amazonaws.com", "ecr.us-east-1.amazonaws.com" ], Advanced Stack Components Version April 22, 2025 243 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description": "KMS key for my-app" } } For the resulting policy, see Allow AWS services to access created CMK. 3. Output the RFC template JSON file to a file; this example names it CreateKmsKeyAutoRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateKmsKeyAutoRfc.json 4. Modify and save the CreateKmsKeyAutoRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1d84keiri1jhg", "ChangeTypeVersion": "1.0", "Title": "Create KMS Key" } 5. Create the RFC, specifying the CreateKmsKeyAuto Rfc file and the CreateKmsKeyAutoParams file: aws amscm create-rfc --cli-input-json file://CreateKmsKeyAutoRfc.json --execution- parameters file://CreateKmsKeyAutoParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and |
ams-ct-070 | ams-ct.pdf | 70 | RFC template JSON file to a file; this example names it CreateKmsKeyAutoRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateKmsKeyAutoRfc.json 4. Modify and save the CreateKmsKeyAutoRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1d84keiri1jhg", "ChangeTypeVersion": "1.0", "Title": "Create KMS Key" } 5. Create the RFC, specifying the CreateKmsKeyAuto Rfc file and the CreateKmsKeyAutoParams file: aws amscm create-rfc --cli-input-json file://CreateKmsKeyAutoRfc.json --execution- parameters file://CreateKmsKeyAutoParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • This CT creates a CloudFormation stack which creates a KMS key with DeletionPolicy: Retain. By design, the created KMS key will persist even after you delete the stack. If you are sure you want to delete the KMS key, create an RFC with Change Type ct-2zxya20wmf5bf, Management | Advanced stack components | KMS key | Delete (review required). • This change type is ExecutionMode=Automated, so this change type does not require manual review by AMS operations and should execute more rapidly than KMS Key: Create (review required); however, if you have an unusual situation, the manual version might work better for you. See KMS Key | Create (Review Required). Advanced Stack Components Version April 22, 2025 244 AMS Advanced Change Type Reference AMS Advanced Change Type Details • This CT has a new parameter, AllowServiceRolesAccessKMSKeys, that provides the specified AWS services access to the KMS key. The change was made because the Autoscaling group service role was unable to start the EC2 instances with encrypted EBS volumes due to lack of permissions to the KMS key. • To learn more about AWS KMS keys, see AWS Key Management Service (KMS), AWS Key Management Service FAQs, and AWS Key Management Service Concepts. KMS Key Create resulting policies Depending on how you created your KMS key, you created policies. These example policies match various KMS key create scenarios provided in Create KMS key. Grants Permissions to Decrypt with the CML for an IAM User or a Role Resulting example policy grants IAM users, roles or instance profiles, permission to decrypt using the CMK: { "Sid": "Allow decrypt using the key", "Effect": "Allow", "Principal": { "AWS": [ "arn:aws:iam::999999999999:role/roleA", "arn:aws:iam::999999999999:user/userB", "arn:aws:iam::999999999999:role/instanceProfileA" ] }, "Action": [ "kms:DescribeKey", "kms:Decrypt" ], "Resource": "*" } For the execution parameters to create this policy with the KMS key Create change type, see Create KMS key Grants Permissions to Encrypt with the CML for an IAM User or a Role Resulting example policy grants IAM users, roles or instance profiles, permission to encrypt using the CMK: Advanced Stack Components Version April 22, 2025 245 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Sid": "Allow encrypt using the key", "Effect": "Allow", "Principal": { "AWS": [ "arn:aws:iam::999999999999:role/roleA", "arn:aws:iam::999999999999:user/userB", "arn:aws:iam::999999999999:role/instanceProfileA" ] }, "Action": [ "kms:DescribeKey", "kms:Encrypt", "kms:ReEncrypt*", "kms:GenerateDataKey", "kms:GenerateDataKeyWithoutPlaintext" ], "Resource": "*" } For the execution parameters to create this policy with the KMS key Create change type, see Create KMS key Grants Permissions to Create Grants with the CMK for an IAM User, Role, or Account Resulting example policy: { "Sid": "Allow grants", "Effect": "Allow", "Principal": { "AWS": [ "arn:aws:iam::999999999999:role/roleA", "arn:aws:iam::888888888888:root" ] }, "Action": [ "kms:CreateGrant", "kms:ListGrants", "kms:RevokeGrant" ], "Resource": "*" Advanced Stack Components Version April 22, 2025 246 AMS Advanced Change Type Reference AMS Advanced Change Type Details } For the execution parameters to create this policy with the KMS key Create change type, see Create KMS key Allow only AWS services that are Integrated with AWS KMS to Perform the GRANT Operation Resulting example policy: { "Sid": "Allow grants", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::999999999999:role/roleA" }, "Action": [ "kms:CreateGrant", "kms:ListGrants", "kms:RevokeGrant" ], "Resource": "*" }, { "Sid": "Deny if grant is not for AWS resource", "Effect": "Deny", "Principal": { "AWS": "*" }, "Action": [ "kms:CreateGrant", "kms:ListGrants", "kms:RevokeGrant" ], "Resource": "*", "Condition": { "Bool": { "kms:GrantIsForAWSResource": "false" } } } } } Advanced Stack Components Version April 22, 2025 247 AMS Advanced Change Type Reference AMS Advanced Change Type Details For the execution parameters to create this policy with the KMS key Create change type, see Create KMS key Enforce use of Encryption Context Keys in Cryptographic Operations Resulting example policy: { "Effect": "Deny", "Principal": { "AWS": "*" }, "Action": [ "kms:CreateGrant", "kms:Decrypt", "kms:Encrypt", "kms:GenerateDataKey*", "kms:ReEncrypt" ], "Resource": "*", "Condition": { "Null": { "kms:EncryptionContextKeys": "true" } } } For the execution parameters to create this policy with the KMS key Create change type, see Create KMS key Enforce a Specific List of Encryption Context Keys in Cryptographic Operations Resulting example policy: { "Effect": "Deny", "Principal": { "AWS": "*" }, "Action": [ "kms:CreateGrant", "kms:Decrypt", Advanced Stack Components Version April 22, 2025 248 AMS Advanced Change Type Reference AMS Advanced Change Type Details "kms:Encrypt", "kms:GenerateDataKey*", |
ams-ct-071 | ams-ct.pdf | 71 | Context Keys in Cryptographic Operations Resulting example policy: { "Effect": "Deny", "Principal": { "AWS": "*" }, "Action": [ "kms:CreateGrant", "kms:Decrypt", "kms:Encrypt", "kms:GenerateDataKey*", "kms:ReEncrypt" ], "Resource": "*", "Condition": { "Null": { "kms:EncryptionContextKeys": "true" } } } For the execution parameters to create this policy with the KMS key Create change type, see Create KMS key Enforce a Specific List of Encryption Context Keys in Cryptographic Operations Resulting example policy: { "Effect": "Deny", "Principal": { "AWS": "*" }, "Action": [ "kms:CreateGrant", "kms:Decrypt", Advanced Stack Components Version April 22, 2025 248 AMS Advanced Change Type Reference AMS Advanced Change Type Details "kms:Encrypt", "kms:GenerateDataKey*", "kms:ReEncrypt" ], "Resource": "*", "Condition": { "StringEquals": { "kms:EncryptionContextKeys": [ "Name", "Application" ] } } } For the execution parameters to create this policy with the KMS key Create change type, see Create KMS key Allow AWS services to access created CMK Resulting example policy: { "Effect": "Allow", "Principal": { "AWS": "*" }, "Action": [ "kms:ListGrants", "kms:CreateGrant", "kms:DescribeKey", "kms:Encrypt", "kms:Decrypt", "kms:ReEncrypt*", "kms:GenerateDataKey*" ], "Resource": "*", "Condition": { "StringEquals": { "kms:ViaService": [ "ec2.us-west-2.amazonaws.com", "ecr.us-east-1.amazonaws.com" ], Advanced Stack Components Version April 22, 2025 249 AMS Advanced Change Type Reference AMS Advanced Change Type Details "kms:CallerAccount": "111122223333" } } } For the execution parameters to create this policy with the KMS key Create change type, see Create KMS key Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1d84keiri1jhg. Example: Required Parameters { "Description" : "Test description", "VpcId" : "vpc-12345678901234567", "Name" : "TestStack", "StackTemplateId" : "stm-enf1j068fhg34vugt", "TimeoutInMinutes" : 60, "Parameters" : { "Description" : "Test key" } } Example: All Parameters { "Description" : "Test description", "VpcId" : "vpc-12345678", "Name" : "TestStack", "Tags" : [ { "Key" : "foo", "Value" : "bar" } ], "StackTemplateId" : "stm-enf1j068fhg34vugt", "TimeoutInMinutes" : 60, "Parameters" : { "Alias" : "testkey", Advanced Stack Components Version April 22, 2025 250 AMS Advanced Change Type Reference AMS Advanced Change Type Details "EnableKeyRotation" : "true", "Description" : "Test key", "PendingWindow" : 30, "IAMPrincipalsRequiringDecryptPermissions" : [ "arn:aws:iam::123456789012:user/myuser", "arn:aws:iam::123456789012:role/myrole" ], "IAMPrincipalsRequiringEncryptPermissions" : [ "arn:aws:iam::123456789012:user/myuser", "arn:aws:iam::123456789012:role/myrole" ], "IAMPrincipalsRequiringGrantsPermissions" : [ "arn:aws:iam::123456789012:user/myuser", "arn:aws:iam::123456789012:role/myrole", "987654321098" ], "LimitGrantsToAWSResources" : "true", "EnforceEncryptionContextKeys" : "true", "AllowedEncryptionContextKeys" : [ "App" ], "AllowServiceRolesAccessKMSKeys": [ "ec2.us-east-1.amazonaws.com" ] } } KMS Key | Create (Review Required) Request a KMS key by describing key permissions or submitting a key policy document. Full classification: Deployment | Advanced stack components | KMS key | Create (review required) Change Type Details Change type ID ct-2epp05svrlwod Current version 3.0 Expected execution duration 240 minutes AWS approval Required Advanced Stack Components Version April 22, 2025 251 AMS Advanced Change Type Reference AMS Advanced Change Type Details Customer approval Not required if submitter Execution mode Manual Additional Information Create KMS Key (review required) Creating an AWS KMS Key (review required) with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. Advanced Stack Components Version April 22, 2025 252 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the |
ams-ct-072 | ams-ct.pdf | 72 | view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an AWS KMS Key (review required) with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status Advanced Stack Components Version April 22, 2025 253 AMS Advanced Change Type Reference AMS Advanced Change Type Details changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2epp05svrlwod" --change-type-version "3.0" --title "TITLE" --execution-parameters "{\"KeyDescription\": \"Example description\", \"KeyPermissions\": \"key permissions\", \"Operation\": \"Create\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateKmsKeyParams.json: aws amscm get-change-type-version --change-type-id "ct-2epp05svrlwod" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateKmsKeyParams.json 2. Modify and save the CreateKmsKeyParams file. For example, you can replace the contents with something like this: { "Description": "KMS key request", "KeyPermissions": "{\"Id\":\"key-consolepolicy-3\",\"Version\":\"2012-10-17\", \"Statement\":[{\"Sid\":\"Allow use of the key\",\"Effect\":\"Allow\",\"Principal \":{\"AWS\":[\"arn:aws:iam::111122223333:role/KMSRole\"]},\"Action\":[\"kms:Encrypt \",\"kms:Decrypt\",\"kms:ReEncrypt*\",\"kms:GenerateDataKey*\",\"kms:DescribeKey \"],\"Resource\":\"*\"}]}", "Operation": "Create" } 3. Output the RFC template JSON file to a file; this example names it CreateKmsKeyRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateKmsKeyRfc.json Advanced Stack Components Version April 22, 2025 254 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the CreateKmsKeyRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-2epp05svrlwod", "Title": "KmsKey-Create-RFC" } 5. Create the RFC, specifying the CreateKmsKey Rfc file and the CreateKmsKeyParams file: aws amscm create-rfc --cli-input-json file://CreateKmsKeyRfc.json --execution- parameters file://CreateKmsKeyParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note This change type is at v3.0. The required KeyName parameter has been replaced by an optional AliasName parameter; KMS keys use aliases. This is a "review required" change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a "review required" change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. To learn more about AWS KMS keys, see AWS Key Management Service (KMS), AWS Key Management Service FAQs, and AWS Key Management Service Concepts. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2epp05svrlwod. Advanced Stack Components Version April 22, 2025 255 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "KeyDescription": "Exmample description of the key to be created.", "KeyPermissions": "KMS Key permissions to add: kms:Get", "Operation": "Create" } Example: All Parameters { "KeyDescription": "Exmample description of the key to be created.", "AliasName": "testkmskey", "KeyRotation": true, "KeyPermissions": "KMS Key permissions to add: kms:Get", "MultiRegion": false, "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "Operation": "Create", "Priority": "Medium" } Listener | Create (For ALB or NLB) Create a listener for an Application Load Balancer (ALB) or Network Load Balancer (NLB). A listener is a process that checks for connection requests, the rules that you |
ams-ct-073 | ams-ct.pdf | 73 | "KeyDescription": "Exmample description of the key to be created.", "KeyPermissions": "KMS Key permissions to add: kms:Get", "Operation": "Create" } Example: All Parameters { "KeyDescription": "Exmample description of the key to be created.", "AliasName": "testkmskey", "KeyRotation": true, "KeyPermissions": "KMS Key permissions to add: kms:Get", "MultiRegion": false, "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "Operation": "Create", "Priority": "Medium" } Listener | Create (For ALB or NLB) Create a listener for an Application Load Balancer (ALB) or Network Load Balancer (NLB). A listener is a process that checks for connection requests, the rules that you define for a listener determine how the load balancer routes requests to its registered targets. Full classification: Deployment | Advanced stack components | Listener | Create (for ALB or NLB) Change Type Details Change type ID ct-14yjom3kvpinu Advanced Stack Components Version April 22, 2025 256 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create listener Creating a Listener for an ALB or NLB with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. Advanced Stack Components Version April 22, 2025 257 AMS Advanced Change Type Reference AMS Advanced Change Type Details To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Listener for an ALB or NLB with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Advanced Stack Components Version April 22, 2025 258 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-14yjom3kvpinu" --change-type-version "2.0" --title "TITLE" --execution-parameters "{\"Description\":\"DESCRIPTION\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\": \"stm- u5n0r6aacdvdwthhm\", \"Name\":\"NAME\", \"TimeoutInMinutes\":60, \"Parameters\": {\"LoadBalancerArn\":\"LB-ARN",\"DefaultActionTargetGroupArn\":\"TARGET-GROUP-ARN", \"Port\":\"80\",\"Protocol\":\"HTTP\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a |
ams-ct-074 | ams-ct.pdf | 74 | parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-14yjom3kvpinu" --change-type-version "2.0" --title "TITLE" --execution-parameters "{\"Description\":\"DESCRIPTION\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\": \"stm- u5n0r6aacdvdwthhm\", \"Name\":\"NAME\", \"TimeoutInMinutes\":60, \"Parameters\": {\"LoadBalancerArn\":\"LB-ARN",\"DefaultActionTargetGroupArn\":\"TARGET-GROUP-ARN", \"Port\":\"80\",\"Protocol\":\"HTTP\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateListenerParams.json: aws amscm get-change-type-version --change-type-id "ct-14yjom3kvpinu" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateListenerParams.json 2. Modify and save the CreateListenerParams file. For example, you can replace the contents with something like this: { "Description": "Listener-Create", "VpcId": "VPC_ID", "StackTemplateId": "stm-u5n0r6aacdvdwthhm", "Name": "My-Listener", Advanced Stack Components Version April 22, 2025 259 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Parameters": { "LoadBalancerArn": ARN, "DefaultActionTargetGroupArn": ARN, "Port": PORT, "Protocol": Protocol" } } 3. Output the RFC template to a file in your current folder; this example names it CreateListenerRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateListenerRfc.json 4. Modify and save the CreateListenerRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-14yjom3kvpinu", "Title": "Listener-Create-RFC" } 5. Create the RFC, specifying the CreateListenerRfc file and the CreateListenerParams file: aws amscm create-rfc --cli-input-json file://CreateListenerRfc.json --execution- parameters file://CreateListenerParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Next Steps: Submit a Management | Other | Other | Update change type to open ports and associate security groups, see Other | Other requests. Tips Note You can specify up to four Target IDs, Ports, and Availability Zones. Advanced Stack Components Version April 22, 2025 260 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-14yjom3kvpinu. Example: Required Parameters { "Description": "This is a test description", "Name": "Test Stack", "Parameters": { "DefaultActionTargetGroupArn": "arn:aws:elasticloadbalancing:eu- west-1:123456789012:targetgroup/target-group-name/123456789012", "LoadBalancerArn": "arn:aws:elasticloadbalancing:us- west-2:123456789012:loadbalancer/app/my-app-load-balancer/abcdefghij", "Port": "80", "Protocol": "HTTP" }, "StackTemplateId": "stm-u5n0r6aacdvdwthhm", "TimeoutInMinutes": 60, "VpcId": "vpc-01234567890abcdef" } Example: All Parameters { "Description": "This is a test description", "Name": "Test Stack", "Parameters": { "CertificateArn": "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", "DefaultActionTargetGroupArn": "arn:aws:elasticloadbalancing:eu- west-1:123456789012:targetgroup/target-group-name/123456789012", "LoadBalancerArn": "arn:aws:elasticloadbalancing:us- west-2:123456789012:loadbalancer/app/my-app-load-balancer/abcdefghij", "Port": "443", "Protocol": "HTTP", "ALBSslPolicy": "ELBSecurityPolicy-2016-08", "AlpnPolicy": "HTTP2Only" }, "StackTemplateId": "stm-u5n0r6aacdvdwthhm", "TimeoutInMinutes": 60, "VpcId": "vpc-01234567890abcdef" Advanced Stack Components Version April 22, 2025 261 AMS Advanced Change Type Reference AMS Advanced Change Type Details } Load Balancer (ELB) Stack | Create Use to create an Amazon ELB Classic Load Balancer. Use alternate change types to create an Application Load Balancer (ct-111r1yayblnw4) or Network Load Balancer (ct-2qldv4h9osmau). Full classification: Deployment | Advanced stack components | Load balancer (ELB) stack | Create Change Type Details Change type ID ct-12amsdz909cfh Current version 3.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create ELB load balancer Creating an Elastic Load Balancer with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 262 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional |
ams-ct-075 | ams-ct.pdf | 75 | Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. Advanced Stack Components Version April 22, 2025 263 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an Elastic Load Balancer with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 264 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id ct-12amsdz909cfh -- change-type-version 3.0 --title "my-elb" --execution-parameters '{"Description":"My ELB","VpcId":"VPC_ID","StackTemplateId":"stm- sdhopv30000000000","Name":"myElb","TimeoutInMinutes":60,"Parameters":{"ELBSubnetIds": ["SUBNET_ID","SUBNET_ID"],"ELBLoadBalancerPort":"80","ELBLoadBalancerProtocol":"HTTP","ELBInstancePort":"80"}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateElbParams.json: aws amscm get-change-type-version --change-type-id "ct-12amsdz909cfh" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateElbParams.json 2. Modify and save the CreateElbParams file. The values given in the example reflect a deployment of a Public ELB, with the health check thresholds relaxed and the ELBScheme set to true (for a public ELB). Note that the Name you set here is not the actual ELB name, you can find that name in the console as the ELB instance name. Not all optional parameters are shown in the example. { "Description": "ELB-Create", "VpcId": "VPC_ID", "StackTemplateId": "stm-sdhopv00000000000", "Name": "My-ELB", "Parameters": { "ELBSubnetIds": ["PUBLIC_AZ1", "PUBLIC_AZ2"], "ELBHealthCheckHealthyThreshold": 2, "ELBHealthCheckInterval": 30, "ELBHealthCheckTarget": "HTTP:80/status", "ELBHealthCheckTimeout": 10, "ELBHealthCheckUnhealthyThreshold": 3, "ELBScheme": true } } Advanced Stack Components Version April 22, 2025 265 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. Output the RFC template to a file in your current folder; this example names it CreateElbRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateElbRfc.json 4. Modify and save the CreateElbRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-12amsdz909cfh", "Title": "ELB-Create-RFC" } 5. Create the RFC, specifying the CreateElbRfc file and the CreateElbParams file: aws amscm create-rfc --cli-input-json file://CreateElbRfc.json --execution- parameters file://CreateElbParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the load balancer, look in the execution output: Use the stack_id to view the ELB in the Cloud Formation console or to create a Delete Stack RFC, use the ELBCName value to programmatically access the ELB. You might need to submit a Management | Other | Other | Update change type to open ports and associate security groups, see Other | Other requests. Tips To learn more about AWS Classic Load Balancers, see What Is a Classic Load Balancer? Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-12amsdz909cfh. Example: Required Parameters { Advanced Stack Components Version April 22, 2025 266 AMS Advanced |
ams-ct-076 | ams-ct.pdf | 76 | stack_id to view the ELB in the Cloud Formation console or to create a Delete Stack RFC, use the ELBCName value to programmatically access the ELB. You might need to submit a Management | Other | Other | Update change type to open ports and associate security groups, see Other | Other requests. Tips To learn more about AWS Classic Load Balancers, see What Is a Classic Load Balancer? Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-12amsdz909cfh. Example: Required Parameters { Advanced Stack Components Version April 22, 2025 266 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "StackTemplateId": "stm-sdhopv30000000000", "Name": "Test Stack", "TimeoutInMinutes": 60, "Parameters": { "ELBSubnetIds": ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"], "ELBInstancePort": "80", "ELBInstanceProtocol": "HTTP", "ELBLoadBalancerPort": "80", "ELBLoadBalancerProtocol": "HTTP" } } Example: All Parameters { "Description": "This is a test description", "VpcId": "vpc-12345678", "StackTemplateId": "stm-sdhopv30000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "ELBSubnetIds": ["subnet-a0b1c2d3", "subnet-a0b2c9d8"], "ELBHealthCheckHealthyThreshold": 2, "ELBHealthCheckInterval": 10, "ELBHealthCheckTarget": "HTTP:80/index.html", "ELBHealthCheckTimeout": 10, "ELBHealthCheckUnhealthyThreshold": 3, "ELBIdleTimeout": 30, "ELBInstancePort": "80", "ELBInstanceProtocol": "HTTPS", "ELBCookieExpirationPeriod": "60", Advanced Stack Components Version April 22, 2025 267 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ELBCookieStickinessPolicyName": "MyPolicy", "ELBLoadBalancerName": "MyLoadBalancer", "ELBLoadBalancerPort": "443", "ELBLoadBalancerProtocol": "HTTP", "ELBSSLCertificateId": "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", "ELBScheme": false, "ELBCrossZone": true, "ELBBackendInstances": ["i-12345678", "i-01234567"], "ELBInstancePort2": "80", "ELBInstanceProtocol2": "HTTPS", "ELBCookieExpirationPeriod2": "60", "ELBCookieStickinessPolicyName2": "MyPolicy2", "ELBLoadBalancerPort2": "445", "ELBLoadBalancerProtocol2": "HTTP", "ELBSSLCertificateId2": "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" } } Load Balancer (ELB) Stack | Create (With Additional Listeners) Create an Elastic ("Classic") load balancer (ELB). Full classification: Deployment | Advanced stack components | Load balancer (ELB) stack | Create (with additional listeners) Change Type Details Change type ID ct-0ary07xiajwx4 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 268 AMS Advanced Change Type Reference Additional Information Create ELB load balancer with additional listeners AMS Advanced Change Type Details Creating an Elastic Load Balancer (with additional listeners) with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Advanced Stack Components Version April 22, 2025 269 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an Elastic Load Balancer (with additional listeners) with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters |
ams-ct-077 | ams-ct.pdf | 77 | it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Advanced Stack Components Version April 22, 2025 270 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm --profile saml --region us-east-1 create-rfc --change-type- id "ct-0ary07xiajwx4" --change-type-version "1.0" --title 'My-ELB-AL- Create-RFC' --description "Test" --execution-parameters "{\"Description\": \"Test\",\"VpcId\":\"VPC_ID\",\"Name\":\"TestStack\",\"StackTemplateId\": \"stm-3tdleig07sbhstgnf\",\"TimeoutInMinutes\":60,\"LoadBalancer\":{\"SecurityGroups\": [\"sg-12345678901234567\"],\"SubnetIds\":[\"subnet-12345678901234567\"]},\"Listener1\": {\"InstancePort\":\"80\",\"Port\":\"80\",\"Protocol\":\"HTTP\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateElbAlParams.json: aws amscm get-change-type-version --change-type-id "ct-0ary07xiajwx4" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateElbAlParams.json 2. Modify and save the CreateElbAlParams file. The values given in the example reflect a deployment of a Public ELB, with the health check thresholds relaxed and the ELBScheme set to true (for a public ELB). Note that the Name you set here is not the actual ELB name, you can find that name in the console as the ELB instance name. Not all optional parameters are shown in the example. { "Description" : "Test", "VpcId" : "VPC_ID", "Name" : "TestStack", "StackTemplateId" : "stm-3tdleig07sbhstgnf", "TimeoutInMinutes" : 60, "LoadBalancer" : { "SecurityGroups" : ["SG_ID, SG_ID"], "SubnetIds" : ["SUBNET_ID, SUBNET_ID"] Advanced Stack Components Version April 22, 2025 271 AMS Advanced Change Type Reference AMS Advanced Change Type Details }, "Listener1" : { "InstancePort" : "80", "Port" : "80", "Protocol" : "HTTP" } } 3. Output the RFC template to a file in your current folder; this example names it CreateElbAlRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateElbAlRfc.json 4. Modify and save the CreateElbAlRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0ary07xiajwx4", "Title": "My-ELB-Create-RFC" } 5. Create the RFC, specifying the CreateElbAlRfc file and the CreateElbAlParams file: aws amscm create-rfc --cli-input-json file://CreateElbAlRfc.json --execution- parameters file://CreateElbAlParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the load balancer, look in the execution output: Use the stack_id to view the ELB in the Cloud Formation console or to create a Delete Stack RFC, use the ELBCName value to programmatically access the ELB. Tips To learn more about AWS Classic Load Balancers, see What Is a Classic Load Balancer? Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0ary07xiajwx4. Advanced Stack Components Version April 22, 2025 272 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "Description" : "Test description", "VpcId" : "vpc-12345678901234567", "Name" : "TestStack", "StackTemplateId" : "stm-3tdleig07sbhstgnf", "TimeoutInMinutes" : 60, "LoadBalancer" : { "SecurityGroups" : ["sg-12345678901234567"], "SubnetIds" : ["subnet-12345678901234567"] }, "Listener1" : { "InstancePort" : "80", "Port" : "80", "Protocol" : "HTTP" } } Example: All Parameters { "Description" : "Test description", "VpcId" : "vpc-12345678", "Name" : "TestStack", "Tags" : [ { "Key" : "foo", "Value" : "bar" } ], "StackTemplateId" : "stm-3tdleig07sbhstgnf", "TimeoutInMinutes" : 60, "LoadBalancer" : { "Name" : "testLoadBalancer", "Scheme" : "false", "SecurityGroups" : ["sg-12345678"], "SubnetIds" : ["subnet-12345678"], "AccessLogInterval" : "60", "ConnectionDrainingTimeout" : 60, "IdleTimeout" : 60, "CrossZone" : "true", "HealthCheckHealthyThreshold" : "2", Advanced Stack Components Version April 22, 2025 273 AMS Advanced Change Type Reference AMS Advanced Change Type Details "HealthCheckInterval" : "10", "HealthCheckTarget" : "TCP:80", "HealthCheckTimeout" : "5", "HealthCheckUnhealthyThreshold" : "10", "BackendInstances" : ["i-12345678"], "LBCookieExpirationPeriod" : "2", "LBCookieStickinessPolicyName" : "LBCOOKIE", "AppCookieName" : "APPCOOKIE", "AppCookiePolicyName" : "app-cookie" }, "Listener1" : { "InstancePort" : "80", "InstanceProtocol" : "HTTP", "Port" : "80", "Protocol" : "HTTP", "PolicyNames" : ["cookie4"], "SSLCertificateId" : "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" }, "Listener2" : { "InstancePort" : "80", "InstanceProtocol" : "HTTP", "Port" : "80", "Protocol" : "HTTP", "PolicyNames" : ["cookie4", "sslPolicy"], "SSLCertificateId" : "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" }, "Listener3" : |
ams-ct-078 | ams-ct.pdf | 78 | : "true", "HealthCheckHealthyThreshold" : "2", Advanced Stack Components Version April 22, 2025 273 AMS Advanced Change Type Reference AMS Advanced Change Type Details "HealthCheckInterval" : "10", "HealthCheckTarget" : "TCP:80", "HealthCheckTimeout" : "5", "HealthCheckUnhealthyThreshold" : "10", "BackendInstances" : ["i-12345678"], "LBCookieExpirationPeriod" : "2", "LBCookieStickinessPolicyName" : "LBCOOKIE", "AppCookieName" : "APPCOOKIE", "AppCookiePolicyName" : "app-cookie" }, "Listener1" : { "InstancePort" : "80", "InstanceProtocol" : "HTTP", "Port" : "80", "Protocol" : "HTTP", "PolicyNames" : ["cookie4"], "SSLCertificateId" : "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" }, "Listener2" : { "InstancePort" : "80", "InstanceProtocol" : "HTTP", "Port" : "80", "Protocol" : "HTTP", "PolicyNames" : ["cookie4", "sslPolicy"], "SSLCertificateId" : "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" }, "Listener3" : { "InstancePort" : "80", "InstanceProtocol" : "HTTP", "Port" : "80", "Protocol" : "HTTP", "PolicyNames" : ["cookie4", "sslPolicy", "two"], "SSLCertificateId" : "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" }, "Listener4" : { "InstancePort" : "80", "InstanceProtocol" : "HTTP", "Port" : "80", "Protocol" : "HTTP", "PolicyNames" : ["cookie4", "sslPolicy"], Advanced Stack Components Version April 22, 2025 274 AMS Advanced Change Type Reference AMS Advanced Change Type Details "SSLCertificateId" : "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" }, "Listener5" : { "InstancePort" : "80", "InstanceProtocol" : "HTTP", "Port" : "80", "Protocol" : "HTTP", "PolicyNames" : ["cookie4", "sslPolicy"], "SSLCertificateId" : "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" } } Network Load Balancer | Create Use to create a Network Load Balancer. Full classification: Deployment | Advanced stack components | Network Load Balancer | Create Change Type Details Change type ID ct-2qldv4h9osmau Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create NLB load balancer Creating an NLB with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 275 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. Advanced Stack Components Version April 22, 2025 276 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an NLB with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 277 AMS Advanced Change Type Reference AMS Advanced Change |
ams-ct-079 | ams-ct.pdf | 79 | To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 277 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-2qldv4h9osmau" --change-type-version "1.0" --title "Test-NLB-QC" --execution- parameters "{\"Description\":\"QCNLB\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\": \"stm-l70qr9itukvqssg8d\", \"Name\":\"QCNLB\", \"TimeoutInMinutes\":60, \"Parameters\": {\"SubnetIds\":[\"SUBNET_ID\",\"SUBNET_ID\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateNlbParams.json: aws amscm get-change-type-version --change-type-id "ct-2qldv4h9osmau" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateNlbParams.json 2. Modify and save the CreateNlbParams file. The values given in the example reflect a deployment of a public Network Load Balancer, with the health check thresholds relaxed and the Public parameters set to true (for a public NLB). Note that the Name you set here is not the actual NLB name, you can find that name in the console as the NLB instance name. { "Description": "NLB-Create", "VpcId": "VPC_ID", "StackTemplateId": "stm-l70qr9itukvqssg8d", "Name": "My-NLB", "Parameters": { "SubnetIds": ["PUBLIC_AZ1", "PUBLIC_AZ2"], "HealthCheckHealthyThreshold": 2, "HealthCheckInterval": 30, "HealthCheckTargetPath": traffic-port", "DeregistrationDelayTimeout": 10, "Public": true } } 3. Output the RFC template to a file in your current folder; this example names it CreateNlbRfc.json: Advanced Stack Components Version April 22, 2025 278 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > CreateNlbRfc.json 4. Modify and save the CreateNlbRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2qldv4h9osmau", "Title": "NLB-Create-RFC" } 5. Create the RFC, specifying the CreateNlbRfc file and the CreateNlbParams file: aws amscm create-rfc --cli-input-json file://CreateNlbRfc.json --execution- parameters file://CreateNlbParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the load balancer, look in the execution output: Use the stack_id to view the NLB in the CloudFormation console or to create a Delete Stack RFC, and use the NLB CName value to programmatically access the NLB. Tips Note You can specify up to four Target IDs, Ports, and Availability Zones. To learn more about AWS Network Load Balancers, see Create a Network Load Balancer. To create a network load balancer listener, see Target Group | Create (For NLB). To create a network load balancer target group, see Create NLB target group. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2qldv4h9osmau. Advanced Stack Components Version April 22, 2025 279 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters Example not available. Example: All Parameters { "Description": "This is a test description", "Name": "Test Stack", "Parameters": { "CrossZoneEnabled": "false", "DeregistrationDelayTimeoutSeconds": "300", "HealthCheckHealthyThreshold": "3", "HealthCheckIntervalSeconds": "30", "HealthCheckTargetPath": "/", "HealthCheckTargetPort": "80", "HealthCheckTargetProtocol": "TCP", "InstancePort": "80", "LoadBalancerName": "my-load-balancer", "LoadBalancerPort": "80", "ProxyProtocolV2": "false", "Public": "false", "SubnetIds": ["subnet-01234567890abcdef", "subnet-01234567891abcdef"], "Target1AvailabilityZone": "us-east-1a", "Target1ID": "i-01234567890abcdef", "Target1Port": "80", "Target2AvailabilityZone": "us-east-1a", "Target2ID": "i-11234567890abcdef", "Target2Port": "80", "Target3AvailabilityZone": "us-east-1a", "Target3ID": "i-21234567890abcdef", "Target3Port": "80", "Target4AvailabilityZone": "us-east-1a", "Target4ID": "i-31234567890abcdef", "Target4Port": "80", "TargetType": "instance" }, "StackTemplateId": "stm-l70qr9itukvqssg8d", "TimeoutInMinutes": 60, "VpcId": "vpc-01234567890abcdef" } Advanced Stack Components Version April 22, 2025 280 AMS Advanced Change Type Reference AMS Advanced Change Type Details OpenSearch | Create Domain Create an Amazon OpenSearch Service domain. An OpenSearch domain encapsulates OpenSearch engine instances that process OpenSearch requests. Amazon OpenSearch Service supports OpenSearch and legacy Elasticsearch OSS (up to 7.10, the final open source version of the software). Full classification: Deployment | Advanced stack components | OpenSearch | Create domain Change Type Details Change type ID ct-281et7bs9ep4s Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create OpenSearch Service Domain Creating an OpenSearch domain with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 281 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types |
ams-ct-080 | ams-ct.pdf | 80 | Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create OpenSearch Service Domain Creating an OpenSearch domain with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 281 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. Advanced Stack Components Version April 22, 2025 282 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an OpenSearch domain with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 283 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc \ --change-type-id "ct-281et7bs9ep4s" \ --change-type-version "2.0" --title "Create OpenSearch domain" \ --execution-parameters "{\"Description\":\"Create OS domain\",\"VpcId\": \"vpc-317a9856\",\"Name\": \"OpenSearchDomain\",\"StackTemplateId\": \"stm- szccoe01000000000\",\"TimeoutInMinutes\": 60,\"Parameters\":{\"DomainName\": \"opensearchdomain\",\"EngineVersion\":\"OpenSearch_7.10\",\"DedicatedMasterCount \": \"3\",\"DedicatedMasterType\": \"r5.xlarge.search\",\"InstanceType\": \"r5.xlarge.search\",\"InstanceCount\": 2\"EBSIops\": \"0\",\"EBSVolumeSize \": 100\"EBSVolumeType\": \"gp2\",\"SubnetIds\":[\"subnet-d3cf52f9\"]}}" \ TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateOpenSearchDomainParams.json: aws amscm get-change-type-version --change-type-id "ct-281et7bs9ep4s" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateOpenSearchDomainParams.json 2. Modify and save the CreateOpenSearchDomainParams file. See examples below; make sure to modify these parameters to meet your specific needs. { "Description": "OpenSearch Service Domain", "VpcId": "vpc-317a9856", "Name": "open_search", "StackTemplateId": "stm-szccoe02000000000", "TimeoutInMinutes": 60, "Parameters": { "DomainName": "my-opensearch-domain", "EngineVersion": "OpenSearch_2.3", "DedicatedMasterCount": "3", "DedicatedMasterType": "r6g.large.search", "InstanceType": "r6g.large.search", "InstanceCount": "2", "EBSVolumeSize": "35", "EBSVolumeType": "gp3", Advanced Stack Components Version April 22, 2025 284 AMS Advanced Change Type Reference AMS Advanced Change Type Details "SubnetIds": [ "subnet-0123456789abcdefg" ] } } 3. Output the RFC template to a file in your current folder; this example names it CreateOpenSearchDomainRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateOpenSearchDomainRfc.json 4. Modify and save the CreateOpenSearchDomainRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": |
ams-ct-081 | ams-ct.pdf | 81 | specific needs. { "Description": "OpenSearch Service Domain", "VpcId": "vpc-317a9856", "Name": "open_search", "StackTemplateId": "stm-szccoe02000000000", "TimeoutInMinutes": 60, "Parameters": { "DomainName": "my-opensearch-domain", "EngineVersion": "OpenSearch_2.3", "DedicatedMasterCount": "3", "DedicatedMasterType": "r6g.large.search", "InstanceType": "r6g.large.search", "InstanceCount": "2", "EBSVolumeSize": "35", "EBSVolumeType": "gp3", Advanced Stack Components Version April 22, 2025 284 AMS Advanced Change Type Reference AMS Advanced Change Type Details "SubnetIds": [ "subnet-0123456789abcdefg" ] } } 3. Output the RFC template to a file in your current folder; this example names it CreateOpenSearchDomainRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateOpenSearchDomainRfc.json 4. Modify and save the CreateOpenSearchDomainRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-281et7bs9ep4s", "ChangeTypeVersion": "1.0", "Title": "Create OpenSearch domain" } 5. Create the RFC, specifying the CreateOpenSearchDomainRfc file and the CreateOpenSearchDomainParams file: aws amscm create-rfc --cli-input-json file://CreateOpenSearchDomainRfc.json -- execution-parameters file://CreateOpenSearchDomainParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips This change type replaces the former change type, ct-0azen3a9anxzj. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-281et7bs9ep4s. Example: Required Parameters { Advanced Stack Components Version April 22, 2025 285 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description": "Test description", "VpcId": "vpc-12345678", "Name": "teststak", "StackTemplateId": "stm-szccoe02000000000", "TimeoutInMinutes": 60, "Parameters": { "DomainName": "testdomain", "EngineVersion": "Elasticsearch_7.10", "DedicatedMasterCount": "0", "DedicatedMasterType": "r6g.large.search", "InstanceType": "r6g.large.search", "InstanceCount": 1, "EBSIops": "1000", "EBSThroughput": "125", "EBSVolumeSize": 100, "EBSVolumeType": "gp2", "SubnetIds": [ "subnet-12345678", "subnet-13456789" ] } } Example: All Parameters { "Description": "Test description", "VpcId": "vpc-12345678", "Name": "teststak", "StackTemplateId": "stm-szccoe02000000000", "TimeoutInMinutes": 60, "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "Parameters": { "DomainName": "testdomain", Advanced Stack Components Version April 22, 2025 286 AMS Advanced Change Type Reference AMS Advanced Change Type Details "EngineVersion": "Elasticsearch_7.10", "DedicatedMasterCount": "0", "DedicatedMasterType": "r6g.large.search", "InstanceType": "r6g.large.search", "InstanceCount": 1, "ZoneAwarenessEnabled": "false", "EBSIops": "1000", "EBSThroughput": "125", "EBSVolumeSize": 100, "EBSVolumeType": "gp2", "EncryptionKey": "default", "AutomatedSnapshotStartHour": "", "AllowExplicitIndex": "true", "IndicesFieldDataCacheSize": "20", "MaxClauseCount": "512", "SubnetIds": [ "subnet-12345678" ] } } RDS Database Stack | Create Create an Amazon Relational Database Service (RDS) DB instance. To provision an Aurora single instance or multi-AZ instances, use CT ct-2jvzjwunghrhy. Full classification: Deployment | Advanced stack components | RDS database stack | Create Change Type Details Change type ID ct-2z60dyvto9g6c Current version 3.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 287 AMS Advanced Change Type Reference Additional Information Create DB stack Creating an RDS Stack with the Console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Advanced Stack Components Version April 22, 2025 288 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an RDS Stack with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command |
ams-ct-082 | ams-ct.pdf | 82 | the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an RDS Stack with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: create-rfc --change-type-id "ct-2z60dyvto9g6c" --change-type-version "3.0" -- title "RDS-Create-QC-RFC" --execution-parameters "{\"Description\":\"My RDS DB\", Advanced Stack Components Version April 22, 2025 289 AMS Advanced Change Type Reference AMS Advanced Change Type Details \"VpcId\":\"VPC_ID\", \"StackTemplateId\":\"stm-sl81ze00000000000\", \"Name\": \"RDS-Create-QC\", \"TimeoutInMinutes\":60, \"Parameters\":{\"RDSAllocatedStorage \":100, \"RDSDBEngine\":\"MySQL\", \"RDSDBName\":\"MyDB\", \"RDSEngineVersion\": \"8.0.20\", \"RDSLicenseModel\":\"bring-your-own-license\", \"RDSMasterUsername\": \"myUser\", \"RDSMasterUserPassword\":\"myPassWord\", \"RDSSubnetIds\":[\"SUBNET_ID\", \"SUBNET_ID\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CreateRdsParams.json. aws amscm get-change-type-version --change-type-id "ct-2z60dyvto9g6c" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: Oracle example: { "Description": "Create-RDS-DB", "VpcId": "VPC_ID", "StackTemplateId": "stm-sl81ze00000000000", "Name": "My-RDS-DB", "TimeoutInMinutes": 60, "Parameters": { "RDSAllocatedStorage": 50, "RDSDBEngine": "oracle-se1", "RDSDBName": "MyRds", "RDSEngineVersion": "11.2.0.4.v13", "RDSInstanceType": "db.m1.small", "RDSLicenseModel": "license-included", "RDSMasterUsername": "dbadmin", "RDSMasterUserPassword": "p4ssw0rd", "RDSSubnetIds": ["PRIVATE_AZ1_SUBNET", "PRIVATE_AZ2_SUBNET"] } } MySQL example: { Advanced Stack Components Version April 22, 2025 290 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description": "Create-RDS-DB", "VpcId": "VPC_ID", "StackTemplateId": "stm-sl81ze00000000000", "Name": "My-RDS-DB", "TimeoutInMinutes": 60, "Parameters": { "RDSAllocatedStorage": 50, "RDSDBEngine": "MySQL", "RDSDBName": "MyRds", "RDSEngineVersion": "8.0.20", "RDSInstanceType": "db.m1.small", "RDSLicenseModel": "general-public-license", "RDSMasterUsername": "dbadmin", "RDSMasterUserPassword": "p4ssw0rd", "RDSSubnetIds": ["PRIVATE_AZ1_SUBNET", "PRIVATE_AZ2_SUBNET"] } } 3. Output the JSON template to a file in your current folder; this example names it CreateRdsRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdsRfc.json 4. Modify and save the CreateRdsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-2z60dyvto9g6c", "Title": "RDS-Create-RFC" } 5. Create the RFC, specifying the execution parameters file and the CreateRdsRfc file: aws amscm create-rfc --cli-input-json file://CreateRdsRfc.json --execution- parameters file://CreateRdsParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the RDS, look in the execution output: Use the "stack_id" to view the RDS in the Cloud Formation Console. To create a Delete Stack or Update RDS RFC, use the first part Advanced Stack Components Version April 22, 2025 291 AMS Advanced Change Type Reference AMS Advanced Change Type Details of the DatabaseEndpoint (the DB instance ID) to create a Reboot RDS RFC, use the entire DatabaseEndpoint to programmatically access the RDS DB. 7. You are now able to manage the database via a database management tool such as SQL server management studio. You do not have to request access from AMS. Tips Note The RDSDBEngine parameter has a new value available: mariadb. Note You can add up to 50 tags, but to do so you must enable the Additional configuration view. To learn more about Amazon RDS, including size recommendations, see Amazon Relational Database Service Documentation. To create an Aurora RDS stack, see Create DB stack (for Aurora). To create an RDS stack from a snapshot, see Create DB from snapshot. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2z60dyvto9g6c. Example: Required Parameters { "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "StackTemplateId": "stm-sl81ze20000000000", "Name": "Test Stack", "TimeoutInMinutes": 60, "Parameters": { "RDSAllocatedStorage": 50, Advanced Stack Components Version April 22, 2025 292 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RDSDBEngine": "mysql", "RDSDBName": "my_db", "RDSEngineVersion": "5.6.27", "RDSInstanceType": "db.m3.medium", "RDSMasterUsername": "myadminuser", "RDSMasterUserPassword": "MySecurePassword", "RDSSubnetIds": ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"] } } Example: All Parameters { "Description": "This is a test description", "VpcId": "vpc-12345678", "StackTemplateId": "stm-sl81ze20000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "RDSAllocatedStorage": 100, "RDSBackupRetentionPeriod": 7, "RDSAutoMinorVersionUpgrade": |
ams-ct-083 | ams-ct.pdf | 83 | ct-2z60dyvto9g6c. Example: Required Parameters { "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "StackTemplateId": "stm-sl81ze20000000000", "Name": "Test Stack", "TimeoutInMinutes": 60, "Parameters": { "RDSAllocatedStorage": 50, Advanced Stack Components Version April 22, 2025 292 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RDSDBEngine": "mysql", "RDSDBName": "my_db", "RDSEngineVersion": "5.6.27", "RDSInstanceType": "db.m3.medium", "RDSMasterUsername": "myadminuser", "RDSMasterUserPassword": "MySecurePassword", "RDSSubnetIds": ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"] } } Example: All Parameters { "Description": "This is a test description", "VpcId": "vpc-12345678", "StackTemplateId": "stm-sl81ze20000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "RDSAllocatedStorage": 100, "RDSBackupRetentionPeriod": 7, "RDSAutoMinorVersionUpgrade": true, "RDSCharacterSetName": "", "RDSDBEngine": "sqlserver-ex", "RDSDBName": "my_db", "RDSDBParameterGroupName": "default.sqlserver-ex-13.0", "RDSDeletionProtection": true, "RDSEngineVersion": "13.00.4522.0.v1", "RDSInstanceType": "db.t2.micro", "RDSIOPS": 0, "RDSLicenseModel": "license-included", "RDSMasterUsername": "myadminuser", "RDSMasterUserPassword": "MySecurePassword", Advanced Stack Components Version April 22, 2025 293 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RDSMultiAZ": false, "RDSOptionGroupName": "default:sqlserver-ex-13-00", "RDSPerformanceInsights" : "true", "RDSPerformanceInsightsKMSKey":"arn:aws:kms:us-east-1:123456789012:key/2590cd3a- f979-49db-adec-d213775385af", "RDSPerformanceInsightsRetentionPeriod":"7", "RDSPort": 1433, "RDSPreferredBackupWindow": "22:00-23:00", "RDSPreferredMaintenanceWindow": "wed:03:32-wed:04:02", "RDSStorageEncrypted": true, "RDSStorageEncryptionKey": "arn:aws:kms:us-east-1:123456789012:key/2590cd3a- f979-49db-adec-d213775385af", "RDSStorageType": "gp2", "RDSSubnetIds": ["subnet-12345678", "subnet-23456789"], "RDSTimezone": "Eastern Standard Time" } } RDS Database Stack | Create (For Aurora) Create an AWS Relational Database Service (RDS) Aurora stack using either multi-availability zone (MultiAZ) or a single instance. Full classification: Deployment | Advanced stack components | RDS database stack | Create (for Aurora) Change Type Details Change type ID ct-2jvzjwunghrhy Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 294 AMS Advanced Change Type Reference Additional Information Create DB stack (for Aurora) Creating an Aurora RDS Stack with the Console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Advanced Stack Components Version April 22, 2025 295 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an Aurora RDS Stack with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Advanced Stack Components Version April 22, 2025 296 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change |
ams-ct-084 | ams-ct.pdf | 84 | --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Advanced Stack Components Version April 22, 2025 296 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-2jvzjwunghrhy" --change-type-version "1.0" --title "Test Create (for Aurora)" -- execution-parameters "{\"Description\":\"Aurora_RDS_TEST\",\"VpcId\":\"VPC_ID\",\"Name \":\"Aurora-TEST\",\"StackTemplateId\":\"stm-j24cifrdi0untnsn6\",\"TimeoutInMinutes \":60,\"Parameters\":{\"AutoMinorVersionUpgrade\":\"true\",\"BackupRetentionPeriod\":7, \"ClusterName\":\"\",\"DBEngine\":\"aurora\",\"DBName\":\"DB_NAME\",\"DBSubnetGroupName \":\"DB_SUBNET_GROUP_NAME\",\"EngineVersion\":\"\",\"InstanceType\":\"db.r4.large\", \"MasterUsername\":\"DB_USER\",\"MasterUserPassword\":\"DB_PW\",\"MultiAZ\": \"true\",\"PerformanceInsights\":\"true\",\"PerformanceInsightsKMSKey\":\"\", \"PerformanceInsightsRetentionPeriod\":\"7\",\"Port\":\"0\",\"PreferredBackupWindow \":\"22:00-23:00\",\"PreferredMaintenanceWindow\":\"wed:03:32-wed:04:02\", \"StorageEncryptionKey\":\"\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CreateRdsArParams.json. aws amscm get-change-type-version --change-type-id "ct-2jvzjwunghrhy" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsArParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: Oracle example: { "Description": "Aurora_RDS_TEST", "VpcId": "VPC_ID", "Name": "Aurora-TEST", "StackTemplateId": "stm-j24cifrdi0untnsn6", Advanced Stack Components Version April 22, 2025 297 AMS Advanced Change Type Reference AMS Advanced Change Type Details "TimeoutInMinutes": 60, "Parameters": { "AutoMinorVersionUpgrade": "true", "BackupRetentionPeriod": 7, "ClusterName": "", "DBEngine": "aurora", "DBName": "DB_NAME", "DBSubnetGroupName": "DB_SUBNET_GROUP_NAME", "EngineVersion": "", "InstanceType": "db.r4.large", "MasterUsername": "DB_USER", "MasterUserPassword": "DB_PW", "MultiAZ": "true", "PerformanceInsights": "true", "PerformanceInsightsKMSKey": "", "PerformanceInsightsRetentionPeriod": "7", "Port": "0", "PreferredBackupWindow": "22:00-23:00", "PreferredMaintenanceWindow": "wed:03:32-wed:04:02", "StorageEncryptionKey": "" } } 3. Output the JSON template to a file in your current folder; this example names it CreateRdsArRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdsArRfc.json 4. Modify and save the CreateRdsArRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2jvzjwunghrhy", "Title": "RDS-Create-Aurora-RFC" } 5. Create the RFC, specifying the execution parameters file and the CreateRdsArRfc file: aws amscm create-rfc --cli-input-json file://CreateRdsArRfc.json --execution- parameters file://CreateRdsArParams.json Advanced Stack Components Version April 22, 2025 298 AMS Advanced Change Type Reference AMS Advanced Change Type Details You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the RDS, look in the execution output: Use the "stack_id" to view the RDS in the Cloud Formation Console. To create a Delete Stack or Update RDS RFC, use the first part of the DatabaseEndpoint (the DB instance ID) to create a Reboot RDS RFC, use the entire DatabaseEndpoint to programmatically access the RDS DB. 7. You are now able to manage the database via a database management tool such as SQL server management studio. You do not have to request access from AMS. Tips Note You can add up to 50 tags, but to do so you must enable the Additional configuration view. For more information, see Amazon Aurora – Relational Database Built for the Cloud - AWS. To learn more about Amazon RDS, including size recommendations, see Amazon Relational Database Service Documentation. To create an Aurora RDS stack from a backup, see Create DB stack from backup (for Aurora). To create a non-Aurora RDS stack, see Update DB stack. To create an non-Aurora RDS stack from a snapshot, see Create DB from snapshot. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2jvzjwunghrhy. Example: Required Parameters { "Description": "Create an RDS stack for an Aurora database (DB) with multiple availability zones (MultiAZ) or as a single instance DB. Also creates an Aurora DB cluster consisting of a DB instance, compatible with either MySQL or PostgreSQL, and Advanced Stack Components Version April 22, 2025 299 AMS Advanced Change Type Reference AMS Advanced Change Type Details a cluster volume that represents the data for the DB cluster, copied across three Availability Zones as a single, virtual volume. The DB cluster contains a primary instance and, optionally, up to 15 Aurora Replicas.", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-j24cifrdi0untnsn6", "Name": "Stack Name", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "DBEngine": "aurora", "EngineVersion": "", "DBName": "dbname", "DBSubnetGroupName": "db-subnet-group", "MasterUsername": "dbusername", "MasterUserPassword": "dbpassword" } } Example: All Parameters { "Description": "Create an RDS stack for an Aurora database (DB) with multiple availability zones (MultiAZ) or as a single instance DB. Also creates an Aurora DB cluster consisting of a DB instance, compatible with either MySQL or PostgreSQL, and a cluster volume that represents the data for the DB cluster, copied across three |
ams-ct-085 | ams-ct.pdf | 85 | 15 Aurora Replicas.", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-j24cifrdi0untnsn6", "Name": "Stack Name", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "DBEngine": "aurora", "EngineVersion": "", "DBName": "dbname", "DBSubnetGroupName": "db-subnet-group", "MasterUsername": "dbusername", "MasterUserPassword": "dbpassword" } } Example: All Parameters { "Description": "Create an RDS stack for an Aurora database (DB) with multiple availability zones (MultiAZ) or as a single instance DB. Also creates an Aurora DB cluster consisting of a DB instance, compatible with either MySQL or PostgreSQL, and a cluster volume that represents the data for the DB cluster, copied across three Availability Zones as a single, virtual volume. The DB cluster contains a primary instance and, optionally, up to 15 Aurora Replicas.", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-j24cifrdi0untnsn6", "Name": "Stack Name", "Tags": [ { "Key": "foo", "Value": "bar" Advanced Stack Components Version April 22, 2025 300 AMS Advanced Change Type Reference AMS Advanced Change Type Details }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "AutoMinorVersionUpgrade": "true", "BackupRetentionPeriod": 7, "ClusterName": "dbcluster", "DBEngine": "aurora-postgresql", "EngineVersion": "10.4", "DBName": "dbname", "DBSubnetGroupName": "db-subnet-group", "InstanceType": "db.r4.large", "MasterUsername": "dbusername", "MasterUserPassword": "dbpassword", "MultiAZ": "true", "PerformanceInsights": "true", "PerformanceInsightsKMSKey": "default", "PerformanceInsightsRetentionPeriod": "7", "Port": "1150", "PreferredBackupWindow": "22:00-23:00", "PreferredMaintenanceWindow": "wed:03:32-wed:04:02", "StorageEncryptionKey": "default" } } RDS Database Stack | Create DB Subnet Group Create a Relational Database Service (RDS) database (DB) subnet group to be used with a specified RDS DB. Full classification: Deployment | Advanced stack components | RDS database stack | Create DB subnet group Change Type Details Change type ID ct-17w6f6kzf6w51 Advanced Stack Components Version April 22, 2025 301 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create DB subnet groups Creating an RDS DB Subnet Group with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. Advanced Stack Components Version April 22, 2025 302 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an RDS DB Subnet Group with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: Advanced Stack Components Version April 22, 2025 303 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status |
ams-ct-086 | ams-ct.pdf | 86 | command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: Advanced Stack Components Version April 22, 2025 303 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: create-rfc --change-type-id "ct-17w6f6kzf6w51" --change-type-version "1.0" --title "RDS-subnet-group" --execution-parameters "{\"Description\":\"RDS DB subnet group\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\":\"stm-iutsfv5ci7suupr86\", \"Name\":\"RDS subnet group\", \"TimeoutInMinutes\":60, \"Parameters\": {\"DBSubnetGroupName\": \"mydbsubnetgroup\", \"DBSubnetGroupDescription\": \"DbSubnetGroupDescription\", \"SubnetIds\": [\"SUBNET_ID_1\",\"SUBNET_ID_2\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CreateRdsParams.json. aws amscm get-change-type-version --change-type-id "ct-2z60dyvto9g6c" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "Description": "RDS DB subnet group", "VpcId": "VPC_ID", Advanced Stack Components Version April 22, 2025 304 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Name": "RDS DB subnet group", "StackTemplateId": "stm-iutsfv5ci7suupr86", "TimeoutInMinutes": 60, "Parameters": { "DBSubnetGroupName": "mydbsubnetgroup", "DBSubnetGroupDescription": "Example RDS db subnet group description", "SubnetIds": [ "SUBNET_ID_1", "SUBNET_ID_2" ] } } 3. Output the JSON template to a file in your current folder; this example names it CreateRdsRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdsRfc.json 4. Modify and save the CreateRdsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-17w6f6kzf6w51", "Title": "RDS-Create-RFC" } 5. Create the RFC, specifying the execution parameters file and the CreateRdsRfc file: aws amscm create-rfc --cli-input-json file://CreateRdsRfc.json --execution- parameters file://CreateRdsParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note You can add up to 50 tags, but to do so you must enable the Advanced view. Advanced Stack Components Version April 22, 2025 305 AMS Advanced Change Type Reference AMS Advanced Change Type Details To learn more about Amazon RDS DB subnet groups, see Working with an Amazon RDS DB Instance in a VPC. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-17w6f6kzf6w51. Example: Required Parameters { "Description": "Create RDS db subnet group", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-iutsfv5ci7suupr86", "Name": "Stack Name", "TimeoutInMinutes": 60, "Parameters": { "DBSubnetGroupName": "dbsubnetgroupname", "SubnetIds": ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"] } } Example: All Parameters { "Description": "Create RDS db subnet group", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-iutsfv5ci7suupr86", "Name": "Stack Name", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "DBSubnetGroupName": "dbsubnetgroupname", Advanced Stack Components Version April 22, 2025 306 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DBSubnetGroupDescription": "Test description", "SubnetIds": ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"] } } RDS Database Stack | Create from Backup Create an Amazon Relational Database Service (RDS) from a backup. When you restore a backup this way, the service-specific restore parameters are presented automatically. Full classification: Deployment | Advanced stack components | RDS database stack | Create from backup Change Type Details Change type ID ct-0pgvtw5rpcsb6 Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create DB stack from backup Creating an RDS stack from backup with the Console Screenshot of this change type, in the AMS console: Advanced Stack Components Version April 22, 2025 307 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT |
ams-ct-087 | ams-ct.pdf | 87 | pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Advanced Stack Components Version April 22, 2025 308 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an RDS stack from backup with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc \ Advanced Stack Components Version April 22, 2025 309 AMS Advanced Change Type Reference AMS Advanced Change Type Details --change-type-id "ct-0pgvtw5rpcsb6" \ --change-type-version "1.0" --title "Create RDS From Backup" \ --execution-parameters "{\"Description\":\"Create RDS Instance Stack from Backup: awsbackup:job-00000000-0000-0000-0000-000000000.\",\"VpcId\": \"vpc-00000000\",\"StackTemplateId\":\"stm-siqajx00000000000\",\"Name\": \"restoredb\",\"TimeoutInMinutes\":360,\"Parameters\":{\"DBSnapshotIdentifier \":\"awsbackup:job-00000000-0000-0000-0000-000000000\",\"DBSubnetIds\": [\"subnet-79663144\", \"subnet-d0cf52fa\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateRdsFromBackupParams.json: aws amscm get-change-type-version --change-type-id "ct-0g690ekkyfm79" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsFromBackupParams.json 2. Modify and save the CreateRdsFromBackupParams file. { "Description": "Create RDS Instance Stack from Backup: awsbackup:job-00000000-0000-0000-0000-000000000.", "VpcId": "vpc-00000000", "StackTemplateId": "stm-siqajx00000000000", "Name": "Stack Name", "TimeoutInMinutes": 360, "Parameters": { "DBSnapshotIdentifier": "awsbackup:job-00000000-0000-0000-0000-000000000", "DBSubnetIds": ["subnet-79663144", "subnet-d0cf52fa"] } } 3. Output the RFC template to a file in your current folder; this example names it CreateRdsFromBackupRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdsFromBackupRfc.json 4. Modify and save the CreateRdsFromBackupRfc.json file. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 310 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-0pgvtw5rpcsb6", "ChangeTypeVersion": "1.0", "Title": "Create RDS Instance Stack from Backup" } 5. Create the RFC, specifying the CreateRdsFromBackupRfc file and the CreateRdsFromBackupParams file: aws amscm create-rfc --cli-input-json file://CreateRdsFromBackupRfc.json -- execution-parameters file://CreateRdsFromBackupParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon RDS, including size recommendations, see Amazon Relational Database Service Documentation. Execution Input Parameters For detailed information about the execution input parameters, see Schema for |
ams-ct-088 | ams-ct.pdf | 88 | Type Details "ChangeTypeId": "ct-0pgvtw5rpcsb6", "ChangeTypeVersion": "1.0", "Title": "Create RDS Instance Stack from Backup" } 5. Create the RFC, specifying the CreateRdsFromBackupRfc file and the CreateRdsFromBackupParams file: aws amscm create-rfc --cli-input-json file://CreateRdsFromBackupRfc.json -- execution-parameters file://CreateRdsFromBackupParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon RDS, including size recommendations, see Amazon Relational Database Service Documentation. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0pgvtw5rpcsb6. Example: Required Parameters { "Description": "Create RDS Instance Stack from snapshot: awsbackup:job-00000000-0000-0000-0000-000000000000.", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-siqajx00000000000", "Name": "Stack Name", "Parameters": { "DBSnapshotIdentifier": "awsbackup:job-00000000-0000-0000-0000-000000000000", "DBSubnetIds": ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"] } } Example: All Parameters { Advanced Stack Components Version April 22, 2025 311 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description": "Create RDS Instance Stack from snapshot: rds:sr341e8q8bofsd-2017-04-19-22-13.", "VpcId": "vpc-12345678", "StackTemplateId": "stm-siqajx00000000000", "Name": "Stack Name", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "DBInstanceClass": "db.m3.medium", "DBInstanceIdentifier": "my-rds-id", "DBSnapshotIdentifier": "customizedSnapshotId", "DBSubnetIds": ["subnet-a0b1c2d3", "subnet-a0b2c9d8"] } } RDS Database Stack | Create from Backup (For Aurora) Create an AWS Relational Database Service (RDS) Aurora stack from AWS Backup. Full classification: Deployment | Advanced stack components | RDS database stack | Create from backup (for Aurora) Change Type Details Change type ID ct-2wllq61djysxz Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Advanced Stack Components Version April 22, 2025 312 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution mode Automated Additional Information Create DB stack from backup (for Aurora) Creating an Aurora RDS Stack From Backup with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Advanced Stack Components Version April 22, 2025 313 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an Aurora RDS Stack From Backup with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Advanced Stack Components |
ams-ct-089 | ams-ct.pdf | 89 | files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Advanced Stack Components Version April 22, 2025 314 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change- type-id "ct-2wllq61djysxz" --change-type-version "1.0" --title "TestCreateAuroraStackFromBackup" --execution-parameters "{\"Description\": \"TestCreateAuroraStackFromBackup\",\"VpcId\":\"VPC_ID\",\"Name\":\"Test Aurora Stack From Backup\",\"Parameters\":{\"SnapshotIdentifier\":\"SNAPSHOT_IDENTIFIER\", \"AutoMinorVersionUpgrade\":\"true\",\"BackupRetentionPeriod\":7,\"ClusterName\": \"\",\"DBEngine\":\"aurora\",\"DBName\":\"\",\"EngineVersion\":\"\",\"InstanceType \":\"db.r4.large\",\"MultiAZ\":\"true\",\"Port\":\"0\",\"PreferredBackupWindow \":\"22:00-23:00\",\"PreferredMaintenanceWindow\":\"\",\"DBSubnetGroupName \":\"DB_SUBNET_GROUP_NAME\"},\"StackTemplateId\":\"stm-j24cifrdi0untnsn6\", \"TimeoutInMinutes\":60}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CreateRdsArFrmBkupParams.json. aws amscm get-change-type-version --change-type-id "ct-2wllq61djysxz" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsArFrmBkupParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "Description": "TestCreateAuroraStackFromBackup", "VpcId": "VPC_ID", "Name": "Test Aurora Stack From Backup", "Parameters": { "SnapshotIdentifier": "SNAPSHOT_IDENTIFIER", "AutoMinorVersionUpgrade": "true", Advanced Stack Components Version April 22, 2025 315 AMS Advanced Change Type Reference AMS Advanced Change Type Details "BackupRetentionPeriod": 7, "ClusterName": "", "DBEngine": "aurora", "DBName": "", "EngineVersion": "", "InstanceType": "db.r4.large", "MultiAZ": "true", "Port": "0", "PreferredBackupWindow": "22:00-23:00", "PreferredMaintenanceWindow": "", "DBSubnetGroupName": "DB_SUBNET_GROUP_NAME" }, "StackTemplateId": "stm-j24cifrdi0untnsn6", "TimeoutInMinutes": 60 } 3. Output the JSON template to a file in your current folder; this example names it CreateRdsArFrmBkupRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdsArFrmBkupRfc.json 4. Modify and save the CreateRdsArFrmBkupRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2wllq61djysxz", "Title": "RDS-Create-Aurora-From-Backup-RFC" } 5. Create the RFC, specifying the execution parameters file and the CreateRdsArFrmBkupRfc file: aws amscm create-rfc --cli-input-json file://CreateRdsArFrmBkupRfc.json -- execution-parameters file://CreateRdsArFrmBkupParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the RDS, look in the execution output: Use the "stack_id" to view the RDS in the Cloud Formation Console. To create a Delete Stack or Update RDS RFC, use the first part of the DatabaseEndpoint (the DB instance ID); to create a Reboot RDS RFC, use the entire DatabaseEndpoint -> ClusterEndpoint to programmatically access the RDS DB. Advanced Stack Components Version April 22, 2025 316 AMS Advanced Change Type Reference AMS Advanced Change Type Details 7. You are now able to manage the database via a database management tool such as SQL server management studio. You do not have to request access from AMS. Tips Note You can add up to 50 tags, but to do so you must enable the Additional configuration view. For more information, see Amazon Aurora – Relational Database Built for the Cloud - AWS. To learn more about Amazon RDS, including size recommendations, see Amazon Relational Database Service Documentation. To create an Aurora RDS stack (not using backup), see Create DB stack (for Aurora). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2wllq61djysxz. Example: Required Parameters { "Description": "Create an AWS Relational Database Service (RDS) Aurora stack from AWS Backup.", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-j24cifrdi0untnsn6", "Name": "Stack Name", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], Advanced Stack Components Version April 22, 2025 317 AMS Advanced Change Type Reference AMS Advanced Change Type Details "TimeoutInMinutes": 60, "Parameters": { "SnapshotIdentifier": "arn:aws:rds:xx-xxxx-x:000000000000:cluster- snapshot:awsbackup:job-00000000-0000-0000-0000-000000000000", "DBEngine": "aurora", "EngineVersion": "", "DBSubnetGroupName": "db-subnet-group" } } Example: All Parameters { "Description": "Create an AWS Relational Database Service (RDS) Aurora stack from AWS Backup.", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-j24cifrdi0untnsn6", "Name": "Stack Name", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "SnapshotIdentifier": "arn:aws:rds:xx-xxxx-x:000000000000:cluster- snapshot:awsbackup:job-00000000-0000-0000-0000-000000000000", "AutoMinorVersionUpgrade": "true", "BackupRetentionPeriod": 7, "ClusterName": "dbcluster", "DBEngine": "aurora-postgresql", "EngineVersion": "10.4", "DBName": "dbname", "DBSubnetGroupName": "db-subnet-group", "InstanceType": "db.r4.large", "MultiAZ": "true", "Port": "1150", "PreferredBackupWindow": "22:00-23:00", Advanced Stack Components Version April 22, 2025 318 AMS Advanced Change Type Reference AMS Advanced Change Type Details "PreferredMaintenanceWindow": "wed:03:32-wed:04:02" } } RDS Database Stack | Create from Snapshot Create an Amazon Relational Database Service (RDS) DB instance from an RDS snapshot. Full classification: Deployment | Advanced stack components | RDS database stack | Create from snapshot |
ams-ct-090 | ams-ct.pdf | 90 | [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "SnapshotIdentifier": "arn:aws:rds:xx-xxxx-x:000000000000:cluster- snapshot:awsbackup:job-00000000-0000-0000-0000-000000000000", "AutoMinorVersionUpgrade": "true", "BackupRetentionPeriod": 7, "ClusterName": "dbcluster", "DBEngine": "aurora-postgresql", "EngineVersion": "10.4", "DBName": "dbname", "DBSubnetGroupName": "db-subnet-group", "InstanceType": "db.r4.large", "MultiAZ": "true", "Port": "1150", "PreferredBackupWindow": "22:00-23:00", Advanced Stack Components Version April 22, 2025 318 AMS Advanced Change Type Reference AMS Advanced Change Type Details "PreferredMaintenanceWindow": "wed:03:32-wed:04:02" } } RDS Database Stack | Create from Snapshot Create an Amazon Relational Database Service (RDS) DB instance from an RDS snapshot. Full classification: Deployment | Advanced stack components | RDS database stack | Create from snapshot Change Type Details Change type ID ct-20san5sgtwd9e Current version 2.0 Expected execution duration 720 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create DB from snapshot Creating an RDS Stack From a Snapshot with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 319 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Advanced Stack Components Version April 22, 2025 320 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an RDS Stack From a Snapshot with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Backup is enabled on RDS instances with a default backup retention period of 7 days (RDSBackups and RDSBackupRetentionPeriod). RDS stacks do not require a grant access RFC to access them, and are instead accessed using the username and password you provided when you created the stack. Advanced Stack Components Version April 22, 2025 321 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can add up to 50 tags. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: create-rfc --change-type-id "ct-20san5sgtwd9e" --change-type-version "2.0" --title "RDS-Create-FrmSS-QC-RFC" --execution-parameters "{\"Description\":\"My RDS DB From SS\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\":\"stm-siqajx00000000000\", |
ams-ct-091 | ams-ct.pdf | 91 | access RFC to access them, and are instead accessed using the username and password you provided when you created the stack. Advanced Stack Components Version April 22, 2025 321 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can add up to 50 tags. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: create-rfc --change-type-id "ct-20san5sgtwd9e" --change-type-version "2.0" --title "RDS-Create-FrmSS-QC-RFC" --execution-parameters "{\"Description\":\"My RDS DB From SS\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\":\"stm-siqajx00000000000\", \"Name\":\"RDS-Create-FrmSS-QC\", \"TimeoutInMinutes\":60, \"Parameters\": { \"DBSnapshotIdentifier\":\"DB_ID\", \"DBSubnetIds\":[\"SUBNET_ID\",\"SUBNET_ID\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type (ct-20san5sgtwd9e) to a JSON file named CreateRdsFSParams.json. aws amscm get-change-type-version --change-type-id "ct-20san5sgtwd9e" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsFSParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: Oracle example: { "Description": "Create-RDS-DB", "VpcId": "VPC_ID", "StackTemplateId": "stm-siqajx00000000000", "Name": "My-RDS-DB", "TimeoutInMinutes": 60, "Parameters": { "DBSnapshotIdentifier": rds:memzlbcde0abcd-2018-05-21-11-58, "DBInstanceIdentifer": "MyRds", "DBSubnetIds": ["PRIVATE_AZ1_SUBNET", "PRIVATE_AZ2_SUBNET"] } Advanced Stack Components Version April 22, 2025 322 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 3. Output the JSON template to a file in your current folder; this example names it CreateRdsRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdsRfc.json 4. Modify and save the CreateRdsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-20san5sgtwd9e", "Title": "RDS-Create-RFC" } 5. Create the RFC, specifying the execution parameters file and the CreateRdsRfc file: aws amscm create-rfc --cli-input-json file://CreateRdsRfc.json --execution- parameters file://CreateRdsParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the RDS, look in the execution output: Use the "stack_id" to view the RDS in the Cloud Formation Console. To create a Delete Stack or Update RDS RFC, use the first part of the DatabaseEndpoint (the DB instance ID) to create a Reboot RDS RFC, use the entire DatabaseEndpoint to programmatically access the RDS DB. 7. You are now able to manage the database via a database management tool such as SQL server management studio. You do not have to request access from AMS. Tips Note You can't restore a DB instance from a DB snapshot that is both shared and encrypted. Instead, you can make a copy of the DB snapshot and restore the DB instance from the copy. To copy the shared snapshot, use the RDS Snapshot | Copy CT. Advanced Stack Components Version April 22, 2025 323 AMS Advanced Change Type Reference AMS Advanced Change Type Details This CT is now at version 2, with new parameters, DBDomain, DBDomainIAMRoleName, and DBEngine. Additionally, The v1 of the CT would initiate the stack launch and return the stackId immediately, but not wait for the stack to finish launching. The v2 of the CT waits for the stack to finish launching before marking the RFC as successful or failed. You can add up to 50 tags, but to do so you must enable the Additional configuration view. To learn more about Amazon RDS, see Amazon Relational Database Service Documentation. To create a non-Aurora RDS stack, see RDS database stack | Create. To create an Aurora RDS stack, see RDS database stack | Create (For Aurora). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-20san5sgtwd9e. Example: Required Parameters { "Description": "Create RDS Instance Stack from snapshot: rds:sr341e8q8bofsd-2017-04-19-22-13.", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-siqajx20000000000", "Name": "Stack Name", "TimeoutInMinutes": 360, "Parameters": { "DBSnapshotIdentifier": "rds:lr1jnp6dfxk6mha-2017-04-13-22-14", "DBSubnetIds": ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"] } } Example: All Parameters { "Description": "Create RDS Instance Stack from snapshot: rds:sr341e8q8bofsd-2017-04-19-22-13.", "VpcId": "vpc-12345678", "StackTemplateId": "stm-siqajx20000000000", "Name": "Stack Name", "Tags": [ { Advanced Stack Components Version April 22, 2025 324 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 360, "Parameters": { "DBInstanceClass": "db.m3.medium", "DBInstanceIdentifier": "my-rds-id", "DBSnapshotIdentifier": "customizedSnapshotId", "DBSubnetIds": ["subnet-a0b1c2d3", "subnet-a0b2c9d8"], "DBDomain": "d-1234567890", "DBDomainIAMRoleName": "customer_amazon_rds_directory_service_access_role", "DBEngine": "sqlserver-se" } } RDS Database Stack | Create Option Group (Review Required) An option group specifies features (options), and their settings, that you then associate with an Amazon RDS DB instance. When you associate a DB instance with an option group, the specified options and option settings are enabled for that DB instance. Full classification: Deployment | Advanced stack components | RDS database stack | Create option group (review required) Change Type Details Change type ID ct-10yi1sd9nst1c Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Advanced Stack Components Version April 22, 2025 325 AMS Advanced Change Type Reference Additional Information |
ams-ct-092 | ams-ct.pdf | 92 | An option group specifies features (options), and their settings, that you then associate with an Amazon RDS DB instance. When you associate a DB instance with an option group, the specified options and option settings are enabled for that DB instance. Full classification: Deployment | Advanced stack components | RDS database stack | Create option group (review required) Change Type Details Change type ID ct-10yi1sd9nst1c Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Advanced Stack Components Version April 22, 2025 325 AMS Advanced Change Type Reference Additional Information AMS Advanced Change Type Details Create Amazon RDS option group (review required) Creating an Amazon RDS Option Group with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 326 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an Amazon RDS Option Group with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 327 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-10yi1sd9nst1c" --change-type-version "1.0" --title "Create option group (review required)" --execution-parameters "{\"OptionGroupName\": \"CreatingTheOptionGroup\", \"Description\": \"RDS option group\", \"EngineName\": \"sqlserver-ee\", \"MajorEngineVersion\": \"10.01\", \"DBInstanceName\": \"database-1\", \"Priority\": \"Medium\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CreateRdsOptionGroupParams.json. aws amscm get-change-type-version --change-type-id "ct-10yi1sd9nst1c" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsOptionGroupParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "OptionGroupName": "OptionGroup", "EngineName": "sqlserver-ee", "MajorEngineVersion": "10.01" } 3. Output the JSON template to a file in your current folder; this example names it CreateRdsOptionGroupRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdsOptionGroupRfc.json 4. |
ams-ct-093 | ams-ct.pdf | 93 | "Create option group (review required)" --execution-parameters "{\"OptionGroupName\": \"CreatingTheOptionGroup\", \"Description\": \"RDS option group\", \"EngineName\": \"sqlserver-ee\", \"MajorEngineVersion\": \"10.01\", \"DBInstanceName\": \"database-1\", \"Priority\": \"Medium\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CreateRdsOptionGroupParams.json. aws amscm get-change-type-version --change-type-id "ct-10yi1sd9nst1c" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsOptionGroupParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "OptionGroupName": "OptionGroup", "EngineName": "sqlserver-ee", "MajorEngineVersion": "10.01" } 3. Output the JSON template to a file in your current folder; this example names it CreateRdsOptionGroupRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdsOptionGroupRfc.json 4. Modify and save the CreateRdsOptionGroupRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-10yi1sd9nst1c", Advanced Stack Components Version April 22, 2025 328 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "RDS-Create-RFC" } 5. Create the RFC, specifying the execution parameters file and the CreateRdsOptionGroupRfc file: aws amscm create-rfc --cli-input-json file://CreateRdsOptionGroupRfc.json -- execution-parameters file://CreateRdsOptionGroupParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • To learn more about Amazon RDS DB option groups, see Working with option groups. • You can add up to 50 tags, but to do so you must enable the Advanced view. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-10yi1sd9nst1c. Example: Required Parameters { "OptionGroupName": "OptionGroup", "EngineName": "sqlserver-ee", "MajorEngineVersion": "10.01" } Example: All Parameters { "OptionGroupName": "OptionGroup", "EngineName": "sqlserver-ee", "MajorEngineVersion": "10.01", "Description": "A meaningful description of the option group", "DBInstanceName": "my-test-db", "Priority": "Low" Advanced Stack Components Version April 22, 2025 329 AMS Advanced Change Type Reference AMS Advanced Change Type Details } RDS Database Stack | Create Parameter Group (Review Required) Create a custom RDS parameter group and optionally attach it to an existing RDS instance. Full classification: Deployment | Advanced stack components | RDS database stack | Create parameter group (review required) Change Type Details Change type ID ct-3da2lxapopb86 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Create Custom RDS Parameter Group Requesting administrator access with the console The following shows this change type in the AMS console. How it works: Advanced Stack Components Version April 22, 2025 330 AMS Advanced Change Type Reference AMS Advanced Change Type Details 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Requesting administrator access with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID |
ams-ct-094 | ams-ct.pdf | 94 | submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Requesting administrator access with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Advanced Stack Components Version April 22, 2025 331 AMS Advanced Change Type Reference AMS Advanced Change Type Details Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-3da2lxapopb86" --change-type-version "1.0" -- title "Create Custom RDS Parameter Group" --execution-parameters "{\"ParameterGroupName \": \"my-db-parameter-group\", \"ParameterGroupFamily\": \"mysql5.6\", \"Description \": \"A meaningful description of the parameter group\", \"Priority\": \"Medium\", \"Parameters\": [{\"ParameterName\": \"max_connections\", \"ParameterValue\": \"100\"}], \"RDSInstanceName\": \"my-test-db\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it RDSCreateParameterGroupParams.json: aws amscm get-change-type-version --change-type-id "ct-3da2lxapopb86" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > RDSCreateParameterGroupParams.json Advanced Stack Components Version April 22, 2025 332 AMS Advanced Change Type Reference AMS Advanced Change Type Details Modify and save the RDSCreateParameterGroupParams file. For example, you can replace the contents with something like this: { "ParameterGroupName": "my-db-parameter-group", "ParameterGroupFamily": "mysql5.6", "Description": "A meaningful description of the parameter group", "Priority": "Medium", "Parameters": [ { "ParameterName": "max_connections", "ParameterValue": "100" } ], "RDSInstanceName": "my-test-db" } 2. Output the RFC template to a file in your current folder; this example names it RDSCreateParameterGroupRfc.json: aws amscm create-rfc --generate-cli-skeleton > RDSCreateParameterGroupRfc.json 3. Modify and save the RDSCreateParameterGroupRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-3da2lxapopb86", "ChangeTypeVersion": "1.0", "Title": "Create Custom RDS Parameter Group" } 4. Create the RFC, specifying the RDSCreateParameterGroupRfc file and the GRDSCreateParameterGroupParams file: aws amscm create-rfc --cli-input-json file://RDSCreateParameterGroupRfc.json -- execution-parameters file://RDSCreateParameterGroupParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Advanced Stack Components Version April 22, 2025 333 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3da2lxapopb86. Example: Required Parameters { "ParameterGroupName": "my-db-parameter-group", "ParameterGroupFamily": "mysql5.6" } Example: All Parameters { "ParameterGroupName": "my-db-parameter-group", "ParameterGroupFamily": "mysql5.6", "Description": "A meaningful description of the parameter group.", "Priority": "Medium", "Parameters": [ { "ParameterName": "max_connections", "ParameterValue": "100" } ], "RDSInstanceName": "my-test-db" } RDS Snapshot | Copy Create a KMS key encrypted copy of an Amazon Relational Database Service (Amazon RDS) DB snapshot. If you are copying a snapshot shared from another AWS account, it must be located in the same region in which the document is executed. Full classification: Deployment | Advanced stack components | RDS snapshot | Copy Change Type Details Change type ID ct-1c0jrxd3su5oe Advanced Stack Components Version April 22, 2025 334 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Copy RDS snapshot Copying an RDS DB Snapshot with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. Advanced Stack Components Version April 22, 2025 335 AMS Advanced Change Type Reference AMS Advanced Change Type Details |
ams-ct-095 | ams-ct.pdf | 95 | In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. Advanced Stack Components Version April 22, 2025 335 AMS Advanced Change Type Reference AMS Advanced Change Type Details To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Copying an RDS DB Snapshot with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Advanced Stack Components Version April 22, 2025 336 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-1c0jrxd3su5oe" --change-type-version "1.0" --title "Copy RDS DB snapshot" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CopyDbSnapshot\",\"Region\":\"us-east-1\",\"Parameters\": {\"SourceDbSnapshotArn\":[\"arn:aws:rds:us-east-2:012345678901:snapshot:my-db- snapshot\"],\"TargetDbSnapshotIdentifier\":[\"new-db-snapshot\"],\"KmsKeyId\": [\"arn:aws:kms:us-east-1:012345678901:key/01234567-abcd-abcd-abcd-0123456789ab\"], \"SourceRegion\":[\"us-east-2\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CopyRdsDbSnapshotParams.json. aws amscm get-change-type-version --change-type-id "ct-1c0jrxd3su5oe" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CopyRdsDbSnapshotParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CopyDbSnapshot", "Region": "us-east-1", "Parameters": { Advanced Stack Components Version April 22, 2025 337 AMS Advanced Change Type Reference AMS Advanced Change Type Details "SourceDbSnapshotArn": [ "arn:aws:rds:us-east-2:012345678901:snapshot:my-db-snapshot" ], "TargetDbSnapshotIdentifier": [ "new-db-snapshot" ], "KmsKeyId": [ "arn:aws:kms:us-east-1:012345678901:key/01234567-abcd-abcd-abcd-0123456789ab" ], "SourceRegion": [ "us-east-2" ] } } 3. Output the JSON template to a file in your current folder; this example names it CopyRdsDbSnapshotRfc.json: aws amscm create-rfc --generate-cli-skeleton > CopyRdsDbSnapshotRfc.json 4. Modify and save the CopyRdsDbSnapshotRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1c0jrxd3su5oe", "Title": "Copy RDS DB Snapshot" } 5. Create the RFC, specifying the execution parameters file and the CopyRdsDbSnapshotRfc file: aws amscm create-rfc --cli-input-json file://CopyRdsDbSnapshotRfc.json --execution- parameters file://CopyRdsDbSnapshotParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Advanced Stack Components Version April 22, 2025 338 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note For more information on RDS snapshots, see Copying a DB |
ams-ct-096 | ams-ct.pdf | 96 | like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1c0jrxd3su5oe", "Title": "Copy RDS DB Snapshot" } 5. Create the RFC, specifying the execution parameters file and the CopyRdsDbSnapshotRfc file: aws amscm create-rfc --cli-input-json file://CopyRdsDbSnapshotRfc.json --execution- parameters file://CopyRdsDbSnapshotParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Advanced Stack Components Version April 22, 2025 338 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note For more information on RDS snapshots, see Copying a DB snapshot. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1c0jrxd3su5oe. Example: Required Parameters { "DocumentName": "AWSManagedServices-CopyDbSnapshot", "Region": "us-east-1", "Parameters": { "SourceDbSnapshotArn": ["arn:aws:rds:us-east-1:012345678901:snapshot:test- snapshot"], "TargetDbSnapshotIdentifier": ["new-snapshot"], "KmsKeyId": ["01234567-abcd-abcd-abcd-0123456789ab"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-CopyDbSnapshot", "Region": "us-east-1", "Parameters": { "SourceDbSnapshotArn": ["arn:aws:rds:us-east-1:012345678901:snapshot:test- snapshot"], "TargetDbSnapshotIdentifier": ["new-snapshot"], "KmsKeyId": ["01234567-abcd-abcd-abcd-0123456789ab"], "SourceRegion": ["us-east-1"], "OptionGroupName": ["my-option-group-name"] } } Advanced Stack Components Version April 22, 2025 339 AMS Advanced Change Type Reference AMS Advanced Change Type Details RDS Snapshot | Copy (For Aurora) Create a copy of an Amazon Relational Database Service (Amazon RDS) DB Cluster snapshot. If you are copying a snapshot shared from another AWS account, it must be located in the same AWS Region as the specified DocumentName. Full classification: Deployment | Advanced stack components | RDS snapshot | Copy (for Aurora) Change Type Details Change type ID ct-19fdy7np55xiu Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Copy RDS Aurora snapshot Copying an RDS Aurora snapshot with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 340 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Copying an RDS Aurora snapshot with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. Advanced Stack Components Version April 22, 2025 341 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, |
ams-ct-097 | ams-ct.pdf | 97 | Details 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id="ct-19fdy7np55xiu" --change-type-version="1.0" --title="Copy Amazon RDS Aurora snapshot" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-CopyDBClusterSnapshot\",\"Region\":\"us-east-1\",\"Parameters \":{\"SourceDBClusterSnapshotARN\":[\"arn:aws:rds:us-east-1:111122223333:cluster- snapshot:myauroradbcluster-snapshot\"],\"TargetDBClusterSnapshotIdentifier \":[\"myauroradbcluster-target-snapshot\"],\"KmsKeyId\":[\"arn:aws:kms:us- east-1:111122223333:key/01234567-abcd-abcd-abcd-0123456789ab\"],\"SourceRegion\":[\"us- east-1\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CopyRdsAuroraSnapshotParams.json. Advanced Stack Components Version April 22, 2025 342 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm get-change-type-version --change-type-id "ct-19fdy7np55xiu" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CopyRdsAuroraSnapshotParams.json 2. Modify and save the execution parameters in the CopyRdsAuroraSnapshotParams.json file. For example, you can replace the contents with something like this: { "DocumentName":"AWSManagedServices-CopyDBClusterSnapshot", "Region":"us-east-1", "Parameters": { "SourceDBClusterSnapshotARN":"arn:aws:rds:us-east-1:111122223333:cluster- snapshot:myauroradbcluster-snapshot", "TargetDBClusterSnapshotIdentifier":"myauroradbcluster-target-snapshot", "KmsKeyId": "arn:aws:kms:us-east-1:111122223333:key/01234567-abcd-abcd- abcd-0123456789ab", "SourceRegion":"us-east-1" } } 3. Output the JSON template to a file in your current folder; this example names it CopyRdsAuroraSnapshotRfc.json: aws amscm create-rfc --generate-cli-skeleton > CopyRDSAuroraSnapshotRfc.json 4. Modify and save the CopyRdsAuroraSnapshotRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-19fdy7np55xiu", "Title": "Copy Aurora snapshot" } 5. Copy the RFC, specifying the input CopyDBClusterSnapshotRfc.json file and the execution parameters file CopyDBClusterSnapshotParams.json: aws amscm create-rfc --cli-input-json file://CopyRdsAuroraSnapshotRfc.json -- execution-parameters file://CopyRdsAuroraSnapshotParams.json Advanced Stack Components Version April 22, 2025 343 AMS Advanced Change Type Reference AMS Advanced Change Type Details You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For an overview of backing up and restoring Aurora clusters, see Backing up and restoring an Amazon Aurora DB cluster. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-19fdy7np55xiu. Example: Required Parameters { "DocumentName": "AWSManagedServices-CopyDBClusterSnapshot", "Region": "us-east-1", "Parameters": { "SourceDBClusterSnapshotARN": ["arn:aws:rds:us-east-1:111122223333:cluster- snapshot:source-snapshot"], "TargetDBClusterSnapshotIdentifier": ["target-snapshot"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-CopyDBClusterSnapshot", "Region": "us-east-1", "Parameters": { "SourceDBClusterSnapshotARN": ["arn:aws:rds:us-east-1:111122223333:cluster- snapshot:source-snapshot"], "TargetDBClusterSnapshotIdentifier": ["target-snapshot"], "KmsKeyId": ["01234567-abcd-abcd-abcd-0123456789ab"], "SourceRegion": ["us-east-1"] } } Advanced Stack Components Version April 22, 2025 344 AMS Advanced Change Type Reference RDS Snapshot | Create AMS Advanced Change Type Details Create a snapshot of an Amazon Relational Database Service (RDS) database (DB) instance. The snapshot will be encrypted with the same KMS key as the DB instance, or unencrypted if DB instance is unencrypted. Full classification: Deployment | Advanced stack components | RDS snapshot | Create Change Type Details Change type ID ct-393q3yaq9ewlm Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create RDS snapshot Creating an RDS DB Snapshot with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 345 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration |
ams-ct-098 | ams-ct.pdf | 98 | RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 346 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an RDS DB Snapshot with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 347 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-393q3yaq9ewlm" --change-type-version "1.0" --title "Create DB snapshot" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateDBSnapshot\",\"Region\":\"us-east-1\",\"Parameters \":{\"DBInstanceIdentifier\":[\"rds-db-instance\"],\"DBSnapshotName\":[\"my-db- snapshot\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CreateRdsDbSnapshotParams.json. aws amscm get-change-type-version --change-type-id "ct-393q3yaq9ewlm" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsDbSnapshotParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateDBSnapshot", "Region": "us-east-1", "Parameters": { "DBInstanceIdentifier": [ "rds-db-instance" ], "DBSnapshotName": [ "my-db-snapshot" ] } } 3. Output the JSON template to a file in your current folder; this example names it CreateRdsDbSnapshotRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdsDbSnapshotRfc.json Advanced Stack Components Version April 22, 2025 348 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the CreateRdsDbSnapshotRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-393q3yaq9ewlm", "Title": "Create DB snapshot" } 5. Create the RFC, specifying the execution parameters file and the CreateRdsDbSnapshotRfc file: aws amscm create-rfc --cli-input-json file://CreateRdsDbSnapshotRfc.json -- execution-parameters file://CreateRdsDbSnapshotParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-393q3yaq9ewlm. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-CreateDBSnapshot", "Region": "us-east-1", "Parameters": { "DBInstanceIdentifier": ["dbinstance"], "DBSnapshotName": ["test-snapshot"] } } Advanced Stack Components Version April 22, 2025 349 AMS Advanced Change Type Reference AMS Advanced Change Type Details RDS Snapshot | Create (For Cluster) Create a snapshot of Amazon Aurora or Multi-AZ DB (Amazon RDS) cluster in available state. The snapshot will be encrypted with the same KMS key as the DB cluster, or unencrypted if the DB cluster is unencrypted. Full classification: Deployment | Advanced stack components | RDS snapshot | Create (for cluster) Change Type Details Change type ID ct-2zqwr34epwzx1 Current version 1.0 Expected execution duration 180 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create RDS cluster snapshot Creating an RDS DB |
ams-ct-099 | ams-ct.pdf | 99 | Change Type Reference AMS Advanced Change Type Details RDS Snapshot | Create (For Cluster) Create a snapshot of Amazon Aurora or Multi-AZ DB (Amazon RDS) cluster in available state. The snapshot will be encrypted with the same KMS key as the DB cluster, or unencrypted if the DB cluster is unencrypted. Full classification: Deployment | Advanced stack components | RDS snapshot | Create (for cluster) Change Type Details Change type ID ct-2zqwr34epwzx1 Current version 1.0 Expected execution duration 180 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create RDS cluster snapshot Creating an RDS DB cluster snapshot with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 350 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. Advanced Stack Components Version April 22, 2025 351 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an RDS DB cluster snapshot with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 352 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2zqwr34epwzx1" --change-type-version "1.0" --title "Create a snapshot of a RDS DB Cluster" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateDBClusterSnapshot\",\"Region\": \"us-east-1\",\"Parameters\": {\"DBClusterIdentifier\": [\"testdbcluster\"], \"DBClusterSnapshotIdentifier\": [\"testdbcluster-snapshot\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CreateRdsDbClusterSnapshotParams.json. aws amscm get-change-type-version --change-type-id "ct-2zqwr34epwzx1" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsDbClusterSnapshotParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateDBClusterSnapshot", "Region": "us-east-1", "Parameters": { "DBClusterIdentifier" : [ "testdbcluster" ], "DBClusterSnapshotIdentifier" : [ "testdbcluster-snapshot" ] } } 3. Output the JSON template to a file in your current folder; this example names |
ams-ct-100 | ams-ct.pdf | 100 | "1.0" --title "Create a snapshot of a RDS DB Cluster" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateDBClusterSnapshot\",\"Region\": \"us-east-1\",\"Parameters\": {\"DBClusterIdentifier\": [\"testdbcluster\"], \"DBClusterSnapshotIdentifier\": [\"testdbcluster-snapshot\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CreateRdsDbClusterSnapshotParams.json. aws amscm get-change-type-version --change-type-id "ct-2zqwr34epwzx1" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdsDbClusterSnapshotParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateDBClusterSnapshot", "Region": "us-east-1", "Parameters": { "DBClusterIdentifier" : [ "testdbcluster" ], "DBClusterSnapshotIdentifier" : [ "testdbcluster-snapshot" ] } } 3. Output the JSON template to a file in your current folder; this example names it CreateRdsDbClusterSnapshotRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdsDbClusterSnapshotRfc.json 4. Modify and save the CreateRdsDbClusterSnapshotRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", Advanced Stack Components Version April 22, 2025 353 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-2zqwr34epwzx1", "Title": "Create DB cluster snapshot" } 5. Create the RFC, specifying the execution parameters file and the CreateRdsDbClusterSnapshotRfc file: aws amscm create-rfc --cli-input-json file://CreateRdsDbClusterSnapshotRfc.json -- execution-parameters file://CreateRdsDbClusterSnapshotParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2zqwr34epwzx1. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-CreateDBClusterSnapshot", "Region": "us-east-1", "Parameters": { "DBClusterIdentifier": ["dbcluster"], "DBClusterSnapshotIdentifier": ["dbclustersnapshotname"] } } Redshift | Create (Cluster from Snapshot) Create a Redshift cluster with the same configration as the source snapshot. Advanced Stack Components Version April 22, 2025 354 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Deployment | Advanced stack components | Redshift | Create (cluster from snapshot) Change Type Details Change type ID ct-3jrqmeq7j0wke Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create cluster from snapshot Creating a Redshift Cluster from a snapshot with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. Advanced Stack Components Version April 22, 2025 355 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Redshift Cluster from a snapshot with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: Advanced Stack Components Version April 22, 2025 356 AMS Advanced Change Type Reference AMS |
ams-ct-101 | ams-ct.pdf | 101 | 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: Advanced Stack Components Version April 22, 2025 356 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: amscm create-rfc --change-type-id "ct-3jrqmeq7j0wke” --change-type-version "1.0" --title "Create redshift cluster from snapshot" --execution-parameters "{\"Description\": \"DESCRIPTION\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\": \"stm-szovkq00000000000\", \"Name\":\"loremipsum\",\"TimeoutInMinutes\": 60, \"Parameters\": {\"AllowVersionUpgrade\": \"false\",\"DatabasePortNumber\": 5439, \"AutomatedSnapshotRetentionPeriod\": 7,\"PreferredMaintenanceWindow\": \"\", \"ClusterSnapshot\": \"mysnapshot\",\"ClusterSubnetGroup\": \"mysubnetgroup\"} TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CreateRdshftClusterFromSnapshotParams.json. aws amscm get-change-type-version --change-type-id "ct-3jrqmeq7j0wke" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdshftClusterFromSnapshotParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: Oracle example: Advanced Stack Components Version April 22, 2025 357 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Description" : "Create a Redshift cluster from a snapshot", "VpcId" : "vpc-12345678901234567", "Name" : "TestStack", "StackTemplateId" : "stm-szovkq00000000000", "TimeoutInMinutes" : 60, "Parameters" : { "ClusterSnapshot" : "mysnapshot", "ClusterSubnetGroup" : "mysubnetgroup" } } 3. Output the JSON template to a file in your current folder; this example names it CreateRdshftClusterFromSnapshotRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdshftClusterFromSnapshotRfc.json 4. Modify and save the CreateRdshftClusterFromSnapshotRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3jrqmeq7j0wke", "Title": "Redshift-Cluster-Create-From-Snapshot-RFC" } 5. Create the RFC, specifying the execution parameters file and the CreateRdshftClusterFromSnapshotRfc file: aws amscm create-rfc --cli-input-json file:// CreateRdshftClusterFromSnapshotRfc.json --execution-parameters file:// CreateRdshftClusterFromSnapshotParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Advanced Stack Components Version April 22, 2025 358 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note You can add up to 50 tags, but to do so you must enable the Additional configuration view. To learn more about AWS Redshift snapshots, see Amazon Redshift snapshots. To create an AWS Redshift cluster subnet group, see Create cluster subnet group. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3jrqmeq7j0wke. Example: Required Parameters { "Description" : "Create a Redshift cluster from a snapshot", "VpcId" : "vpc-12345678901234567", "Name": "Teststack", "StackTemplateId" : "stm-szovkq00000000000", "TimeoutInMinutes" : 60, "Parameters" : { "ClusterSnapshot" : "mysnapshot", "ClusterSubnetGroup": "mysubnetgroup", "NodeType": "ds2.xlarge" } } Example: All Parameters { "Description" : "Create a Redshift cluster from a snapshot", "VpcId" : "vpc-12345678901234567", "Name": "Teststack", "Tags" : [ { "Key" : "foo", "Value" : "bar" Advanced Stack Components Version April 22, 2025 359 AMS Advanced Change Type Reference AMS Advanced Change Type Details } ], "StackTemplateId" : "stm-szovkq00000000000", "TimeoutInMinutes" : 60, "Parameters" : { "ClusterIdentifier" : "test1223", "ClusterSnapshot" : "mysnapshot", "SnapshotAccountOwner" : "123456789101", "SnapshotClusterIdentifier" : "mycluster", "NodeType": "ds2.xlarge", "IamRoles" : "arn:aws:iam::123456789012:role/customer_redshift_role", "ParameterGroupName" : "myparamgroup", "ClusterSubnetGroup" : "mysubnetgroup", "AllowVersionUpgrade" : "false", "SecurityGroups" : ["sg-12345678"], "DatabasePortNumber" : 5439, "AutomatedSnapshotRetentionPeriod" : 7, "PreferredMaintenanceWindow" : "sat:00:00-sat:01:00" } } Redshift | Create (Cluster Subnet Group) Use to create a Redshift cluster subnet group. Full classification: Deployment | Advanced stack components | Redshift | Create (cluster subnet group) Change Type Details Change type ID ct-0q43l40hxrzum Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 360 AMS Advanced Change Type Reference Additional Information Create cluster subnet group Creating a Redshift Cluster Subnet Group with the Console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in |
ams-ct-102 | ams-ct.pdf | 102 | Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 360 AMS Advanced Change Type Reference Additional Information Create cluster subnet group Creating a Redshift Cluster Subnet Group with the Console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Advanced Stack Components Version April 22, 2025 361 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Redshift Cluster Subnet Group with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Advanced Stack Components Version April 22, 2025 362 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-0q43l40hxrzum" --change-type-version "1.0" --title "RedshiftClusterSubnetGroup" --execution-parameters "{\"Description\": \"DESCRIPTION\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\": \"stm-5rsvv3l4760usboci\", \"Name\":\"loremipsum\", \"TimeoutInMinutes\": 60, \"Parameters\": { \"SubnetGroupDescription\": \"mysubnetgroup\", \"SubnetIds\": [ \"SUBNET_ID\", \"SUBNET_ID\" ] } }" TEMPLATE CREATE: 1. Output the execution parameters for this change type (ct-0q43l40hxrzum) to a JSON file named CreateRedshftClusterSGParams.json. aws amscm get-change-type-version --change-type-id "ct-0q43l40hxrzum" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRedshftClusterSGParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "Description": "Create a Redshift cluster subnet group", "VpcId": "VPC_ID", "StackTemplateId": "stm-5rsvv3l4760usboci", "Name": "Stack_Name", "TimeoutInMinutes": 60, "Parameters": { "SubnetGroupDescription": "My Redshift Subnet Group", "SubnetIds": [ "SUBNET_ID", "SUBNET_ID" ] } } Advanced Stack Components Version April 22, 2025 363 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. Output the JSON template to a file in your current folder; this example names it CreateRedshftClusterSGRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRedshftClusterSGRfc.json 4. Modify and save the CreateRedshftClusterSGRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0q43l40hxrzum", "Title": "Redshift-Cluster-Create-SG-RFC" |
ams-ct-103 | ams-ct.pdf | 103 | with something like this: { "Description": "Create a Redshift cluster subnet group", "VpcId": "VPC_ID", "StackTemplateId": "stm-5rsvv3l4760usboci", "Name": "Stack_Name", "TimeoutInMinutes": 60, "Parameters": { "SubnetGroupDescription": "My Redshift Subnet Group", "SubnetIds": [ "SUBNET_ID", "SUBNET_ID" ] } } Advanced Stack Components Version April 22, 2025 363 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. Output the JSON template to a file in your current folder; this example names it CreateRedshftClusterSGRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRedshftClusterSGRfc.json 4. Modify and save the CreateRedshftClusterSGRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0q43l40hxrzum", "Title": "Redshift-Cluster-Create-SG-RFC" } 5. Create the RFC, specifying the execution parameters file and the CreateRedshftClusterSGRfc file: aws amscm create-rfc --cli-input-json file://CreateRedshftClusterSGRfc.json -- execution-parameters file://CreateRedshftClusterSGParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note You can add up to 50 tags, but to do so you must enable the Additional configuration view. To learn more about AWS Redshift, see Amazon Redshift Cluster Subnet Groups. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0q43l40hxrzum. Advanced Stack Components Version April 22, 2025 364 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "Description": "Create a Redshift cluster subnet group", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-5rsvv3l4760usboci", "Name": "Stack Name", "TimeoutInMinutes": 60, "Parameters": { "SubnetGroupDescription": "Test subnet group description", "SubnetIds": ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"] } } Example: All Parameters { "Description": "Create a Redshift cluster subnet group", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-5rsvv3l4760usboci", "Name": "Stack Name", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "SubnetGroupDescription": "Test subnet group description", "SubnetIds": ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"] } } Redshift | Create (Cluster) Create an Amazon Redshift cluster that is a fully managed data warehouse that consists of a set of compute nodes. Advanced Stack Components Version April 22, 2025 365 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Deployment | Advanced stack components | Redshift | Create (cluster) Change Type Details Change type ID ct-1malj7snzxrkr Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create cluster Creating a Redshift Cluster with the Console Screenshot of this change type in the AMS console: How it works: Advanced Stack Components Version April 22, 2025 366 AMS Advanced Change Type Reference AMS Advanced Change Type Details 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Redshift Cluster with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described |
ams-ct-104 | ams-ct.pdf | 104 | the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Redshift Cluster with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Advanced Stack Components Version April 22, 2025 367 AMS Advanced Change Type Reference AMS Advanced Change Type Details Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-1malj7snzxrkr" --change-type-version "1.0" --title "RedshiftClusterRfc" --execution-parameters "{\"Description\":\"DESCRIPTION\", \"VpcId\": \"VPC_ID\", \"StackTemplateId\": \"stm-n8kpln6rtg1eiq83b\", \"Name\": \"My_Redshift_Cluster\", \"TimeoutInMinutes\":60, \"Parameters\": {\"ClusterSubnetGroup \":\"CLUSTER_SUBNET_GROUP\",\"DatabaseName\":\"DB_NAME\",\"MasterUsername\":\"USER\", \"MasterUserPassword\":\"PASSWORD\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type (ct-1malj7snzxrkr) to a JSON file named CreateRdshftClusterParams.json. aws amscm get-change-type-version --change-type-id "ct-1malj7snzxrkr" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRdshftClusterParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: Oracle example: { "Description": "Create a Redshift cluster", "VpcId": "VPC_ID", "StackTemplateId": "stm-n8kpln6rtg1eiq83b", "Name": "Stack_Name", Advanced Stack Components Version April 22, 2025 368 AMS Advanced Change Type Reference AMS Advanced Change Type Details "TimeoutInMinutes": 60, "Parameters": { "ClusterSubnetGroup": "mysubnetgroup", "DatabaseName": "myfirstdb", "MasterUsername": "myusername", "MasterUserPassword": "Mypassword1234" } } 3. Output the JSON template to a file in your current folder; this example names it CreateRdshftClusterRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRdshftClusterRfc.json 4. Modify and save the CreateRdshftClusterRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1malj7snzxrkr", "Title": "Redshift-Cluster-Create-RFC" } 5. Create the RFC, specifying the execution parameters file and the CreateRdshftClusterRfc file: aws amscm create-rfc --cli-input-json file://CreateRdshftClusterRfc.json -- execution-parameters file://CreateRdshftClusterParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note You can add up to 50 tags, but to do so you must enable the Additional configuration view. To learn more about AWS Redshift, see Amazon Redshift. Advanced Stack Components Version April 22, 2025 369 AMS Advanced Change Type Reference AMS Advanced Change Type Details To create an AWS Redshift cluster subnet group, see Create cluster subnet group. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1malj7snzxrkr. Example: Required Parameters { "Description": "Create a Redshift cluster", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-n8kpln6rtg1eiq83b", "Name": "Stack Name", "TimeoutInMinutes": 60, "Parameters": { "ClusterSubnetGroup": "mysubnetgroup", "DatabaseName": "myfirstdb", "MasterUsername": "loremipsum", "MasterUserPassword": "Mypassword1234" } } Example: All Parameters { "Description": "Create a Redshift cluster", "VpcId": "vpc-12345678901234567", "StackTemplateId": "stm-n8kpln6rtg1eiq83b", "Name": "Stack Name", "TimeoutInMinutes": 60, "Parameters": { "ClusterIdentifier": "mycluster", "DatabaseName": "myfirstdb", "DatabasePortNumber": 14231, "MasterUsername": "loremipsum", "MasterUserPassword": "Mypassword1234", "NodeType": "ds2.xlarge", "ClusterType": "multi-node", "NumberOfNodes": "5", "ParameterGroupName": "myparamgroupname", "ClusterSubnetGroup": "mysubnetgroup", "SecurityGroups": ["sg-1a2b3c4d","sg-1a2b3c4d5e6f7g8h9"], Advanced Stack Components Version April 22, 2025 370 AMS Advanced Change Type Reference AMS Advanced Change Type Details "AllowVersionUpgrade": "true", "AutomatedSnapshotRetentionPeriod": 30, "PreferredMaintenanceWindow": "sat:00:00-sat:01:00", "IamRoles": "arn:aws:iam::123456789012:role/customer_redshift_role", "KmsKeyId": "arn:aws:kms:us- east-1:123456789012:key/503f4b06-3507-452a-9812-7772ddc72af7" } } S3 Access Point | Create Access Point (Review Required) Create an access point and associate it with the specified S3 bucket. Full classification: Deployment | Advanced stack components | S3 Access Point | Create Access Point (review required) Change Type Details Change type ID ct-1elb1vtam0ka5 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Create an S3 access point Creating an S3 access point with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 371 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick |
ams-ct-105 | ams-ct.pdf | 105 | Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Advanced Stack Components Version April 22, 2025 372 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an S3 access point with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --title="Add Static Route" --description="Create an access point and associate it with the specified S3 bucket." --ct-id="ct-1elb1vtam0ka5" --ct- version="1.0" --input-params="{\"Access Point Name\":\"accesspoint1\",\"Bucket Name\": \"s3bucket1\",\"Network Origin\":\"VPC\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateS3AccessPointParams.json. aws amscm get-change-type-version --change-type-id "ct-1elb1vtam0ka5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > Advanced Stack Components Version April 22, 2025 373 AMS Advanced Change Type Reference AMS Advanced Change Type Details CreateS3AccessPointParams.json\"Access Point Policy\":\"Example access point policy\" 2. Modify and save the CreateS3AccessPointParams file. { "Access Point Name": "accesspoint1", "Bucket Name": "s3bucket1", "Network Origin": "VPC", "Vpc Id": "vpc-12345678" "Access Point Policy": "Example access point policy" } 3. Output the RFC template JSON file to a file named CreateS3AccessPointRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateS3AccessPointRfc.json 4. Modify and save the CreateS3AccessPointRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1elb1vtam0ka5", "Title": "S3-Accesspoint-Create-RFC" } 5. Create the RFC, specifying the CreateS3AccessPointRfc file and the CreateS3AccessPointParams file: aws amscm create-rfc --cli-input-json file://CreateS3AccesspointRfc.json -- execution-parameters file://CreateS3AccesspointParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon S3, see Amazon Simple Storage Service Documentation. Advanced Stack Components Version April 22, 2025 374 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1elb1vtam0ka5. Example: Required Parameters Example not available. Example: All Parameters Example not available. S3 Storage | Create Create an Amazon S3 bucket for cloud storage. Full classification: Deployment | Advanced stack components | S3 storage | Create Change Type Details Change type ID ct-1a68ck03fn98r Current version 5.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not |
ams-ct-106 | ams-ct.pdf | 106 | Amazon S3, see Amazon Simple Storage Service Documentation. Advanced Stack Components Version April 22, 2025 374 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1elb1vtam0ka5. Example: Required Parameters Example not available. Example: All Parameters Example not available. S3 Storage | Create Create an Amazon S3 bucket for cloud storage. Full classification: Deployment | Advanced stack components | S3 storage | Create Change Type Details Change type ID ct-1a68ck03fn98r Current version 5.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create S3 storage Creating an S3 Bucket with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 375 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Advanced Stack Components Version April 22, 2025 376 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an S3 Bucket with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Example with only required parameters, version 5.0: aws amscm create-rfc --title "my-s3-bucket" --change-type-id "ct-1a68ck03fn98r" --change-type-version "5.0" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateBucket\",\"Region\":\"us-east-1\",\"Parameters\": {\"BucketName\":\"amzn-s3-demo-bucket\"}}" Example with all parameters, version 5.0: aws amscm create-rfc --title "My S3 Bucket" --change-type-id "ct-1a68ck03fn98r" --change-type-version "5.0" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateBucket\",\"Region\":\"us-east-1\",\"Parameters\": {\"BucketName\":\"amzn-s3-demo-bucket\",\"ServerSideEncryption\":\"KmsManagedKeys\", Advanced Stack Components Version April 22, 2025 377 AMS Advanced Change Type Reference AMS Advanced Change Type Details \"KMSKeyId\":\"arn:aws:kms:ap-southeast-2:123456789012:key/9d5948f1-2082-4c07-a183- eb829b8d81c4\",\"Versioning\":\"Enabled\",\"IAMPrincipalsRequiringReadObjectAccess\": [\"arn:aws:iam::123456789012:user/myuser\",\"arn:aws:iam::123456789012:role/myrole\"], \"IAMPrincipalsRequiringWriteObjectAccess\":[\"arn:aws:iam::123456789012:user/myuser\", \"arn:aws:iam::123456789012:role/myrole\"],\"ServicesRequiringReadObjectAccess\": [\"rds.amazonaws.com\",\"ec2.amazonaws.com\",\"logs.ap-southeast-2.amazonaws.com\"], \"ServicesRequiringWriteObjectAccess\":[\"rds.amazonaws.com\",\"ec2.amazonaws.com\", \"logs.ap-southeast-2.amazonaws.com\"],\"EnforceSecureTransport \":true,\"AccessAllowedIpRanges\":[\"1.0.0.0/24\",\"2.0.0.0/24\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateBucketParams.json. aws amscm get-change-type-version --change-type-id "ct-1a68ck03fn98r" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateBucketParams.json 2. Modify and save the CreateBucketParams file. Note that you do not need to use your account ID in the BucketName, but it can make finding the bucket easier (remember that bucket names must be unique in the account across all regions and cannot have uppercase letters). If using this to create a tier-and-tie WordPress site, you may want to indicate that purpose when setting the BucketName. Example with read access: { "DocumentName": "AWSManagedServices-CreateBucket", "Region": "us-east-1", "Parameters": { "BucketName": "amzn-s3-demo-bucket", "IAMPrincipalsWithReadObjectAccess": [ "arn:aws:iam::123456789123:role/roleA", |
ams-ct-107 | ams-ct.pdf | 107 | file; this example names it CreateBucketParams.json. aws amscm get-change-type-version --change-type-id "ct-1a68ck03fn98r" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateBucketParams.json 2. Modify and save the CreateBucketParams file. Note that you do not need to use your account ID in the BucketName, but it can make finding the bucket easier (remember that bucket names must be unique in the account across all regions and cannot have uppercase letters). If using this to create a tier-and-tie WordPress site, you may want to indicate that purpose when setting the BucketName. Example with read access: { "DocumentName": "AWSManagedServices-CreateBucket", "Region": "us-east-1", "Parameters": { "BucketName": "amzn-s3-demo-bucket", "IAMPrincipalsWithReadObjectAccess": [ "arn:aws:iam::123456789123:role/roleA", "arn:aws:iam::987654321987:role/roleB" ] } } Example with write access: { Advanced Stack Components Version April 22, 2025 378 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-CreateBucket", "Region": "us-east-1", "Parameters": { "BucketName": "amzn-s3-demo-bucket", "IAMPrincipalsRequiringWriteObjectAccess": [ "arn:aws:iam::123456789123:role/roleA", "arn:aws:iam::987654321987:role/roleB" ] } } For the resulting policy, see Grants READ access for an IAM User or a Role. Example with read access to service: { "DocumentName": "AWSManagedServices-CreateBucket", "Region": "us-east-1", "Parameters": { "BucketName": "amzn-s3-demo-bucket", "ServicesRequiringWriteObjectAccess": [ "rds.amazonaws.com", "logs.ap-southeast-2.amazonaws.com", "ec2.amazonaws.com" ] } } For the resulting policy, see Grants WRITE access for an IAM User or a Role. Example with write access to service: { "DocumentName": "AWSManagedServices-CreateBucket", "Region": "us-east-1", "Parameters": { "BucketName": "amzn-s3-demo-bucket", "ServicesRequiringWriteObjectAccess": [ "rds.amazonaws.com", "logs.ap-southeast-2.amazonaws.com", "ec2.amazonaws.com" ] Advanced Stack Components Version April 22, 2025 379 AMS Advanced Change Type Reference AMS Advanced Change Type Details } } Example with enforce secure transport: { "DocumentName": "AWSManagedServices-CreateBucket", "Region": "us-east-1", "Parameters": { "BucketName": "amzn-s3-demo-bucket", "EnforceSecureTransport": "true" } } For the resulting policy, see Uses EnforceSecureTransport. Example with limits access to the bucket from a set of IP ranges: { "DocumentName": "AWSManagedServices-CreateBucket", "Region": "us-east-1", "Parameters": { "BucketName": "amzn-s3-demo-bucket", "AccessAllowedIpRanges": [ "1.2.3.0/24", "2.3.4.0/24" ] } } For the resulting policy, see Limits Access to IP Range. 3. Output the RFC template JSON file to a file named CreateBucketRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateBucketRfc.json 4. Modify and save the CreateBucketRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "5.0", "ChangeTypeId": "ct-1a68ck03fn98r", Advanced Stack Components Version April 22, 2025 380 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "S3-Bucket-Create-RFC", "RequestedStartTime": "2016-12-05T14:20:00Z", "RequestedEndTime": "2016-12-05T16:20:00Z" } 5. Create the RFC, specifying the CreateBucketRfc file and the CreateBucketParams file: aws amscm create-rfc --cli-input-json file://CreateBucketRfc.json --execution- parameters file://CreateBucketParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the S3 bucket or load objects to it, look in the execution output: Use the stack_id to view the bucket in the Cloud Formation Console, use the S3 bucket name to view the bucket in the S3 Console. Note When uploading objects from a non-owner account, it is mandatory to specify the bucket-owner-full-control ACL, that grants the bucket owner account full control over all the objects in the bucket. Example: aws s3api put-object --acl bucket-owner-full-control --bucket amzn-s3-demo- bucket --key data.txt --body /tmp/data.txt Tips Note This walkthrough describes, and provides example commands for, creating an Amazon S3 storage bucket using version 5.0 of the change type (ct-1a68ck03fn98r). This version does not allow you to create a public S3 bucket, only private is allowed. To create a public S3 storage bucket, use a previous version of the change type, and specify PublicRead for the AccessControl parameter. Also, this walkthrough does not grant the permissions necessary for deleting versioned objects. Advanced Stack Components Version April 22, 2025 381 AMS Advanced Change Type Reference AMS Advanced Change Type Details To learn more about Amazon S3, see Amazon Simple Storage Service Documentation. S3 Storage Bucket Create Example Resulting Policies Depending on how you created your Amazon S3 storage bucket, you created policies. These example policies match various Amazon S3 create scenarios provided in Creating an S3 Bucket with the CLI. Grants READ access for an IAM User or a Role Resulting example policy grants READ access to the objects in the bucket for an IAM user or a role: { "Sid": "AllowBucketReadActionsForArns", "Effect": "Allow", "Principal": { "AWS": [ "arn:aws:iam::123456789123:role/roleA”, "arn:aws:iam::987654321987:role/roleB” ] }, "Action": [ "s3:GetBucketAcl", "s3:GetBucketLocation", "s3:ListBucket" ], "Resource": "arn:aws:s3:::ACCOUNT-ID.BUCKET_NAME" }, { "Sid": "AllowObjectReadActionsForArns", "Effect": "Allow", "Principal": { "AWS": [ "arn:aws:iam::123456789123:role/roleA”, "arn:aws:iam::987654321987:role/roleB” ] }, "Action": [ "s3:GetObject", "s3:ListMultipartUploadParts" ], "Resource": "arn:aws:s3:::ACCOUNT-ID.amzn-s3-demo-bucket/*" } Advanced Stack Components Version April 22, 2025 382 AMS Advanced Change Type Reference AMS Advanced Change Type Details For the execution parameters to create this policy with the S3 storage bucket Create change type, see Creating an S3 Bucket with the CLI Grants WRITE access for an IAM User or a Role The following resulting example policy grants WRITE access to the objects in the bucket for a IAM user or a role. This policy does not grant |
ams-ct-108 | ams-ct.pdf | 108 | }, { "Sid": "AllowObjectReadActionsForArns", "Effect": "Allow", "Principal": { "AWS": [ "arn:aws:iam::123456789123:role/roleA”, "arn:aws:iam::987654321987:role/roleB” ] }, "Action": [ "s3:GetObject", "s3:ListMultipartUploadParts" ], "Resource": "arn:aws:s3:::ACCOUNT-ID.amzn-s3-demo-bucket/*" } Advanced Stack Components Version April 22, 2025 382 AMS Advanced Change Type Reference AMS Advanced Change Type Details For the execution parameters to create this policy with the S3 storage bucket Create change type, see Creating an S3 Bucket with the CLI Grants WRITE access for an IAM User or a Role The following resulting example policy grants WRITE access to the objects in the bucket for a IAM user or a role. This policy does not grant the permissions necessary for deleting versioned objects. { "Sid": "AllowObjectWriteActionsForArns", "Effect": "Allow", "Principal": { "AWS": [ "arn:aws:iam::123456789123:role/roleA”, "arn:aws:iam::987654321987:role/roleB” ] }, "Action": [ "s3:PutObject", "s3:DeleteObject", "s3:AbortMultipartUpload" ], "Resource": "arn:aws:s3:::ACCOUNT-ID.amzn-s3-demo-bucket/*" } For the execution parameters to create this policy with the S3 storage bucket Create change type, see Creating an S3 Bucket with the CLI Grants READ access for an AWS Service Resulting example policy grants READ access to the objects in the bucket for an AWS service: { "Sid": "AllowBucketReadActionsForServcices", "Effect": "Allow", "Principal": { "Service": [ "rds.amazonaws.com", "logs.ap-southeast-2.amazonaws.com", "ec2.amazonaws.com" ] }, "Action": [ Advanced Stack Components Version April 22, 2025 383 AMS Advanced Change Type Reference AMS Advanced Change Type Details "s3:GetBucketAcl", "s3:GetBucketLocation", "s3:ListBucket" ], "Resource": "arn:aws:s3:::ACCOUNT-ID.amzn-s3-demo-bucket/*" }, { "Sid": "AllowObjectReadActionsForServcices", "Effect": "Allow", "Principal": { "Service": [ "rds.amazonaws.com", "logs.ap-southeast-2.amazonaws.com", "ec2.amazonaws.com" ] }, "Action": [ "s3:GetObject", "s3:ListMultipartUploadParts" ], "Resource": "arn:aws:s3:::ACCOUNT-ID.amzn-s3-demo-bucket/*" } For the execution parameters to create this policy with the S3 storage bucket Create change type, see Creating an S3 Bucket with the CLI Grants WRITE access for an AWS Service The following resulting example policy grants WRITE access to the objects in the bucket for an AWS service. This policy does not grant the permissions necessary for deleting versioned objects. { "Sid": "AllowObjectWriteActionsForServcices", "Effect": "Allow", "Principal": { "Service": [ "rds.amazonaws.com", "logs.ap-southeast-2.amazonaws.com", "ec2.amazonaws.com" ] }, "Action": [ "s3:PutObject", Advanced Stack Components Version April 22, 2025 384 AMS Advanced Change Type Reference AMS Advanced Change Type Details "s3:DeleteObject", "s3:AbortMultipartUpload" ], "Resource": "arn:aws:s3:::ACCOUNT-ID.amzn-s3-demo-bucket/*" } For the execution parameters to create this policy with the S3 storage bucket Create change type, see Creating an S3 Bucket with the CLI Uses EnforceSecureTransport Resulting example policy enforcing secure transport: { "Sid": "EnforceSecureTransport", "Effect": "Deny", "Principal": "*", "Action": "*", "Resource": "arn:aws:s3:::ACCOUNT-ID.amzn-s3-demo-bucket/*", "Condition": { "Bool": { "aws:SecureTransport": "false" } } } For the execution parameters to create this policy with the S3 storage bucket Create change type, see Creating an S3 Bucket with the CLI Limits Access to IP Range Resulting example policy limiting access to the bucket from a set of IP ranges: { "Sid": "RestrictBasedOnIPRanges", "Effect": "Deny", "Principal": "*", "Action": "s3:*", "Resource": "arn:aws:s3:::ACCOUNT-ID.amzn-s3-demo-bucket/*", "Condition": { "NotIpAddress": { "aws:SourceIp": [ “1.2.3.0/24", Advanced Stack Components Version April 22, 2025 385 AMS Advanced Change Type Reference AMS Advanced Change Type Details “2.3.4.0/24" ] } } } For the execution parameters to create this policy with the S3 storage bucket Create change type, see Creating an S3 Bucket with the CLI Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1a68ck03fn98r. Example: Required Parameters { "DocumentName" : "AWSManagedServices-CreateBucket", "Region": "us-east-1", "Parameters": { "BucketName": "mybucket" } } Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateBucket", "Region": "us-east-1", "Parameters": { "BucketName": "mybucket", "ServerSideEncryption": "KmsManagedKeys", "KMSKeyId": "arn:aws:kms:ap-southeast-2:123456789012:key/9d5948f1-2082-4c07-a183- eb829b8d81c4", "Versioning": "Enabled", "IAMPrincipalsRequiringReadObjectAccess": [ "arn:aws:iam::123456789012:user/myuser", "arn:aws:iam::123456789012:role/myrole" ], "IAMPrincipalsRequiringWriteObjectAccess": [ "arn:aws:iam::123456789012:user/myuser", "arn:aws:iam::123456789012:role/myrole" ], Advanced Stack Components Version April 22, 2025 386 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ServicesRequiringReadObjectAccess": [ "rds.amazonaws.com", "ec2.amazonaws.com", "logs.ap-southeast-2.amazonaws.com" ], "ServicesRequiringWriteObjectAccess": [ "rds.amazonaws.com", "ec2.amazonaws.com", "logs.ap-southeast-2.amazonaws.com" ], "EnforceSecureTransport": true, "AccessAllowedIpRanges": [ "1.0.0.0/24", "2.0.0.0/24" ], "Tags": [ "{\"Key\": \"foo\", \"Value\": \"bar\"}", "{ \"Key\": \"testkey\",\"Value\": \"testvalue\" }" ] } } S3 Storage | Create Policy (Review Required) Create an S3 bucket policy. The existing bucket policy (if any) is replaced with the new policy. Full classification: Deployment | Advanced stack components | S3 storage | Create policy (review required) Change Type Details Change type ID ct-220bdb8blaixf Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Advanced Stack Components Version April 22, 2025 387 AMS Advanced Change Type Reference Additional Information Create S3 storage policy Creating an S3 Storage Policy with the Console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC |
ams-ct-109 | ams-ct.pdf | 109 | an S3 Storage Policy with the Console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Advanced Stack Components Version April 22, 2025 388 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an S3 Storage Policy with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Advanced Stack Components Version April 22, 2025 389 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-220bdb8blaixf" --change-type-version "1.0" --title "TITLE" --execution-parameters "{\"BucketName\": \"amzn-s3-demo-bucket\", \"BucketPolicy\": \"Example bucket policy\", \"Operation\": \"Create policy\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateS3PolicyParams.json. aws amscm get-change-type-version --change-type-id "ct-220bdb8blaixf" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateS3PolicyParams.json 2. Modify and save the CreateS3PolicyParams file. For example, you can replace the contents with something like this: { "BucketName": "amzn-s3-demo-bucket", "BucketPolicy": "Bucket Policy example", "Operation": "Create policy" } 3. Output the RFC template JSON file to a file named CreateS3PolicyRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateS3PolicyRfc.json 4. Modify and save the CreateS3PolicyRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", Advanced Stack Components Version April 22, 2025 390 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-220bdb8blaixf", "Title": "S3-Policy-Create-RFC" } 5. Create the RFC, specifying the CreateS3PolicyRfc file and the CreateS3PolicyParams file: aws amscm create-rfc --cli-input-json file://CreateS3PolicyRfc.json --execution- parameters file://CreateS3PolicyParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon S3, see Using Bucket Policies and User Policies. This is a "review required" change |
ams-ct-110 | ams-ct.pdf | 110 | "1.0", Advanced Stack Components Version April 22, 2025 390 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-220bdb8blaixf", "Title": "S3-Policy-Create-RFC" } 5. Create the RFC, specifying the CreateS3PolicyRfc file and the CreateS3PolicyParams file: aws amscm create-rfc --cli-input-json file://CreateS3PolicyRfc.json --execution- parameters file://CreateS3PolicyParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon S3, see Using Bucket Policies and User Policies. This is a "review required" change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a "review required" change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-220bdb8blaixf. Example: Required Parameters { "BucketName": "examplebucketname", "BucketPolicy": "Example bucket permissions", "Operation": "Create policy" } Example: All Parameters { "BucketName": "examplebucketname", "BucketPolicy": "Example bucket permissions", Advanced Stack Components Version April 22, 2025 391 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Operation": "Create policy", "Priority": "Medium" } Security Group | Create Create a security group with limited scope. For complex security groups, use the manual Security group Create change type (ct-1oxx2g2d7hc90). Full classification: Deployment | Advanced stack components | Security group | Create Change Type Details Change type ID ct-3pc215bnwb6p7 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create security group Creating a Security Group with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 392 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. Advanced Stack Components Version April 22, 2025 393 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Security Group with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC |
ams-ct-111 | ams-ct.pdf | 111 | create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 394 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml amscm create-rfc --change-type-id "ct-3pc215bnwb6p7" --change- type-version "1.0" --title "Test-SG-Auto" --execution-parameters "{\"VpcId\": \"VPC_ID\", \"Description\":\"Test-SG-Auto\", \"SecurityGroupName\":\"Test-SG-Auto\", \"TcpUdpIngressRules\":{\"Protocol\":\"TCP\", \"FromPort\":\"PORT\, \"ToPort\": \"PORT\"}, \"TcpUdpEgressRules\":{\"Protocol\":\"TCP\", \"FromPort\":\"PORT\, \"ToPort \":\"PORT\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateSGAParams.json. aws amscm get-change-type-version --change-type-id "ct-3pc215bnwb6p7" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateSGAParams.json 2. Modify and save the CreateSGAParams file. For example, you can replace the contents with something like this: { "SecurityGroupName": "My-WEB-SG", "SecurityGroupDescription": "SG_DESCRIPTION", "TcpUdpIngressRules": { "Protocol": "PROTOCOL", "FromPortRange": "PORT_RANGE", "ToPort": "TRAFFIC_SOURCE" }, "TcpUdpEgressRules": { "Protocol": "PROTOCOL", "FromPort": "PORT", "ToPort": "PORT" } } 3. Output the RFC template JSON file to a file named CreateSGARfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateSGARfc.json Advanced Stack Components Version April 22, 2025 395 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the CreateSGARfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3pc215bnwb6p7", "Title": "SG-Create-Auto-RFC" } 5. Create the RFC, specifying the CreateSGARfc file and the CreateSGAParams file: aws amscm create-rfc --cli-input-json file://CreateSGARfc.json --execution- parameters file://CreateSGAParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. Once the security group is created, use Associate security group to resource to associate the security group with your AMS resources. Tips Note After the security group is created, use Associate security group to resource to associate the security group with your AMS resources. To delete a security group, the security group must *not* have associated resources. To learn more about AWS security groups and creating security groups, see Security Group Rules Reference. This page helps you determine the rules you want and, importantly, how to name your security group so choosing it when creating other resources is intuitive. Also see Amazon EC2 Security Groups for Linux Instances and Security Groups for Your VPC. Only the following IP address ranges are allowed in ingress rules: • 10.0.0.0/8 • 172.16.0.0/12 • 192.168.0.0/16 Advanced Stack Components Version April 22, 2025 396 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3pc215bnwb6p7. Example: Required Parameters { "VpcId": "vpc-12345678", "SecurityGroupName": "app1-webserver", "SecurityGroupDescription": "App1 group" } Example: All Parameters { "VpcId": "vpc-01234567890abcdef", "SecurityGroupName": "app1-webserver", "SecurityGroupDescription": "App1 group", "TcpUdpIngressRules": [ { "Protocol": "TCP", "FromPort": 80, "ToPort": 80, "AddressRanges": ["192.168.0.0/16"], "Description": "Client1" }, { "Protocol": "UDP", "FromPort": 80, "ToPort": 80, "SecurityGroupIds": ["sg- abd45678901234567"], "Description": "Client1" }, { "Protocol": "TCP", "FromPort": 80, "ToPort": 80, "AddressRanges": ["192.168.0.0/16"], "SecurityGroupIds": ["sg-abc45678"], "Description": "Client1" } ], "TcpUdpEgressRules": [ { "Protocol": "TCP", "FromPort": 100, "ToPort": 120, "AddressRanges": ["192.168.0.0/16"], "Description": "Client1" }, { "Protocol": "UDP", "FromPort": 100, "ToPort": 120, "SecurityGroupIds": ["sg- abd45678901234567"], "Description": "Client1" }, { "Protocol": "TCP", "FromPort": 100, "ToPort": 120, "AddressRanges": ["192.168.0.0/16"], "SecurityGroupIds": ["sg-abc45678"], "Description": "Client1" } ], "IcmpIngressRules": [ { "Type": -1, "Code": -1, "AddressRanges": ["192.168.0.0/16"], "Description": "Client1" }, { "Type": 15, "Code": 8, "SecurityGroupIds": ["sg-abd45678901234567"], "Description": "Client1" } ], "IcmpEgressRules": [ Advanced Stack Components Version April 22, 2025 397 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Type": -1, "Code": -1, "AddressRanges": ["192.168.0.0/16"], "Description": "Client1" }, { "Type": 30, "Code": 15, "SecurityGroupIds": ["sg-abd45678901234567"], "Description": "Client1" } ], "Tags": [ { "Key": "B", "Value": "bb" }, { "Key": "C", "Value": "cc" }, { "Key": "D", "Value": "dd" }, { "Key": "E", "Value": "ee" } ] } Security Group | Create (Review Required) Create a security group, and optionally associate it with AWS resources. Full classification: Deployment | Advanced stack components | |
ams-ct-112 | ams-ct.pdf | 112 | "SecurityGroupIds": ["sg-abd45678901234567"], "Description": "Client1" } ], "IcmpEgressRules": [ Advanced Stack Components Version April 22, 2025 397 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Type": -1, "Code": -1, "AddressRanges": ["192.168.0.0/16"], "Description": "Client1" }, { "Type": 30, "Code": 15, "SecurityGroupIds": ["sg-abd45678901234567"], "Description": "Client1" } ], "Tags": [ { "Key": "B", "Value": "bb" }, { "Key": "C", "Value": "cc" }, { "Key": "D", "Value": "dd" }, { "Key": "E", "Value": "ee" } ] } Security Group | Create (Review Required) Create a security group, and optionally associate it with AWS resources. Full classification: Deployment | Advanced stack components | Security group | Create (review required) Change Type Details Change type ID ct-1oxx2g2d7hc90 Current version 2.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Create security group (review required) Creating a Security Group (review required) with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 398 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Advanced Stack Components Version April 22, 2025 399 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Security Group (review required) with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 400 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws --profile saml amscm create-rfc --change-type-id "ct-1oxx2g2d7hc90" --change-type- version "2.0" --title "Test-SG-RR" --execution-parameters "{\"Description\":\"Test- SG-RR\", \"Name\":\"Test-SG-IC\", \"InboundRules\":{\"Protocol\":\"TCP\", \"PortRange \":\"49152-65535\, \"Source\":\"203.0.113.5/32\"}, \"OutboundRules\":{\"Protocol\": \"TCP\", \"PortRange\":\"49152-65535\, \"Destination\":\"203.0.113.5/32\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateSgRrParams.json. aws amscm get-change-type-version --change-type-id "ct-1oxx2g2d7hc90" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateSgRrParams.json 2. Modify and save the CreateSgRrParams file. |
ams-ct-113 | ams-ct.pdf | 113 | inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 400 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws --profile saml amscm create-rfc --change-type-id "ct-1oxx2g2d7hc90" --change-type- version "2.0" --title "Test-SG-RR" --execution-parameters "{\"Description\":\"Test- SG-RR\", \"Name\":\"Test-SG-IC\", \"InboundRules\":{\"Protocol\":\"TCP\", \"PortRange \":\"49152-65535\, \"Source\":\"203.0.113.5/32\"}, \"OutboundRules\":{\"Protocol\": \"TCP\", \"PortRange\":\"49152-65535\, \"Destination\":\"203.0.113.5/32\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateSgRrParams.json. aws amscm get-change-type-version --change-type-id "ct-1oxx2g2d7hc90" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateSgRrParams.json 2. Modify and save the CreateSgRrParams file. For example, you can replace the contents with something like this: { "Description": "SG-Create-With-Review", "Name": "My-SG", "VpcId": "vpc-12345abc", "InboundRules": { "Protocol": "TRAFFIC_PROTOCOL", "PortRange": "PORT_RANGE", "Source": "TRAFFIC_SOURCE" }, "OutboundRules": { "Protocol": "TRAFFIC_PROTOCOL", "PortRange": "PORT_RANGE", "Destination": "TRAFFIC_DESTINATION" } } 3. Output the RFC template JSON file to a file named CreateSgRrRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateSgRrRfc.json 4. Modify and save the CreateSgRrRfc.json file. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 401 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-1oxx2g2d7hc90", "Title": "SG-Create-RR-RFC" } 5. Create the RFC, specifying the CreateSgRrRfc file and the CreateSgRrParams file: aws amscm create-rfc --cli-input-json file://CreateSgRrRfc.json --execution- parameters file://CreateSgRrParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note There is an automated change type for creating a security group, Deployment | Advanced stack components | Security group | Create (no review required) (ct-3pc215bnwb6p7) that provides options for TCP and ICMP ingress and egress rules. If those rules are adequate, the Create (auto) change type will execute more quickly than this change type. For details, see Security Group | Create. Note Once the security group is created, use Security Group | Associate to associate the security group with your AMS resources. In order to delete a security group, it must have associated resources. Note Outbound rules are not required; however, if they are not specified, then a "127.0.0.1/32 Blackhole Rule" is used, meaning that the resource will only be able to communicate to itself and not with other resources. You can see this default outbound rule when using the AMS console, but not when using the AMS API/CLI. Advanced Stack Components Version April 22, 2025 402 AMS Advanced Change Type Reference AMS Advanced Change Type Details This is a "review required" change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a "review required" change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. To learn more about AWS security groups and creating security groups, see Security Group Rules Reference; this page can help you determine the rules you want and, importantly, how to name your security group so choosing it when creating other resources is intuitive. Also see Amazon EC2 Security Groups for Linux Instances and/or Security Groups for Your VPC. To better understand general AWS security, see Best Practices for Security, Identity, & Compliance. Once the security group is created, use Security Group | Associate to associate the security group with your AMS resources. In order to delete a security group, it must have associated resources. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1oxx2g2d7hc90. Example: Required Parameters { "VpcId": "vpc-12345abc", "Name": "app1-webserver", "Description": "App1 group", "InboundRules": [], "OutboundRules": [] } Example: All Parameters { "VpcId": "vpc-1234abcd", "Name": "app1-webserver", "Description": "App1 group", "AssociatedResources": [ "i-1234abcd", "i-234abcd1", "i-34abcd12", "i-4abcd123", Advanced Stack Components Version April 22, 2025 403 AMS Advanced Change Type Reference AMS Advanced Change Type Details "i-abcd1234", "i-1234567890abcdefg", "i-234567890abcdefg1", "i-34567890abcdefg12", "i-4567890abcdefg123", "i-567890abcdefg1234" ], "InboundRules": [ { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", |
ams-ct-114 | ams-ct.pdf | 114 | "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, Advanced Stack Components Version April 22, 2025 404 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, Advanced Stack Components Version April 22, 2025 405 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "TCP", "PortRange":"80", "Source": "192.168.0.0/16", "Description": "Client1" } ], "OutboundRules": [ { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, Advanced Stack Components Version April 22, 2025 406 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": |
ams-ct-115 | ams-ct.pdf | 115 | "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, Advanced Stack Components Version April 22, 2025 407 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" }, { "Protocol": "ALL", "PortRange": "ALL", "Destination": "192.168.0.0/16", "Description": "Client1" } ], "Priority": "Medium", "Tags": [ { "Key": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUV", "Value": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrst" }, { "Key": "B", "Value": "bb" }, { "Key": "C", "Value": "cc" }, { "Key": "D", "Value": "dd" }, Advanced Stack Components Version April 22, 2025 408 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Key": "E", "Value": "ee" }, { "Key": "F", "Value": "ff" }, { "Key": "G", "Value": "gg" }, { "Key": "H", "Value": "hh" }, { "Key": "I", "Value": "ii" }, { "Key": "J", "Value": "jj" }, { "Key": "K", "Value": "kk" }, { "Key": "L", "Value": "ll" }, { "Key": "M", "Value": "mm" }, { "Key": "N", "Value": "nn" }, { "Key": "O", "Value": "oo" }, { "Key": "P", "Value": "pp" }, { "Key": "Q", "Value": "qq" }, { "Key": "R", "Value": "rr" }, { "Key": "S", "Value": "ss" }, { "Key": "T", "Value": "tt" }, { "Key": "U", "Value": "uu" }, { "Key": "V", "Value": "vv" }, { "Key": "W", "Value": "ww" }, { "Key": "X", "Value": "xx" }, { "Key": "Y", "Value": "yy" }, { "Key": "Z", "Value": "zz" }, { "Key": "a", "Value": "aa" }, { "Key": "b", "Value": "bb" }, { "Key": "c", "Value": "cc" }, { "Key": "d", "Value": "dd" }, { "Key": "e", "Value": "ee" }, { "Key": "f", "Value": "ff" }, { "Key": "g", "Value": "gg" }, { "Key": "h", "Value": "hh" }, { "Key": "i", "Value": "ii" }, { "Key": "j", "Value": "jj" }, { "Key": "k", "Value": "kk" }, { "Key": "l", "Value": "ll" }, { "Key": "m", "Value": "mm" }, { "Key": "n", "Value": "nn" }, { "Key": "o", "Value": "oo" }, { "Key": "p", "Value": "pp" }, { "Key": "q", "Value": "qq" }, { "Key": "r", "Value": "rr" }, { "Key": "s", "Value": "ss" }, { "Key": "t", "Value": "tt" }, { "Key": "u", "Value": "uu" }, { "Key": "v", "Value": "vv" }, Advanced Stack Components Version April 22, 2025 409 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Key": "w", "Value": "ww" }, { "Key": "x", "Value": "xx" } ] } Storage Gateway | Create from Backup Start an AWS Backup service restore job to restore a Storage Gateway volume snapshot of the specified resource. Full classification: Deployment | Advanced stack components | Storage Gateway | Create from Backup Change Type Details Change type ID ct-0cupn1txog5tk Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Storage gateway, create from backup Creating a Storage Gateway from backup with the Console Screenshot of this change type, in the AMS console: Advanced Stack Components Version April 22, 2025 410 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or |
ams-ct-116 | ams-ct.pdf | 116 | AWS approval Required Customer approval Not required Execution mode Automated Additional Information Storage gateway, create from backup Creating a Storage Gateway from backup with the Console Screenshot of this change type, in the AMS console: Advanced Stack Components Version April 22, 2025 410 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Advanced Stack Components Version April 22, 2025 411 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Storage Gateway from backup with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Restoring store volumes (DiskId parameter is mandatory): Advanced Stack Components Version April 22, 2025 412 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc \ --change-type-id "ct-0cupn1txog5tk" \ --change-type-version "1.0" --title "StartRestoreJobStorageGatewayVolume for Cached Volume" \ "{\"DocumentName\":\"AWSManagedServices-StartRestoreJobStorageGatewayVolume\", \"Region\":\"us-east-1\",\"Parameters\":{\"RecoveryPointArn\":[\"arn:aws:ec2:us- east-1::snapshot/snap-0000000000000\"],\"BackupVaultName\":[\"my-vault-name\"], \"GatewayArn\":[\"arn:aws:storagegateway:us-east-1:000000000000:gateway/sgw-0000000\"], \"TargetName\":[\"myTarget\"],\"GatewayType\":[\"Cached\"]}}" Restoring cached volumes: aws amscm create-rfc \ --change-type-id "ct-0cupn1txog5tk" \ --change-type-version "1.0" --title "StartRestoreJobStorageGatewayVolume for Stored Volume" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- StartRestoreJobStorageGatewayVolume\",\"Region\":\"us-east-1\",\"Parameters\": {\"RecoveryPointArn\":[\"arn:aws:ec2:us-east-1::snapshot/snap-0000000000000\"], \"BackupVaultName\":[\"my-vault-name\"],\"GatewayArn\":[\"arn:aws:storagegateway:us- east-1:000000000000:gateway/sgw-0000000\"],\"TargetName\":[\"myTarget\"],\"GatewayType \":[\"Stored\"],\"DiskId\":[\"pci-0000:00:1c.0-nvme-1\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateStoreGatewayFromBackupParams.json: aws amscm get-change-type-version --change-type-id "ct-1h1tuxn2oxrtf" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateStoreGatewayFromBackupParams.json 2. Modify and save the CreateStoreGatewayFromBackupParams file. For restore stored volumes: { "DocumentName": "AWSManagedServices-StartRestoreJobStorageGatewayVolume", "Region": "us-east-1", "Parameters": { "RecoveryPointArn": [ "arn:aws:ec2:us-east-1::snapshot/snap-00000000000000" Advanced Stack Components Version April 22, 2025 413 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "BackupVaultName": [ "my-vault-name" ], "GatewayArn": [ "arn:aws:storagegateway:us-east-1:000000000000:gateway/sgw-0000000" ], "TargetName": [ "myTarget" ], "GatewayType": [ "Stored" ], "DiskId": [ "pci-0000:00:1c.0-nvme-1" ] } } For restore cached volumes: { "DocumentName": "AWSManagedServices-StartRestoreJobStorageGatewayVolume", "Region": "us-east-1", "Parameters": { "RecoveryPointArn": [ "arn:aws:ec2:us-east-1::snapshot/snap-000000000000" ], "BackupVaultName": [ "my-vault-name" ], "GatewayArn": [ "arn:aws:storagegateway:us-east-1:000000000000:gateway/sgw-0000000" ], "TargetName": [ "myTarget" ], "GatewayType": [ "Cached" ] } Advanced Stack Components Version April 22, 2025 |
ams-ct-117 | ams-ct.pdf | 117 | Modify and save the CreateStoreGatewayFromBackupParams file. For restore stored volumes: { "DocumentName": "AWSManagedServices-StartRestoreJobStorageGatewayVolume", "Region": "us-east-1", "Parameters": { "RecoveryPointArn": [ "arn:aws:ec2:us-east-1::snapshot/snap-00000000000000" Advanced Stack Components Version April 22, 2025 413 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "BackupVaultName": [ "my-vault-name" ], "GatewayArn": [ "arn:aws:storagegateway:us-east-1:000000000000:gateway/sgw-0000000" ], "TargetName": [ "myTarget" ], "GatewayType": [ "Stored" ], "DiskId": [ "pci-0000:00:1c.0-nvme-1" ] } } For restore cached volumes: { "DocumentName": "AWSManagedServices-StartRestoreJobStorageGatewayVolume", "Region": "us-east-1", "Parameters": { "RecoveryPointArn": [ "arn:aws:ec2:us-east-1::snapshot/snap-000000000000" ], "BackupVaultName": [ "my-vault-name" ], "GatewayArn": [ "arn:aws:storagegateway:us-east-1:000000000000:gateway/sgw-0000000" ], "TargetName": [ "myTarget" ], "GatewayType": [ "Cached" ] } Advanced Stack Components Version April 22, 2025 414 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 3. Output the RFC template to a file in your current folder; this example names it CreateStoreGatewayFromBackupRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateStoreGatewayFromBackupRfc.json 4. Modify and save the CreateStoreGatewayFromBackupRfc.json file. For example, you can replace the contents with something like this: For restore stored volumes: { "ChangeTypeId": "ct-0cupn1txog5tk", "ChangeTypeVersion": "1.0", "Title": "Testing ct-0cupn1txog5tk StartRestoreJobStorageGatewayVolume in region us-east-1 for stored volumes" } For restore cached volumes: { "ChangeTypeId": "ct-0cupn1txog5tk", "ChangeTypeVersion": "1.0", "Title": "Testing ct-0cupn1txog5tk StartRestoreJobStorageGatewayVolume in region us-east-1 for cached volumes" } 5. Create the RFC, specifying the CreateStoreGatewayFromBackupRfc file and the CreateStoreGatewayFromBackupParams file: aws amscm create-rfc --cli-input-json file://CreateStoreGatewayFromBackupRfc.json --execution-parameters file://CreateStoreGatewayFromBackupParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Advanced Stack Components Version April 22, 2025 415 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0cupn1txog5tk. Example: Required Parameters { "DocumentName": "AWSManagedServices-StartRestoreJobStorageGatewayVolume", "Region": "us-east-1", "Parameters": { "RecoveryPointArn": [ "arn:aws:ec2:us-east-1::snapshot/snap-00000000000000000" ], "BackupVaultName": [ "Vault01" ], "GatewayArn": [ "arn:aws:storagegateway:us-east-1:000000000000:gateway/sgw-0000000" ], "TargetName": [ "mytarget" ], "GatewayType": [ "Cached" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-StartRestoreJobStorageGatewayVolume", "Region": "us-east-1", "Parameters": { "RecoveryPointArn": [ "arn:aws:ec2:us-east-1::snapshot/snap-00000000000000000" ], "BackupVaultName": [ "Vault01" ], Advanced Stack Components Version April 22, 2025 416 AMS Advanced Change Type Reference "GatewayArn": [ AMS Advanced Change Type Details "arn:aws:storagegateway:us-east-1:000000000000:gateway/sgw-0000000" ], "TargetName": [ "mytarget" ], "GatewayType": [ "Cached" ], "DiskId": [ "pci-0000:00:1c.0" ], "VolumeSize": [ "0" ], "IamRoleArn": [ "arn:aws:iam::123456789012:role/my_role" ], "KmsKeyArn": [ "arn:aws:kms:us-east-1:000000000000:key/00000000-0000-0000-0000-000000000000" ] } } Tag | Create Add tags to existing, supported resources: Autoscaling, EC2, Elastic Load Balancing, RDS, S3 buckets and Redshift clusters. Additionally, CloudWatch LogGroups that do not belong to a CloudFormation stack are supported. AMS infrastructure stacks (stacks named mc-*) cannot have tags added with this change type. Full classification: Deployment | Advanced stack components | Tag | Create Change Type Details Change type ID ct-3cx7we852p3af Current version 1.0 Expected execution duration 60 minutes AWS approval Required Advanced Stack Components Version April 22, 2025 417 AMS Advanced Change Type Reference AMS Advanced Change Type Details Customer approval Not required Execution mode Automated Additional Information Create tags Creating tags with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. Advanced Stack Components Version April 22, 2025 418 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run |
ams-ct-118 | ams-ct.pdf | 118 | page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating tags with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status Advanced Stack Components Version April 22, 2025 419 AMS Advanced Change Type Reference AMS Advanced Change Type Details changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-3cx7we852p3af" --change-type-version "1.0" --title "Create Tags" --execution-parameters --execution-parameters '{"DocumentName":"AWSManagedServices-UpdateTags","Region":"us-east-1","Parameters": {"ResourceArns":["i-1234567890abcdef0","vol-1234567890abcdef0","arn:aws:rds:us- east-1:123456789012:db/my-db-instance"],"AddOrUpdateTags":["{\"Key\":\"Name\",\"Value \":\"App1\"}","{\"Key\":\"Owner\",\"Value\":\"Dev\"}"]}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema to a file in your current folder. This example names it TagCreateAutoParams.json. aws amscm create-rfc --generate-cli-skeleton > TagCreateAutoParams.json 2. Modify and save the TagCreateAutoParams.json file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-UpdateTags", "Region": "us-east-1", "Parameters": { "ResourceArns": [ "i-1234567890abcdef0", "vol-1234567890abcdef0", "arn:aws:rds:us-east-1:123456789012:db/my-db-instance" ], "AddOrUpdateTags": [ "{\"Key\":\"Name\",\"Value\":\"App1\"}", "{\"Key\":\"Owner\",\"Value\":\"Dev\"}" Advanced Stack Components Version April 22, 2025 420 AMS Advanced Change Type Reference AMS Advanced Change Type Details ] } } 3. Output the RFC template JSON file to a file; this example names it TagCreateAutoRfc.json: aws amscm create-rfc --generate-cli-skeleton > TagCreateAutoRfc.json 4. Modify and save the TagCreateAutoRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3cx7we852p3af", "Title": "TagCreateAutoRfc" } 5. Create the RFC: aws amscm create-rfc --cli-input-json file://TagCreateAutoRfc.json --execution- parameters file://TagCreateAutoParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note AMS infrastructure stacks (stacks named mc-*) cannot have tags added with this change type. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3cx7we852p3af. Advanced Stack Components Version April 22, 2025 421 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-UpdateTags", "Region": "us-east-1", "Parameters": { "ResourceArns": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0", "arn:aws:ec2:us-east-1:123456789012:volume/vol-1234567890abcdef0", "snap-1234567890abcdef0", "arn:aws:rds:us-east-1:123456789012:db/my-db-instance", "arn:aws:redshift:us-east-1:123456789012:cluster:my-cluster", "arn:aws:logs:ap-southeast-2:123456789012:log-group:my-log-group:*" ], "AddOrUpdateTags": [ "{\"Key\":\"k1\",\"Value\":\"v1\"}", "{\"Key\":\"k2\",\"Value\":\"v2\"}", "{\"Key\":\"aws-migration-project-id\",\"Value\":\"project-id\"}" ] } } Tag | Create (Review Required) Add tags to existing, supported resources except those in AMS infrastructure stacks (stacks named mc-*). Tags simplify categorization, identification and targeting AWS resources. For Autoscaling, EC2, Elastic Load Balancing, RDS resources and S3 buckets, use the automated CT ct-3cx7we852p3af. Full classification: Deployment | Advanced stack components | Tag | Create (review required) Change Type Details Change type ID ct-0176f0n99vcps Current version 2.0 Advanced Stack Components Version April 22, 2025 422 AMS Advanced Change Type Reference AMS Advanced Change Type Details Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Create tags (review required) Creating tags (review required) with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) |
ams-ct-119 | ams-ct.pdf | 119 | ct-0176f0n99vcps Current version 2.0 Advanced Stack Components Version April 22, 2025 422 AMS Advanced Change Type Reference AMS Advanced Change Type Details Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Create tags (review required) Creating tags (review required) with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. Advanced Stack Components Version April 22, 2025 423 AMS Advanced Change Type Reference AMS Advanced Change Type Details To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating tags (review required) with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Advanced Stack Components Version April 22, 2025 424 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --title create-tag --change-type-id ct-0176f0n99vcps -- change-type-version 2.0 --execution-parameters '{"Resources":[{"ResourceArn":"i- abcd1234","AddOrUpdateTags":[{"Key":"Name","Value":"app-instance-1"}, {"Key":"Owner","Value":"Dep A"}]},{"ResourceArn":"arn:aws:ec2:ap- southeast-2:123456789012:instance/i-019714a96c22f5452","AddOrUpdateTags": [{"Key":"Name","Value":"app-instance-2"},{"Key":"Owner","Value":"Dep A"}]}]}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema to a file in your current folder. This example names it TagCreateParams.json. aws amscm create-rfc --generate-cli-skeleton > TagCreateParams.json 2. Modify and save the TagCreateParams.json file. For example, you can replace the contents with something like this: { "Resources": [ { "ResourceArn": "i-abcd1234", "AddOrUpdateTags": [ { "Key": "Name", Advanced Stack Components Version April 22, 2025 425 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Value": "app-instance-1" }, { "Key": "Owner", "Value": "Dep A" } ] }, { "ResourceArn": "arn:aws:ec2:ap-southeast-2:123456789012:instance/ i-1234567890abcdef1", "AddOrUpdateTags": [ { "Key": "Name", "Value": "app-instance-2" }, { "Key": "Owner", "Value": "Dep A" } ] } ] } 3. Output the RFC template JSON file to a file; this example names it TagCreateRfc.json: aws amscm create-rfc --generate-cli-skeleton > TagCreateRfc.json 4. Modify and save the TagCreateRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-0176f0n99vcps", "Title": "TagCreateRfc" } 5. Create the RFC: aws |
ams-ct-120 | ams-ct.pdf | 120 | 22, 2025 425 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Value": "app-instance-1" }, { "Key": "Owner", "Value": "Dep A" } ] }, { "ResourceArn": "arn:aws:ec2:ap-southeast-2:123456789012:instance/ i-1234567890abcdef1", "AddOrUpdateTags": [ { "Key": "Name", "Value": "app-instance-2" }, { "Key": "Owner", "Value": "Dep A" } ] } ] } 3. Output the RFC template JSON file to a file; this example names it TagCreateRfc.json: aws amscm create-rfc --generate-cli-skeleton > TagCreateRfc.json 4. Modify and save the TagCreateRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-0176f0n99vcps", "Title": "TagCreateRfc" } 5. Create the RFC: aws amscm create-rfc --cli-input-json file://TagCreateRfc.json --execution- parameters file://TagCreateParams.json Advanced Stack Components Version April 22, 2025 426 AMS Advanced Change Type Reference AMS Advanced Change Type Details You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0176f0n99vcps. Example: Required Parameters Example not available. Example: All Parameters { "Resources": [ { "ResourceArn": "arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0", "AddOrUpdateTags": [ { "Key": "k1", "Value": "v1" }, { "Key": "k2", "Value": "v2" }, { "Key": "k3", "Value": "v3" } ] }, { "ResourceArn": "i-0fedcba0987654321", "AddOrUpdateTags": [ { "Key": "k1", "Value": "v1" Advanced Stack Components Version April 22, 2025 427 AMS Advanced Change Type Reference AMS Advanced Change Type Details }, { "Key": "k2", "Value": "v2" }, { "Key": "k3", "Value": "v3" } ] } ], "Priority": "Medium" } Target Group | Create (For ALB) Use to create a target group for an Application Load Balancer. Full classification: Deployment | Advanced stack components | Target Group | Create (for ALB) Change Type Details Change type ID ct-1r19m51jeijlk Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create ALB target group Creating a Target Group for an Application Load Balancer with the Console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 428 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. Advanced Stack Components Version April 22, 2025 429 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Target Group for an Application Load Balancer with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this |
ams-ct-121 | ams-ct.pdf | 121 | Creating a Target Group for an Application Load Balancer with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 430 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Version 1.0: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-1r19m51jeijlk" --change-type-version "1.0" --title "TITLE" --execution-parameters "{\"Description\":\"TargetGroup-ALB\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\": \"stm-9c1t8maqho0os5k21\", \"Name\":\"TG-ALB\", \"TimeoutInMinutes\":60, \"Parameters \": {\"InstancePort\":\"80\",\"InstanceProtocol\":\"HTTP\"}}" Version 2.0: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-1r19m51jeijlk" --change-type-version "2.0" --title "TITLE" --execution-parameters "{\"Description\":\"TargetGroup-ALB\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\": \"stm-9c1t8maqho0os5k22\", \"Name\":\"TG-ALB\", \"TimeoutInMinutes\":60, \"Parameters \": {\"ApplicationLoadBalancerArn\":\"ARN\",\"InstancePort\":\"80\",\"InstanceProtocol \":\"HTTP\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateTgAlbParams.json. aws amscm get-change-type-version --change-type-id "ct-1r19m51jeijlk" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateTgAlbParams.json 2. Modify and save the CreateTgAlbParams file. For example, you can replace the contents with something like this: Version 1.0: { "Description": "Target-Group-ALB-Create", "VpcId": "VPC_ID", "StackTemplateId": "stm-9c1t8maqho0os5k21", "Name": "My-ALB-Target-Group", "Parameters": { "LoadBalancerArn": ARN, Advanced Stack Components Version April 22, 2025 431 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DefaultActionTargetGroupArn": ARN, "Port": PORT, "Protocol": Protocol" } } Version 2.0: { "Description": "Target-Group-ALB-Create", "VpcId": "VPC_ID", "StackTemplateId": "stm-9c1t8maqho0os5k22", "Name": "My-ALB-Target-Group", "Parameters": { "ApplicationLoadBalancerArn": ARN, "InstancePort": PORT, "InstanceProtocol": Protocol" } } 3. Output the RFC template to a file in your current folder named CreateTgAlbRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateTgAlbRfc.json 4. Modify and save the CreateTgAlbRfc.json file. For example, you can replace the contents with something like this: Version 1.0: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1r19m51jeijlk", "Title": "Target-Group-ALB-Create-RFC" } Version 2.0: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-1r19m51jeijlk", "Title": "Target-Group-ALB-Create-RFC" Advanced Stack Components Version April 22, 2025 432 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 5. Create the RFC, specifying the CreateTgAlbRfc file and the CreateTgAlbParams file: aws amscm create-rfc --cli-input-json file://CreateTgAlbRfc.json --execution- parameters file://CreateTgAlbParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Next, create a listener for the Application Load Balancer. For more information,see ALB listeners. To open ports and associate security groups, submit a Management | Other | Other | Update change type. For more information, see Other | Other requests. Tips Note The 2.0 version of this change type uses a different StackTemplateId (stm-9c1t8maqho0os5k22) from the 1.0 version. This is important if you are submitting the RFC with this change type version at the command line. The new version includes a new, required, parameter: ApplicationLoadBalancer. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1r19m51jeijlk. Example: Required Parameters { "Description": "Test description.", "VpcId": "vpc-1234567890abcdef0", "Name": "MyRFCName", "StackTemplateId": "stm-9c1t8maqho0os5k22", "TimeoutInMinutes": 60, "Parameters": { "InstancePort": "80", "InstanceProtocol": "HTTP", Advanced Stack Components Version April 22, 2025 433 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ApplicationLoadBalancerArn": "arn:aws:elasticloadbalancing:us- west-2:123456789012:loadbalancer/app/my-app-load-balancer/abcdefghij" } } Example: All Parameters { "Description": "Test description.", "VpcId": "vpc-1234567890abcdef0", "Name": "MyRFCName", "StackTemplateId": "stm-9c1t8maqho0os5k22", "TimeoutInMinutes": 60, "Parameters": { "ApplicationLoadBalancerArn": "arn:aws:elasticloadbalancing:us- west-2:123456789012:loadbalancer/app/my-app-load-balancer/abcdefghij", "HealthCheckHealthyThreshold": "5", "HealthCheckUnhealthyThreshold": "3", "HealthCheckInterval": 30, "HealthCheckTimeout": "10", "HealthCheckTargetPath": "/healthcheck", "HealthCheckTargetPort": "80", "HealthCheckTargetProtocol": "HTTP", "ValidHTTPCode": "200-259", "InstancePort": "80", "Name": "mytargetgroup", "InstanceProtocol": "HTTP", "DeregistrationDelayTimeout": "300", "SlowStartDuration": "60", "StickinessCookieExpirationPeriod": "3600", "TargetType": "ip", "Target1ID": "192.168.0.1", "Target1Port": "80", "Target1AvailabilityZone": "all", "Target2ID": "192.168.0.2", "Target2Port": "80", "Target2AvailabilityZone": "all", "Target3ID": "10.44.4.125", "Target3Port": "8080", "Target3AvailabilityZone": "", "Target4ID": "10.44.4.126", "Target4Port": "8080", "Target4AvailabilityZone": "", Advanced Stack Components Version April 22, 2025 434 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Target5ID": "192.168.0.127", "Target5Port": "80", "Target5AvailabilityZone": "all", "Target6ID": "192.168.0.128", "Target6Port": "80", "Target6AvailabilityZone": "all", "Target7ID": "10.44.4.129", "Target7Port": "8080", "Target7AvailabilityZone": "", "Target8ID": "10.44.4.130", "Target8Port": "8080", "Target8AvailabilityZone": "" } } Target Group | Create (For NLB) Use to create a |
ams-ct-122 | ams-ct.pdf | 122 | "HealthCheckTargetPath": "/healthcheck", "HealthCheckTargetPort": "80", "HealthCheckTargetProtocol": "HTTP", "ValidHTTPCode": "200-259", "InstancePort": "80", "Name": "mytargetgroup", "InstanceProtocol": "HTTP", "DeregistrationDelayTimeout": "300", "SlowStartDuration": "60", "StickinessCookieExpirationPeriod": "3600", "TargetType": "ip", "Target1ID": "192.168.0.1", "Target1Port": "80", "Target1AvailabilityZone": "all", "Target2ID": "192.168.0.2", "Target2Port": "80", "Target2AvailabilityZone": "all", "Target3ID": "10.44.4.125", "Target3Port": "8080", "Target3AvailabilityZone": "", "Target4ID": "10.44.4.126", "Target4Port": "8080", "Target4AvailabilityZone": "", Advanced Stack Components Version April 22, 2025 434 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Target5ID": "192.168.0.127", "Target5Port": "80", "Target5AvailabilityZone": "all", "Target6ID": "192.168.0.128", "Target6Port": "80", "Target6AvailabilityZone": "all", "Target7ID": "10.44.4.129", "Target7Port": "8080", "Target7AvailabilityZone": "", "Target8ID": "10.44.4.130", "Target8Port": "8080", "Target8AvailabilityZone": "" } } Target Group | Create (For NLB) Use to create a target group for a Network Load Balancer. Full classification: Deployment | Advanced stack components | Target Group | Create (for NLB) Change Type Details Change type ID ct-3t4lifos8tu58 Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create NLB target group Creating a Target Group for a Network Load Balancer with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 435 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. Advanced Stack Components Version April 22, 2025 436 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Target Group for a Network Load Balancer with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 437 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Version 1.0: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-3t4lifos8tu58" --change-type-version "1.0" --title "TITLE" --execution-parameters "{\"Description\":\"TargetGroup-NLB\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\": \"stm-6pvp2f7cp481g1r46\", \"Name\":\"TG-NLB\", \"TimeoutInMinutes\":60, \"Parameters \": {\"InstancePort\":\"80\",\"InstanceProtocol\":\"HTTP\"}}" Version 2.0: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-3t4lifos8tu58" --change-type-version "2.0" --title "TITLE" --execution-parameters "{\"Description\":\"TargetGroup-NLB\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\": |
ams-ct-123 | ams-ct.pdf | 123 | INLINE CREATE: Advanced Stack Components Version April 22, 2025 437 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Version 1.0: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-3t4lifos8tu58" --change-type-version "1.0" --title "TITLE" --execution-parameters "{\"Description\":\"TargetGroup-NLB\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\": \"stm-6pvp2f7cp481g1r46\", \"Name\":\"TG-NLB\", \"TimeoutInMinutes\":60, \"Parameters \": {\"InstancePort\":\"80\",\"InstanceProtocol\":\"HTTP\"}}" Version 2.0: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-3t4lifos8tu58" --change-type-version "2.0" --title "TITLE" --execution-parameters "{\"Description\":\"TargetGroup-NLB\", \"VpcId\":\"VPC_ID\", \"StackTemplateId\": \"stm-6pvp2f7cp481g1r47\", \"Name\":\"TG-NLB\", \"TimeoutInMinutes\":60, \"Parameters \": {\"NetworkLoadBalancerArn\":\"ARN\",\"InstancePort\":\"80\",\"InstanceProtocol\": \"HTTP\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateTGNlbParams.json. aws amscm get-change-type-version --change-type-id "ct-3t4lifos8tu58" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateTGNlbParams.json 2. Modify and save the CreateTGNlbParams file. For example, you can replace the contents with something like this: Version 1.0: { "Description": "Target-Group-NLB-Create", "VpcId": "VPC_ID", "StackTemplateId": "stm-6pvp2f7cp481g1r46", "Name": "My-NLB-Target-Group", "Parameters": { Advanced Stack Components Version April 22, 2025 438 AMS Advanced Change Type Reference AMS Advanced Change Type Details "InstancePort": PORT } } Version 2.0: { "Description": "Target-Group-NLB-Create", "VpcId": "VPC_ID", "StackTemplateId": "stm-6pvp2f7cp481g1r47", "Name": "My-NLB-Target-Group", "Parameters": { "NetworkLoadBalancerArn": ARN, "InstancePort": PORT } } 3. Output the RFC template to a file in your current folder named CreateTgNlbRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateTgNlbRfc.json 4. Modify and save the CreateTgNlbRfc.json file. For example, you can replace the contents with something like this: Version 1.0: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3t4lifos8tu58", "Title": "Target-Group-NLB-Create-RFC" } Version 2.0: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-3t4lifos8tu58", "Title": "Target-Group-NLB-Create-RFC" } 5. Create the RFC, specifying the CreateTgNlbRfc file and the CreateTgNlbParams file: Advanced Stack Components Version April 22, 2025 439 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://CreateTgNlbRfc.json --execution- parameters file://CreateTgNlbParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Next Steps: Create a listener for the NLB, see NLB listeners. To open ports and associate security groups, submit a Management | Other | Other | Update change type. For more information, see Other | Other requests. Tips Important There is a new version of this change type, v2.0, that uses a different StackTemplateId (stm-6pvp2f7cp481g1r47). This is important if you are submitting the RFC with this change type at the command line. The new version includes a new, required, parameter: NetworkLoadBalancer. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3t4lifos8tu58. Example: Required Parameters { "Description": "Test description.", "VpcId": "vpc-1234567890abcdef0", "Name": "MyRFCName", "StackTemplateId": "stm-6pvp2f7cp481g1r47", "TimeoutInMinutes": 60, "Parameters": { "InstancePort": "80", "NetworkLoadBalancerArn": "arn:aws:elasticloadbalancing:us- west-2:123456789012:loadbalancer/net/my-nlb/abcdefghij" } } Advanced Stack Components Version April 22, 2025 440 AMS Advanced Change Type Details AMS Advanced Change Type Reference Example: All Parameters { "Description": "Test description.", "VpcId": "vpc-1234567890abcdef0", "Name": "MyRFCName", "StackTemplateId": "stm-6pvp2f7cp481g1r47", "TimeoutInMinutes": 60, "Parameters": { "NetworkLoadBalancerArn": "arn:aws:elasticloadbalancing:us- west-2:123456789012:loadbalancer/net/my-nlb/abcdefghij", "HealthCheckHealthyThreshold": "5", "HealthCheckInterval": 30, "HealthCheckTargetPath": "/healthcheck", "HealthCheckTargetPort": "80", "HealthCheckTargetProtocol": "HTTP", "InstancePort": "80", "Name": "mytargetgroup", "ProxyProtocolV2": "true", "DeregistrationDelayTimeout": "300", "TargetType": "ip", "Target1ID": "192.168.0.1", "Target1Port": "80", "Target1AvailabilityZone": "all", "Target2ID": "192.168.0.2", "Target2Port": "80", "Target2AvailabilityZone": "all", "Target3ID": "10.44.4.125", "Target3Port": "8080", "Target3AvailabilityZone": "", "Target4ID": "10.44.4.126", "Target4Port": "8080", "Target4AvailabilityZone": "", "Target5ID": "192.168.0.127", "Target5Port": "80", "Target5AvailabilityZone": "all", "Target6ID": "192.168.0.128", "Target6Port": "80", "Target6AvailabilityZone": "all", "Target7ID": "192.168.0.129", "Target7Port": "8080", "Target7AvailabilityZone": "", "Target8ID": "192.168.0.130", "Target8Port": "8080", Advanced Stack Components Version April 22, 2025 441 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Target8AvailabilityZone": "" } } VPC | Add Static Route (Review Required) Create a static route on your route table inside a VPC. Full classification: Deployment | Advanced stack components | VPC | Add static route (review required) Change Type Details Change type ID ct-06bwg93ukgg8t Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Add VPC static route (review required) Add a static route with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 442 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card |
ams-ct-124 | ams-ct.pdf | 124 | to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. Advanced Stack Components Version April 22, 2025 443 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Adding a static route with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 444 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline) and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --title="Add Static Route" --description="Add static route" --ct-id="ct-06bwg93ukgg8t" --ct-version="1.0" --input-params="{\"RouteTableId \":\"rtb-0123abcd\",\"DestinationCidrBlock\":\"172.31.0.0/16\",\"Target\": \"pcx-0123456789abcdefg\",\"Priority\":\"High\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type; this example names it EncryptAmiParams.json: aws amscm get-change-type-version --change-type-id "ct-06bwg93ukgg8t" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AddStaticRouteParams.json 2. Modify and save the execution AddStaticRouteParams.json file. For example, you can replace the contents with something like this: { "RouteTableId": "rtb-0123abcd", "DestinationCidrBlock": "172.31.0.0/16", "Target": "pcx-0123456789abcdefg", "Priority": "High" } 3. Output the RFC template JSON file; this example names it AddStaticRouteRfc.json: aws amscm create-rfc --generate-cli-skeleton > AddStaticRouteRfc.json 4. Modify and save the AddStaticRouteRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-06bwg93ukgg8t", "Title": "Add static route" } 5. Create the RFC, specifying the AddStaticRouteRfc file and the AddStaticRouteParams file: Advanced Stack Components Version April 22, 2025 445 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://AddStaticRouteRfc.json --execution- parameters file://AddStaticRouteParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For information about VPCs, see Virtual private clouds (VPC). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-06bwg93ukgg8t. Example: Required Parameters { "RouteTableId": "rtb-01234567890abcdef", "Destination": "192.168.10.0/24", "RouteTableTarget": "igw-01234567890abcdef" } Example: All Parameters { "RouteTableId": "rtb-01234567890abcdef", "Destination": "192.168.10.0/24", "RouteTableTarget": "igw-01234567890abcdef", "Priority": "High" } VPC Endpoint |
ams-ct-125 | ams-ct.pdf | 125 | Change Type Details aws amscm create-rfc --cli-input-json file://AddStaticRouteRfc.json --execution- parameters file://AddStaticRouteParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For information about VPCs, see Virtual private clouds (VPC). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-06bwg93ukgg8t. Example: Required Parameters { "RouteTableId": "rtb-01234567890abcdef", "Destination": "192.168.10.0/24", "RouteTableTarget": "igw-01234567890abcdef" } Example: All Parameters { "RouteTableId": "rtb-01234567890abcdef", "Destination": "192.168.10.0/24", "RouteTableTarget": "igw-01234567890abcdef", "Priority": "High" } VPC Endpoint (Interface) | Create Create an interface VPC endpoint, which allows you to connect to services powered by AWS PrivateLink, including many AWS services. Full classification: Deployment | Advanced stack components | VPC endpoint (interface) | Create Advanced Stack Components Version April 22, 2025 446 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-3oafsdbzjtuqp Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create VPC endpoint Creating a VPC endpoint with the console The following shows this change type in the AMS console. How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. Advanced Stack Components Version April 22, 2025 447 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a VPC endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: Advanced Stack Components Version April 22, 2025 448 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline) and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-3oafsdbzjtuqp" --change-type-version "1.0" --title "Create VPC Endpoint" --execution-parameters "{\"Description\":\"VPC endpoint interface\",\"VpcId\":\"vpc-1234567890abcdef0\",\"Name\":\"VPC endpoint interface\",\"StackTemplateId\":\"stm-f0cumpt1rfc1p1739\",\"TimeoutInMinutes \":60,\"Parameters\":{\"VpcId\":\"vpc-1234567890abcdef0\",\"ServiceName\": \"com.amazonaws.us-east-1.codedeploy\",\"SecurityGroups\":[\"sg-1234567890abcdef0\", \"sg-1234567890abcdef1\"],\"SubnetIds\":[\"subnet-1234567890abcdef0\", \"subnet-1234567890abcdef1\"],\"EnablePrivateDns\":\"false\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type; this example names it VPCEndpointCreateParams.json: |
ams-ct-126 | ams-ct.pdf | 126 | parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline) and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-3oafsdbzjtuqp" --change-type-version "1.0" --title "Create VPC Endpoint" --execution-parameters "{\"Description\":\"VPC endpoint interface\",\"VpcId\":\"vpc-1234567890abcdef0\",\"Name\":\"VPC endpoint interface\",\"StackTemplateId\":\"stm-f0cumpt1rfc1p1739\",\"TimeoutInMinutes \":60,\"Parameters\":{\"VpcId\":\"vpc-1234567890abcdef0\",\"ServiceName\": \"com.amazonaws.us-east-1.codedeploy\",\"SecurityGroups\":[\"sg-1234567890abcdef0\", \"sg-1234567890abcdef1\"],\"SubnetIds\":[\"subnet-1234567890abcdef0\", \"subnet-1234567890abcdef1\"],\"EnablePrivateDns\":\"false\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type; this example names it VPCEndpointCreateParams.json: aws amscm get-change-type-version --change-type-id "ct-3oafsdbzjtuqp" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > VPCEndpointCreateParams.json 2. Modify and save the execution parameters as VPCEndpointCreateParams.json. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 449 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Description": "VPC endpoint interface", "VpcId": "vpc-1234567890abcdef0", "Name": "VPC endpoint interface", "StackTemplateId": "stm-f0cumpt1rfc1p1739", "TimeoutInMinutes": 60, "Parameters": { "VpcId": "vpc-1234567890abcdef0", "ServiceName": "com.amazonaws.us-east-1.codedeploy", "SecurityGroups": [ "sg-1234567890abcdef0", "sg-1234567890abcdef1" ], "SubnetIds": [ "subnet-1234567890abcdef0", "subnet-1234567890abcdef1" ], "EnablePrivateDns": "false" } } 3. Output the RFC template JSON file; this example names it VPCEndpointCreateRfc.json: aws amscm create-rfc --generate-cli-skeleton > VPCEndpointCreateRfc.json 4. Modify and save the VPNGatewayCreateRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion" : "1.0", "ChangeTypeId" : "ct-3oafsdbzjtuqp", "Title" : "Create VPC Endpoint " } 5. Create the RFC, specifying the VPCEndpointCreateRfc file and the VPCEndpointCreateParams file: aws amscm create-rfc --cli-input-json file://VPCEndpointCreateRfc.json -- execution-parameters file://VPCEndpointCreateParams.json Advanced Stack Components Version April 22, 2025 450 AMS Advanced Change Type Reference AMS Advanced Change Type Details You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3oafsdbzjtuqp. Example: Required Parameters { "Description": "Test description", "VpcId": "vpc-12345678901234567", "Name": "TestStack", "StackTemplateId": "stm-f0cumpt1rfc1p1739", "TimeoutInMinutes": 60, "Parameters": { "VpcId": "vpc-a388bbc4", "ServiceName": "com.amazonaws.ap-southeast-2.execute-api", "SecurityGroups": [ "sg-94bdebea", "sg-007442bef5c5badff" ], "SubnetIds": [ "subnet-5b706a3c", "subnet-c9809480" ] } } Example: All Parameters { "Description": "Test description", "VpcId": "vpc-12345678", "Name": "TestStack", "Tags": [ { "Key": "foo", Advanced Stack Components Version April 22, 2025 451 AMS Advanced Change Type Reference "Value": "bar" } ], "StackTemplateId": "stm-f0cumpt1rfc1p1739", "TimeoutInMinutes": 60, "Parameters": { "VpcId": "vpc-a388bbc4", "ServiceName": "com.amazonaws.ap-southeast-2.execute-api", AMS Advanced Change Type Details "SecurityGroups": [ "sg-94bdebea", "sg-007442be" ], "SubnetIds": [ "subnet-5b706a3c", "subnet-c9809480" ], "EnablePrivateDns": "true" } } VPN Gateway | Create Create a virtual private network (VPN) gateway (the endpoint on the VPC side of your VPN connection), and associate it to an existing virtual private cloud (VPC) in your account. Full classification: Deployment | Advanced stack components | VPN Gateway | Create Change Type Details Change type ID ct-0qbikxr9okwvy Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 452 AMS Advanced Change Type Reference Additional Information Create VPN gateway Creating a VPN gateway with the console The following shows this change type in the AMS console. AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 453 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration |
ams-ct-127 | ams-ct.pdf | 127 | Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 453 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a VPN gateway with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 454 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline) and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --title create-rds-db-instance-point-in-time- restore --change-type-id ct-0qbikxr9okwvy --change-type-version 1.0 --execution-parameters '{"Description": "test","VpcId": "vpc-317a9856","Name": "newvpngateway","StackTemplateId": "stm- mcti3bha1vhon1sie","TimeoutInMinutes": 60,"Parameters": {"VpcId": "vpc-317a9856","AmazonSideAsn": 64512,"Name": "test"}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type; this example names it EncryptAmiParams.json: aws amscm get-change-type-version --change-type-id "ct-0qbikxr9okwvy" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > VPNGatewayCreateParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "Description": "test", "VpcId": "vpc-317a9856", "Name": "newvpngateway", "StackTemplateId": "stm-mcti3bha1vhon1sie", "TimeoutInMinutes": 60, "Parameters": { "VpcId": "vpc-317a9856", "AmazonSideAsn": 64512, "Name": "test" } } 3. Output the RFC template JSON file; this example names it VPNGatewayCreateRfc.json: aws amscm create-rfc --generate-cli-skeleton > VPNGatewayCreateRfc.json Advanced Stack Components Version April 22, 2025 455 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the VPNGatewayCreateRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion" : "1.0", "ChangeTypeId" : "ct-0qbikxr9okwvy", "Title" : "VPNGateway Create" } 5. Create the RFC, specifying the VPNGatewayCreateRfc file and the VPNGatewayCreateParams file: aws amscm create-rfc --cli-input-json file://VPNGatewayCreateRfc.json --execution- parameters file://VPNGatewayCreateParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0qbikxr9okwvy. Example: Required Parameters { "Description" : "Test description", "VpcId" : "vpc-12345678901234567", "Name" : "TestStack", "StackTemplateId" : "stm-mcti3bha1vhon1sie", "TimeoutInMinutes" : 60, "Parameters" : { "VpcId" : "vpc-12345678901234567" } } Example: All Parameters { Advanced Stack Components Version April 22, 2025 456 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description" : "Test description", "VpcId" : "vpc-12345678", "Name" : "TestStack", "Tags" : [ { "Key" : "foo", "Value" : "bar" } ], "StackTemplateId" : "stm-mcti3bha1vhon1sie", "TimeoutInMinutes" : 60, "Parameters" : { "VpcId" : "vpc-12345678", "AmazonSideAsn" : 64512, "Name" : "Test-VPNGateway" } } AMS Patterns Subcategory Change Type Items and Operations in the AMS Patterns Subcategory • Solution | Deploy (Review Required) Solution | Deploy (Review Required) Deploy an AMS pattern to the current account. Patterns provide tools, architectures, and step- by-step guidance for implementing the methodologies for the migration strategy. Multi-account landing zone accounts can also specify OrganizationalUnit to deploy the pattern to all the accounts in that OU. Full classification: Deployment | AMS patterns | Solution | Deploy (review required) Change Type Details Change type |
ams-ct-128 | ams-ct.pdf | 128 | : 60, "Parameters" : { "VpcId" : "vpc-12345678", "AmazonSideAsn" : 64512, "Name" : "Test-VPNGateway" } } AMS Patterns Subcategory Change Type Items and Operations in the AMS Patterns Subcategory • Solution | Deploy (Review Required) Solution | Deploy (Review Required) Deploy an AMS pattern to the current account. Patterns provide tools, architectures, and step- by-step guidance for implementing the methodologies for the migration strategy. Multi-account landing zone accounts can also specify OrganizationalUnit to deploy the pattern to all the accounts in that OU. Full classification: Deployment | AMS patterns | Solution | Deploy (review required) Change Type Details Change type ID ct-2jndrh7uit8uf Current version 1.0 Expected execution duration 240 minutes AMS Patterns Version April 22, 2025 457 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Deploy AMS Pattern (review required) Creating an AWS KMS Key (review required) with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. AMS Patterns Version April 22, 2025 458 AMS Advanced Change Type Reference AMS Advanced Change Type Details To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an AWS KMS Key (review required) with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID AMS Patterns Version April 22, 2025 459 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline) and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2jndrh7uit8uf" --change-type-version "1.0" --title "Deploy AMS Patterns" --execution-parameters "{\"PatternName \": \"amsEbsVolumeSnapshotTagger\",\"PatternParameters\": "{\"ExcludedTags\": \"BackupProd,Backup\",\"ASMGuardRail\":\"enabled\"}", \"OrganizationalUnit\": \"ou-9dyd-s2vptest\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type; this example names it DeployAMSPatternsParams.json: aws amscm get-change-type-version --change-type-id "ct-2jndrh7uit8uf" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeployAMSPatternsParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "PatternName": "amsEbsVolumeSnapshotTagger", "Parameters": { "ExcludedTags": |
ams-ct-129 | ams-ct.pdf | 129 | (escape quotation marks when providing execution parameters inline) and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2jndrh7uit8uf" --change-type-version "1.0" --title "Deploy AMS Patterns" --execution-parameters "{\"PatternName \": \"amsEbsVolumeSnapshotTagger\",\"PatternParameters\": "{\"ExcludedTags\": \"BackupProd,Backup\",\"ASMGuardRail\":\"enabled\"}", \"OrganizationalUnit\": \"ou-9dyd-s2vptest\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type; this example names it DeployAMSPatternsParams.json: aws amscm get-change-type-version --change-type-id "ct-2jndrh7uit8uf" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeployAMSPatternsParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "PatternName": "amsEbsVolumeSnapshotTagger", "Parameters": { "ExcludedTags": "BackupProd,Backup", "ASMGuardRail": "enabled" }, AMS Patterns Version April 22, 2025 460 AMS Advanced Change Type Reference AMS Advanced Change Type Details "OrganizationalUnit": "ou-9dyd-s2vptest" } 3. Output the RFC template JSON file; this example names it DeployAMSPatternsRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeployAMSPatternsRfc.json 4. Modify and save the DeployAMSPatternsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2jndrh7uit8uf", "Title": "Deploy AMS Patterns" } 5. Create the RFC, specifying the DeployAMSPatternsRfc file and the DeployAMSPatternsParams file: aws amscm create-rfc --cli-input-json file://DeployAMSPatternsRfc.json --execution- parameters file://DeployAMSPatternsParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2jndrh7uit8uf. Example: Required Parameters { "PatternName": "amsEbsVolumeSnapshotTagger" } Example: All Parameters { "PatternName": "amsEbsVolumeSnapshotTagger", AMS Patterns Version April 22, 2025 461 AMS Advanced Change Type Reference AMS Advanced Change Type Details "OrganizationalUnitIds": ["ou-9dyd-jvsei4yg"], "Priority": "Medium", "PatternParameters": [ { "Name": "Foo", "Value": "Bar" } ] } AMS Resource Scheduler Subcategory Change Type Items and Operations in the AMS Resource Scheduler Subcategory • Solution | Deploy Solution | Deploy Deploy the AMS Resource Scheduler solution in the account. The AMS Resource Scheduler lets you schedule automatic start and/or stop for Auto Scaling groups, EC2s, and RDS instances. Note that the Resource Scheduler deploys in an enabled state, by default; you can manage that with the AMS Resource Scheduler Disable and Enable change types. Full classification: Deployment | AMS Resource Scheduler | Solution | Deploy Change Type Details Change type ID ct-0ywnhc8e5k9z5 Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated AMS Resource Scheduler Version April 22, 2025 462 AMS Advanced Change Type Reference Additional Information Deploy AMS Resource Scheduler Solution Deploying AMS Resource Scheduler solution with the console The following shows this change type in the AMS console. AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. AMS Resource Scheduler Version April 22, 2025 463 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Deploying AMS Resource Scheduler solution with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with |
ams-ct-130 | ams-ct.pdf | 130 | parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Deploying AMS Resource Scheduler solution with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. AMS Resource Scheduler Version April 22, 2025 464 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id ct-0ywnhc8e5k9z5 --change-type- version "2.0" --title "Deploy Resource Scheduler" --execution-parameters '{"DocumentName":"AWSManagedServices-HandleAMSResourceSchedulerStack- Admin","Region":"us-east-1","Parameters":{"SchedulingActive": ["Yes"],"ScheduledServices":["ec2,rds,autoscaling"],"TagName": ["Schedule"],"DefaultTimezone":["America/New_York"],"Action":["Deploy"]}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it DeployResSchedulerParams.json: aws amscm get-change-type-version --change-type-id "ct-0ywnhc8e5k9z5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeployResSchedulerParams.json 2. Modify and save the DeployResSchedulerParams file. { "DocumentName": "AWSManagedServices-HandleAMSResourceSchedulerStack-Admin", "Region": "us-east-1", "Parameters": { "SchedulingActive": [ "Yes" ], "ScheduledServices": [ "ec2,rds,autoscaling" ], "TagName": [ "Schedule" ], "DefaultTimezone": [ "America/New_York" ], "Action": [ "Deploy" AMS Resource Scheduler Version April 22, 2025 465 AMS Advanced Change Type Reference AMS Advanced Change Type Details ] } } 3. Output the RFC template to a file in your current folder; this example names it DeployResSchedulerRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeployResSchedulerRfc.json 4. Modify and save the DeployResSchedulerRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-0ywnhc8e5k9z5", "Title": "Deploy AMS Resource Scheduler" } 5. Create the RFC, specifying the DeployResSchedulerRfc file and the DeployResSchedulerParams file: aws amscm create-rfc --cli-input-json file://DeployResSchedulerRfc.json -- execution-parameters file://DeployResSchedulerParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For background information, see How the AMS Resource Scheduler works. For a quick-start tutorial, see AMS Resource Scheduler quick start. AMS Resource Scheduler is based on the AWS Instance Scheduler; to learn more, see AWS Instance Scheduler. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0ywnhc8e5k9z5. AMS Resource Scheduler Version April 22, 2025 466 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "DocumentName" : "AWSManagedServices-HandleAMSResourceSchedulerStack-Admin", "Region" : "us-east-1", "Parameters" : { "Action" : ["Deploy"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-HandleAMSResourceSchedulerStack-Admin", "Region" : "us-east-1", "Parameters" : { "SchedulingActive" : [ "Yes" ], "ScheduledServices" : [ "ec2,rds,autoscaling" ], "TagName" : [ "MySchedule" ], "DefaultTimezone" : [ "Australia/Sydney" ], "UseCMK" : [ "arn:aws:kms:ap-southeast-1:830123456789:key/07aaab3c-50d3-4cd8- ab61-3de57127dab9" ], "UseLicenseManager" : [ "arn:aws:license-manager:ap-southeast-1:830123456789:license- configuration:lic-78c1e0cfc1233a4eac7197d7ee57f92c" ], "MemorySize" : [ "512" ], "SchedulerFrequency" : [ "10" ], "Action": [ AMS Resource Scheduler Version April 22, 2025 467 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Deploy" ] } } Applications Subcategory Change Type Items and Operations in the Applications Subcategory • CodeDeploy Application | Create • CodeDeploy Application | Deploy • CodeDeploy Deployment Group | Create • CodeDeploy Deployment Group | Create (For EC2 Instance) CodeDeploy Application | Create Use to create an AWS CodeDeploy application resource with the specified name. Full classification: Deployment | Applications | CodeDeploy application | Create Change Type Details Change type ID ct-0ah3gwb9seqk2 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Applications Version April 22, 2025 468 AMS Advanced Change Type Reference Additional Information Create CodeDeploy application Creating a CodeDeploy application with the console AMS Advanced Change Type Details How |
ams-ct-131 | ams-ct.pdf | 131 | • CodeDeploy Application | Deploy • CodeDeploy Deployment Group | Create • CodeDeploy Deployment Group | Create (For EC2 Instance) CodeDeploy Application | Create Use to create an AWS CodeDeploy application resource with the specified name. Full classification: Deployment | Applications | CodeDeploy application | Create Change Type Details Change type ID ct-0ah3gwb9seqk2 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Applications Version April 22, 2025 468 AMS Advanced Change Type Reference Additional Information Create CodeDeploy application Creating a CodeDeploy application with the console AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Applications Version April 22, 2025 469 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a CodeDeploy application with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Applications Version April 22, 2025 470 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-0ah3gwb9seqk2" --change-type-version "1.0" --title "Stack-Create-CD-App" --execution-parameters "{\"Description\":\"TestCdApp\", \"VpcId\":\"VPC_ID\",\"StackTemplateId\":\"stm-sft6rv00000000000\",\"Name\":\"Test\", \"TimeoutInMinutes\":60,\"Parameters\":{\"CodeDeployApplicationName\":\"Test\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for the CodeDeploy application CT to a file in your current folder; this example names it CreateCDAppParams.json: aws amscm get-change-type-version --change-type-id "ct-0ah3gwb9seqk2" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateCDAppParams.json 2. Modify and save the JSON file as follows. For example, you can replace the contents with something like this: { "Description": "Create WP CodeDeploy App", "VpcId": "VPC_ID", "StackTemplateId": "stm-sft6rv00000000000", "Name": "WpCDApp", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "WordPressCDApp" } } 3. Output the JSON template for CreateRfc to a file in your current folder; this example names it CreateCDAppRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateCDAppRfc.json 4. Modify and save the JSON file as follows. For example, you can replace the contents with something like this: Applications Version April 22, 2025 471 AMS Advanced Change Type |
ams-ct-132 | ams-ct.pdf | 132 | "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateCDAppParams.json 2. Modify and save the JSON file as follows. For example, you can replace the contents with something like this: { "Description": "Create WP CodeDeploy App", "VpcId": "VPC_ID", "StackTemplateId": "stm-sft6rv00000000000", "Name": "WpCDApp", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "WordPressCDApp" } } 3. Output the JSON template for CreateRfc to a file in your current folder; this example names it CreateCDAppRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateCDAppRfc.json 4. Modify and save the JSON file as follows. For example, you can replace the contents with something like this: Applications Version April 22, 2025 471 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0ah3gwb9seqk2", "Title": "CD-App-Stack-RFC" } 5. Create the RFC, specifying the CreateCDAppRfc file and the execution parameters file: aws amscm create-rfc --cli-input-json file://CreateCDAppRfc.json --execution- parameters file://CreateCDAppParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS CodeDeploy, see Create an Application with AWS CodeDeploy. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0ah3gwb9seqk2. Example: Required Parameters Example not available. Example: All Parameters { "Description": "Stack Description.", "VpcId": "vpc-12345678", "StackTemplateId": "stm-sft6rv00000000000", "Name": "Name your stack", "Tags": [{"Key":"foo","Value":"bar"}], "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "foobarapp" } Applications Version April 22, 2025 472 AMS Advanced Change Type Reference AMS Advanced Change Type Details } CodeDeploy Application | Deploy Deploy a revision of an existing AWS CodeDeploy application, which are source files CodeDeploy will deploy to your instances or scripts CodeDeploy will run on your instances. Full classification: Deployment | Applications | CodeDeploy application | Deploy Change Type Details Change type ID ct-2edc3sd1sqmrb Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Deploy CodeDeploy application Deploying a CodeDeploy application with the console Applications Version April 22, 2025 473 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Deploying a CodeDeploy application with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. Applications Version April 22, 2025 474 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. |
ams-ct-133 | ams-ct.pdf | 133 | parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. Applications Version April 22, 2025 474 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline) and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2edc3sd1sqmrb" --change- type-version "2.0" --title "Stack-Deploy-CD-App" --execution- parameters "{\"Description\":\"MyCDAppDeployTest\",\"VpcId\": \"VPC_ID\",\"Name\":\"Test\",\"TimeoutInMinutes\":60,\"Parameters\": {\"CodeDeployApplicationName\":\"TestCDApp\",\"CodeDeployDeploymentConfigName\": \"CodeDeployDefault.OneAtATime\",\"CodeDeployDeploymentGroupName\":\"TestCDDepGroup\", \"CodeDeployIgnoreApplicationStopFailures\":false,\"CodeDeployRevision\": {\"RevisionType\":\"S3\",\"S3Location\":{\"S3Bucket\":\"amzn-s3-demo-bucket\", \"S3BundleType\":\"tar\",\"S3Key\":\"TestKey\"}}}}"Test\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for the CodeDeploy application deployment CT; this example names it DeployCDAppParams.json: Applications Version April 22, 2025 475 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm get-change-type-version --change-type-id "ct-2edc3sd1sqmrb" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeployCDAppParams.json 2. Modify the JSON file as follows. For example, you can replace the contents with something like this: { "Description": "Deploy WordPress CodeDeploy Application", "VpcId": "VPC_ID", "Name": "WP CodeDeploy Deployment Group", "TimeoutInMinutes": 360, "Parameters": { "CodeDeployApplicationName": "WordPressCDApp", "CodeDeployDeploymentGroupName": "WordPressCDDepGroup", "CodeDeployIgnoreApplicationStopFailures": false, "CodeDeployRevision": { "RevisionType": "S3", "S3Location": { "S3Bucket": "amzn-s3-demo-bucket", "S3BundleType": "zip", "S3Key": "wordpress.zip" } } } } 3. Output the JSON template for CreateRfc to a file in your current folder; this example names it DeployCDAppRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeployCDAppRfc.json 4. Modify and save the DeployCDAppRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-2edc3sd1sqmrb", "Title": "CD-Deploy-For-CD-APP-Stack-RFC" } 5. Create the RFC, specifying the execution parameters file and the DeployCDAppRfc file: Applications Version April 22, 2025 476 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://DeployCDAppRfc.json --execution- parameters file://DeployCDAppParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information, see Create a deployment with CodeDeploy. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2edc3sd1sqmrb. Example: Required Parameters { "Description": "Stack Description.", "VpcId": "vpc-01234567890abcdef", "Name": "Name your stack", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "foobarapp", "CodeDeployDeploymentGroupName": "myfoogroup", "CodeDeployRevision": { "RevisionType": "S3", "S3Location": { "S3Bucket": "mybucket", "S3BundleType": "zip", "S3Key": "mykey" } } } } Example: All Parameters { "Description": "Stack Description.", Applications Version April 22, 2025 477 AMS Advanced Change Type Reference AMS Advanced Change Type Details "VpcId": "vpc-12345678", "Name": "Name your stack", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "foobarapp", "CodeDeployDeploymentConfigName": "CodeDeployDefault.HalfAtATime", "CodeDeployDeploymentGroupName": "myfoogroup", "CodeDeployIgnoreApplicationStopFailures": false, "CodeDeployRevision": { "RevisionType": "S3", "S3Location": { "S3Bucket": "mybucket", "S3BundleType": "zip", "S3ETag": "1234567", "S3Key": "mykey", "S3Version": "versionfoo" } } } } CodeDeploy Deployment Group | Create Use to create an AWS CodeDeploy application deployment group, an entity that describes what instances to deploy a given application to. Full classification: Deployment | Applications | CodeDeploy deployment group | Create Change Type Details Change type ID ct-2gd0u847qd9d2 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Applications Version April 22, 2025 478 AMS Advanced Change Type Reference Additional Information Create CodeDeploy deployment group Creating a CodeDeploy deployment group with the console AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the |
ams-ct-134 | ams-ct.pdf | 134 | by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Applications Version April 22, 2025 479 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a CodeDeploy deployment group with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Applications Version April 22, 2025 480 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline) and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2gd0u847qd9d2" --change-type-version "1.0" --title "Stack-Create-CD-Dep-Group" --execution-parameters "{\"Description \":\"TestCdDepGroupRfc\",\"VpcId\":\"VPC_ID\",\"StackTemplateId\":\"stm- sp9lrk00000000000\",\"Name\":\"MyTestCDDepGroup\",\"TimeoutInMinutes\":60,\"Parameters \":{\"CodeDeployApplicationName\":\"TestCDApp\",\"CodeDeployAutoScalingGroups\": [\"TestASG\"],\"CodeDeployDeploymentConfigName\":\"CodeDeployDefault.OneAtATime\", \"CodeDeployDeploymentGroupName\":\"Test\",\"CodeDeployServiceRoleArn\": \"arn:aws:iam::000000000:role/aws-codedeploy-role\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema to a file in your current folder; this example names it CreateCDDepGroupParams.json: aws amscm get-change-type-version --change-type-id "ct-2gd0u847qd9d2" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateCDDepGroupParams.json 2. Modify and save the JSON file. For example, you can replace the contents with something like this: { "Description": "CreateCDDeploymentGroup", "VpcId": "VPC_ID", "StackTemplateId": "stm-sp9lrk00000000000", "Name": "WordPressCDAppGroup", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "WordPressCDApp", "CodeDeployAutoScalingGroups": ["ASG_NAME"], "CodeDeployDeploymentConfigName": "CodeDeployDefault.HalfAtATime", "CodeDeployDeploymentGroupName": "UNIQUE_CDDepGroupNAME", "CodeDeployServiceRoleArn": "arn:aws:iam::ACCOUNT_ID:role/aws- codedeploy-role" } } Applications Version April 22, 2025 481 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. Output the JSON template for CreateRfc to a file in your current folder; this example names it CreateCDDepGroupRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateCDDepGroupRfc.json 4. Modify and save the JSON file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2gd0u847qd9d2", "Title": "CD-Dep-Group-RFC" } 5. Create the RFC, specifying the CreateCDDepGroupRfc file and the execution parameters file: aws amscm create-rfc --cli-input-json file://CreateCDDepGroupRfc.json --execution- parameters file://CreateCDDepGroupParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS CodeDeploy deployment groups, see Create a Deployment Group with AWS CodeDeploy. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2gd0u847qd9d2. Example: Required Parameters { "Description": "Stack Description.", "VpcId": "vpc-01234567890abcdef", "StackTemplateId": "stm-sp9lrk00000000000", "Name": "Name your stack", "TimeoutInMinutes": 60, "Parameters": { Applications Version April 22, 2025 482 AMS Advanced Change Type Reference AMS Advanced Change Type Details "CodeDeployApplicationName": "foobarapp", "CodeDeployAutoScalingGroups": ["myfooasg"], "CodeDeployDeploymentGroupName": "mydeploymentgroup", "CodeDeployServiceRoleArn": "foo::arn::bar" } } |
ams-ct-135 | ams-ct.pdf | 135 | to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS CodeDeploy deployment groups, see Create a Deployment Group with AWS CodeDeploy. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2gd0u847qd9d2. Example: Required Parameters { "Description": "Stack Description.", "VpcId": "vpc-01234567890abcdef", "StackTemplateId": "stm-sp9lrk00000000000", "Name": "Name your stack", "TimeoutInMinutes": 60, "Parameters": { Applications Version April 22, 2025 482 AMS Advanced Change Type Reference AMS Advanced Change Type Details "CodeDeployApplicationName": "foobarapp", "CodeDeployAutoScalingGroups": ["myfooasg"], "CodeDeployDeploymentGroupName": "mydeploymentgroup", "CodeDeployServiceRoleArn": "foo::arn::bar" } } Example: All Parameters { "Description": "Stack Description.", "VpcId": "vpc-01234567890abcdef", "StackTemplateId": "stm-sp9lrk00000000000", "Name": "Name your stack", "Tags": [{"Key":"foo","Value":"bar"}], "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "foobarapp", "CodeDeployAutoScalingGroups": ["myfooasg"], "CodeDeployDeploymentConfigName": "CodeDeployDefault.HalfAtATime", "CodeDeployDeploymentGroupName": "mydeploymentgroup", "CodeDeployServiceRoleArn": "foo::arn::bar" } } CodeDeploy Deployment Group | Create (For EC2 Instance) Create an AWS CodeDeploy application deployment group specifically for an EC2 instance as target. Tags you create in the EC2 instances, and specify here (EC2FilterTag1, 2, and 3), mark the instances as targets for the deployment group. A name for the deployment group is automatically generated. Full classification: Deployment | Applications | CodeDeploy deployment group | Create (for EC2 instance) Change Type Details Change type ID ct-00tlkda4242x7 Current version 1.0 Applications Version April 22, 2025 483 AMS Advanced Change Type Reference AMS Advanced Change Type Details Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create CodeDeploy deployment group for EC2 Creating a CodeDeploy deployment group for EC2 with the console How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. Applications Version April 22, 2025 484 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a CodeDeploy deployment group for EC2 with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: Applications Version April 22, 2025 485 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters |
ams-ct-136 | ams-ct.pdf | 136 | Change Type Reference AMS Advanced Change Type Details aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-00tlkda4242x7" --change-type- version "1.0" --title "Stack-Create-CD-Ec2-Dep-Group" --execution-parameters "{\"Description\":\"MyTestCdDepEc2DepGroup\",\"VpcId\":\"VPC_ID\",\"Name\": \"TestCDDepEc2Group\",\"StackTemplateId\":\"stm-n3hsoirgqeqqdbpk2\",\"TimeoutInMinutes \":60,\"Parameters\":{\"ApplicationName\":\"TestCDApp\",\"DeploymentConfigName\": \"CodeDeployDefault.OneAtATime\",\"AutoRollbackEnabled\":\"False\",\"EC2FilterTag\": \"Name=Test\",\"EC2FilterTag2\":\"\",\"EC2FilterTag3\":\"\",\"ServiceRoleArn\":\"\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema to a file; this example names it CreateCDDepGroupEc2Params.json: aws amscm get-change-type-version --change-type-id "ct-00tlkda4242x7" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateCDDepGroupEc2Params.json 2. Modify and save the JSON file. For example, you can replace the contents with something like this: { Applications Version April 22, 2025 486 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description": "CreateCDDepGroupEc2", "VpcId": "VPC_ID", "StackTemplateId": "stm-n3hsoirgqeqqdbpk2", "Name": "CDAppGroupEc2", "TimeoutInMinutes": 60, "Parameters": { "ApplicationName": "CDAppEc2", "DeploymentConfigName": "CodeDeployDefault.OneAtATime", "CodeDeployDeploymentGroupName": "UNIQUE_CDDepGroupNAME", "CodeDeployServiceRoleArn": "arn:aws:iam::ACCOUNT_ID:role/aws- codedeploy-role" } } 3. Output the JSON template for CreateRfc to a file in your current folder; this example names it CreateCDDepGroupEc2Rfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateCDDepGroupEc2Rfc.json 4. Modify and save the JSON file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-00tlkda4242x7", "Title": "CD-Dep-Group-For-Ec2-Stack-RFC" } 5. Create the RFC, specifying the CreateCDDepGroupEc2Rfc file and the execution parameters file: aws amscm create-rfc --cli-input-json file://CreateCDDepGroupEc2Rfc.json -- execution-parameters file://CreateCDDepGroupEc2Params.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS CodeDeploy deployment groups, see Create a Deployment Group with AWS CodeDeploy. Applications Version April 22, 2025 487 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-00tlkda4242x7. Example: Required Parameters { "Description": "Stack Description.", "VpcId": "vpc-01234567890abcdef", "StackTemplateId": "stm-n3hsoirgqeqqdbpk2", "Name": "Name your stack", "Tags": [{"Key":"foo","Value":"bar"}], "TimeoutInMinutes": 60, "Parameters": { "ApplicationName": "foobarapp", "EC2FilterTag": "Key1=Value1" } } Example: All Parameters { "Description": "Stack Description.", "VpcId": "vpc-01234567890abcdef", "StackTemplateId": "stm-n3hsoirgqeqqdbpk2", "Name": "Name your stack", "Tags": [{"Key":"foo","Value":"bar"}], "TimeoutInMinutes": 60, "Parameters": { "ApplicationName": "foobarapp", "DeploymentConfigName": "CodeDeployDefault.HalfAtATime", "AutoRollbackEnabled": "True", "EC2FilterTag": "Key1=Value1", "EC2FilterTag2": "Key2=Value2", "EC2FilterTag3": "Key3=Value3", "ServiceRoleArn": "arn:aws:iam::123456789012:role/test02" } } Applications Version April 22, 2025 488 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS Backup Subcategory Change Type Items and Operations in the AWS Backup Subcategory • Backup Plan | Create Backup Plan | Create Create an AWS Backup plan, a policy expression that defines when and how you want to back up your AWS resources. Full classification: Deployment | AWS Backup | Backup plan | Create Change Type Details Change type ID ct-2hyozbpa0sx0m Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create AWS Backup plan Creating an AWS Backup plan with the console The following shows this change type in the AMS console. AWS Backup Version April 22, 2025 489 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add |
ams-ct-137 | ams-ct.pdf | 137 | the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. AWS Backup Version April 22, 2025 490 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an AWS Backup plan with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: With all parameters for one rule: AWS Backup Version April 22, 2025 491 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-2hyozbpa0sx0m" --change-type-version "2.0" -- title "AWS Backup custom backup plan for AMS" \ --description "RFC_DESCRIPTION" \ --execution-parameters "{\"VpcId\":\"VPC_ID\",\"Description\":\"PLAN_DESCRIPTION\", \"Parameters\":{\"BackupPlanName\":\"PLAN_NAME\",\"ResourceTagKey\":\"TAG_KEY\", \"ResourceTagValue\":\"TAG_VALUE\",\"BackupRule1Name\":\"RULE_NAME\", \"BackupRule1Vault\":\"VAULT\",\"BackupRule1CompletionWindowMinutes \":120,\"BackupRule1ScheduleExpression\":\"cron(0 1 ? * * *)\", \"BackupRule1DeleteAfterDays\":90,\"BackupRule1MoveToColdStorageAfterDays\":365, \"BackupRule1StartWindowMinutes\":60,\"BackupRule1RecoveryPointTagKey\":\"TAG_KEY\", \"BackupRule1RecoveryPointTagValue\":\"TAG_VALUE\,\"BackupRule1EnableContinuousBackup \":\"false\",\"BackupRule1CopyActionsDestVaultArn\":\"VAULT\", \"BackupRule1CAMoveToColdStorageAfterDays\":0,\"BackupRule1CopyActionsDeleteAfterDays \":90},\"StackTemplateId\":\"stm-sc68a620000000000\",\"TimeoutInMinutes\":60,\"Name\": \"TEST_STACK\"}" With only required parameters for one rule: aws amscm create-rfc --change-type-id "ct-2hyozbpa0sx0m" --change-type-version "2.0" -- title "AWS Backup custom backup plan for AMS" \ --description "RFC_DESCRIPTION" \ --execution-parameters "{\"VpcId\":\"VPC_ID\",\"Description\":\"PLAN_DESCRIPTION\", \"Parameters\":{\"BackupPlanName\":\"PLAN_NAME\",\"ResourceTagKey\":\"TAG_KEY\", \"ResourceTagValue\":\"TAG_VALUE\",\"BackupRule1Name\":\"RULE_NAME\",\"BackupRule1Vault \":\"VAULT\",\"BackupRule1ScheduleExpression\":\"cron(0 1 ? * * *)\"},\"StackTemplateId \":\"stm-sc68a620000000000\",\"TimeoutInMinutes\":60,\"Name\":\"TEST_STACK\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateBackupPlanParams.json: aws amscm get-change-type-version --change-type-id "ct-2hyozbpa0sx0m" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateBackupPlanParams.json 2. Modify and save the CreateBackupPlanParams file. Note that the BackupRule1EnableContinuousBackup parameter set to true causes AWS Backup to create continuous backups capable of point-in-time restore (PITR); the default for this parameter is false. AWS Backup Version April 22, 2025 492 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "VpcId": "VPC_ID", "Description": "PLAN_DESCRIPTION", "Parameters": { "BackupPlanName" : "PLAN_NAME", "ResourceTagKey" : "TAG_KEY", "ResourceTagValue" : "TAG_VALUE", "BackupRule1Name" : "RULE_NAME", "BackupRule1Vault" : "VAULT", "BackupRule1EnableContinuousBackup" : "true", "BackupRule1ScheduleExpression" : "cron(0 1 ? * * *)" }, "StackTemplateId": "stm-sc68a620000000000", "TimeoutInMinutes": 60, "Name": "TEST_STACK" } 3. Output the RFC template to a file in your current folder; this example names it CreateBackupPlanRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateBackupPlanRfc.json 4. Modify and save the CreateBackupPlanRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId" : "ct-2hyozbpa0sx0m", "Version" : "2.0", "Title": "AWS Backup create backup plan" } 5. Create the RFC, specifying the CreateBackupPlanRfc file and the CreateBackupPlanParams file: aws amscm create-rfc --cli-input-json file://CreateBackupPlanRfc.json --execution- parameters file://CreateBackupPlanParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. AWS Backup Version April 22, 2025 493 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips • The continuous backup configuration requires some additional knowledge. With continuous backups, you can restore your AWS Backup-supported resource by rewinding it back to a specific time |
ams-ct-138 | ams-ct.pdf | 138 | Create the RFC, specifying the CreateBackupPlanRfc file and the CreateBackupPlanParams file: aws amscm create-rfc --cli-input-json file://CreateBackupPlanRfc.json --execution- parameters file://CreateBackupPlanParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. AWS Backup Version April 22, 2025 493 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips • The continuous backup configuration requires some additional knowledge. With continuous backups, you can restore your AWS Backup-supported resource by rewinding it back to a specific time that you choose, within 1 second of precision (going back a maximum of 35 days). In AMS Advanced, you configure this with the BackupRule1EnableContinuousBackup parameter set to true, which causes AWS Backup to create continuous backups capable of point-in-time restore (PITR). To learn more, see Restoring to a specified time using Point-In-Time Recovery (PITR). • Not all resource types supported by AWS Backup are enabled by default. Review the enabled resource types in your account using Getting Started 1: Service Opt-In. • If you need to change your backup plan, open an RFC using the Other | Create (Review Required) CT (ct-1e1xtak34nx76). • To learn more about AWS Backup, see AWS Backup: How It Works. • Before creating backup plans, confirm supported resources at Feature availability by resource. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2hyozbpa0sx0m. Example: Required Parameters { "Description": "This is a test description.", "VpcId": "vpc-1234567890abcdef0", "Name": "Test Stack", "Parameters": { "BackupPlanName": "MyCustomBackupPlan", "ResourceTagKey": "custom_backup_test", "ResourceTagValue": "true", "BackupRule1Name": "BackupRule1", "BackupRule1Vault": "ams-custom-backups", "BackupRule1CompletionWindowMinutes": 1440, "BackupRule1ScheduleExpression": "cron(0 2 ? * * *)", "BackupRule1DeleteAfterDays": 0, "BackupRule1MoveToColdStorageAfterDays": 0, "BackupRule1StartWindowMinutes": 180, "BackupRule1RecoveryPointTagKey": "test", "BackupRule1RecoveryPointTagValue": "test" }, AWS Backup Version April 22, 2025 494 AMS Advanced Change Type Reference AMS Advanced Change Type Details "TimeoutInMinutes": 60, "StackTemplateId": "stm-sc68a620000000000" } Example: All Parameters { "Description": "This is a test description.", "VpcId": "vpc-1234567890abcdef0", "Name": "Test Stack", "Parameters": { "BackupPlanName": "MyCustomBackupPlan", "ResourceTagKey": "custom_backup_test", "ResourceTagValue": "true", "WindowsVSS" : "disabled", "BackupRule1Name": "BackupRule1", "BackupRule1Vault": "ams-custom-backups", "BackupRule1CompletionWindowMinutes": 1440, "BackupRule1ScheduleExpression": "cron(0 2 ? * * *)", "BackupRule1DeleteAfterDays": 0, "BackupRule1MoveToColdStorageAfterDays": 0, "BackupRule1StartWindowMinutes": 180, "BackupRule1RecoveryPointTagKey": "test", "BackupRule1RecoveryPointTagValue": "test", "BackupRule1EnableContinuousBackup": "false", "BackupRule2Name": "BackupRule2", "BackupRule2Vault": "ams-custom-backups", "BackupRule2CompletionWindowMinutes": 1440, "BackupRule2ScheduleExpression": "cron(0 2 ? * * *)", "BackupRule2DeleteAfterDays": 0, "BackupRule2MoveToColdStorageAfterDays": 0, "BackupRule2StartWindowMinutes": 180, "BackupRule2RecoveryPointTagKey": "test", "BackupRule2RecoveryPointTagValue": "test", "BackupRule2EnableContinuousBackup": "false", "BackupRule3Name": "BackupRule3", "BackupRule3Vault": "ams-custom-backups", "BackupRule3CompletionWindowMinutes": 1440, "BackupRule3ScheduleExpression": "cron(0 2 ? * * *)", "BackupRule3DeleteAfterDays": 0, AWS Backup Version April 22, 2025 495 AMS Advanced Change Type Reference AMS Advanced Change Type Details "BackupRule3MoveToColdStorageAfterDays": 0, "BackupRule3StartWindowMinutes": 180, "BackupRule3RecoveryPointTagKey": "test", "BackupRule3RecoveryPointTagValue": "test", "BackupRule3EnableContinuousBackup": "false", "BackupRule4Name": "BackupRule4", "BackupRule4Vault": "ams-custom-backups", "BackupRule4CompletionWindowMinutes": 1440, "BackupRule4ScheduleExpression": "cron(0 2 ? * * *)", "BackupRule4DeleteAfterDays": 0, "BackupRule4MoveToColdStorageAfterDays": 0, "BackupRule4StartWindowMinutes": 180, "BackupRule4RecoveryPointTagKey": "test", "BackupRule4RecoveryPointTagValue": "test", "BackupRule4EnableContinuousBackup": "false", "BackupRule5Name": "BackupRule5", "BackupRule5Vault": "ams-custom-backups", "BackupRule5CompletionWindowMinutes": 1440, "BackupRule5ScheduleExpression": "cron(0 2 ? * * *)", "BackupRule5DeleteAfterDays": 0, "BackupRule5MoveToColdStorageAfterDays": 0, "BackupRule5StartWindowMinutes": 180, "BackupRule5RecoveryPointTagKey": "test", "BackupRule5RecoveryPointTagValue": "test", "BackupRule5EnableContinuousBackup": "false", "BackupRule6Name": "BackupRule6", "BackupRule6Vault": "ams-custom-backups", "BackupRule6CompletionWindowMinutes": 1440, "BackupRule6ScheduleExpression": "cron(0 2 ? * * *)", "BackupRule6DeleteAfterDays": 0, "BackupRule6MoveToColdStorageAfterDays": 0, "BackupRule6StartWindowMinutes": 180, "BackupRule6RecoveryPointTagKey": "test", "BackupRule6RecoveryPointTagValue": "test", "BackupRule6EnableContinuousBackup": "false" }, "TimeoutInMinutes": 60, "StackTemplateId": "stm-sc68a620000000000" } AWS Backup Version April 22, 2025 496 AMS Advanced Change Type Reference AMS Advanced Change Type Details Directory Service Subcategory Change Type Items and Operations in the Directory Service Subcategory • DNS | Create Conditional Forwarder • DNS | Create Group Managed Service Account DNS | Create Conditional Forwarder Create AD DNS conditional forwarder with up to five DNS servers associated with a remote domain name. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Deployment | Directory Service | DNS | Create conditional forwarder Change Type Details Change type ID ct-3nba0wtdugnan Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create DNS conditional forwards Creating DNS conditional forwards with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 497 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with |
ams-ct-139 | ams-ct.pdf | 139 | Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Directory Service Version April 22, 2025 498 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating DNS conditional forwards with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Directory Service Version April 22, 2025 499 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-3nba0wtdugnan" --change-type-version "1.0" --title "Create conditional forwarders" --execution-parameters "{\"DocumentName \": \"AWSManagedServices-CreateADDNSConditionalForwarder-Admin\",\"Region\": \"us- east-1\",\"Parameters\": {\"RemoteDomainName\": [\"Domain_Name\"], \"IPAddresses\": [\"132.133.134.135\", \"135.134.133.132\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CondForwardCreateParams.json: aws amscm get-change-type-version --change-type-id "ct-3nba0wtdugnan" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CondForwardCreateParams.json Modify and save the CondForwardCreateParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateADDNSConditionalForwarder-Admin", "Region": "us-east-1", "Parameters": { "RemoteDomainName": [ "Domain_Name" ], "IPAddresses": [ "132.133.134.135", "135.134.133.132" ] } } 2. Output the RFC template to a file in your current folder; this example names it CondForwardCreateRfc.json: aws amscm create-rfc --generate-cli-skeleton > CondForwardCreateRfc.json 3. Modify and save the CondForwardCreateRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-3nba0wtdugnan", Directory Service Version April 22, 2025 500 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeVersion": "1.0", "Title": "Create conditional forwarders" } 4. Create the RFC, specifying the CondForwardCreateRfc file and the CondForwardCreateParams file: aws amscm create-rfc --cli-input-json file://CondForwardCreateRfc.json --execution- parameters file://CondForwardCreateParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3nba0wtdugnan. Example: Required Parameters { "DocumentName" : "AWSManagedServices-CreateADDNSConditionalForwarder-Admin", "Region" : "us-east-1", "Parameters": { "RemoteDomainName": ["test.test1.com"], "IPAddresses": ["10.0.0.1", "10.0.0.2"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateADDNSConditionalForwarder-Admin", "Region" : "us-east-1", "Parameters": { "RemoteDomainName": ["test.test1.com"], "IPAddresses": ["10.0.0.1", "10.0.0.2"] } } Directory Service Version |
ams-ct-140 | ams-ct.pdf | 140 | --cli-input-json file://CondForwardCreateRfc.json --execution- parameters file://CondForwardCreateParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3nba0wtdugnan. Example: Required Parameters { "DocumentName" : "AWSManagedServices-CreateADDNSConditionalForwarder-Admin", "Region" : "us-east-1", "Parameters": { "RemoteDomainName": ["test.test1.com"], "IPAddresses": ["10.0.0.1", "10.0.0.2"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateADDNSConditionalForwarder-Admin", "Region" : "us-east-1", "Parameters": { "RemoteDomainName": ["test.test1.com"], "IPAddresses": ["10.0.0.1", "10.0.0.2"] } } Directory Service Version April 22, 2025 501 AMS Advanced Change Type Reference AMS Advanced Change Type Details DNS | Create Group Managed Service Account Create a new Active Directory (AD) Group Managed Service Account (gMSA). For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Deployment | Directory Service | DNS | Create group managed service account Change Type Details Change type ID ct-2qhl8j1pjnbgn Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create group managed service account Creating a group managed service account with the console The following shows this change type in the AMS console. How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. Directory Service Version April 22, 2025 502 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a group managed service account with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. Directory Service Version April 22, 2025 503 AMS Advanced Change Type Reference AMS Advanced Change Type Details To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2qhl8j1pjnbgn" --change-type-version "1.0" --title "Create Group Managed Service Account" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateADGroupManagedServiceAccount-Admin \",\"Region\": \"us-east-1\",\"Parameters\": {\"AccountName\": [\"Test-Sample\"], \"ManagedPasswordIntervalInDays\": [\"30\"],\"PrincipalAllowedToRetrievePassword \": [\"Test-admin\"],\"ComputerName\": [\"TestComputer\"],\"DNSHostName\": [\"test.domain.com\"],\"KerberosEncryptionType\": [\"RC4\"]}}" TEMPLATE CREATE: |
ams-ct-141 | ams-ct.pdf | 141 | line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2qhl8j1pjnbgn" --change-type-version "1.0" --title "Create Group Managed Service Account" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateADGroupManagedServiceAccount-Admin \",\"Region\": \"us-east-1\",\"Parameters\": {\"AccountName\": [\"Test-Sample\"], \"ManagedPasswordIntervalInDays\": [\"30\"],\"PrincipalAllowedToRetrievePassword \": [\"Test-admin\"],\"ComputerName\": [\"TestComputer\"],\"DNSHostName\": [\"test.domain.com\"],\"KerberosEncryptionType\": [\"RC4\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it GroupManServAcctCreateParams.json: aws amscm get-change-type-version --change-type-id "ct-2qhl8j1pjnbgn" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > GroupManServAcctCreateParams.json Directory Service Version April 22, 2025 504 AMS Advanced Change Type Reference AMS Advanced Change Type Details Modify and save the GroupManServAcctCreateParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateADGroupManagedServiceAccount-Admin", "Region": "us-east-1", "Parameters": { "AccountName": [ "Test-Sample" ], "ManagedPasswordIntervalInDays": [ "30" ], "PrincipalAllowedToRetrievePassword": [ "Test-admin" ], "ComputerName": [ "Test-Computer" ], "DNSHostName": [ "test.domain.com" ], "KerberosEncryptionType": [ "RC4" ] } } 2. Output the RFC template to a file in your current folder; this example names it GroupManServAcctCreateRfc.json: aws amscm create-rfc --generate-cli-skeleton > GroupManServAcctCreateRfc.json 3. Modify and save the GroupManServAcctCreateRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2qhl8j1pjnbgn", "Title": "Create Group Managed Service Account" }} Directory Service Version April 22, 2025 505 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Create the RFC, specifying the GroupManServAcctCreateRfc file and the GroupManServAcctCreateParams file: aws amscm create-rfc --cli-input-json file://GroupManServAcctCreateRfc.json -- execution-parameters file://GroupManServAcctCreateParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2qhl8j1pjnbgn. Example: Required Parameters { "DocumentName": "AWSManagedServices-CreateADGroupManagedServiceAccount-Admin", "Region": "us-east-1", "Parameters": { "AccountName": ["Sample-account"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-CreateADGroupManagedServiceAccount-Admin", "Region": "us-east-1", "Parameters": { "AccountName": ["Sample-account"], "ManagedPasswordIntervalInDays": ["30"], "PrincipalAllowedToRetrievePassword": ["Sample_Principal"], "ComputerName": ["Sample-Computer"], "DNSHostName": ["test.domain.com"], "KerberosEncryptionType": ["RC4,AES128,AES256"] } } Directory Service Version April 22, 2025 506 AMS Advanced Change Type Reference AMS Advanced Change Type Details Ingestion Subcategory Change Type Items and Operations in the Ingestion Subcategory • Stack from CloudFormation Template | Create • Stack from Migration Partner Migrated Instance | Create Stack from CloudFormation Template | Create Create a stack by pointing to a customized CloudFormation (CFN) template in an S3 bucket, or by pasting the contents of that template as input to this change type. Full classification: Deployment | Ingestion | Stack from CloudFormation Template | Create Change Type Details Change type ID ct-36cn2avfrrj9v Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Ingestion Version April 22, 2025 507 AMS Advanced Change Type Reference Additional Information Create CloudFormation ingest stack Creating a CloudFormation ingest stack using the console AMS Advanced Change Type Details To create a CloudFormation ingest stack using the console 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the |
ams-ct-142 | ams-ct.pdf | 142 | RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Ingestion Version April 22, 2025 508 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a CloudFormation ingest stack using the CLI To create a CloudFormation ingest stack using the CLI 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. 1. Prepare the CloudFormation template that you will use to create the stack, and upload it to your S3 bucket. For important details, see AWS CloudFormation Ingest Guidelines, Best Practices, and Limitations. 2. Create and submit the RFC to AMS: Ingestion Version April 22, 2025 509 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Create and save the execution parameters JSON file, include the CloudFormation template parameters that you want. The following example names it CreateCfnParams.json. Example Web application stack CreateCfnParams.json file: { "Name": "cfn-ingest", "Description": "CFNIngest Web Application Stack", "VpcId": "VPC_ID", "CloudFormationTemplateS3Endpoint": "$S3_URL", "TimeoutInMinutes": 120, "Tags": [ { "Key": "Enviroment Type" "Value": "Dev", }, { "Key": "Application" "Value": "PCS", } ], "Parameters": [ { "Name": "Parameter-for-S3Bucket-Name", "Value": "BUCKET-NAME" }, { "Name": "Parameter-for-Image-Id", "Value": "AMI-ID" } ], } Example SNS topic CreateCfnParams.json file: { "Name": "cfn-ingest", "Description": "CFNIngest Web Application Stack", "CloudFormationTemplateS3Endpoint": "$S3_URL", "Tags": [ {"Key": "Enviroment Type", "Value": "Dev"} ], Ingestion Version April 22, 2025 510 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Parameters": [ {"Name": "TopicName", "Value": "MyTopic1"} ] } 3. Create and save the RFC parameters JSON file with the following content. The following example names it CreateCfnRfc.json file: { "ChangeTypeId": "ct-36cn2avfrrj9v", "ChangeTypeVersion": "2.0", "Title": "cfn-ingest" } 4. Create the RFC, specifying the CreateCfnRfc file and the CreateCfnParams file: aws amscm create-rfc --cli-input-json file://CreateCfnRfc.json --execution- parameters file://CreateCfnParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note This change type is at version 2.0 and is automated (not manually executed). This allows the CT execution to go more quickly, and, a new parameter, CloudFormationTemplate, allows you to paste into the RFC a custom CloudFormation template. Additionally, In this version, we do not attach the default AMS security groups if the you specify your own security groups. If you do not specify your own security groups in the request, AMS will attach the AMS default security groups. In CFN Ingest v1.0, we always appended the AMS default security groups whether or not you provided your own security groups. AMS has enabled 17 AMS Self-Provisioned services for use in this change type. For information about supported resources, see CloudFormation Ingest Stack: Supported Resources. Ingestion Version April 22, 2025 511 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note Version 2.0 accepts an S3 endpoint that is not a presigned URL. If you use the previous version of this CT, the CloudFormationTemplateS3Endpoint parameter value must be a presigned URL. Example command for generating a presigned S3 bucket URL (Mac/Linux): export S3_PRESIGNED_URL=$(aws s3 presign DASHDASHexpires-in 86400 s3://BUCKET_NAME/CFN_TEMPLATE.json) Example command for generating a presigned S3 bucket |
ams-ct-143 | ams-ct.pdf | 143 | your own security groups. AMS has enabled 17 AMS Self-Provisioned services for use in this change type. For information about supported resources, see CloudFormation Ingest Stack: Supported Resources. Ingestion Version April 22, 2025 511 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note Version 2.0 accepts an S3 endpoint that is not a presigned URL. If you use the previous version of this CT, the CloudFormationTemplateS3Endpoint parameter value must be a presigned URL. Example command for generating a presigned S3 bucket URL (Mac/Linux): export S3_PRESIGNED_URL=$(aws s3 presign DASHDASHexpires-in 86400 s3://BUCKET_NAME/CFN_TEMPLATE.json) Example command for generating a presigned S3 bucket URL (Windows): for /f %i in ('aws s3 presign DASHDASHexpires-in 86400 s3://BUCKET_NAME/CFN_TEMPLATE.json') do set S3_PRESIGNED_URL=%i See also Creating Pre-Signed URLs for Amazon S3 Buckets. Note If the S3 bucket exists in an AMS account, you must use your AMS credentials for this command. For example, you may need to append --profile saml after obtaining your AMS AWS Security Token Service (AWS STS) credentials. Related change types: Approve a CloudFormation ingest stack changeset, Update AWS CloudFormation ingest stack To learn more about AWS CloudFormation, see AWS CloudFormation. To see CloudFormation templates, open the AWS CloudFormation Template Reference. Validating a AWS CloudFormation ingest The template is validated to ensure that it can be created in an AMS account. If it passes validation, it's updated to include any resources or configurations required for it to conform with AMS. This includes adding resources such as Amazon CloudWatch alarms in order to allow AMS Operations to monitor the stack. The RFC is rejected if any of the following are true: Ingestion Version April 22, 2025 512 AMS Advanced Change Type Reference AMS Advanced Change Type Details • RFC JSON Syntax is incorrect or does not follow the given format. • The provided S3 bucket presigned URL is not valid. • The template is not valid AWS CloudFormation syntax. • The template does not have defaults set for all parameter values. • The template fails AMS validation. For AMS validation steps, see the information later in this topic. The RFC fails if the CloudFormation stack fails to create due to a resource creation issue. To learn more about CFN validation and validator, see Template Validation and CloudFormation ingest stack: CFN validator examples. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-36cn2avfrrj9v. Example: Required Parameters Example not available. Example: All Parameters Example not available. Stack from Migration Partner Migrated Instance | Create Migrate a running non-AMS instance into an AMS stack, in a given AMS-managed VPC and subnet. Must be an instance that was configured through a cloud migration service. Tags that exist on the instance to be migrated will be applied to the resources created in addition to tags requested in the RFC. Number of total tags between the instance to be migrated and the resources created cannot exceed fifty. Set a Name tag to give the EC2 instance, and AMI, names in the EC2 console. Please note that your RFC will be rejected if a tag on the instance to be migrated has the same key as a tag supplied in the RFC. Full classification: Deployment | Ingestion | Stack from migration partner migrated instance | Create Ingestion Version April 22, 2025 513 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-257p9zjk14ija Current version 3.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Workload Ingest Stack: Creating Migrating an instance to an AMS stack with the Console Screenshot of this change type in the AMS console: Ingestion Version April 22, 2025 514 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. Ingestion Version April 22, 2025 515 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create |
ams-ct-144 | ams-ct.pdf | 144 | can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Note If the RFC is rejected, the execution output includes a link to Amazon CloudWatch logs. AMS Workload Ingest (WIGS) RFCs are rejected when requirements are not met; for example, if anti-virus software is detected on the instance. The CloudWatch logs will include information about the failed requirement and the actions to take for remediation. Migrating an instance to an AMS stack with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC Ingestion Version April 22, 2025 516 AMS Advanced Change Type Reference AMS Advanced Change Type Details parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. You can use the AMS CLI to create an AMS instance from a non-AMS instance migrated to an AMS account. Note Be sure you have followed the prerequisites; see Migrating Workloads: Prerequisites for Linux and Windows. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID INLINE CREATE: Ingestion Version April 22, 2025 517 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-257p9zjk14ija" --change-type-version "2.0" -- title "AMS-WIG-TEST-NO-ACTION" --execution-parameters "{\"InstanceId\":\"INSTANCE_ID\", \"TargetVpcId\":\"VPC_ID\",\"TargetSubnetId\":\"SUBNET_ID\",\"TargetInstanceType\": \"t2.large\",\"ApplyInstanceValidation\":true,\"Name\":\"WIG-TEST\",\"Description\": \"WIG-TEST\",\"EnforceIMDSV2\":\"false\"}" TEMPLATE CREATE: 1. 0utput the execution parameters JSON schema for this change type to a file; example names it MigrateStackParams.json: aws amscm get-change-type-version --change-type-id "ct-257p9zjk14ija" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > MigrateStackParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "InstanceId": "MIGRATED_INSTANCE_ID", "TargetVpcId": "VPC_ID", "TargetSubnetId": "SUBNET_ID", "Name": "Migrated-Stack", "Description": "Create-Migrated-Stack", "EnforceIMDSV2": "false" } 3. Output the RFC template JSON file; example names it MigrateStackRfc.json: aws amscm create-rfc --generate-cli-skeleton > MigrateStackRfc.json 4. Modify and save the MigrateStackRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-257p9zjk14ija", "ChangeTypeVersion": "2.0", "Title": "Migrate-Stack-RFC" Ingestion Version April 22, 2025 518 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 5. Create the RFC, specifying the MigrateStackRfc file and the MigrateStackParams file: aws amscm create-rfc --cli-input-json file://MigrateStackRfc.json --execution- parameters file://MigrateStackParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. The new instance appears |
ams-ct-145 | ams-ct.pdf | 145 | and save the MigrateStackRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-257p9zjk14ija", "ChangeTypeVersion": "2.0", "Title": "Migrate-Stack-RFC" Ingestion Version April 22, 2025 518 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 5. Create the RFC, specifying the MigrateStackRfc file and the MigrateStackParams file: aws amscm create-rfc --cli-input-json file://MigrateStackRfc.json --execution- parameters file://MigrateStackParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. The new instance appears in the Instance list for the application owner's account for the relevant VPC. 6. Once the RFC completes successfully, notify the application owner so he or she can log into the new instance and verify that the workload is operational. Note If the RFC is rejected, the execution output includes a link to Amazon CloudWatch logs. AMS Workload Ingest (WIGS) RFCs are rejected when requirements are not met; for example, if anti-virus software is detected on the instance. The CloudWatch logs will include information about the failed requirement and the actions to take for remediation. Tips Note Be sure you have followed the prerequisites; see Migrating Workloads: Prerequisites for Linux and Windows. Note If a tag on the instance being migrated has the same key as a tag supplied in the RFC, the RFC fails. Ingestion Version April 22, 2025 519 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can specify up to four Target IDs, Ports, and Availability Zones. Note If the RFC is rejected, the execution output includes a link to Amazon CloudWatch logs. AMS Workload Ingest (WIGS) RFCs are rejected when requirements are not met; for example, if anti-virus software is detected on the instance. The CloudWatch logs will include information about the failed requirement and the actions to take for remediation. Note If the RFC is rejected, the execution output includes a link to Amazon CloudWatch logs. AMS Workload Ingest (WIGS) RFCs are rejected when requirements are not met; for example, if anti-virus software is detected on the instance. The CloudWatch logs will include information about the failed requirement and the actions to take for remediation. If needed, see Workload ingestion (WIGS) failure. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-257p9zjk14ija. Example: Required Parameters Example not available. Example: All Parameters { "InstanceId" : "i-1234567890abababa", "TargetVpcId" : "vpc-01234567890abcdef", "TargetSubnetId" : "subnet-12345678901234567", "TargetSecurityGroupIds": ["sg-01234567890abcdef", "sg-1234567890abcdef0"], Ingestion Version April 22, 2025 520 AMS Advanced Change Type Reference "Name": "My Stack", "Description": "This is my stack", "TargetInstanceType": "t2.large", "ApplyInstanceValidation": true, "KmsKeyId": "arn:aws:kms:us-east-1:012345678910:key/a3ccc020- AMS Advanced Change Type Details abcd-1234-8d69-2f060c3c1234", "EnforceIMDSV2": "true", "Tags": [ { "Key": "key1", "Value": "value1" }, { "Key": "key2", "Value": "value2" }, { "Key": "key3", "Value": "value3" }, { "Key": "key4", "Value": "value4" }, { "Key": "key5", "Value": "value5" }, { "Key": "key6", "Value": "value6" }, { "Key": "key7", "Value": "value7" }, { "Key": "key8", "Value": "value8" }, { "Key": "key9", "Value": "value9" }, Ingestion Version April 22, 2025 521 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Key": "key10", "Value": "value10" }, { "Key": "key11", "Value": "value11" }, { "Key": "key12", "Value": "value12" }, { "Key": "key13", "Value": "value13" }, { "Key": "key14", "Value": "value14" }, { "Key": "key15", "Value": "value15" }, { "Key": "key16", "Value": "value16" }, { "Key": "key17", "Value": "value17" }, { "Key": "key18", "Value": "value18" }, { "Key": "key19", "Value": "value19" }, { "Key": "key20", "Value": "value20" }, Ingestion Version April 22, 2025 522 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Key": "key21", "Value": "value21" }, { "Key": "key22", "Value": "value22" }, { "Key": "key23", "Value": "value23" }, { "Key": "key24", "Value": "value24" }, { "Key": "key25", "Value": "value25" }, { "Key": "key26", "Value": "value26" }, { "Key": "key27", "Value": "value27" }, { "Key": "key28", "Value": "value28" }, { "Key": "key29", "Value": "value29" }, { "Key": "key30", "Value": "value30" }, { "Key": "key31", "Value": "value31" }, Ingestion Version April 22, 2025 523 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Key": "key32", "Value": "value32" }, { "Key": "key33", "Value": "value33" }, { "Key": "key34", "Value": "value34" }, { "Key": "key35", "Value": "value35" }, { "Key": "key36", "Value": "value36" }, { "Key": "key37", "Value": "value37" }, { "Key": "key38", "Value": "value38" }, { "Key": "key39", "Value": "value39" }, { "Key": "key40", "Value": "value40" }, { "Key": "key41", "Value": "value41" }, { "Key": "key42", "Value": "value42" }, Ingestion Version April 22, 2025 524 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Key": "key43", "Value": "value43" }, { "Key": "key44", "Value": "value44" }, { "Key": "key45", "Value": "value45" }, { "Key": "key46", "Value": "value46" }, { "Key": "key47", "Value": "value47" |
ams-ct-146 | ams-ct.pdf | 146 | }, { "Key": "key34", "Value": "value34" }, { "Key": "key35", "Value": "value35" }, { "Key": "key36", "Value": "value36" }, { "Key": "key37", "Value": "value37" }, { "Key": "key38", "Value": "value38" }, { "Key": "key39", "Value": "value39" }, { "Key": "key40", "Value": "value40" }, { "Key": "key41", "Value": "value41" }, { "Key": "key42", "Value": "value42" }, Ingestion Version April 22, 2025 524 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "Key": "key43", "Value": "value43" }, { "Key": "key44", "Value": "value44" }, { "Key": "key45", "Value": "value45" }, { "Key": "key46", "Value": "value46" }, { "Key": "key47", "Value": "value47" }, { "Key": "key48", "Value": "value48" }, { "Key": "key49", "Value": "value49" }, { "Key": "key50", "Value": "value50" } ] } Managed Firewall Subcategory Change Type Items and Operations in the Managed Firewall Subcategory • Outbound (Palo Alto) | Create Allow List • Outbound (Palo Alto) | Create Security Policy Managed Firewall Version April 22, 2025 525 AMS Advanced Change Type Reference AMS Advanced Change Type Details Outbound (Palo Alto) | Create Allow List Create an allow list file for AMS managed Palo Alto firewall - Outbound. Full classification: Deployment | Managed Firewall | Outbound (Palo Alto) | Create allow list Change Type Details Change type ID ct-309eozh6lpkr8 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create allow list for managed Palo Alto outbound firewall Creating an allow list for your managed Palo Alto firewall with the Console Screenshot of this change type in the AMS console: How it works: Managed Firewall Version April 22, 2025 526 AMS Advanced Change Type Reference AMS Advanced Change Type Details 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an allow list for your managed Palo Alto firewall with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Managed Firewall Version April 22, 2025 527 AMS Advanced Change Type Reference AMS Advanced Change Type Details Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when |
ams-ct-147 | ams-ct.pdf | 147 | --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-309eozh6lpkr8" --change-type-version "1.0" -- title "Create Allow List" --execution-parameters "{ \"RequestType\": \"CreateAllowList \", \"Parameters\": { "AllowListName": "CustomAllowList" } } " TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateAllowListParams.json. aws amscm get-change-type-version --change-type-id "ct-309eozh6lpkr8" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAllowListParams.json 2. Modify and save the CreateAllowListParams file. For example, you can replace the contents with something like this: Managed Firewall Version April 22, 2025 528 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "RequestType": "CreateAllowList", "Parameters": { "AllowListName": "CustomAllowList" } } 3. Output the RFC template JSON file to a file named CreateAllowListRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateAllowListRfc.json 4. Modify and save the CreateAllowListRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-309eozh6lpkr8", "Title": "Create-Allow-List-RFC" } 5. Create the RFC, specifying the CreateAllowList Rfc file and the CreateAllowListParams file: aws amscm create-rfc --cli-input-json file://CreateAllowListRfc.json --execution- parameters file://CreateAllowListParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Palo Alto managed firewall in AMS, see Managed Palo Alto egress firewall. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-309eozh6lpkr8. Example: Required Parameters Example not available. Managed Firewall Version April 22, 2025 529 AMS Advanced Change Type Reference Example: All Parameters { "Parameters": { "AllowListName": "test_file" }, "RequestType": "CreateAllowList" } AMS Advanced Change Type Details Outbound (Palo Alto) | Create Security Policy Create a security policy for AMS managed Palo Alto firewall - Outbound. Full classification: Deployment | Managed Firewall | Outbound (Palo Alto) | Create security policy Change Type Details Change type ID ct-281dpwh9tqnan Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create security policy for managed Palo Alto outbound firewall Creating a security policy for your managed Palo Alto firewall with the Console Screenshot of this change type in the AMS console: Managed Firewall Version April 22, 2025 530 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Managed Firewall Version April 22, 2025 531 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area |
ams-ct-148 | ams-ct.pdf | 148 | in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Managed Firewall Version April 22, 2025 531 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a security policy for your managed Palo Alto firewall with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Managed Firewall Version April 22, 2025 532 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-281dpwh9tqnan" --change-type-version "1.0" --title "Create Security Policy" --execution-parameters "{ \"RequestType\": \"CreateSecurityPolicy\", \"Parameters\": { "SecurityPolicyName": "custom-sec-name", "SourceAddresses": ["1.0.0.0"], "DestinationAddresses": ["2.0.0.0"], "AllowLists": ["CustomAllowList"], "ServicePorts": { "tcp": [20]: "udp": [30] }} } " TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateSecurityPolicyParams.json. aws amscm get-change-type-version --change-type-id "ct-281dpwh9tqnan" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateSecurityPolicyParams.json 2. Modify and save the CreateSecurityPolicyParams file. For example, you can replace the contents with something like this: { "RequestType": "CreateSecurityPolicy", "Parameters": { "SecurityPolicyName": "custom-sec-name", "SourceAddresses": ["1.0.0.0"], "DestinationAddresses": ["2.0.0.0"], "AllowLists": [], "ServicePorts": { "tcp": [20] "udp": [30] } } } 3. Output the RFC template JSON file to a file named CreateSecurityPolicyRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateSecurityPolicyRfc.json 4. Modify and save the CreateSecurityPolicyRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", Managed Firewall Version April 22, 2025 533 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-281dpwh9tqnan", "Title": "Create-Security-Policy-RFC" } 5. Create the RFC, specifying the CreateSecurityPolicy Rfc file and the CreateSecurityPolicyParams file: aws amscm create-rfc --cli-input-json file://CreateSecurityPolicyRfc.json -- execution-parameters file://CreateSecurityPolicyParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips This automated change type applies only to AMS multi-account landing zone (MALZ). To learn more about Palo Alto managed firewall in AMS, see Managed Palo Alto egress firewall. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-281dpwh9tqnan. Example: Required Parameters Example not available. Example: All Parameters { "Parameters": { "SecurityPolicyName": "custom-sec-pol", "SourceAddresses": ["10.0.0.1", "10.50.0.0/16"], "DestinationAddresses": ["1.1.1.1", "100.0.0.0/8", "amazon.com"], "ServicePorts": { "tcp": [1000, 1200] }, "ActionType": "Allow", "EnablePolicy": false }, "RequestType": "CreateSecurityPolicy" } Managed Firewall Version April 22, 2025 534 AMS Advanced Change Type Reference AMS Advanced Change Type Details Managed Landing Zone Subcategory Change Type Items and Operations in the Managed Landing Zone Subcategory • Application Account | Create VPC • Application Account | Create VPC Additional CIDR and Subnets • Management Account | Create Accelerate Account • Management Account | Create Application Account (With VPC) • Management Account | Create Custom OUs • Management Account | Create Custom SCP (Review Required) • Management Account | Create Customer-Managed Application Account • Management Account | Create Developer Mode Account (With VPC) • Management Account | Create StackSets Stack (Review Required) • Management Account | Create Tools Account (With VPC) • Networking Account | Add Static Route • Networking Account | Create Application Route Table (Review |
ams-ct-149 | ams-ct.pdf | 149 | • Application Account | Create VPC • Application Account | Create VPC Additional CIDR and Subnets • Management Account | Create Accelerate Account • Management Account | Create Application Account (With VPC) • Management Account | Create Custom OUs • Management Account | Create Custom SCP (Review Required) • Management Account | Create Customer-Managed Application Account • Management Account | Create Developer Mode Account (With VPC) • Management Account | Create StackSets Stack (Review Required) • Management Account | Create Tools Account (With VPC) • Networking Account | Add Static Route • Networking Account | Create Application Route Table (Review Required) • Networking Account | Create Transit Gateway Route Table Application Account | Create VPC Create a VPC with up to 10 private subnets and up to 5 optional public subnets per availability zone (AZ) for two or three AZ's. Full classification: Deployment | Managed landing zone | Application account | Create VPC Change Type Details Change type ID ct-1j3503fres5a5 Current version 3.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Managed Landing Zone Version April 22, 2025 535 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution mode Automated Additional Information Create VPC Application account: Creating a VPC with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Managed Landing Zone Version April 22, 2025 536 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Application account: Creating a VPC with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Managed Landing Zone Version April 22, 2025 537 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Note Run this change type from your Application account. Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-1j3503fres5a5" --change-type-version "3.0" --title "Application account VPC onboarding" --execution-parameters "{\"VpcName\": |
ams-ct-150 | ams-ct.pdf | 150 | part of the request (not Managed Landing Zone Version April 22, 2025 537 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Note Run this change type from your Application account. Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-1j3503fres5a5" --change-type-version "3.0" --title "Application account VPC onboarding" --execution-parameters "{\"VpcName\": \"VPC_NAME\", \"Parameters\": { \"NumberOfAZs\": \"INTEGER\", \"VPCCIDR\": \"X.X.X.X/ X\", \"PrivateSubnet1AZ1CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ2CIDR\": \"X.X.X.X/ X\", \"RouteType\": \"ROUTE_TYPE\", \"TransitGatewayApplicationRouteTableName\": \"TABLE_NAME\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateAppAcctVpcParams.json: aws amscm get-change-type-version --change-type-id "ct-1j3503fres5a5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAppAcctVpcParams.json 2. Modify and save the CreateAppAcctVpcParams file. For example, you can replace the contents with something like this: { "VpcName": "TestVPC", "Parameters": { "NumberOfAZs": "INTEGER", "VPCCIDR": "x.x.x.x/x", "PrivateSubnet1AZ1CIDR": "x.x.x.x/x", Managed Landing Zone Version April 22, 2025 538 AMS Advanced Change Type Reference AMS Advanced Change Type Details "PrivateSubnet1AZ2CIDR": "x.x.x.x/x", "PrivateSubnet1AZ3CIDR": "x.x.x.x/x", "PublicSubnetAZ1CIDR": "x.x.x.x/x", "PublicSubnetAZ2CIDR": "x.x.x.x/x", "PublicSubnetAZ3CIDR": "x.x.x.x/x", "RouteType": "ROUTE_TYPE", "TransitGatewayApplicationRouteTableName": "ROUTE_TABLE_NAME" } } 3. Output the RFC template JSON file to a file; this example names it CreateAppAcctVpcRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateAppAcctVpcRfc.json 4. Modify and save the CreateAppAcctVpcRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-1j3503fres5a5", "Title": "App-Acct-Vpc-RFC" } 5. Create the RFC, specifying the CreateAppAcctVpcRfc file and the CreateAppAcctVpcParams file: aws amscm create-rfc --cli-input-json file://CreateAppAcctVpcRfc.json --execution- parameters file://CreateAppAcctVpcParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • Important To create an additional public subnet in a new availability zone (AZ), a private subnet must already be present. • This change type is now at version 3.0 and it has been automated (it is no longer manually run by AMS). The 2.0 version of this change type was a "review required" (manual) change type. Managed Landing Zone Version April 22, 2025 539 AMS Advanced Change Type Reference AMS Advanced Change Type Details • To learn more about AMS multi-account landing zone, see VPC sharing: A new approach to multiple accounts and VPC management. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1j3503fres5a5. Example: Required Parameters { "VpcName": "TestVPC", "Parameters": { "VPCCIDR": "10.0.0.0/22", "NumberOfAZs": 2, "PrivateSubnet1AZ1CIDR": "10.0.0.0/24", "PrivateSubnet1AZ2CIDR": "10.0.1.0/24" } } Example: All Parameters { "VpcName": "TestVPC", "Parameters": { "VPCCIDR": "10.0.0.0/22", "NumberOfAZs": 3, "RouteType": "isolated", "TransitGatewayApplicationRouteTableName": "applications", "PublicSubnetAZ1CIDR": "10.0.0.0/24", "PublicSubnetAZ2CIDR": "10.0.1.0/24", "PublicSubnetAZ3CIDR": "10.0.2.0/24", "PublicSubnet2AZ1CIDR": "10.0.0.0/24", "PublicSubnet2AZ2CIDR": "10.0.1.0/24", "PublicSubnet2AZ3CIDR": "10.0.2.0/24", "PublicSubnet3AZ1CIDR": "10.0.0.0/24", "PublicSubnet3AZ2CIDR": "10.0.1.0/24", "PublicSubnet3AZ3CIDR": "10.0.2.0/24", "PublicSubnet4AZ1CIDR": "10.0.0.0/24", "PublicSubnet4AZ2CIDR": "10.0.1.0/24", "PublicSubnet4AZ3CIDR": "10.0.2.0/24", "PublicSubnet5AZ1CIDR": "10.0.0.0/24", Managed Landing Zone Version April 22, 2025 540 AMS Advanced Change Type Reference AMS Advanced Change Type Details "PublicSubnet5AZ2CIDR": "10.0.1.0/24", "PublicSubnet5AZ3CIDR": "10.0.2.0/24", "PrivateSubnet1AZ1CIDR": "10.0.0.0/24", "PrivateSubnet1AZ2CIDR": "10.0.1.0/24", "PrivateSubnet1AZ3CIDR": "10.0.2.0/24", "PrivateSubnet2AZ1CIDR": "10.0.3.0/24", "PrivateSubnet2AZ2CIDR": "10.0.4.0/24", "PrivateSubnet2AZ3CIDR": "10.0.5.0/24", "PrivateSubnet3AZ1CIDR": "10.0.0.0/24", "PrivateSubnet3AZ2CIDR": "10.0.1.0/24", "PrivateSubnet3AZ3CIDR": "10.0.2.0/24", "PrivateSubnet4AZ1CIDR": "10.0.3.0/24", "PrivateSubnet4AZ2CIDR": "10.0.4.0/24", "PrivateSubnet4AZ3CIDR": "10.0.5.0/24", "PrivateSubnet5AZ1CIDR": "10.0.0.0/24", "PrivateSubnet5AZ2CIDR": "10.0.1.0/24", "PrivateSubnet5AZ3CIDR": "10.0.2.0/24", "PrivateSubnet6AZ1CIDR": "10.0.3.0/24", "PrivateSubnet6AZ2CIDR": "10.0.4.0/24", "PrivateSubnet6AZ3CIDR": "10.0.5.0/24", "PrivateSubnet7AZ1CIDR": "10.0.0.0/24", "PrivateSubnet7AZ2CIDR": "10.0.1.0/24", "PrivateSubnet7AZ3CIDR": "10.0.2.0/24", "PrivateSubnet8AZ1CIDR": "10.0.3.0/24", "PrivateSubnet8AZ2CIDR": "10.0.4.0/24", "PrivateSubnet8AZ3CIDR": "10.0.5.0/24", "PrivateSubnet9AZ1CIDR": "10.0.0.0/24", "PrivateSubnet9AZ2CIDR": "10.0.1.0/24", "PrivateSubnet9AZ3CIDR": "10.0.2.0/24", "PrivateSubnet10AZ1CIDR": "10.0.3.0/24", "PrivateSubnet10AZ2CIDR": "10.0.4.0/24", "PrivateSubnet10AZ3CIDR": "10.0.5.0/24" } } Application Account | Create VPC Additional CIDR and Subnets Create an additional VPC CIDR, or subnets, or both, for an existing application account VPC. Add up to five public and twenty private subnet tiers to the additional CIDR, or to existing CIDRs under the VPC. A subnet tier is a set of subnets provisioned in two or three Availability Zones (AZ). Full classification: Deployment | Managed landing zone | Application account | Create VPC Additional CIDR and Subnets Managed Landing Zone Version April 22, 2025 541 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-2ha68tpd7nr3y Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create VPC CIDRs and subnets Application account: creating VPC CIDRs or Subnets with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. Managed Landing Zone Version April 22, 2025 542 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can |
ams-ct-151 | ams-ct.pdf | 151 | Application account: creating VPC CIDRs or Subnets with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. Managed Landing Zone Version April 22, 2025 542 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Application account: creating VPC CIDRs or Subnets with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. Managed Landing Zone Version April 22, 2025 543 AMS Advanced Change Type Reference AMS Advanced Change Type Details To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Note Run this change type from your Application account. Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: To create only additional VPC CIDRs: aws amscm create-rfc --change-type-id "ct-2ha68tpd7nr3y" --change-type-version "1.0" --title "Additional VPC CIDR Creation" --execution-parameters "{\"VPCId\": \"VPC_ID\", \"Parameters\": { \"VPCCIDR\": \"X.X.X.X/X\"}}" To create only additional subnets: aws amscm create-rfc --change-type-id "ct-2ha68tpd7nr3y" --change-type-version "1.0" --title "Additional VPC Subnet Creation" --execution-parameters "{\"VPCId\": \"VPC_ID\", \"Parameters\": {\"PrivateRouteTableAZ1ID\": \"Transit Gateway Route Table AZ1 Name\", \"PrivateRouteTableAZ2ID\": \"Transit Gateway Route Table AZ2 Name\", \"PrivateSubnet1AZ1CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ2CIDR\": \"X.X.X.X/X\"}}" Managed Landing Zone Version April 22, 2025 544 AMS Advanced Change Type Reference AMS Advanced Change Type Details To create additional VPC CIDR and subnets: aws amscm create-rfc --change-type-id "ct-2ha68tpd7nr3y" --change-type-version "1.0" --title "Additional VPC CIDR and subnet Creation" --execution-parameters "{\"VPCId\": \"VPC_ID\", \"Parameters\": { \"VPCCIDR\": \"X.X.X.X/X\", \"PrivateRouteTableAZ1ID \": \"Transit Gateway Route Table AZ1 Name\", \"PrivateRouteTableAZ2ID\": \"Transit Gateway Route Table AZ2 Name\", \"PrivateSubnet1AZ1CIDR\": \"X.X.X.X/X\", \"PrivateSubnet1AZ2CIDR\": \"X.X.X.X/X\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateAppAcctVpcCidrSubnetParams.json: aws amscm get-change-type-version --change-type-id "ct-2ha68tpd7nr3y" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAppAcctVpcCidrSubnetParams.json 2. Modify and save the CreateAppAcctVpcCidrSubnetParams file. For example, you can replace the contents with something like this: To create only additional VPC CIDRs: { { "VPCId": "VPC_ID", "Parameters": { "VPCCIDR": "x.x.x.x/x", } } } To create only additional subnets: { "VPCId": "VPC_ID", "Parameters": { "PrivateRouteTableAZ1ID": "Transit Gateway Route Table |
ams-ct-152 | ams-ct.pdf | 152 | \": \"Transit Gateway Route Table AZ1 Name\", \"PrivateRouteTableAZ2ID\": \"Transit Gateway Route Table AZ2 Name\", \"PrivateSubnet1AZ1CIDR\": \"X.X.X.X/X\", \"PrivateSubnet1AZ2CIDR\": \"X.X.X.X/X\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateAppAcctVpcCidrSubnetParams.json: aws amscm get-change-type-version --change-type-id "ct-2ha68tpd7nr3y" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAppAcctVpcCidrSubnetParams.json 2. Modify and save the CreateAppAcctVpcCidrSubnetParams file. For example, you can replace the contents with something like this: To create only additional VPC CIDRs: { { "VPCId": "VPC_ID", "Parameters": { "VPCCIDR": "x.x.x.x/x", } } } To create only additional subnets: { "VPCId": "VPC_ID", "Parameters": { "PrivateRouteTableAZ1ID": "Transit Gateway Route Table AZ1 Name", "PrivateRouteTableAZ2ID": "Transit Gateway Route Table AZ2 Name", "PrivateSubnet1AZ1CIDR": "x.x.x.x/x", "PrivateSubnet1AZ2CIDR": "x.x.x.x/x" } Managed Landing Zone Version April 22, 2025 545 AMS Advanced Change Type Reference AMS Advanced Change Type Details } To create additional VPC CIDR and subnets: { "VPCId": "VPC_ID", "Parameters": { "VPCCIDR": "x.x.x.x/x", "PrivateRouteTableAZ1ID": "Transit Gateway Route Table AZ1 Name", "PrivateRouteTableAZ2ID": "Transit Gateway Route Table AZ2 Name", "PrivateSubnet1AZ1CIDR": "x.x.x.x/x", "PrivateSubnet1AZ2CIDR": "x.x.x.x/x" } } 3. Output the RFC template JSON file to a file; this example names it CreateAppAcctVpcCidrSubnetRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateAppAcctVpcCidrSubnetRfc.json 4. Modify and save the CreateAppAcctVpcCidrSubnetRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2ha68tpd7nr3y", "Title": "App-Acct-Vpc-Cidr-Subnets-RFC" } 5. Create the RFC, specifying the CreateAppAcctVpcCidrSubnetRfc file and the CreateAppAcctVpcCidrSubnetParams file: aws amscm create-rfc --cli-input-json file://CreateAppAcctVpcCidrSubnetRfc.json -- execution-parameters file://CreateAppAcctVpcCidrSubnetParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Managed Landing Zone Version April 22, 2025 546 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips • Important To create an additional public subnet in a new availability zone (AZ), a private subnet must already be present. • To use this CT to create additional public subnets in an already-provisioned VPC, the VPC must already have public subnets inside it. If this is not the case, contact AMS to deploy those public subnets inside the VPC first. • To learn more about AMS multi-account landing zone, see VPC sharing: A new approach to multiple accounts and VPC management. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2ha68tpd7nr3y. Example: Required Parameters Example not available. Example: All Parameters Example not available. Management Account | Create Accelerate Account Create an Accelerate account in your AMS-managed landing zone. Accelerate provides patching, backup, monitoring and reports, but no requests for change. Full classification: Deployment | Managed landing zone | Management account | Create Accelerate account Change Type Details Change type ID ct-2p93tyd5angmi Managed Landing Zone Version April 22, 2025 547 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 3600 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create an Accelerate account Management account: Creating an Accelerate account with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. Managed Landing Zone Version April 22, 2025 548 AMS Advanced Change Type Reference AMS Advanced Change Type Details To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the |
ams-ct-153 | ams-ct.pdf | 153 | RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Management account: Creating an Accelerate account with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Managed Landing Zone Version April 22, 2025 549 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Note Run this change type from your Management account. Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2p93tyd5angmi" --change-type-version "1.0" -- title "Create Accelerate account" --execution-parameters "{\"AccountName\": \"account- name-1\",\"Regions\": [\"us-east-1\", \"us-east-2\"],\"AccountEmail\": \"account- email-1@example.com\", \"AccelerateOUName\":\"accelerate\", \"SupportLevel\":\"plus\", \"EnablePatch\":true}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateAccAcctParams.json: aws amscm get-change-type-version --change-type-id "ct-1zdasmc2ewzrs" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAccAcctParams.json 2. Modify and save the CreateAccAcctParams file. For example, you can replace the contents with something like this: { Managed Landing Zone Version April 22, 2025 550 AMS Advanced Change Type Reference AMS Advanced Change Type Details "AccountName": "AccountName", "AccountEmail": "nobody@amazon.com", "AccelerateOUName": "accelerate", "Regions": [ "ap-northeast-1", "ap-northeast-2" ], "SupportLevel": "plus", "EnablePatch": true } 3. Output the RFC template JSON file to a file; this example names it CreateAccAcctRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateAccAcctRfc.json 4. Modify and save the CreateAccAcctRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2p93tyd5angmi", "Title": "Create-Accelerate-Acct" } 5. Create the RFC, specifying the CreateAccAcct Rfc file and the CreateAccAcctParams file: aws amscm create-rfc --cli-input-json file://CreateAccAcctRfc.json --execution- parameters file://CreateAccAcctParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about AMS Accelerate, see What is AMS Accelerate?. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2p93tyd5angmi. Managed Landing Zone Version April 22, 2025 551 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "AccountName": "AccountName", "AccountEmail": "nobody@amazon.com", "AccelerateOUName": "accelerate", "Regions": [ "ap-northeast-1", "ap-northeast-2" ], "SupportLevel": "plus", "EnablePatch": true } Example: All Parameters { "AccountName": "AccountName", "AccountEmail": "nobody@amazon.com", "AccelerateOUName": "accelerate", "Regions": [ "ap-northeast-1", "ap-northeast-2" ], "SupportLevel": "plus", "EnablePatch": true } Management Account | Create Application Account (With VPC) Create a managed AWS landing zone application account and a VPC with up to 10 private subnets and up to 5 optional public subnets per availability zone (AZ) for two or three AZ's. Optionally, also create an AWS Backup plan with up to four different rules. Managed AWS landing zone core accounts must already be onboarded to AWS Managed Services (AMS). Full classification: Deployment | Managed landing zone | Management account | Create application account (with VPC) Change Type Details Change type ID ct-1zdasmc2ewzrs Managed Landing Zone Version April 22, 2025 552 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 2.0 Expected execution duration 3600 minutes AWS approval Required Customer approval |
ams-ct-154 | ams-ct.pdf | 154 | private subnets and up to 5 optional public subnets per availability zone (AZ) for two or three AZ's. Optionally, also create an AWS Backup plan with up to four different rules. Managed AWS landing zone core accounts must already be onboarded to AWS Managed Services (AMS). Full classification: Deployment | Managed landing zone | Management account | Create application account (with VPC) Change Type Details Change type ID ct-1zdasmc2ewzrs Managed Landing Zone Version April 22, 2025 552 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 2.0 Expected execution duration 3600 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create an Application account with VPC Management account: Creating an application account (with VPC) with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. Managed Landing Zone Version April 22, 2025 553 AMS Advanced Change Type Reference AMS Advanced Change Type Details To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Management account: Creating an application account (with VPC) with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Managed Landing Zone Version April 22, 2025 554 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Note Run this change type from your Management account. Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-1zdasmc2ewzrs" --change-type-version "2.0" --title "Application account onboarding" --execution-parameters "{\"AccountName \": \"ACCOUNT_NAME\",\"AccountEmail\": \"EMAIL_ADDRESS\",\"ApplicationOUName\": \"APP_ACCOUNT_OU_NAME:CHILD_OU_NAME\",\"SupportLevel\": \"LEVEL\",\"VpcName\": \"VPC_NAME\",\"NumberOfAZs\": \"INTEGER\",\"VpcCIDR\": \"X.X.X.X/X\", \"PrivateSubnet1AZ1CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ2CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ3CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ1CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ2CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ3CIDR\": \"X.X.X.X/X\", \"RouteType\": \"ROUTE_TYPE\", \"TransitGatewayApplicationRouteTableName\": \"TABLE_NAME\"}" With backup parameters: aws amscm create-rfc --change-type-id "ct-1zdasmc2ewzrs" --change-type-version "2.0" --title "Application account onboarding" --execution-parameters "{\"AccountName \": \"ACCOUNT_NAME\",\"AccountEmail\": \"EMAIL_ADDRESS\",\"ApplicationOUName\": \"APP_ACCOUNT_OU_NAME:CHILD_OU_NAME\",\"SupportLevel\": \"LEVEL\",\"VpcName\": \"VPC_NAME\",\"NumberOfAZs\": \"INTEGER\",\"VpcCIDR\": Managed Landing Zone Version April 22, 2025 555 AMS Advanced Change Type Reference AMS Advanced Change Type Details \"X.X.X.X/X\", \"PrivateSubnet1AZ1CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ2CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ3CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ1CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ2CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ3CIDR\": \"X.X.X.X/X\", \"RouteType\": \"ROUTE_TYPE\", \"TransitGatewayApplicationRouteTableName\": \"TABLE_NAME\", \"BackupPlanName\":\"PLAN_NAME\", \"ResourceTagKey\": \"TAG_KEY\", \"ResourceTagValue\":\"TAG_VALUE\", "\BackupRule1ScheduleExpression\": \"cron(0 2 ? * * |
ams-ct-155 | ams-ct.pdf | 155 | contents with something like this: aws amscm create-rfc --change-type-id "ct-1zdasmc2ewzrs" --change-type-version "2.0" --title "Application account onboarding" --execution-parameters "{\"AccountName \": \"ACCOUNT_NAME\",\"AccountEmail\": \"EMAIL_ADDRESS\",\"ApplicationOUName\": \"APP_ACCOUNT_OU_NAME:CHILD_OU_NAME\",\"SupportLevel\": \"LEVEL\",\"VpcName\": \"VPC_NAME\",\"NumberOfAZs\": \"INTEGER\",\"VpcCIDR\": \"X.X.X.X/X\", \"PrivateSubnet1AZ1CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ2CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ3CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ1CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ2CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ3CIDR\": \"X.X.X.X/X\", \"RouteType\": \"ROUTE_TYPE\", \"TransitGatewayApplicationRouteTableName\": \"TABLE_NAME\"}" With backup parameters: aws amscm create-rfc --change-type-id "ct-1zdasmc2ewzrs" --change-type-version "2.0" --title "Application account onboarding" --execution-parameters "{\"AccountName \": \"ACCOUNT_NAME\",\"AccountEmail\": \"EMAIL_ADDRESS\",\"ApplicationOUName\": \"APP_ACCOUNT_OU_NAME:CHILD_OU_NAME\",\"SupportLevel\": \"LEVEL\",\"VpcName\": \"VPC_NAME\",\"NumberOfAZs\": \"INTEGER\",\"VpcCIDR\": Managed Landing Zone Version April 22, 2025 555 AMS Advanced Change Type Reference AMS Advanced Change Type Details \"X.X.X.X/X\", \"PrivateSubnet1AZ1CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ2CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ3CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ1CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ2CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ3CIDR\": \"X.X.X.X/X\", \"RouteType\": \"ROUTE_TYPE\", \"TransitGatewayApplicationRouteTableName\": \"TABLE_NAME\", \"BackupPlanName\":\"PLAN_NAME\", \"ResourceTagKey\": \"TAG_KEY\", \"ResourceTagValue\":\"TAG_VALUE\", "\BackupRule1ScheduleExpression\": \"cron(0 2 ? * * *)\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateMgmtAcctAppAcctWithVpcParams.json: aws amscm get-change-type-version --change-type-id "ct-1zdasmc2ewzrs" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateMgmtAcctAppAcctWithVpcParams.json 2. Modify and save the CreateMgmtAcctAppAcctWithVpcParams file. For example, you can replace the contents with something like this: { "AccountName": "ACCOUNT_NAME", "AccountEmail": "ACCOUNT_EMAIL", "ApplicationOUName": "APPLICATION_OU_NAME:CHILD_OU_NAME", "SupportLevel": "PLUS_or_PREMIUM", "VpcName": "VPC_NAME", "NumberOfAZs": "TWO_or_THREE", "VpcCIDR": "x.x.x.x/x", "PrivateSubnet1AZ1CIDR": "x.x.x.x/x", "PrivateSubnet1AZ2CIDR": "x.x.x.x/x", "PrivateSubnet1AZ3CIDR": "x.x.x.x/x", "PublicSubnetAZ1CIDR": "x.x.x.x/x", "PublicSubnetAZ2CIDR": "x.x.x.x/x", "PublicSubnetAZ3CIDR": "x.x.x.x/x", "RouteType": "ROUTABLE_or_ISOLATED", "TransitGatewayApplicationRouteTableName": "ROUTE_TABLE_NAME" } With backup AND patch parameters: { Managed Landing Zone Version April 22, 2025 556 AMS Advanced Change Type Reference AMS Advanced Change Type Details "AccountName": "ACCOUNT_NAME", "AccountEmail": "ACCOUNT_EMAIL", "ApplicationOUName": "APPLICATION_OU_NAME:CHILD_OU_NAME", "SupportLevel": "PLUS_or_PREMIUM", "VpcName": "VPC_NAME", "NumberOfAZs": "TWO_or_THREE", "VpcCIDR": "x.x.x.x/x", "PrivateSubnet1AZ1CIDR": "x.x.x.x/x", "PrivateSubnet1AZ2CIDR": "x.x.x.x/x", "PrivateSubnet1AZ3CIDR": "x.x.x.x/x", "PublicSubnetAZ1CIDR": "x.x.x.x/x", "PublicSubnetAZ2CIDR": "x.x.x.x/x", "PublicSubnetAZ3CIDR": "x.x.x.x/x", "RouteType": "ROUTABLE_or_ISOLATED", "TransitGatewayApplicationRouteTableName": "ROUTE_TABLE_NAME", "BackupPlanName": "PLAN_NAME", "ResourceTagKey": "TAG_KEY", "ResourceTagValue": "TAG_VALUE", "BackupRule1ScheduleExpression": "cron(0 2 ? * * *)," "PatchOrchestratorFirstTagKey": "TAG_KEY", "PatchOrchestratorDefaultMaintenanceWindowCutoff": "INTEGER", "PatchOrchestratorDefaultMaintenanceWindowDuration": "INTEGER", "PatchOrchestratorDefaultMaintenanceWindowSchedule": "cron(0 18 * * ? *)," "PatchOrchestratorDefaultMaintenanceWindowTimeZone": "TIME_ZONE", "PatchOrchestratorDefaultPatchBackupRetentionInDays": "INTEGER", "PatchOrchestratorNotificationEmails": "DISTRO_EMAIL" } 3. Output the RFC template JSON file to a file; this example names it CreateMgmtAcctAppAcctWithVpcRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateMgmtAcctAppAcctWithVpcRfc.json 4. Modify and save the CreateMgmtAcctAppAcctWithVpcRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-1zdasmc2ewzrs", "Title": "Management-Acct-App-Acct-With-Vpc-RFC" } Managed Landing Zone Version April 22, 2025 557 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Create the RFC, specifying the CreateMgmtAcctAppAcctWithVpcRfc file and the CreateMgmtAcctAppAcctWithVpcParams file: aws amscm create-rfc --cli-input-json file://CreateMgmtAcctAppAcctWithVpcRfc.json --execution-parameters file://CreateMgmtAcctAppAcctWithVpcParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note The minimum value for this parameter has changed from 60 to 1. Important This change type has been automated and you can now configure the VPC to have up to 10 private subnets and up to 5 public subnets. Additionally, you can now configure backup and patching. To learn more about AMS multi-account landing zone, see AWS Managed Services (AMS) Now Offers Managed Landing Zones. How do I create a managed AWS landing zone application account with a VPC? Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1zdasmc2ewzrs. Example: Required Parameters { "AccountName": "AccountName", "AccountEmail": "nobody@amazon.com", "SupportLevel": "plus", Managed Landing Zone Version April 22, 2025 558 AMS Advanced Change Type Reference AMS Advanced Change Type Details "VpcName": "TestVPC", "VpcCIDR": "10.0.0.0/22", "NumberOfAZs": 2, "PrivateSubnet1AZ1CIDR": "10.0.0.0/24", "PrivateSubnet1AZ2CIDR": "10.0.1.0/24", "BackupPlanName": "default-backup-plan", "ResourceTagKey": "Backup", "ResourceTagValue": "True", "BackupRule1ScheduleExpression": "cron(0 2 ? * * )" } Example: All Parameters { "AccountName": "AccountName", "AccountEmail": "nobody@amazon.com", "ApplicationOUName": "applications", "SupportLevel": "plus", "VpcName": "TestVPC", "VpcCIDR": "10.0.0.0/22", "NumberOfAZs": 3, "RouteType": "isolated", "TransitGatewayApplicationRouteTableName": "defaultAppRouteTable", "PublicSubnetAZ1CIDR": "10.0.0.0/24", "PublicSubnetAZ2CIDR": "10.0.1.0/24", "PublicSubnetAZ3CIDR": "10.0.2.0/24", "PublicSubnet2AZ1CIDR": "10.0.0.0/24", "PublicSubnet2AZ2CIDR": "10.0.1.0/24", "PublicSubnet2AZ3CIDR": "10.0.2.0/24", "PublicSubnet3AZ1CIDR": "10.0.0.0/24", "PublicSubnet3AZ2CIDR": "10.0.1.0/24", "PublicSubnet3AZ3CIDR": "10.0.2.0/24", "PublicSubnet4AZ1CIDR": "10.0.0.0/24", "PublicSubnet4AZ2CIDR": "10.0.1.0/24", "PublicSubnet4AZ3CIDR": "10.0.2.0/24", "PublicSubnet5AZ1CIDR": "10.0.0.0/24", "PublicSubnet5AZ2CIDR": "10.0.1.0/24", "PublicSubnet5AZ3CIDR": "10.0.2.0/24", "PrivateSubnet1AZ1CIDR": "10.0.0.0/24", "PrivateSubnet1AZ2CIDR": "10.0.1.0/24", "PrivateSubnet1AZ3CIDR": "10.0.2.0/24", "PrivateSubnet2AZ1CIDR": "10.0.3.0/24", "PrivateSubnet2AZ2CIDR": "10.0.4.0/24", Managed Landing Zone Version April 22, 2025 559 AMS Advanced Change Type Reference AMS Advanced Change Type Details "PrivateSubnet2AZ3CIDR": "10.0.5.0/24", "PrivateSubnet3AZ1CIDR": "10.0.0.0/24", "PrivateSubnet3AZ2CIDR": "10.0.1.0/24", "PrivateSubnet3AZ3CIDR": "10.0.2.0/24", "PrivateSubnet4AZ1CIDR": "10.0.3.0/24", "PrivateSubnet4AZ2CIDR": "10.0.4.0/24", "PrivateSubnet4AZ3CIDR": "10.0.5.0/24", "PrivateSubnet5AZ1CIDR": "10.0.0.0/24", "PrivateSubnet5AZ2CIDR": "10.0.1.0/24", "PrivateSubnet5AZ3CIDR": "10.0.2.0/24", "PrivateSubnet6AZ1CIDR": "10.0.3.0/24", "PrivateSubnet6AZ2CIDR": "10.0.4.0/24", "PrivateSubnet6AZ3CIDR": "10.0.5.0/24", "PrivateSubnet7AZ1CIDR": "10.0.0.0/24", "PrivateSubnet7AZ2CIDR": "10.0.1.0/24", "PrivateSubnet7AZ3CIDR": "10.0.2.0/24", "PrivateSubnet8AZ1CIDR": "10.0.3.0/24", "PrivateSubnet8AZ2CIDR": "10.0.4.0/24", "PrivateSubnet8AZ3CIDR": "10.0.5.0/24", "PrivateSubnet9AZ1CIDR": "10.0.0.0/24", "PrivateSubnet9AZ2CIDR": "10.0.1.0/24", "PrivateSubnet9AZ3CIDR": "10.0.2.0/24", "PrivateSubnet10AZ1CIDR": "10.0.3.0/24", "PrivateSubnet10AZ2CIDR": "10.0.4.0/24", "PrivateSubnet10AZ3CIDR": "10.0.5.0/24", "DirectAlertsEmail": "test@amazon.com", "SamlMetadataDocumentURL": "https://test.com", "BackupPlanName": "default-backup-plan", "ResourceTagKey": "Backup", "ResourceTagValue": "True", "BackupRule1ScheduleExpression": "cron(0 2 ? * * )", "PatchOrchestratorFirstTagKey": "AppId", "PatchOrchestratorSecondTagKey": "Environment", "PatchOrchestratorDefaultMaintenanceWindowCutoff": 1, "PatchOrchestratorDefaultMaintenanceWindowDuration": 4, "PatchOrchestratorDefaultMaintenanceWindowSchedule": "cron(0 18 * * ? *)", "PatchOrchestratorDefaultMaintenanceWindowTimeZone": "UTC", "PatchOrchestratorDefaultPatchBackupRetentionInDays": 60, "PatchOrchestratorNotificationEmails": ["user@test.com"] } Managed Landing Zone Version April 22, 2025 560 AMS Advanced Change Type Reference AMS Advanced Change Type Details Management Account | Create Custom OUs Create multiple custom AWS organizational units (OU) under the following paths, "customer- managed", "applications:managed", "applications:tools" and "applications:development". Full classification: Deployment | Managed landing zone | Management account | Create custom OUs Change Type Details Change type ID ct-1ksyoxreh35tu Current version 2.0 Expected execution duration 3600 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create a custom OU Management account: Creating a Management |
ams-ct-156 | ams-ct.pdf | 156 | ? *)", "PatchOrchestratorDefaultMaintenanceWindowTimeZone": "UTC", "PatchOrchestratorDefaultPatchBackupRetentionInDays": 60, "PatchOrchestratorNotificationEmails": ["user@test.com"] } Managed Landing Zone Version April 22, 2025 560 AMS Advanced Change Type Reference AMS Advanced Change Type Details Management Account | Create Custom OUs Create multiple custom AWS organizational units (OU) under the following paths, "customer- managed", "applications:managed", "applications:tools" and "applications:development". Full classification: Deployment | Managed landing zone | Management account | Create custom OUs Change Type Details Change type ID ct-1ksyoxreh35tu Current version 2.0 Expected execution duration 3600 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create a custom OU Management account: Creating a Management account custom OU with the console Screenshot of this change type in the AMS console: How it works: Managed Landing Zone Version April 22, 2025 561 AMS Advanced Change Type Reference AMS Advanced Change Type Details 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Management account: Creating a Management account custom OU with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Managed Landing Zone Version April 22, 2025 562 AMS Advanced Change Type Reference AMS Advanced Change Type Details Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Note Run this change type from your Management account. Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc \ --change-type-id "ct-1ksyoxreh35tu" \ --change-type-version "2.0" --title "New OU Creation" \ --execution-parameters "{\"CustomOUPaths\": [ \"applications:managed:OU1:OU2:OU3\", \"applications:managed:OU1:OU2:OU3\"]}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it MgmtAcctCreateOuParams.json: Managed Landing Zone Version April 22, 2025 563 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm get-change-type-version --change-type-id "ct-1ksyoxreh35tu" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > MgmtAcctCreateOuParams.json 2. Modify and save the MgmtAcctCreateOuParams file. For example, you can replace the contents with something like this: { "CustomOUPaths": ["applications:managed:healthcare", "customer-managed:CustomOU", "applications:tools:automation", "applications:development:healthcare"] } 3. Output the RFC template JSON file to a file; this example names it MgmtAcctCreateOuRfc.json: aws amscm create-rfc --generate-cli-skeleton |
ams-ct-157 | ams-ct.pdf | 157 | \ --execution-parameters "{\"CustomOUPaths\": [ \"applications:managed:OU1:OU2:OU3\", \"applications:managed:OU1:OU2:OU3\"]}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it MgmtAcctCreateOuParams.json: Managed Landing Zone Version April 22, 2025 563 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm get-change-type-version --change-type-id "ct-1ksyoxreh35tu" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > MgmtAcctCreateOuParams.json 2. Modify and save the MgmtAcctCreateOuParams file. For example, you can replace the contents with something like this: { "CustomOUPaths": ["applications:managed:healthcare", "customer-managed:CustomOU", "applications:tools:automation", "applications:development:healthcare"] } 3. Output the RFC template JSON file to a file; this example names it MgmtAcctCreateOuRfc.json: aws amscm create-rfc --generate-cli-skeleton > MgmtAcctCreateOuRfc.json 4. Modify and save the MgmtAcctCreateOuRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-1ksyoxreh35tu", "Title": "Management-Acct-Create-OU-RFC" } 5. Create the RFC, specifying the MgmtAcctCreateOu Rfc file and the MgmtAcctCreateOuParams file: aws amscm create-rfc --cli-input-json file://MgmtAcctCreateOuRfc.json --execution- parameters file://MgmtAcctCreateOuParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Managed Landing Zone Version April 22, 2025 564 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note This change type is now at version 2.0. A new parameter, CustomOUPath replaces the previous CustomOUName parameter, and the change type is now automated and not manually executed. To learn more about AMS multi-account landing zone, see AWS Managed Services (AMS) Now Offers Managed Landing Zones. For information on creating OUs, see Managing organizational units (OUs). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1ksyoxreh35tu. Example: Required Parameters Example not available. Example: All Parameters Example not available. Management Account | Create Custom SCP (Review Required) Create a custom service control policy (SCP) to manage permissions across AWS organization. Full classification: Deployment | Managed landing zone | Management account | Create custom SCP (review required) Change Type Details Change type ID ct-33ste5yc7hprs Managed Landing Zone Version April 22, 2025 565 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 3600 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Create a service control policy (SCP) (review required) Management account: Creating a Management account custom SCP with the console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. Managed Landing Zone Version April 22, 2025 566 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Management account: Creating a Management account custom SCP with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both |
ams-ct-158 | ams-ct.pdf | 158 | Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Management account: Creating a Management account custom SCP with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status Managed Landing Zone Version April 22, 2025 567 AMS Advanced Change Type Reference AMS Advanced Change Type Details changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Note Run this change type from your Management account. Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc \ --change-type-id "ct-33ste5yc7hprs" \ --change-type-version "1.0" --title "New SCP Creation" \ --execution-parameters "{\"TargetId\":\"ou-hlzm-8ievlm9x\", \"CustomServiceControlPolicy\":\"Test\", \"SCPDescription\":\"Test SCP\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateMasterAcctScpParams.json: aws amscm get-change-type-version --change-type-id "ct-33ste5yc7hprs" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateMasterAcctScpParams.json 2. Modify and save the CreateMasterAcctScpParams file. For example, you can replace the contents with something like this: { "TargetId":"ou-hlzm-8ievlm9x", "CustomServiceControlPolicy":"MySCP", "SCPDescription":"Test SCP" } Managed Landing Zone Version April 22, 2025 568 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. Output the RFC template JSON file to a file; this example names it CreateMasterAcctScpRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateMasterAcctScpRfc.json 4. Modify and save the CreateMasterAcctScpRfc file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-33ste5yc7hprs", "ChangeTypeVersion": "1.0", "Title": "New SCP Creation" } 5. Create the RFC, specifying the CreateMasterAcctCreateScp Rfc file and the CreateMasterAcctScpParams.json file: aws amscm create-rfc --cli-input-json file://CreateMasterAcctScpRfc.json -- execution-parameters file://CreateMasterAcctScpParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips This is a "review required" change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a "review required" change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. To learn more about AMS multi-account landing zone, see AWS Managed Services (AMS) Now Offers Managed Landing Zones. Note Make sure that you refer to and use the curated Service Control Policies (SCPs) library that fits your business requirements. Provide the unique ID from the library in the form of SCP- AMS-XXX in the RFC title. Managed Landing Zone Version April 22, 2025 569 AMS Advanced Change Type Reference AMS Advanced Change Type Details For more information, see Curated SCPs and Config Rules. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-33ste5yc7hprs. Example: Required Parameters { "TargetId": "ou-96dv-e18n036l", "CustomServiceControlPolicy": "" } Example: All Parameters { "TargetId": "ou-96dv-e18n036l", "CustomServiceControlPolicy": "", "SCPDescription": "Description of the custom Service Control Policy (SCP) that needs to be attached to the provided target.", "Priority": "Medium" } Management Account | Create Customer-Managed Application Account Create a customer-managed application account in a multi-account AWS landing zone. Customer- managed accounts give you full control to operate the infrastructure within the centralized architecture managed by AMS. Multi-account AWS landing zone core accounts must already be onboarded to AWS Managed Services (AMS). Full classification: Deployment | Managed landing zone | Management account | Create customer- managed application account Change Type Details Change type ID ct-3pwbixz27n3tn Managed Landing Zone Version April 22, 2025 570 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 3600 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create a |
ams-ct-159 | ams-ct.pdf | 159 | multi-account AWS landing zone. Customer- managed accounts give you full control to operate the infrastructure within the centralized architecture managed by AMS. Multi-account AWS landing zone core accounts must already be onboarded to AWS Managed Services (AMS). Full classification: Deployment | Managed landing zone | Management account | Create customer- managed application account Change Type Details Change type ID ct-3pwbixz27n3tn Managed Landing Zone Version April 22, 2025 570 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 3600 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create a Customer Managed application account Management account: Creating a Management account customer-managed application account with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. Managed Landing Zone Version April 22, 2025 571 AMS Advanced Change Type Reference AMS Advanced Change Type Details To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Management account: Creating a Management account customer-managed application account with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Managed Landing Zone Version April 22, 2025 572 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Note Run this change type from your Management account. Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc \ --change-type-id "ct-3pwbixz27n3tn" \ --change-type-version "1.0" --title "New customer-managed account creation" \ --execution-parameters "{\"AccountName\":\"test\", \"AccountEmail\":\"test@test.com\", \"CustomerManagedOUName\":\"customer-managed\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it NewCustomerManagedAccountParams.json: aws amscm get-change-type-version --change-type-id "ct-1zdasmc2ewzrs" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > NewCustomerManagedAccountParams.json 2. Modify and save the NewCustomerManagedAccountParams file. For example, you can replace the contents with something like this: Managed Landing Zone Version April 22, 2025 573 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "AccountName":"test", "AccountEmail":"test@test.com", "CustomerManagedOUName":"customer-managed" } 3. Output the RFC template JSON file to a file; |
ams-ct-160 | ams-ct.pdf | 160 | create-rfc \ --change-type-id "ct-3pwbixz27n3tn" \ --change-type-version "1.0" --title "New customer-managed account creation" \ --execution-parameters "{\"AccountName\":\"test\", \"AccountEmail\":\"test@test.com\", \"CustomerManagedOUName\":\"customer-managed\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it NewCustomerManagedAccountParams.json: aws amscm get-change-type-version --change-type-id "ct-1zdasmc2ewzrs" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > NewCustomerManagedAccountParams.json 2. Modify and save the NewCustomerManagedAccountParams file. For example, you can replace the contents with something like this: Managed Landing Zone Version April 22, 2025 573 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "AccountName":"test", "AccountEmail":"test@test.com", "CustomerManagedOUName":"customer-managed" } 3. Output the RFC template JSON file to a file; this example names it NewCustomerManagedAccountRfc.json: aws amscm create-rfc --generate-cli-skeleton > NewCustomerManagedAccountRfc.json 4. Modify and save the NewCustomerManagedAccountRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-3pwbixz27n3tn", "ChangeTypeVersion": "1.0", "Title": "New customer-managed account creation" } 5. Create the RFC, specifying the NewCustomerManagedAccount Rfc file and the NewCustomerManagedAccountParams file: aws amscm create-rfc --cli-input-json file://NewCustomerManagedAccountRfc.json -- execution-parameters file://NewCustomerManagedAccountParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about AMS multi-account landing zone, see AWS Managed Services (AMS) Now Offers Managed Landing Zones. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3pwbixz27n3tn. Managed Landing Zone Version April 22, 2025 574 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters Example not available. Example: All Parameters Example not available. Management Account | Create Developer Mode Account (With VPC) Create a managed AWS landing zone developer mode account and a VPC with up to 10 private subnets and up to 5 optional public subnets per availability zone (AZ) for two or three AZ's. Optionally, also create an AWS Backup plan with up to four different rules. Managed AWS landing zone core accounts must already be onboarded to AWS Managed Services (AMS). Full classification: Deployment | Managed landing zone | Management account | Create developer mode account (with VPC) Change Type Details Change type ID ct-38xcr0q86k9lh Current version 1.0 Expected execution duration 3600 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create Developer mode account with VPC Management account: Creating a developer mode account with VPC with the console Screenshot of this change type in the AMS console: Managed Landing Zone Version April 22, 2025 575 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. Managed Landing Zone Version April 22, 2025 576 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Management account: Creating a developer mode account with VPC with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one |
ams-ct-161 | ams-ct.pdf | 161 | no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Management account: Creating a developer mode account with VPC with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Managed Landing Zone Version April 22, 2025 577 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note Run this change type from your Management account. Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-38xcr0q86k9lh" --change-type-version "1.0" -- title "Dev Mode account onboarding" --execution-parameters "{\"AccountName \": \"ACCOUNT_NAME\",\"AccountEmail\": \"/\",\"DeveloperModeOUName\": \"Development_OU_NAME:CHILD_OU_NAME\",\"SupportLevel\": \"LEVEL\",\"VpcName\": \"VPC_NAME\",\"NumberOfAZs\": \"INTEGER\",\"VpcCIDR\": \"X.X.X.X/X\", \"PrivateSubnet1AZ1CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ2CIDR\": \"X.X.X.X/X\",\"PrivateSubnet1AZ3CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ1CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ2CIDR\": \"X.X.X.X/X\",\"PublicSubnetAZ3CIDR\": \"X.X.X.X/X\", \"RouteType\": \"ROUTE_TYPE\", \"TransitGatewayApplicationRouteTableName\": \"TABLE_NAME\", \"BackupPlanName\":\"PLAN_NAME\", \"ResourceTagKey\": \"TAG_KEY\", \"ResourceTagValue\":\"TAG_VALUE\", "\BackupRule1ScheduleExpression\": \"cron(0 2 ? * * *)\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateDevModeAcctWithVpcParams.json: aws amscm get-change-type-version --change-type-id "ct-38xcr0q86k9lh" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDevModeAcctWithVpcParams.json 2. Modify and save the CreateDevModeAcctWithVpcParams file. For example, you can replace the contents with something like this: { "AccountName": "ACCOUNT_NAME", "AccountEmail": "ACCOUNT_EMAIL", "DeveloperModeOUName": "DEVELOPER_MODE_OU_NAME:CHILD_OU_NAME", "SupportLevel": "PLUS_or_PREMIUM", "VpcName": "VPC_NAME", Managed Landing Zone Version April 22, 2025 578 AMS Advanced Change Type Reference AMS Advanced Change Type Details "NumberOfAZs": "TWO_or_THREE", "VpcCIDR": "x.x.x.x/x", "PrivateSubnet1AZ1CIDR": "x.x.x.x/x", "PrivateSubnet1AZ2CIDR": "x.x.x.x/x", "PrivateSubnet1AZ3CIDR": "x.x.x.x/x", "PublicSubnetAZ1CIDR": "x.x.x.x/x", "PublicSubnetAZ2CIDR": "x.x.x.x/x", "PublicSubnetAZ3CIDR": "x.x.x.x/x", "RouteType": "ROUTABLE_or_ISOLATED", "TransitGatewayApplicationRouteTableName": "ROUTE_TABLE_NAME" } 3. Output the RFC template JSON file to a file; this example names it CreateDevModeAcctWithVpcRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDevModeAcctWithVpcRfc.json 4. Modify and save the CreateDevModeAcctWithVpcRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-38xcr0q86k9lh", "ChangeTypeVersion": "1.0", "Title": "Create developer mode account with VPC" } 5. Create the RFC, specifying the CreateDevModeAcctWithVpcRfc file and the CreateDevModeAcctWithVpcParams file: aws amscm create-rfc --cli-input-json file://CreateDevModeAcctWithVpcRfc.json -- execution-parameters file://CreateDevModeAcctWithVpcParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about developer mode, see Developer mode. Managed Landing Zone Version April 22, 2025 579 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-38xcr0q86k9lh. Example: Required Parameters Example not available. Example: All Parameters Example not available. Management Account | Create StackSets Stack (Review Required) Create AWS CloudFormation (CFN) StackSets stacks and deploy the stack instances. Use the CloudFormation StackSets feature to create stacks across multiple accounts. Full classification: Deployment | Managed landing zone | Management account | Create StackSets stack (review required) Change Type Details Change type ID ct-16pknsfa8lul7 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Managed Landing Zone Version April 22, 2025 580 AMS Advanced Change Type Reference Additional Information Create a Stacksets stack Creating a Stacksets stack with the console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note |
ams-ct-162 | ams-ct.pdf | 162 | Stacksets stack with the console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Managed Landing Zone Version April 22, 2025 581 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Stacksets stack with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Managed Landing Zone Version April 22, 2025 582 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Note Run this change type from your Management account. Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-16pknsfa8lul7" --change-type-version "1.0" --title "Create StackSets Stack" --execution-parameters "{\"Name\": \"Stackset name\", \"Region\": \"us-east-1\", \"OuId"\: \"ou-cccc-00000000\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UpdateStacksetsStackParams.json: aws amscm get-change-type-version --change-type-id "ct-1v9g9n30woc8h" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateStacksetsStackParams.json 2. Modify and save the UpdateStacksetsStackParams file. For example, you can replace the contents with something like this: { "CloudFormationTemplate": "template", "CloudFormationTemplateS3Endpoint": "S3 link of the template", "Description": "Create Stackset", "Name": "test-stackset", "OuId": ["ou-cccc-00000000"], "Region": "us-east-1", "Parameters": [ { "Name": "test-value", "Value": "test-value" } Managed Landing Zone Version April 22, 2025 583 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "Tags": [ { "Key": "key1", "Value": "value1" }, { "Key": "key2", "Value": "value2" } ], "Priority": "High" } 3. Output the RFC template JSON file to a file; this example names it UpdateStacksetsStackRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateStacksetsStackRfc.json 4. Modify and save the UpdateStacksetsStackRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-16pknsfa8lul7", "Title": "Create StackSets Stack " } 5. Create the RFC, specifying the UpdateStacksetsStack Rfc file and the UpdateStacksetsStackParams file: aws amscm create-rfc --cli-input-json file://UpdateStacksetsStackRfc.json -- execution-parameters file://UpdateStacksetsStackParams.json You receive the ID of the new RFC in the |
ams-ct-163 | ams-ct.pdf | 163 | ], "Tags": [ { "Key": "key1", "Value": "value1" }, { "Key": "key2", "Value": "value2" } ], "Priority": "High" } 3. Output the RFC template JSON file to a file; this example names it UpdateStacksetsStackRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateStacksetsStackRfc.json 4. Modify and save the UpdateStacksetsStackRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-16pknsfa8lul7", "Title": "Create StackSets Stack " } 5. Create the RFC, specifying the UpdateStacksetsStack Rfc file and the UpdateStacksetsStackParams file: aws amscm create-rfc --cli-input-json file://UpdateStacksetsStackRfc.json -- execution-parameters file://UpdateStacksetsStackParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • For AWS CloudFormation details, see Create a stack set • For general AWS CloudFormation information on stack sets, see StackSets concepts Managed Landing Zone Version April 22, 2025 584 AMS Advanced Change Type Reference AMS Advanced Change Type Details • To learn more about AMS multi-account landing zone, see AWS Managed Services (AMS) Now Offers Managed Landing Zones. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-16pknsfa8lul7. Example: Required Parameters { "Description": "AMSTestCT - Create a test stackset", "Name": "test-stackset", "OuId": ["ou-cccc-00000000"], "Region": "us-east-1" } Example: All Parameters { "CloudFormationTemplate": "template", "CloudFormationTemplateS3Endpoint": "https://s3.amazonaws.com/cf- templates-33kj7hiuwdk9-us-east-1/2017261mYA-stm-dynamic-sqs-no-params- sept-2017.template", "Description": "AMSTestCT - Create a test stackset", "Name": "test-stackset", "OuId": ["ou-cccc-00000000"], "Region": "us-east-1", "Parameters": [ { "Name": "test-value", "Value": "test-value" } ], "Tags": [ { "Key": "key1", "Value": "value1" }, { "Key": "key2", "Value": "value2" } ], Managed Landing Zone Version April 22, 2025 585 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Priority": "High" } Management Account | Create Tools Account (With VPC) Create a managed AWS landing zone tools account and a VPC with a private subnet, an isolated private subnet, and a public subnet. Optionally, also create an AWS Backup plan with up to four different rules. Managed AWS landing zone core accounts must already be onboarded to AWS Managed Services (AMS). Full classification: Deployment | Managed landing zone | Management account | Create tools account (with VPC) Change Type Details Change type ID ct-2j7q1hgf26x5c Current version 2.0 Expected execution duration 3600 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create Tools account with VPC Management account: Creating a Management account Tools account with the console Screenshot of this change type in the AMS console: Managed Landing Zone Version April 22, 2025 586 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Managed Landing Zone Version April 22, 2025 587 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Management account: Creating a Management account Tools account with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters |
ams-ct-164 | ams-ct.pdf | 164 | displays with the submitted RFC details, and the initial Run output. Managed Landing Zone Version April 22, 2025 587 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Management account: Creating a Management account Tools account with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Note Run this change type from your Management account. Managed Landing Zone Version April 22, 2025 588 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc \ --change-type-id "ct-2j7q1hgf26x5c" \ --change-type-version "1.0" --title "New tools account creation" \ --execution-parameters "{\"AccountName\": \"tools\",\"AccountEmail \": \"test@test.com\",\"ApplicationOUName\": \"applications:tools\", \"TransitGatewayApplicationRouteTableName\": \"defaultAppRouteDomain\", \"SupportLevel\": \"plus\",\"VpcName\": \"testvpc4\",\"VpcCIDR\": \"10.106.0.0/24\", \"PrivateSubnetIsolatedCIDR\": \"10.106.0.128/26\", \"PrivateSubnetCIDR\": \"10.106.0.192/26\",\"PublicSubnetCIDR\":\"10.106.0.192/26\",\"DirectAlertsEmail \": \"test@test.com\",\"BackupRule1ScheduleExpression\": \"cron(0 2 ? * * )\", \"BackupPlanName\": \"test\",\"ResourceTagKey\": \"backup\",\"ResourceTagValue\": \"true\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it NewToolsAccountParams.json: aws amscm get-change-type-version --change-type-id "ct-2j7q1hgf26x5c" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > NewToolsAccountParams.json 2. Modify and save the NewToolsAccountParams file. For example, you can replace the contents with something like this: { "AccountName":"tools", "AccountEmail":"test@test.com", "ApplicationOUName":"applications:tools", "TransitGatewayApplicationRouteTableName": "defaultAppRouteDomain", "SupportLevel": "plus", "VpcName": "testvpc4", "VpcCIDR": "10.106.0.0/24", "PrivateSubnetIsolatedCIDR": "10.106.0.128/26", "PrivateSubnetCIDR":"10.106.0.192/26", "PublicSubnetCIDR":"10.106.0.192/26", "DirectAlertsEmail": "test@test.com", "BackupRule1ScheduleExpression": "cron(0 2 ? * * )", Managed Landing Zone Version April 22, 2025 589 AMS Advanced Change Type Reference AMS Advanced Change Type Details "BackupPlanName": "test", "ResourceTagKey": "backup", "ResourceTagValue": "true" } 3. Output the RFC template JSON file to a file; this example names it NewToolsAccountRfc.json: aws amscm create-rfc --generate-cli-skeleton > NewToolsAccountRfc.json 4. Modify and save the NewToolsAccountRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-2j7q1hgf26x5c", "ChangeTypeVersion": "2.0", "Title": "New tools account with VPC creation" } 5. Create the RFC, specifying the NewToolsAccount Rfc file and the NewToolsAccountParams file: aws amscm create-rfc --cli-input-json file://NewToolsAccountRfc.json --execution- parameters file://NewToolsAccountParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note This change type is updated to version 2.0 with changes to input parameters. To learn more about AMS multi-account landing zone, see AWS Managed Services (AMS) Now Offers Managed Landing Zones. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2j7q1hgf26x5c. Managed Landing Zone Version April 22, 2025 590 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters Example not available. Example: All Parameters Example not available. Networking Account | Add Static Route Create a static route on transit gateway (TGW) route table. Use this change type for multi-account landing zone (MALZ) Networking accounts only. Full classification: Deployment | Managed landing zone | Networking account | Add static route Change Type Details Change type ID ct-3r2ckznmt0a59 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Add a static route Networking account: Adding a static route with the Console Screenshot of this change type in the AMS console: Managed Landing Zone Version April 22, 2025 591 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose |
ams-ct-165 | ams-ct.pdf | 165 | Not required Execution mode Automated Additional Information Add a static route Networking account: Adding a static route with the Console Screenshot of this change type in the AMS console: Managed Landing Zone Version April 22, 2025 591 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Managed Landing Zone Version April 22, 2025 592 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Networking account: Adding a static route with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Managed Landing Zone Version April 22, 2025 593 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-3r2ckznmt0a59" --change-type-version "1.0" --title "Create a static route on Transit Gateway Route Table" --execution- parameters "{\"DocumentName\": \"AWSManagedServices-CreateRouteInTGWRouteTable \",\"Region\": \"us-east-1\",\"Parameters\": {\"TransitGatewayAttachmentId\": [\"tgw-attach-0878cf82a40721d19\"],\"TransitGatewayRouteTableId\": [\"tgw- rtb-06ddc751c0c0c881c\"], \"Blackhole\": [\"false"], \"DestinationCidrBlock\": [\"10.0.0.0/24\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it AddStaticRouteParams.json: aws amscm get-change-type-version --change-type-id "ct-3r2ckznmt0a59" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AddStaticRouteParams.json 2. Modify and save the AddStaticRouteParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateRouteInTGWRouteTable", "Region": "us-east-1", "Parameters": { "DestinationCidrBlock" : [ "10.0.0.0/24" ], "Blackhole" : [ "false" ], "TransitGatewayAttachmentId": [ "tgw-attach-0878cf82a40721d19" ], "TransitGatewayRouteTableId": [ "tgw-rtb-06ddc751c0c0c881c" ] } } 3. Output the RFC template JSON file to a file; this example names it AddStaticRouteRfc.json: aws amscm create-rfc --generate-cli-skeleton > AddStaticRouteRfc.json 4. Modify and save the AddStaticRouteRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3r2ckznmt0a59", "Title": "Create a static route on Transit Gateway Route Table" Managed Landing Zone Version April 22, 2025 594 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 5. Create the RFC, specifying the AddStaticRouteRfc file and the AddStaticRouteParams |
ams-ct-166 | ams-ct.pdf | 166 | ], "Blackhole" : [ "false" ], "TransitGatewayAttachmentId": [ "tgw-attach-0878cf82a40721d19" ], "TransitGatewayRouteTableId": [ "tgw-rtb-06ddc751c0c0c881c" ] } } 3. Output the RFC template JSON file to a file; this example names it AddStaticRouteRfc.json: aws amscm create-rfc --generate-cli-skeleton > AddStaticRouteRfc.json 4. Modify and save the AddStaticRouteRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3r2ckznmt0a59", "Title": "Create a static route on Transit Gateway Route Table" Managed Landing Zone Version April 22, 2025 594 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 5. Create the RFC, specifying the AddStaticRouteRfc file and the AddStaticRouteParams file: aws amscm create-rfc --cli-input-json file://AddStaticRouteRfc.json --execution- parameters file://AddStaticRouteParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Before you run this Change Type, confirm the following points: • The TGW route table exists and is available. • The TGW route table is not DMZBastionsRouteDomain or EgressRouteDomain. • The TGW attachment exists. • The CIDR is not default (0.0.0.0/0), invalid, or that the route already exists. Note This Change Type is only valid in Multi-account Landing Zone (MALZ) Networking accounts. To learn more about AMS multi-account landing zone, see AWS Managed Services (AMS) Now Offers Managed Landing Zones. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3r2ckznmt0a59. Example: Required Parameters { "DocumentName": "AWSManagedServices-CreateRouteInTGWRouteTable", "Region": "us-east-1", "Parameters": { "DestinationCidrBlock": ["10.0.2.0/24"], Managed Landing Zone Version April 22, 2025 595 AMS Advanced Change Type Reference AMS Advanced Change Type Details "TransitGatewayRouteTableId": [ "tgw-rtb-06ddc751c0c0c881c" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-CreateRouteInTGWRouteTable", "Region": "us-east-1", "Parameters": { "Blackhole": [false], "DestinationCidrBlock": ["10.0.2.0/24"], "TransitGatewayAttachmentId": [ "tgw-attach-0878cf82a40721d19" ], "TransitGatewayRouteTableId": [ "tgw-rtb-06ddc751c0c0c881c" ] } } Networking Account | Create Application Route Table (Review Required) Create a custom AWS Transit Gateway (TGW) route table for the application accounts in the networking account. By default, the route table does not connect to the on-premise network, but contains preset routes. To request connections to the on-premise network, submit a Management| Other|Other|Update change type. Full classification: Deployment | Managed landing zone | Networking account | Create application route table (review required) Change Type Details Change type ID ct-1urj94c3hdfu5 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Managed Landing Zone Version April 22, 2025 596 AMS Advanced Change Type Reference Additional Information Create application route table (review required) AMS Advanced Change Type Details Networking account: creating an application route table with the Console (review required) Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Managed Landing Zone Version April 22, 2025 597 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Networking account: creating an application route table with the CLI (review required) How it works: 1. |
ams-ct-167 | ams-ct.pdf | 167 | lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Networking account: creating an application route table with the CLI (review required) How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Managed Landing Zone Version April 22, 2025 598 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-1urj94c3hdfu5" --change-type-version "1.0" --title "Create Application TGW route table" --execution-parameters "{\"TransitGatewayApplicationRouteTableName\":\"TABLE_NAME\", \"AddPresetStaticRoutes \": true}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateRouteTableParams.json: aws amscm get-change-type-version --change-type-id "ct-1urj94c3hdfu5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRouteTableParams.json 2. Modify and save the CreateRouteTableParams file. For example, you can replace the contents with something like this: { "TransitGatewayApplicationRouteTableName": "ROUTE_TABLE_NAME", "AddPresetStaticRoutes": true } 3. Output the RFC template JSON file to a file; this example names it CreateRouteTableRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRouteTableRfc.json 4. Modify and save the CreateRouteTableRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1urj94c3hdfu5", "Title": "Create-TG-Route-Table-RFC" } 5. Create the RFC, specifying the CreateRouteTableRfc file and the CreateRouteTableParams file: Managed Landing Zone Version April 22, 2025 599 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://CreateRouteTableRfc.json --execution- parameters file://CreateRouteTableParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips This is a "review required" change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a "review required" change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. • This change type is manual. To use the automated version of this change type, see Networking Account | Create Application Route Table. • By default, the route table does not connect to on-premise network, but contains preset routes. To request connections to the on-premise network, submit a Deployment | Managed landing zone | Networking account | Add static route change type, with the route table ID, to add routes to it. If you set the AddPresetStaticRoutes parameter to False, the route table that created is empty and you must file a Deployment | Managed landing zone | Networking account | Add static route change type, with the route table ID, to add routes to it. • To learn more about AMS multi-account landing zone, see AWS Managed Services (AMS) Now Offers Managed Landing Zones. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1urj94c3hdfu5. Example: Required Parameters { "TransitGatewayApplicationRouteTableName": "routeTableName" } Managed Landing Zone Version April 22, 2025 600 AMS Advanced Change Type Details AMS Advanced Change Type Reference Example: All Parameters { "TransitGatewayApplicationRouteTableName": "routeTableName", "AddPresetStaticRoutes": true, "Priority": "Medium" } Networking Account | Create Transit Gateway Route Table Create a transit gateway (TGW) route table. Use this change type for multi-account landing zone (MALZ) Networking accounts only. Full classification: |
ams-ct-168 | ams-ct.pdf | 168 | To learn more about AMS multi-account landing zone, see AWS Managed Services (AMS) Now Offers Managed Landing Zones. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1urj94c3hdfu5. Example: Required Parameters { "TransitGatewayApplicationRouteTableName": "routeTableName" } Managed Landing Zone Version April 22, 2025 600 AMS Advanced Change Type Details AMS Advanced Change Type Reference Example: All Parameters { "TransitGatewayApplicationRouteTableName": "routeTableName", "AddPresetStaticRoutes": true, "Priority": "Medium" } Networking Account | Create Transit Gateway Route Table Create a transit gateway (TGW) route table. Use this change type for multi-account landing zone (MALZ) Networking accounts only. Full classification: Deployment | Managed landing zone | Networking account | Create transit gateway route table Change Type Details Change type ID ct-3dscwaeyi6cup Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create application route table (review required) Networking account: creating an application route table with the Console (review required) Screenshot of this change type in the AMS console: Managed Landing Zone Version April 22, 2025 601 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Managed Landing Zone Version April 22, 2025 602 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Networking account: creating an application route table with the CLI (review required) How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Managed Landing Zone Version April 22, 2025 603 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-1urj94c3hdfu5" --change-type-version "1.0" --title "Create Application TGW route table" --execution-parameters "{\"TransitGatewayApplicationRouteTableName\":\"TABLE_NAME\", \"AddPresetStaticRoutes \": true}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateRouteTableParams.json: aws amscm get-change-type-version --change-type-id "ct-1urj94c3hdfu5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRouteTableParams.json |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.