id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
ams-ct-369 | ams-ct.pdf | 369 | 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 1303 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. Deleting 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 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: Advanced Stack Components Version April 22, 2025 1304 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --title delete-tags --change-type-id ct-1erytvmumckoa -- change-type-version 1.0 --execution-parameters '{"Description":"test","Resources": [{"ResourceArn":"i-abcd1234","RemoveTags":["Name","Owner"]}, {"ResourceArn":"arn:aws:ec2:ap-southeast-2:123456789012:instance/ i-019714a96c22f5452","RemoveTags":["Name","Owner"]}]}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema to a file in your current folder. This example names it TagDeleteParams.json. aws amscm create-rfc --generate-cli-skeleton > TagDeleteParams.json 2. Modify and save the TagDeleteParams.json file. For example, you can replace the contents with something like this: { "Description": "Delete tags", "Resources": [ { "ResourceArn": "i-abcd1234", "RemoveTags": [ "Unused tag 1", "Unused tag 2" ] }, { "ResourceArn": "arn:aws:ec2:ap-southeast-2:123456789012:instance/ i-1234567890abcdef1", "RemoveTags": [ "Unused tag 1", "Unused tag 2" ] } ] } 3. Output the RFC template to a file in your current folder. This example names it TagDeleteRfc.json. aws amscm create-rfc --generate-cli-skeleton > TagDeleteRfc.json Advanced Stack Components Version April 22, 2025 1305 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the TagDeleteRfc.json file. The internal quotation marks in the ExecutionParameters JSON extension must be escaped with a backslash (\). Example: { "ChangeTypeId": "ct-1erytvmumckoa", "Title": "Delete-Tags-RFC" } 5. Create the RFC: aws amscm create-rfc --cli-input-json file://TagDeleteRfc.json --execution- parameters file://TagDeleteParams.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 |
ams-ct-370 | ams-ct.pdf | 370 | Example: { "ChangeTypeId": "ct-1erytvmumckoa", "Title": "Delete-Tags-RFC" } 5. Create the RFC: aws amscm create-rfc --cli-input-json file://TagDeleteRfc.json --execution- parameters file://TagDeleteParams.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. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1erytvmumckoa. Example: Required Parameters Example not available. Example: All Parameters { "Description": "Remove tags from instances", "Resources": [ Advanced Stack Components Version April 22, 2025 1306 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "ResourceArn": "arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0", "RemoveTags": ["k1", "k2"] }, { "ResourceArn": "i-0fedcba0987654321", "RemoveTags": ["k1", "k2"] } ], "Priority": "Medium" } Tag | Update Update tags on existing, tagged 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 updated with this change type. Full classification: Management | Advanced stack components | Tag | Update Change Type Details Change type ID ct-0xqwmtn1hfh8u Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update tags Updating tags with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 1307 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 1308 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. Updating 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 changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part |
ams-ct-371 | ams-ct.pdf | 371 | 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 1309 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-0xqwmtn1hfh8u" --change-type-version "1.0" --title "Update Tags" --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\"}"],"RemoveTags":["Unused tag 1","Unused tag 2","Unused tag 3"]}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema to a file in your current folder. This example names it TagUpdateAutoParams.json. aws amscm create-rfc --generate-cli-skeleton > TagUpdateAutoParams.json 2. Modify and save the TagUpdateAutoParams.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\"} ], "RemoveTags": [ "Unused tag 1", "Unused tag 2", "Unused tag 3" ] } Advanced Stack Components Version April 22, 2025 1310 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 TagUpdateAutoRfc.json: aws amscm create-rfc --generate-cli-skeleton > TagUpdateAutoRfc.json 4. Modify and save the TagUpdateAutoRfc.json file. The internal quotation marks in the ExecutionParameters JSON extension must be escaped with a backslash (\). Example without start and end time: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0xqwmtn1hfh8u", "Title": "Update-Tags-Auto-RFC" } 5. Create the RFC: aws amscm create-rfc --cli-input-json file://TagUpdateAutoRfc.json --execution- parameters file://TagUpdateAutoParams.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 AMS infrastructure stacks (stacks named mc-*) can't have tags updated with this change type. Use the Bulk update change type (ct-3047c34zuvswh) if you have more than fifty tags to manage. Tags can't contain the following prefixes: • ams • AMS • Ams Advanced Stack Components Version April 22, 2025 1311 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-0xqwmtn1hfh8u. 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\"}" ], "RemoveTags": [ "k4", "k5", "k6" ] } } Tag | Update (Review Required) Add tags to, update tags on, or remove tags from, existing, supported, resources except those in AMS infrastructure stacks (stacks named mc-*). Tags simplify categorization, identification and targeting AWS resources. Use BulkUpdate if you have >50 tags to manage. For Autoscaling, EC2, Elastic Load Balancing, RDS resources and S3 buckets, use automated CT ct-0xqwmtn1hfh8u. Advanced Stack Components Version April 22, 2025 1312 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Management | Advanced stack components | Tag | Update (review required) Change Type Details Change type ID ct-0zko7t3rk2efb Current version 2.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Update tags (review required) Updating 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. Advanced Stack Components Version April 22, 2025 1313 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 |
ams-ct-372 | ams-ct.pdf | 372 | 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. Updating 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. Advanced Stack Components Version April 22, 2025 1314 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 --title update-tags --change-type-id ct-0zko7t3rk2efb --change-type-version 2.0 --execution-parameters '{"Resources": [{"ResourceArn":"i-abcd1234","AddOrUpdateTags":[{"Key":"Name","Value":"app- instance-1"},{"Key":"Owner","Value":"Dep A"}],"RemoveTags":["Team","Prod"]}, {"ResourceArn":"arn:aws:ec2:ap-southeast-2:123456789012:instance/ i-019714a96c22f5452","AddOrUpdateTags":[{"Key":"Name","Value":"app-instance-1"}, {"Key":"Owner","Value":"Dep A"}],"RemoveTags":["Team","Prod"]}]}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema to a file in your current folder. This example names it TagUpdateParams.json. aws amscm create-rfc --generate-cli-skeleton > TagUpdateParams.json 2. Modify and save the TagUpdateParams.json file. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 1315 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Resources": [ { "ResourceArn": "i-abcd1234", "AddOrUpdateTags": [ { "Key": "Name", "Value": "app-instance-1" }, { "Key": "Owner", "Value": "Dep A" } ], "RemoveTags": [ "Unused tag 1", "Unused tag 2" ] }, { "ResourceArn": "arn:aws:ec2:ap-southeast-2:123456789012:instance/ i-1234567890abcdef1", "AddOrUpdateTags": [ { "Key": "Name", "Value": "app-instance-1" }, { "Key": "Owner", "Value": "Dep A" } ], "RemoveTags": [ "Unused tag 1", "Unused tag 2" ] } ] } 3. Output the RFC template to a file in your current folder; this example names it TagUpdateRfc.json: aws amscm create-rfc --generate-cli-skeleton > TagUpdateRfc.json Advanced Stack Components Version April 22, 2025 1316 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the TagUpdateRfc.json file. The internal quotation marks in the ExecutionParameters JSON extension must be escaped with a backslash (\). Example without start and end time: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-0zko7t3rk2efb", "Title": "Update-Tags-RFC" } 5. Create the RFC: aws amscm create-rfc --cli-input-json file://TagUpdateRfc.json --execution- parameters file://TagUpdateParams.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 |
ams-ct-373 | ams-ct.pdf | 373 | Advanced Change Type Details 4. Modify and save the TagUpdateRfc.json file. The internal quotation marks in the ExecutionParameters JSON extension must be escaped with a backslash (\). Example without start and end time: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-0zko7t3rk2efb", "Title": "Update-Tags-RFC" } 5. Create the RFC: aws amscm create-rfc --cli-input-json file://TagUpdateRfc.json --execution- parameters file://TagUpdateParams.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. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0zko7t3rk2efb. Example: Required Parameters Example not available. Example: All Parameters { "Resources": [ { Advanced Stack Components Version April 22, 2025 1317 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ResourceArn": "arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0", "AddOrUpdateTags": [ { "Key": "k1", "Value": "v1" }, { "Key": "k2", "Value": "v2" }, { "Key": "k3", "Value": "v3" } ], "RemoveTags": ["k4", "k5", "k6"] }, { "ResourceArn": "i-0fedcba0987654321", "AddOrUpdateTags": [ { "Key": "k1", "Value": "v1" }, { "Key": "k2", "Value": "v2" }, { "Key": "k3", "Value": "v3" } ], "RemoveTags": ["k4", "k5", "k6"] } ], "Priority": "Medium" } Target Group | Attach Instances Attach instance or instances to the target group (ALB and NLB). Full classification: Management | Advanced stack components | Target group | Attach instances Advanced Stack Components Version April 22, 2025 1318 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-3sk74t8igor0s Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Attach instances to a target group Attaching Instances to a Target 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 1319 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. Attaching Instances to a Target 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 |
ams-ct-374 | ams-ct.pdf | 374 | at the top of the page. Attaching Instances to a Target 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 1320 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-3sk74t8igor0s" \ --change-type-version "1.0" --title "AttachInstancesToTargetGroup" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- AttachInstancesToTargetGroup\",\"Region\":\"us-east-1\",\"Parameters\":{\"InstancesIds \":[\"i-000000000000\",\"i-111111111111\"],\"InstancesPort\":[\"80\"],\"TargetGroupArn \":[\"arn:aws:elasticloadbalancing:us-east-1:00000000000:targetgroup/test-target- group/0000000000\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it TgAttachInstanceParams.json. aws amscm get-change-type-version --change-type-id "ct-3sk74t8igor0s" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > TgAttachInstanceParams.json 2. Modify and save the TgAttachInstanceParams file. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 1321 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "DocumentName": "AWSManagedServices-AttachInstancesToTargetGroup", "Region": "us-east-1", "Parameters": { "InstancesIds": [ "i-000000000000", "i-111111111111" ], "InstancesPort": [ "80" ], "TargetGroupArn": [ "arn:aws:elasticloadbalancing:us-east-1:00000000000:targetgroup/test- target-group/0000000000" ] } } 3. Output the RFC template to a file in your current folder named TgAttachInstanceRfc.json: aws amscm create-rfc --generate-cli-skeleton > TgAttachInstanceRfc.json 4. Modify and save the TgAttachInstanceRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3sk74t8igor0s", "Title": "Target-Group-Attach-Instance-RFC" } 5. Create the RFC, specifying the TgAttachInstanceRfc file and the TgAttachInstanceParams file: aws amscm create-rfc --cli-input-json file://TgAttachInstanceRfc.json --execution- parameters file://TgAttachInstanceParams.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 1322 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips For information about target groups, see ELB Target Groups. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3sk74t8igor0s. Example: Required Parameters { "DocumentName": "AWSManagedServices-AttachInstancesToTargetGroup", "Region": "us-east-1", "Parameters": { "InstancesIds": ["i-0000000000"], "InstancesPort": ["80"], "TargetGroupArn": ["arn:aws:elasticloadbalancing:eu- west-1:000000000000:targetgroup/target-group-name/000000000000"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-AttachInstancesToTargetGroup", "Region": "us-east-1", "Parameters": { "InstancesIds": ["i-0000000000"], "InstancesPort": ["80"], "TargetGroupArn": ["arn:aws:elasticloadbalancing:eu- west-1:000000000000:targetgroup/target-group-name/000000000000"] } } Target Group | Detach Instances Detach instances or private IPv4 addresses from a target group. If the instances or private IP addresses exist but aren't registered with a target group, then the RFC execution ends in a success state without action on the target group. Advanced Stack Components Version April 22, 2025 1323 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Management | Advanced stack components | Target group | Detach instances Change Type Details Change type ID ct-37bq2l9c8fzxv Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Detach instances or private IPv4 from a target group Detaching Instances from a Target 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 1324 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 |
ams-ct-375 | ams-ct.pdf | 375 | Browse change types view, or select a CT in the Choose by category view. Advanced Stack Components Version April 22, 2025 1324 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. Detaching Instances from a Target 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 1325 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: Detach instances from target group: aws amscm create-rfc \ --change-type-id "ct-37bq2l9c8fzxv" \ --change-type-version "2.0" --title "DetachInstancesFromTargetGroup" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- DetachInstancesFromTargetGroup\",\"Region\":\"us-east-1\",\"Parameters\": {\"InstancesIds\":[\"i-000000000000\",\"i-111111111111\"],\"InstancesPort\":[\"80\"], \"TargetGroupArn\":[\"arn:aws:elasticloadbalancing:us-east-1:00000000000:targetgroup/ test-target-group/0000000000\"]}}" Detach IP address from target group: aws amscm create-rfc \ --change-type-id "ct-37bq2l9c8fzxv" \ --change-type-version "2.0" --title "DetachInstancesFromTargetGroup" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- DetachInstancesFromTargetGroup\",\"Region\":\"us-east-1\",\"Parameters\":{\"IPAddresses \":[\"172.31.0.11\",\"172.31.0.12\"],\"InstancesPort\":[\"80\"],\"TargetGroupArn Advanced Stack Components Version April 22, 2025 1326 AMS Advanced Change Type Reference AMS Advanced Change Type Details \":[\"arn:aws:elasticloadbalancing:us-east-1:00000000000:targetgroup/test-target- group/0000000000\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it TgDetachInstanceParams.json. aws amscm get-change-type-version --change-type-id "ct-37bq2l9c8fzxv" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > TgDetachInstanceParams.json 2. Modify and save the TgDetachInstanceParams file. For example, you can replace the contents with something like this: Parameter file with instance ids as an example: { "DocumentName": "AWSManagedServices-DetachInstancesFromTargetGroup", "Region": "us-east-1", "Parameters": { "InstancesIds": [ "i-000000000000", "i-111111111111" ], "InstancesPort": [ "80" ], "TargetGroupArn": [ "arn:aws:elasticloadbalancing:us-east-1:00000000000:targetgroup/test- target-group/0000000000" ] } } Parameter file with IP address as an example: { "DocumentName": "AWSManagedServices-DetachInstancesFromTargetGroup", "Region": "us-east-1", "Parameters": { "IPAddresses": [ Advanced Stack Components Version April 22, 2025 1327 AMS Advanced Change Type Reference AMS Advanced Change Type Details "172.31.0.11", "172.31.0.12" ], "InstancesPort": [ "80" ], "TargetGroupArn": [ "arn:aws:elasticloadbalancing:us-east-1:00000000000:targetgroup/test- target-group/0000000000" ] } } 3. Output the RFC template to a file in your current folder named TgDetachInstanceRfc.json: aws amscm create-rfc --generate-cli-skeleton > TgDetachInstanceRfc.json 4. Modify and save the TgDetachInstanceRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-37bq2l9c8fzxv", "Title": "Target-Group-Detach-Instance-RFC" } 5. Create the RFC, specifying the TgDetachInstanceRfc file and the TgDetachInstanceParams file: aws amscm create-rfc --cli-input-json file://TgDetachInstanceRfc.json --execution- parameters file://TgDetachInstanceParams.json You receive the ID of the new RFC in the response and can use it to submit and |
ams-ct-376 | ams-ct.pdf | 376 | Type Details "172.31.0.11", "172.31.0.12" ], "InstancesPort": [ "80" ], "TargetGroupArn": [ "arn:aws:elasticloadbalancing:us-east-1:00000000000:targetgroup/test- target-group/0000000000" ] } } 3. Output the RFC template to a file in your current folder named TgDetachInstanceRfc.json: aws amscm create-rfc --generate-cli-skeleton > TgDetachInstanceRfc.json 4. Modify and save the TgDetachInstanceRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-37bq2l9c8fzxv", "Title": "Target-Group-Detach-Instance-RFC" } 5. Create the RFC, specifying the TgDetachInstanceRfc file and the TgDetachInstanceParams file: aws amscm create-rfc --cli-input-json file://TgDetachInstanceRfc.json --execution- parameters file://TgDetachInstanceParams.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 target groups, see ELB Target Groups. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-37bq2l9c8fzxv. Advanced Stack Components Version April 22, 2025 1328 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "DocumentName": "AWSManagedServices-DetachInstancesFromTargetGroup", "Region": "us-east-1", "Parameters": { "InstancesPort": ["80"], "TargetGroupArn": ["arn:aws:elasticloadbalancing:eu- west-1:000000000000:targetgroup/target-group-name/000000000000"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-DetachInstancesFromTargetGroup", "Region": "us-east-1", "Parameters": { "InstancesIds": ["i-0000000000"], "InstancesPort": ["80"], "IPAddresses": ["10.0.0.5"], "TargetGroupArn": ["arn:aws:elasticloadbalancing:eu- west-1:000000000000:targetgroup/target-group-name/000000000000"] } } Target Group | Update (For ALB) Use to update properties of an existing Target Group for an Application Load Balancer created by CT id ct-1r19m51jeijlk. Full classification: Management | Advanced stack components | Target group | Update (for ALB) Change Type Details Change type ID ct-2v82sp4np40ki Current version 1.0 Expected execution duration 360 minutes AWS approval Required Advanced Stack Components Version April 22, 2025 1329 AMS Advanced Change Type Reference AMS Advanced Change Type Details Customer approval Not required Execution mode Automated Additional Information Update ALB target group Updating a Target Group for an Application Load Balancer 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 1330 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. Updating 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 |
ams-ct-377 | ams-ct.pdf | 377 | 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 1331 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 --title update-tg-alb --change-type-id ct-2v82sp4np40ki --change- type-version 1.0 --execution-parameters '{"Description":"Update target group for ALB","VpcId":"vpc-1234abcd","StackTemplateId":"stm-9c1t8maqho0os5k22","Name":"update- tg-alb","TimeoutInMinutes":60,"Parameters":{"HealthCheckHealthyThreshold": "5","HealthCheckUnhealthyThreshold": "3","HealthCheckInterval": 30,"HealthCheckTimeout": "10","HealthCheckTargetPath": "/healthcheck","HealthCheckTargetPort": "80","HealthCheckTargetProtocol": "HTTP","ValidHTTPCode": "200-259","DeregistrationDelayTimeout": "300","SlowStartDuration": "60","StickinessCookieExpirationPeriod": "3600","Target1ID": "i-abcdef01","Target1Port": "80","Target1AvailabilityZone": "AZ","Target2ID": "i-abcdefabcdefabcd1","Target2Port": "80","Target2AvailabilityZone": "AZ"}}' 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-2v82sp4np40ki" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateTgAlbParams.json 2. Modify and save the UpdateTgAlbParams file. For example, you can replace the contents with something like this: { "Description": "Target-Group-ALB-Create", "VpcId": "VPC_ID", "Name": "My-ALB-Target-Group", "Parameters": { "LoadBalancerArn": ARN, Advanced Stack Components Version April 22, 2025 1332 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DefaultActionTargetGroupArn": ARN, "Port": PORT, "Protocol": Protocol" } } 3. Output the RFC template to a file in your current folder named UpdateTgAlbRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateTgAlbRfc.json 4. Modify and save the UpdateTgAlbRfc.json file. For example, you can replace the contents with something like this: Version 1.0: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2v82sp4np40ki", "Title": "Target-Group-ALB-Update-RFC" } 5. Create the RFC, specifying the UpdateTgAlbRfc file and the UpdateTgAlbParams file: aws amscm create-rfc --cli-input-json file://UpdateTgAlbRfc.json --execution- parameters file://UpdateTgAlbParams.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 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. Advanced Stack Components Version April 22, 2025 1333 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-2v82sp4np40ki. Example: Required Parameters { "VpcId": "vpc-1234567890abcdef0", "StackId": "stack-123456789abcdefgh", "Parameters": {} } Example: All Parameters { "VpcId": "vpc-1234567890abcdef0", "StackId": "stack-123456789abcdefgh", "Parameters": { "HealthCheckHealthyThreshold": "5", "HealthCheckUnhealthyThreshold": "3", "HealthCheckInterval": 30, "HealthCheckTimeout": "10", "HealthCheckTargetPath": "/healthcheck", "HealthCheckTargetPort": "80", "HealthCheckTargetProtocol": "HTTP", "ValidHTTPCode": "200-259", "DeregistrationDelayTimeout": "300", "SlowStartDuration": "60", "StickinessCookieExpirationPeriod": "3600", "Target1ID": "i-abcdef01", "Target1AvailabilityZone": "", "Target2ID": "i-abcdefabcdefabcd1", "Target2AvailabilityZone": "", "Target3ID": "i-abcdefabcdefabcd2", "Target3AvailabilityZone": "", "Target4ID": "i-abcdefabcdefabcd3", "Target4AvailabilityZone": "", "Target5ID": "i-abcdefabcdefabcd4", "Target5AvailabilityZone": "", "Target6ID": "i-abcdefabcdefabcd5", "Target6AvailabilityZone": "", "Target7ID": "i-abcdefabcdefabcd6", Advanced Stack Components Version April 22, 2025 1334 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Target7AvailabilityZone": "", "Target8ID": "i-abcdefabcdefabcd7", "Target8AvailabilityZone": "" } } Target Group | Update (For NLB) Use to update properties of an existing Target Group for a Network Load Balancer. Full classification: Management | Advanced stack components | Target group | Update (for NLB) Change Type Details Change type ID ct-1x66wvkjw2zp5 Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update NLB target group Updating 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 1335 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 |
ams-ct-378 | ams-ct.pdf | 378 | 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 1336 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. Updating 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: 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: Advanced Stack Components Version April 22, 2025 1337 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --title update-tg-nlb --change-type-id ct-1x66wvkjw2zp5 --change- type-version 1.0 --execution-parameters '{"Description":"Update target group for NLB","VpcId":"vpc-1234abcd","StackTemplateId":"stm-6pvp2f7cp481g1r47","Name":"test- update-tg-nlb","TimeoutInMinutes":60,"Parameters":{"HealthCheckHealthyThreshold": "5","HealthCheckInterval": 30,"HealthCheckTargetPath": "/ healthcheck","HealthCheckTargetPort": "80","HealthCheckTargetProtocol": "HTTP","ProxyProtocolV2": "true","DeregistrationDelayTimeout": "300","Target1ID": "i-abcdef01","Target1Port": "80","Target1AvailabilityZone": "AZ","Target2ID": "i- abcdefabcdefabcd1","Target2Port": "80","Target2AvailabilityZone": "AZ"}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it UpdateTgNlbParams.json. aws amscm get-change-type-version --change-type-id "ct-1x66wvkjw2zp5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateTgNlbParams.json 2. Modify and save the UpdateTgNlbParams file. For example, you can replace the contents with something like this: { "VpcId": "VPC_ID", "StackId": "STACK_ID", "Parameters": { "DeregistrationDelayTimeout": 160 } } 3. Output the RFC template to a file in your current folder named UpdateTgNlbRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateTgNlbRfc.json 4. Modify and save the UpdateTgNlbRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1x66wvkjw2zp5", "Title": "Target-Group-NLB-Update-RFC" } Advanced Stack Components Version April 22, 2025 1338 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Create the RFC, specifying the UpdateTgNlbRfc file and the UpdateTgNlbParams file: aws amscm create-rfc --cli-input-json file://UpdateTgNlbRfc.json --execution- parameters file://UpdateTgNlbParams.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 target groups, see ELB Target Groups. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1x66wvkjw2zp5. Example: Required Parameters { "VpcId": "vpc-1234567890abcdef0", "StackId": "stack-123456789abcdefgh", "Parameters": {} } Example: All Parameters |
ams-ct-379 | ams-ct.pdf | 379 | Change Type Details 5. Create the RFC, specifying the UpdateTgNlbRfc file and the UpdateTgNlbParams file: aws amscm create-rfc --cli-input-json file://UpdateTgNlbRfc.json --execution- parameters file://UpdateTgNlbParams.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 target groups, see ELB Target Groups. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1x66wvkjw2zp5. Example: Required Parameters { "VpcId": "vpc-1234567890abcdef0", "StackId": "stack-123456789abcdefgh", "Parameters": {} } Example: All Parameters { "VpcId": "vpc-1234567890abcdef0", "StackId": "stack-123456789abcdefgh", "Parameters": { "HealthCheckHealthyThreshold": "5", "HealthCheckInterval": 30, "HealthCheckTargetPath": "/healthcheck", "HealthCheckTargetPort": "80", "HealthCheckTargetProtocol": "HTTP", "ProxyProtocolV2": "true", "DeregistrationDelayTimeout": "300", "Target1ID": "192.168.0.1", "Target1Port": "80", "Target1AvailabilityZone": "all", Advanced Stack Components Version April 22, 2025 1339 AMS Advanced Change Type Reference AMS Advanced Change Type Details "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", "Target8AvailabilityZone": "" } } AMS Resource Scheduler Subcategory Change Type Items and Operations in the AMS Resource Scheduler Subcategory • Period | Add • Period | Delete • Period | Describe • Period | Update • Schedule | Add • Schedule | Delete • Schedule | Describe • Schedule | Update • Solution | Update • State | Disable • State | Enable AMS Resource Scheduler Version April 22, 2025 1340 AMS Advanced Change Type Reference AMS Advanced Change Type Details Period | Add Add a new period to use with AMS Resource Scheduler. Periods are used in schedules to precisely define when a resource should run. Full classification: Management | AMS Resource Scheduler | Period | Add Change Type Details Change type ID ct-1976sir132k22 Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Period add Adding an AMS Resource Scheduler period with the console The following shows this change type in the AMS console. How it works: AMS Resource Scheduler Version April 22, 2025 1341 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. Adding an AMS Resource Scheduler period 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. AMS Resource Scheduler Version April 22, 2025 1342 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 |
ams-ct-380 | ams-ct.pdf | 380 | 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. AMS Resource Scheduler Version April 22, 2025 1342 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 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-1976sir132k22" --change-type-version "1.0" -- title "Add period for AMS Resource Scheduler" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-AddOrUpdatePeriod\",\"Region\":\"us-east-1\",\"Parameters \":{\"Action\":[\"add\"],\"Name\":[\"period01\"],\"Description\":[\"Test period definition\"],\"BeginTime\":[\"09:00\"],\"EndTime\":[\"17:00\"],\"Months\":[\"jan- feb\"],\"MonthDays\":[\"jan/3\"],\"WeekDays\":[\"mon-fri\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it AddPeriodParams.json: aws amscm get-change-type-version --change-type-id "ct-1976sir132k22" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AddPeriodParams.json 2. Modify and save the AddPeriodParams file. AMS Resource Scheduler Version April 22, 2025 1343 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "DocumentName" : "AWSManagedServices-AddOrUpdatePeriod", "Region" : "us-east-1", "Parameters" : { "Action" : ["add"], "Name" : ["period01"], "Description" : ["Test period definition"], "BeginTime" : ["09:00"], "EndTime" : ["17:00"], "Months" : ["jan-feb"], "MonthDays" : ["jan/3"], "WeekDays" : ["mon-fri"] } } 3. Output the RFC template to a file in your current folder; this example names it AddPeriodRfc.json: aws amscm create-rfc --generate-cli-skeleton > AddPeriodRfc.json 4. Modify and save the AddPeriodRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1976sir132k22", "Title": "Add period for AMS Resource Scheduler" } 5. Create the RFC, specifying the AddPeriodRfc file and the AddPeriodParams file: aws amscm create-rfc --cli-input-json file://AddPeriodRfc.json --execution- parameters file://AddPeriodParams.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 How the AMS Resource Scheduler works. AMS Resource Scheduler Version April 22, 2025 1344 AMS Advanced Change Type Reference AMS Advanced Change Type Details 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-1976sir132k22. Example: Required Parameters { "DocumentName" : "AWSManagedServices-AddOrUpdatePeriod", "Region" : "us-east-1", "Parameters" : { "Action" : ["add"], "Name" : ["period01"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-AddOrUpdatePeriod", "Region" : "us-east-1", "Parameters" : { "Action" : ["add"], "Name" : ["period01"], "Description" : ["Test period definition"], "BeginTime" : ["09:00"], "EndTime" : ["17:00"], "Months" : ["jan-feb"], "MonthDays" : ["jan/3"], "WeekDays" : ["mon-fri"] } } Period | Delete Delete an existing period used in AMS Resource Scheduler. Full classification: Management | AMS Resource Scheduler | Period | Delete AMS Resource Scheduler Version April 22, 2025 1345 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-042luqo63j4mx Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Period delete Deleting an AMS Resource Scheduler Period 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. AMS Resource Scheduler Version April 22, 2025 1346 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 |
ams-ct-381 | ams-ct.pdf | 381 | or select a CT in the Choose by category view. AMS Resource Scheduler Version April 22, 2025 1346 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. Deleting an AMS Resource Scheduler period 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: AMS Resource Scheduler Version April 22, 2025 1347 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 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-042luqo63j4mx" --change-type-version "1.0" --title "Delete period used in AMS Resource Scheduler" --execution-parameters "{\"DocumentName\":\"AWSManagedServices-DeleteScheduleOrPeriod\",\"Region\":\"us- east-1\",\"Parameters\":{\"ConfigurationType\":[\"period\"],\"Name\":[\"period01\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it DeletePeriodParams.json: aws amscm get-change-type-version --change-type-id "ct-042luqo63j4mx" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeletePeriodParams.json 2. Modify and save the DeletePeriodParams file. { "DocumentName" : "AWSManagedServices-DeleteScheduleOrPeriod", "Region" : "us-east-1", "Parameters" : { "ConfigurationType" : ["period"], AMS Resource Scheduler Version April 22, 2025 1348 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Name" : ["period01"] } } 3. Output the RFC template to a file in your current folder; this example names it DeletePeriodRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeletePeriodRfc.json 4. Modify and save the DeletePeriodRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-042luqo63j4mx", "Title": "Delete period used in AMS Resource Scheduler" } 5. Create the RFC, specifying the DeletePeriodRfc file and the DeletePeriodParams file: aws amscm create-rfc --cli-input-json file://DeletePeriodRfc.json --execution- parameters file://DeletePeriodParams.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 How the AMS Resource Scheduler works. 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-042luqo63j4mx. Example: Required Parameters Example not available. AMS Resource Scheduler Version April 22, 2025 1349 AMS Advanced Change Type Reference Example: All Parameters { "DocumentName" : "AWSManagedServices-DeleteScheduleOrPeriod", AMS Advanced Change Type Details "Region" : "us-east-1", "Parameters" |
ams-ct-382 | ams-ct.pdf | 382 | 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 How the AMS Resource Scheduler works. 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-042luqo63j4mx. Example: Required Parameters Example not available. AMS Resource Scheduler Version April 22, 2025 1349 AMS Advanced Change Type Reference Example: All Parameters { "DocumentName" : "AWSManagedServices-DeleteScheduleOrPeriod", AMS Advanced Change Type Details "Region" : "us-east-1", "Parameters" : { "ConfigurationType" : ["period"], "Name" : ["period01"] } } Period | Describe Describe existing periods used in AMS Resource Scheduler. Full classification: Management | AMS Resource Scheduler | Period | Describe Change Type Details Change type ID ct-1g6x4ev0hnvfn Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Period describe Describing an AMS Resource Scheduler period with the console The following shows this change type in the AMS console. AMS Resource Scheduler Version April 22, 2025 1350 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. AMS Resource Scheduler Version April 22, 2025 1351 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. Describing an AMS Resource Scheduler period 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: AMS Resource Scheduler Version April 22, 2025 1352 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-1g6x4ev0hnvfn" --change-type-version "1.0" --title "Describe periods used in AMS Resource Scheduler" --execution-parameters "{\"DocumentName\":\"AWSManagedServices-DescribeScheduleOrPeriods\",\"Region\":\"us- east-1\",\"Parameters\":{\"ConfigurationType\":[\"periods\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it DescribePeriodParams.json: aws |
ams-ct-383 | ams-ct.pdf | 383 | 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: AMS Resource Scheduler Version April 22, 2025 1352 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-1g6x4ev0hnvfn" --change-type-version "1.0" --title "Describe periods used in AMS Resource Scheduler" --execution-parameters "{\"DocumentName\":\"AWSManagedServices-DescribeScheduleOrPeriods\",\"Region\":\"us- east-1\",\"Parameters\":{\"ConfigurationType\":[\"periods\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it DescribePeriodParams.json: aws amscm get-change-type-version --change-type-id "ct-1g6x4ev0hnvfn" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DescribePeriodParams.json 2. Modify and save the DescribePeriodParams file. { "DocumentName" : "AWSManagedServices-DescribeScheduleOrPeriods", "Region" : "us-east-1", "Parameters" : { "ConfigurationType" : ["periods"] } } 3. Output the RFC template to a file in your current folder; this example names it DescribePeriodRfc.json: aws amscm create-rfc --generate-cli-skeleton > DescribePeriodRfc.json 4. Modify and save the DescribePeriodRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1g6x4ev0hnvfn", "Title": "Describe periods used in AMS Resource Scheduler" } 5. Create the RFC, specifying the DescribePeriodRfc file and the DescribePeriodParams file: aws amscm create-rfc --cli-input-json file://DescribePeriodRfc.json --execution- parameters file://DescribePeriodParams.json AMS Resource Scheduler Version April 22, 2025 1353 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 more information, see How the AMS Resource Scheduler works. 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-1g6x4ev0hnvfn. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName" : "AWSManagedServices-DescribeScheduleOrPeriods", "Region" : "us-east-1", "Parameters" : { "ConfigurationType" : ["periods"] } } Period | Update Update an existing period used in AMS Resource Scheduler. Full classification: Management | AMS Resource Scheduler | Period | Update Change Type Details Change type ID ct-2pkdckieh62ps Current version 1.0 AMS Resource Scheduler Version April 22, 2025 1354 AMS Advanced Change Type Reference AMS Advanced Change Type Details Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Period update Updating an AMS Resource Scheduler period 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. • 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. AMS Resource Scheduler Version April 22, 2025 1355 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. Updating an AMS Resource Scheduler period 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 |
ams-ct-384 | ams-ct.pdf | 384 | 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. Updating an AMS Resource Scheduler period 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 AMS Resource Scheduler Version April 22, 2025 1356 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-2pkdckieh62ps" --change-type-version "1.0" --title "Update period used in AMS Resource Scheduler" --execution-parameters "{\"DocumentName\":\"AWSManagedServices-AddOrUpdatePeriod\",\"Region\":\"us-east-1\", \"Parameters\":{\"Action\":[\"update\"],\"Name\":[\"period01\"],\"Description\":[\"Test period definition\"],\"BeginTime\":[\"09:00\"],\"EndTime\":[\"17:00\"],\"Months\": [\"jan-feb\"],\"MonthDays\":[\"jan/3\"],\"WeekDays\":[\"mon-fri\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it UpdatePeriodParams.json: aws amscm get-change-type-version --change-type-id "ct-2pkdckieh62ps" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdatePeriodParams.json 2. Modify and save the UpdatePeriodParams file. { "DocumentName" : "AWSManagedServices-AddOrUpdatePeriod", "Region" : "us-east-1", "Parameters" : { "Action" : ["update"], "Name" : ["period01"] } } 3. Output the RFC template to a file in your current folder; this example names it UpdatePeriodRfc.json: AMS Resource Scheduler Version April 22, 2025 1357 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > UpdatePeriodRfc.json 4. Modify and save the UpdatePeriodRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2pkdckieh62ps", "Title": "Update period used in AMS Resource Scheduler" } 5. Create the RFC, specifying the UpdatePeriodRfc file and the UpdatePeriodParams file: aws amscm create-rfc --cli-input-json file://UpdatePeriodRfc.json --execution- parameters file://UpdatePeriodParams.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 How the AMS Resource Scheduler works. 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-2pkdckieh62ps. Example: Required Parameters { "DocumentName" : "AWSManagedServices-AddOrUpdatePeriod", "Region" : "us-east-1", "Parameters" : { "Action" : ["update"], "Name" : ["period01"] } AMS Resource Scheduler Version April 22, 2025 1358 AMS Advanced Change Type Reference AMS Advanced Change Type Details } Example: All Parameters { "DocumentName" : "AWSManagedServices-AddOrUpdatePeriod", "Region" : "us-east-1", "Parameters" : { "Action" : ["update"], "Name" : ["period01"], "Description" : ["Test period definition"], "BeginTime" : ["09:00"], "EndTime" : ["17:00"], "Months" : ["jan-feb"], "MonthDays" : ["jan/3"], "WeekDays" : ["mon-fri"] } } Schedule | Add Add a new schedule to be used in AMS Resource Scheduler. Schedules employ defined periods to determine when the specified resource should run. Full classification: Management | AMS Resource Scheduler | Schedule | Add Change Type Details Change type ID ct-2bxelbn765ive Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated AMS Resource Scheduler Version April 22, 2025 1359 AMS Advanced Change Type Reference Additional Information Schedule add Adding an AMS Resource Scheduler schedule 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 |
ams-ct-385 | ams-ct.pdf | 385 | 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 1360 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. Adding an AMS Resource Scheduler schedule 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 1361 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-2bxelbn765ive" --change-type-version "1.0" --title "Add a schedule for AMS Resource Scheduler" --execution-parameters "{\"DocumentName\":\"AWSManagedServices-AddOrUpdateSchedule\",\"Region\": \"us-east-1\",\"Parameters\":{\"Action\":[\"add\"],\"Name\":[\"Schedule01\"], \"Description\":[\"Test schedule\"],\"Hibernate\":[\"true\"],\"Enforced\": [\"false\"],\"OverrideStatus\":[\"running\"],\"Periods\":[\"period01\",\"period02\"], \"RetainRunning\":[\"false\"],\"StopNewInstances\":[\"true\"],\"SSMMaintenanceWindow\": [\"window01\"],\"TimeZone\":[\"Australia/Sydney\"],\"UseMaintenanceWindow\":[\"true\"], \"UseMetrics\":[\"false\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it AddScheduleParams.json: aws amscm get-change-type-version --change-type-id "ct-2bxelbn765ive" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AddScheduleParams.json 2. Modify and save the AddScheduleParams file. { "DocumentName" : "AWSManagedServices-AddOrUpdateSchedule", "Region" : "us-east-1", "Parameters" : { "Action" : ["add"], "Name" : ["Schedule01"], "Description" : ["Test schedule"], "Hibernate" : ["true"], "Enforced" : ["false"], "OverrideStatus" : ["running"], "Periods" : [ "period01", "period02" ], "RetainRunning" : ["false"], "StopNewInstances" : ["true"], AMS Resource Scheduler Version April 22, 2025 1362 AMS Advanced Change Type Reference AMS Advanced Change Type Details "SSMMaintenanceWindow" : ["window01"], "TimeZone" : ["Australia/Sydney"], "UseMaintenanceWindow" : ["true"], "UseMetrics" : ["false"] } } 3. Output the RFC template to a file in your current folder; this example names it AddScheduleRfc.json: aws amscm create-rfc --generate-cli-skeleton > AddScheduleRfc.json 4. Modify and save the AddScheduleRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2bxelbn765ive", "Title": "Add a schedule for AMS Resource Scheduler" } 5. Create the RFC, specifying the AddScheduleRfc file and the AddScheduleParams file: aws amscm create-rfc --cli-input-json file://AddScheduleRfc.json --execution- parameters file://AddScheduleParams.json You receive the ID of the new RFC in the response |
ams-ct-386 | ams-ct.pdf | 386 | "SSMMaintenanceWindow" : ["window01"], "TimeZone" : ["Australia/Sydney"], "UseMaintenanceWindow" : ["true"], "UseMetrics" : ["false"] } } 3. Output the RFC template to a file in your current folder; this example names it AddScheduleRfc.json: aws amscm create-rfc --generate-cli-skeleton > AddScheduleRfc.json 4. Modify and save the AddScheduleRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2bxelbn765ive", "Title": "Add a schedule for AMS Resource Scheduler" } 5. Create the RFC, specifying the AddScheduleRfc file and the AddScheduleParams file: aws amscm create-rfc --cli-input-json file://AddScheduleRfc.json --execution- parameters file://AddScheduleParams.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 How the AMS Resource Scheduler works. 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-2bxelbn765ive. AMS Resource Scheduler Version April 22, 2025 1363 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "DocumentName" : "AWSManagedServices-AddOrUpdateSchedule", "Region" : "us-east-1", "Parameters" : { "Action" : ["add"], "Name" : ["schedule01"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-AddOrUpdateSchedule", "Region" : "us-east-1", "Parameters" : { "Action" : ["add"], "Name" : ["Schedule01"], "Description" : ["Test schedule"], "Hibernate" : ["true"], "Enforced" : ["false"], "OverrideStatus" : ["running"], "Periods" : ["period01, period02"], "RetainRunning" : ["false"], "StopNewInstances" : ["true"], "SSMMaintenanceWindow" : ["window01, window02"], "TimeZone" : ["Australia/Sydney"], "UseMaintenanceWindow" : ["true"], "UseMetrics" : ["false"] } } Schedule | Delete Delete an existing schedule used in AMS Resource Scheduler. Full classification: Management | AMS Resource Scheduler | Schedule | Delete Change Type Details Change type ID ct-3rk1nl1ufn5g3 AMS Resource Scheduler Version April 22, 2025 1364 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Schedule delete Deleting an AMS Resource Scheduler schedule 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. • 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 Resource Scheduler Version April 22, 2025 1365 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. Deleting an AMS Resource Scheduler schedule 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 Resource Scheduler Version April 22, 2025 |
ams-ct-387 | ams-ct.pdf | 387 | 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 Resource Scheduler Version April 22, 2025 1366 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 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-3rk1nl1ufn5g3" --change-type-version "1.0" --title "Delete schedule for AMS Resource Scheduler" --execution-parameters "{\"DocumentName\":\"AWSManagedServices-DeleteScheduleOrPeriod\",\"Region\": \"us-east-1\",\"Parameters\":{\"ConfigurationType\":[\"schedule\"],\"Name\": [\"schedule01\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it DeleteScheduleParams.json: aws amscm get-change-type-version --change-type-id "ct-3rk1nl1ufn5g3" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeleteScheduleParams.json 2. Modify and save the DeleteScheduleParams file. { "DocumentName" : "AWSManagedServices-DeleteScheduleOrPeriod", "Region" : "us-east-1", "Parameters" : { "ConfigurationType" : ["schedule"], "Name" : ["schedule01"] } } AMS Resource Scheduler Version April 22, 2025 1367 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 DeleteScheduleRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteScheduleRfc.json 4. Modify and save the DeleteScheduleRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3rk1nl1ufn5g3", "Title": "Delete schedule for AMS Resource Scheduler" } 5. Create the RFC, specifying the DeleteScheduleRfc file and the DeleteScheduleParams file: aws amscm create-rfc --cli-input-json file://DeleteScheduleRfc.json --execution- parameters file://DeleteScheduleParams.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 How the AMS Resource Scheduler works. 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-3rk1nl1ufn5g3. Example: Required Parameters Example not available. Example: All Parameters { AMS Resource Scheduler Version April 22, 2025 1368 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName" : "AWSManagedServices-DeleteScheduleOrPeriod", "Region" : "us-east-1", "Parameters" : { "ConfigurationType" : ["schedule"], "Name" : ["schedule01"] } } Schedule | Describe Describe (generate a detailed list) of existing schedules used in AMS Resource Scheduler. Full classification: Management | AMS Resource Scheduler | Schedule | Describe Change Type Details Change type ID ct-2ptn20pq7ur3x Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Schedule describe Describing an AMS Resource Scheduler schedule with the console The following shows this change type in the AMS console. AMS Resource Scheduler Version April 22, 2025 1369 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 |
ams-ct-388 | ams-ct.pdf | 388 | 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. AMS Resource Scheduler Version April 22, 2025 1370 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. Describing an AMS Resource Scheduler schedule 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: AMS Resource Scheduler Version April 22, 2025 1371 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-2ptn20pq7ur3x" --change-type-version "1.0" --title "Describe schedules used in AMS Resource Scheduler" --execution-parameters "{\"DocumentName\":\"AWSManagedServices-DescribeScheduleOrPeriods\",\"Region\":\"us- east-1\",\"Parameters\":{\"ConfigurationType\":[\"schedules\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it DescribeScheduleParams.json: aws amscm get-change-type-version --change-type-id "ct-2ptn20pq7ur3x" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DescribeScheduleParams.json 2. Modify and save the DescribeScheduleParams file. { "DocumentName" : "AWSManagedServices-DescribeScheduleOrPeriods", "Region" : "us-east-1", "Parameters" : { "ConfigurationType" : ["schedules"] } } 3. Output the RFC template to a file in your current folder; this example names it DescribeScheduleRfc.json: aws amscm create-rfc --generate-cli-skeleton > DescribeScheduleRfc.json 4. Modify and save the DescribeScheduleRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2ptn20pq7ur3x", "Title": "Describe schedule for AMS Resource Scheduler" } 5. Create the RFC, specifying the DescribeScheduleRfc file and the DescribeScheduleParams file: AMS Resource Scheduler Version April 22, 2025 1372 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://DescribeScheduleRfc.json --execution- parameters file://DescribeScheduleParams.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 How the AMS Resource Scheduler works. 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-2ptn20pq7ur3x. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName" : "AWSManagedServices-DescribeScheduleOrPeriods", "Region" : "us-east-1", "Parameters" : { "ConfigurationType" : ["schedules"] } } Schedule | Update Update an existing schedule to be used in AMS Resource Scheduler. Full classification: Management | AMS Resource Scheduler | Schedule | Update AMS Resource Scheduler Version April 22, 2025 1373 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-3u61cd4edns0x Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution |
ams-ct-389 | ams-ct.pdf | 389 | the execution input parameters, see Schema for Change Type ct-2ptn20pq7ur3x. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName" : "AWSManagedServices-DescribeScheduleOrPeriods", "Region" : "us-east-1", "Parameters" : { "ConfigurationType" : ["schedules"] } } Schedule | Update Update an existing schedule to be used in AMS Resource Scheduler. Full classification: Management | AMS Resource Scheduler | Schedule | Update AMS Resource Scheduler Version April 22, 2025 1373 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-3u61cd4edns0x Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Schedule update Updating an AMS Resource Scheduler schedule 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. AMS Resource Scheduler Version April 22, 2025 1374 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. Updating an AMS Resource Scheduler schedule 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: AMS Resource Scheduler Version April 22, 2025 1375 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 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-3u61cd4edns0x" --change-type-version "1.0" --title "Update a schedule used in AMS Resource Scheduler" --execution- parameters "{\"DocumentName\":\"AWSManagedServices-AddOrUpdateSchedule\",\"Region \":\"us-east-1\",\"Parameters\":{\"Action\":[\"update\"],\"Name\":[\"Schedule01\"], \"Description\":[\"Test schedule\"],\"Hibernate\":[\"true\"],\"Enforced\": [\"false\"],\"OverrideStatus\":[\"running\"],\"Periods\":[\"period01\",\"period02\"], \"RetainRunning\":[\"false\"],\"StopNewInstances\":[\"true\"],\"SSMMaintenanceWindow\": [\"window01\"],\"TimeZone\":[\"Australia/Sydney\"],\"UseMaintenanceWindow\":[\"true\"], \"UseMetrics\":[\"false\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it UpdateScheduleParams.json: aws amscm get-change-type-version --change-type-id "ct-3u61cd4edns0x" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateScheduleParams.json 2. Modify and save the UpdateScheduleParams file. { AMS Resource Scheduler Version April 22, 2025 1376 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName" : "AWSManagedServices-AddOrUpdateSchedule", "Region" : "us-east-1", "Parameters" : { "Action" : ["update"], "Name" : ["Schedule01"] } } 3. Output the RFC template to a file in your current folder; |
ams-ct-390 | ams-ct.pdf | 390 | Resource Scheduler" --execution- parameters "{\"DocumentName\":\"AWSManagedServices-AddOrUpdateSchedule\",\"Region \":\"us-east-1\",\"Parameters\":{\"Action\":[\"update\"],\"Name\":[\"Schedule01\"], \"Description\":[\"Test schedule\"],\"Hibernate\":[\"true\"],\"Enforced\": [\"false\"],\"OverrideStatus\":[\"running\"],\"Periods\":[\"period01\",\"period02\"], \"RetainRunning\":[\"false\"],\"StopNewInstances\":[\"true\"],\"SSMMaintenanceWindow\": [\"window01\"],\"TimeZone\":[\"Australia/Sydney\"],\"UseMaintenanceWindow\":[\"true\"], \"UseMetrics\":[\"false\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it UpdateScheduleParams.json: aws amscm get-change-type-version --change-type-id "ct-3u61cd4edns0x" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateScheduleParams.json 2. Modify and save the UpdateScheduleParams file. { AMS Resource Scheduler Version April 22, 2025 1376 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName" : "AWSManagedServices-AddOrUpdateSchedule", "Region" : "us-east-1", "Parameters" : { "Action" : ["update"], "Name" : ["Schedule01"] } } 3. Output the RFC template to a file in your current folder; this example names it UpdateScheduleRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateScheduleRfc.json 4. Modify and save the UpdateScheduleRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2ptn3u61cd4edns0x20pq7ur3x", "Title": "Update a schedule for AMS Resource Scheduler" } 5. Create the RFC, specifying the UpdateScheduleRfc file and the UpdateScheduleParams file: aws amscm create-rfc --cli-input-json file://UpdateScheduleRfc.json --execution- parameters file://UpdateScheduleParams.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 How the AMS Resource Scheduler works. 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-3u61cd4edns0x. AMS Resource Scheduler Version April 22, 2025 1377 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "DocumentName" : "AWSManagedServices-AddOrUpdateSchedule", "Region" : "us-east-1", "Parameters" : { "Action" : ["update"], "Name" : ["Schedule01"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-AddOrUpdateSchedule", "Region" : "us-east-1", "Parameters" : { "Action" : ["update"], "Name" : ["Schedule01"], "Description" : ["Test schedule"], "Hibernate" : ["true"], "Enforced" : ["false"], "OverrideStatus" : ["running"], "Periods" : ["period01, period02"], "RetainRunning" : ["false"], "StopNewInstances" : ["true"], "SSMMaintenanceWindow" : ["window01, window02"], "TimeZone" : ["Australia/Sydney"], "UseMaintenanceWindow" : ["true"], "UseMetrics" : ["false"] } } Solution | Update Update the AMS Resource Scheduler solution in the account. Full classification: Management | AMS Resource Scheduler | Solution | Update Change Type Details Change type ID ct-2c7ve50jost1v AMS Resource Scheduler Version April 22, 2025 1378 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update AMS Resource Scheduler Solution Updating AMS Resource Scheduler solution 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. • 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 Resource Scheduler Version April 22, 2025 1379 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. Updating 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 |
ams-ct-391 | ams-ct.pdf | 391 | 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. Updating 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 AMS Resource Scheduler Version April 22, 2025 1380 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 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-2c7ve50jost1v --change-type- version "2.0" --title "Update Resource Scheduler Configurations" --execution-parameters '{"DocumentName":"AWSManagedServices- HandleAMSResourceSchedulerStack-Admin","Region":"us-east-1","Parameters": {"SchedulingActive":["Yes"],"ScheduledServices":["ec2,rds,autoscaling"],"TagName": ["Schedule"],"DefaultTimezone":["America/New_York"],"Action":["Update"]}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it UpdateResSchedulerParams.json: aws amscm get-change-type-version --change-type-id "ct-2c7ve50jost1v" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateResSchedulerParams.json 2. Modify and save the UpdateResSchedulerParams file. { "DocumentName": "AWSManagedServices-HandleAMSResourceSchedulerStack-Admin", "Region": "us-east-1", "Parameters": { "SchedulingActive": [ "Yes" AMS Resource Scheduler Version April 22, 2025 1381 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "ScheduledServices": [ "ec2,rds,autoscaling" ], "TagName": [ "Schedule" ], "DefaultTimezone": [ "America/New_York" ], "Action": [ "Update" ] } } 3. Output the RFC template to a file in your current folder; this example names it UpdateResSchedulerRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateResSchedulerRfc.json 4. Modify and save the UpdateResSchedulerRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-2c7ve50jost1v", "Title": "Update Resource Scheduler Configurations" } 5. Create the RFC, specifying the UpdateResSchedulerRfc file and the UpdateResSchedulerParams file: aws amscm create-rfc --cli-input-json file://UpdateResSchedulerRfc.json -- execution-parameters file://UpdateResSchedulerParams.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. AMS Resource Scheduler Version April 22, 2025 1382 AMS Advanced Change Type Reference AMS Advanced Change Type Details 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-2c7ve50jost1v. Example: Required Parameters { "DocumentName" : "AWSManagedServices-HandleAMSResourceSchedulerStack-Admin", "Region" : "us-east-1", "Parameters" : { "Action" : ["Update"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-HandleAMSResourceSchedulerStack-Admin", "Region" : "us-east-1", "Parameters" : { "SchedulingActive" : [ "" ], "ScheduledServices" : [ "" ], "TagName" : [ "" ], "DefaultTimezone" : [ "" ], "UseCMK" : [ AMS Resource Scheduler Version April 22, 2025 1383 AMS Advanced Change Type Reference AMS Advanced Change Type Details "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" : [ "Update" ] } } State | Disable Disable AMS Resource Scheduler in the account. This will prevent resources from being scheduled for automatic start or stop actions even if they are configured for such actions. Full classification: Management | AMS Resource Scheduler | State | Disable Change Type Details Change type ID ct-14v49adibs4db 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 1384 AMS Advanced Change Type Reference Additional Information Disable Disabling AMS Resource Scheduler 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 |
ams-ct-392 | ams-ct.pdf | 392 | they are configured for such actions. Full classification: Management | AMS Resource Scheduler | State | Disable Change Type Details Change type ID ct-14v49adibs4db 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 1384 AMS Advanced Change Type Reference Additional Information Disable Disabling AMS Resource Scheduler 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 1385 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. Disabling AMS Resource Scheduler 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 1386 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-14v49adibs4db" --change-type-version "2.0" --title "Disable AMS Resource Scheduler" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-HandleAMSResourceSchedulerStack-Admin\",\"Region\":\"us-east-1\", \"Parameters\":{\"SchedulingActive\":[\"No\"],\"Action\":\"Update\"}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it DisableResSchedulerParams.json: aws amscm get-change-type-version --change-type-id "ct-14v49adibs4db" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DisableResSchedulerParams.json 2. Modify and save the DisableResSchedulerParams file. { "DocumentName" : "AWSManagedServices-EnableOrDisableAMSResourceScheduler", "Region" : "us-east-1", "Parameters" : { "SchedulingActive" : ["No"], "Action" : "Update" } } 3. Output the RFC template to a file in your current folder; this example names it DisableResSchedulerRfc.json: aws amscm create-rfc --generate-cli-skeleton > DisableResSchedulerRfc.json 4. Modify and save the DisableResSchedulerRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", AMS Resource Scheduler Version April 22, 2025 1387 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-14v49adibs4db", "Title": "Disable AMS Resource Scheduler" } 5. Create the RFC, specifying the DisableResSchedulerRfc file and the DisableResSchedulerParams file: aws amscm create-rfc --cli-input-json file://DisableResSchedulerRfc.json |
ams-ct-393 | ams-ct.pdf | 393 | : "us-east-1", "Parameters" : { "SchedulingActive" : ["No"], "Action" : "Update" } } 3. Output the RFC template to a file in your current folder; this example names it DisableResSchedulerRfc.json: aws amscm create-rfc --generate-cli-skeleton > DisableResSchedulerRfc.json 4. Modify and save the DisableResSchedulerRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", AMS Resource Scheduler Version April 22, 2025 1387 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-14v49adibs4db", "Title": "Disable AMS Resource Scheduler" } 5. Create the RFC, specifying the DisableResSchedulerRfc file and the DisableResSchedulerParams file: aws amscm create-rfc --cli-input-json file://DisableResSchedulerRfc.json -- execution-parameters file://DisableResSchedulerParams.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 How the AMS Resource Scheduler works. 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-14v49adibs4db. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName" : "AWSManagedServices-HandleAMSResourceSchedulerStack-Admin", "Region" : "us-east-1", "Parameters" : { "SchedulingActive" : ["No"], "Action" : "Update" } } AMS Resource Scheduler Version April 22, 2025 1388 AMS Advanced Change Type Reference AMS Advanced Change Type Details State | Enable Enable AMS Resource Scheduler in the account where it was previously disabled. This will re-enable scheduling of resources for automatic start or stop actions where the resources are already tagged with a valid schedule. Make sure to verify currently tagged resources and schedules before enabling the scheduler. Full classification: Management | AMS Resource Scheduler | State | Enable Change Type Details Change type ID ct-2wrvu4kca9xky Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Enable Enabling AMS Resource Scheduler with the console The following shows this change type in the AMS console. AMS Resource Scheduler Version April 22, 2025 1389 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. Enabling AMS Resource Scheduler 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. AMS Resource Scheduler Version April 22, 2025 1390 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 |
ams-ct-394 | ams-ct.pdf | 394 | 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. AMS Resource Scheduler Version April 22, 2025 1390 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 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-2wrvu4kca9xky" --change-type-version "2.0" --title "Enable AMS Resource Scheduler" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-HandleAMSResourceSchedulerStack-Admin\",\"Region\":\"us-east-1\", \"Parameters\":{\"SchedulingActive\":[\"Yes\"],\"Action\":\"Update\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it EnableResSchedulerParams.json: aws amscm get-change-type-version --change-type-id "ct-2wrvu4kca9xky" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > EnableResSchedulerParams.json AMS Resource Scheduler Version April 22, 2025 1391 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Modify and save the EnableResSchedulerParams file. { "DocumentName" : "AWSManagedServices-EnableOrDisableAMSResourceScheduler", "Region" : "us-east-1", "Parameters" : { "SchedulingActive" : ["Yes"], "Action" : "Update" } } 3. Output the RFC template to a file in your current folder; this example names it EnableResSchedulerRfc.json: aws amscm create-rfc --generate-cli-skeleton > EnableResSchedulerRfc.json 4. Modify and save the EnableResSchedulerRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-2wrvu4kca9xky", "Title": "Enable AMS Resource Scheduler" } 5. Create the RFC, specifying the EnableResSchedulerRfc file and the EnableResSchedulerParams file: aws amscm create-rfc --cli-input-json file://EnableResSchedulerRfc.json -- execution-parameters file://EnableResSchedulerParams.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 How the AMS Resource Scheduler works. AMS Resource Scheduler is based on the AWS Instance Scheduler; to learn more, see AWS Instance Scheduler. AMS Resource Scheduler Version April 22, 2025 1392 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-2wrvu4kca9xky. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName" : "AWSManagedServices-HandleAMSResourceSchedulerStack-Admin", "Region" : "us-east-1", "Parameters" : { "SchedulingActive" : ["Yes"], "Action" : "Update" } } Applications Subcategory Change Type Items and Operations in the Applications Subcategory • IAM Instance Profile | Create (Review Required) IAM Instance Profile | Create (Review Required) Use to create an instance profile. Full classification: Management | Applications | IAM instance profile | Create (review required) Change Type Details Change type ID ct-0ixp4ch2tiu04 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Applications Version April 22, 2025 1393 AMS Advanced Change Type Reference AMS Advanced Change Type Details Customer approval Not required if submitter Execution mode Manual Additional Information Create application IAM instance profile (review required) Creating IAM instance profiles (review required) 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. • 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. Applications Version April 22, 2025 1394 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 |
ams-ct-395 | ams-ct.pdf | 395 | 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. Applications Version April 22, 2025 1394 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 IAM instance profiles (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 Applications Version April 22, 2025 1395 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 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-0ixp4ch2tiu04" --change-type-version "1.0" --title "TestInstanceProfile" --execution-parameters "{\"InstanceProfileName \":\"PROFILE_NAME\",\"RelatedIds\":[\"RESOURCE_ID\", \"RESOURCE_ID\"], \"InstanceProfileDescription\":\"PROFILE_DESCRIPTION\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateInstanceProfileParams.json: aws amscm get-change-type-version --change-type-id "ct-0ixp4ch2tiu04" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateInstanceProfileParams.json 2. Modify and save the CreateInstanceProfileParams file. For example, you can replace the contents with something like this: { "InstanceProfileDescription": "PROFILE_DESCRIPTION.", "InstanceProfileName": "PROFILE_NAME", "RelatedIds":[\"RESOURCE_ID\", \"RESOURCE_ID\"], } 3. Output the RFC template JSON to a file; this example names it CreateInstanceProfileRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateInstanceProfileRfc.json 4. Modify and save the CreateInstanceProfileRfc.json file. For example, you can replace the contents with something like this: { Applications Version April 22, 2025 1396 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0ixp4ch2tiu04", "Title": "InstanceProfile-Create-RFC" 5. Create the RFC, specifying the CreateInstanceProfileRfc file and the CreateInstanceProfileParams file: aws amscm create-rfc --cli-input-json file://CreateInstanceProfileRfc.json -- execution-parameters file://CreateInstanceProfileParams.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. For more information about AWS Identity and Access Management, see Using Instance Profiles. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0ixp4ch2tiu04. Example: Required Parameters { "InstanceProfileDescription": "An ample description", "InstanceProfileName": "a_good_name" } Example: All Parameters { "InstanceProfileDescription": "An ample description", "InstanceProfileName": "a_good_name", Applications Version April 22, 2025 1397 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RelatedIds": ["foo", "bar", "baz"], "Priority": "Medium" } AWS Backup Subcategory Change Type Items and Operations in the AWS Backup Subcategory • Backup |
ams-ct-396 | ams-ct.pdf | 396 | happen before the scheduled start time, the RFC is rejected automatically. For more information about AWS Identity and Access Management, see Using Instance Profiles. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0ixp4ch2tiu04. Example: Required Parameters { "InstanceProfileDescription": "An ample description", "InstanceProfileName": "a_good_name" } Example: All Parameters { "InstanceProfileDescription": "An ample description", "InstanceProfileName": "a_good_name", Applications Version April 22, 2025 1397 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RelatedIds": ["foo", "bar", "baz"], "Priority": "Medium" } AWS Backup Subcategory Change Type Items and Operations in the AWS Backup Subcategory • Backup Job | Start • Backup Job | Stop • Backup Plan | Enable Cross Account Copy (Management Account) • Backup Plan | Enable Cross Region Copy • Backup Plan | Update (Review Required) • Recovery Point | Delete Backup Job | Start Start an AWS Backup service backup job to create a one-time snapshot of the specified resource. Full classification: Management | AWS Backup | Backup job | Start Change Type Details Change type ID ct-2hhud2lx01tq7 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated AWS Backup Version April 22, 2025 1398 AMS Advanced Change Type Reference Additional Information Start AWS Backup job Starting a backup job with the console The following shows this change type in the AMS console. 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. AWS Backup Version April 22, 2025 1399 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. Starting a backup job 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: AWS Backup Version April 22, 2025 1400 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-2hhud2lx01tq7" --change-type-version "1.0" --title "AWS Backup Start Backup |
ams-ct-397 | ams-ct.pdf | 397 | 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: AWS Backup Version April 22, 2025 1400 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-2hhud2lx01tq7" --change-type-version "1.0" --title "AWS Backup Start Backup Job" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-StartBackupJob\",\"Region\":\"us-east-1\",\"Parameters \":{\"BackupVaultName\":[\"backup-vault\"],\"ResourceArn\":[\"arn:aws:ec2:us- east-1:000000000000:volume/vol-123456789\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it StartBackupJobParams.json: aws amscm get-change-type-version --change-type-id "ct-2hhud2lx01tq7" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > StartBackupJobParams.json 2. Modify and save the StartBackupJobParams file. { "DocumentName": "AWSManagedServices-StartBackupJob", "Region": "us-east-1", "Parameters": { "BackupVaultName": ["backup-vault"], "CompleteWindowMinutes": [ "200" ], "DeleteAfterDays": [ "10" ], "ResourceArn": ["arn:aws:ec2:us-east-1:000000000000:volume/vol-123456789"], "StartWindowMinutes": [ "60" ] } } 3. Output the RFC template to a file in your current folder; this example names it StartBackupJobRfc.json: aws amscm create-rfc --generate-cli-skeleton > StartBackupJobRfc.json 4. Modify and save the StartBackupJobRfc.json file. For example, you can replace the contents with something like this: { AWS Backup Version April 22, 2025 1401 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-2hhud2lx01tq7", "ChangeTypeVersion": "1.0", "Title": "AWS Backup Start Backup Job" } 5. Create the RFC, specifying the StartBackupJobRfc file and the StartBackupJobParams file: aws amscm create-rfc --cli-input-json file://StartBackupJobRfc.json --execution- parameters file://StartBackupJobParams.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 AWS Backup, see AWS Backup: How It Works. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2hhud2lx01tq7. Example: Required Parameters { "DocumentName": "AWSManagedServices-StartBackupJob", "Region": "us-east-1", "Parameters": { "ResourceArn": ["arn:aws:ec2:us-east-1:000000000000:volume/vol-123456789"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-StartBackupJob", "Region": "us-east-1", "Parameters": { "BackupVaultName": ["backup-vault"], "CompleteWindowMinutes": [ "200" ], "DeleteAfterDays": [ "10" ], "ResourceArn": ["arn:aws:ec2:us-east-1:000000000000:volume/vol-123456789"], AWS Backup Version April 22, 2025 1402 AMS Advanced Change Type Reference AMS Advanced Change Type Details "StartWindowMinutes": [ "60" ] } } Backup Job | Stop Stop an AWS Backup service running, or scheduled, backup job. Full classification: Management | AWS Backup | Backup job | Stop Change Type Details Change type ID ct-1895yr1p87noq Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Stop AWS Backup job Stopping a backup job with the console The following shows this change type in the AMS console. AWS Backup Version April 22, 2025 1403 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. Stopping a backup job with the CLI How it works: |
ams-ct-398 | ams-ct.pdf | 398 | 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. Stopping a backup job 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. AWS Backup Version April 22, 2025 1404 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 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-1895yr1p87noq" --change-type-version "1.0" --title "AWS Backup Stop Backup Job" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-StopBackupJob\",\"Region\":\"us-east-1\",\"Parameters\": {\"BackupJobId\":[\"278bac28-d634-45b4-85b6-3685e99f2ca1\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it StopBackupJobParams.json: aws amscm get-change-type-version --change-type-id "ct-1895yr1p87noq" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > StopBackupJobParams.json 2. Modify and save the StopBackupJobParams file. AWS Backup Version April 22, 2025 1405 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "DocumentName": "AWSManagedServices-StopBackupJob", "Region": "us-east-1", "Parameters": { "BackupJobId": [ "278bac28-d634-45b4-85b6-3685e99f2ca1" ] } } 3. Output the RFC template to a file in your current folder; this example names it StopBackupJobRfc.json: aws amscm create-rfc --generate-cli-skeleton > StopBackupJobRfc.json 4. Modify and save the StopBackupJobRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1895yr1p87noq", "ChangeTypeVersion": "1.0", "Title": "AWS Backup Stop Backup Job" } 5. Create the RFC, specifying the StopBackupJobRfc file and the StopBackupJobParams file: aws amscm create-rfc --cli-input-json file://StopBackupJobRfc.json --execution- parameters file://StopBackupJobParams.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 AWS Backup, see AWS Backup: How It Works. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1895yr1p87noq. AWS Backup Version April 22, 2025 1406 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "DocumentName": "AWSManagedServices-StopBackupJob", "Region": "us-east-1", "Parameters": { "BackupJobId": [ "76659DD5-1A99-46FE-97AD-D6D0126382CA" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-StopBackupJob", "Region": "us-east-1", "Parameters": { "BackupJobId": [ "2abf2ce0-9096-407c-95a6-4d0b584b9a0a" ] } } Backup Plan | Enable Cross Account Copy (Management Account) Enable and configure cross-account backup and monitoring in a management account. This automation can only be completed successfully in a management account. Full classification: Management | AWS Backup | Backup plan | Enable cross account copy (Management account) Change Type Details Change type ID ct-2yja7ihh30ply Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated AWS Backup Version April 22, 2025 1407 AMS Advanced Change Type Reference Additional Information Enable cross account backup plan copy Enabling cross account backup plan copy 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 |
ams-ct-399 | ams-ct.pdf | 399 | 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. AWS Backup Version April 22, 2025 1408 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. Enabling cross account backup plan copy 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: AWS Backup Version April 22, 2025 1409 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-2yja7ihh30ply" \ --change-type-version "1.0" --title "ConfigCrossAccountCopyInManagementAccount" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- HandleConfigureCrossAccountBackupInManagementAccount-Admin\",\"Region\":\"ap- southeast-2\",\"Parameters\":{\"DestinationAccountId\":[\"123456789012\"], \"SourceAccountId\":[\"210987654321\"]}}" \ --endpoint-url https://amscm-gamma.us-east-1.amazonaws.com TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it ConfigCrossAcctCopyBackupPlanParams.json: aws amscm get-change-type-version --change-type-id "ct-2yja7ihh30ply" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ConfigCrossAcctCopyBackupPlanParams.json 2. Modify and save the ConfigCrossAcctCopyBackupPlanParams file. { "DocumentName": "AWSManagedServices- HandleConfigureCrossAccountBackupInManagementAccount-Admin", "Region": "ap-southeast-2", "Parameters": { "DestinationAccountId": [ "123456789012" ], "SourceAccountId": [ "210987654321" ] } } 3. Output the RFC template to a file in your current folder; this example names it ConfigCrossAcctCopyBackupPlanRfc.json: AWS Backup Version April 22, 2025 1410 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > ConfigCrossAcctCopyBackupPlanRfc.json 4. Modify and save the ConfigCrossAcctCopyBackupPlanRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-2yja7ihh30ply", "ChangeTypeVersion": "1.0", "Title": "ConfigureCrossAcctCopyBackup" } 5. Create the RFC, specifying the ConfigCrossAcctCopyBackupPlanRfc file and the ConfigCrossAcctCopyBackupPlanParams file: aws amscm create-rfc --cli-input-json file://ConfigCrossAcctCopyBackupPlanRfc.json --execution-parameters file://ConfigCrossAcctCopyBackupPlanParams.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 AWS Backup, see AWS Backup: How It Works. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2yja7ihh30ply. Example: Required Parameters Example not available. Example: All |
ams-ct-400 | ams-ct.pdf | 400 | "ChangeTypeId": "ct-2yja7ihh30ply", "ChangeTypeVersion": "1.0", "Title": "ConfigureCrossAcctCopyBackup" } 5. Create the RFC, specifying the ConfigCrossAcctCopyBackupPlanRfc file and the ConfigCrossAcctCopyBackupPlanParams file: aws amscm create-rfc --cli-input-json file://ConfigCrossAcctCopyBackupPlanRfc.json --execution-parameters file://ConfigCrossAcctCopyBackupPlanParams.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 AWS Backup, see AWS Backup: How It Works. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2yja7ihh30ply. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices- HandleConfigureCrossAccountBackupInManagementAccount-Admin", AWS Backup Version April 22, 2025 1411 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters": { "DestinationAccountId": [ "123456789012" ], "SourceAccountId": [ "123456789012" ] } } Backup Plan | Enable Cross Region Copy Update an existing backup plan rule with copy actions like cross region destination vault, and storage retention settings. Full classification: Management | AWS Backup | Backup plan | Enable cross region copy Change Type Details Change type ID ct-0fqo03yizfnw6 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Enabling a cross region backup plan copy Enabling a cross-region backup plan copy with the console The following shows this change type in the AMS console. AWS Backup Version April 22, 2025 1412 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. AWS Backup Version April 22, 2025 1413 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. Enabling a cross-region backup plan copy 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 \ AWS Backup Version April 22, 2025 1414 AMS Advanced |
ams-ct-401 | ams-ct.pdf | 401 | 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 \ AWS Backup Version April 22, 2025 1414 AMS Advanced Change Type Reference AMS Advanced Change Type Details --change-type-id "ct-0fqo03yizfnw6" \ --change-type-version "1.0" --title "ConfigureCrossRegionBackup" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- ConfigureCrossRegionBackup\",\"Region\":\"us-east-1\",\"Parameters\":{\"BackupPlanName \":[\"ConfigureCrossRegionBackup-Plan\"],\"RuleName\":[\"BackupRule1\"], \"DestinationRegion\":[\"eu-west-1\"],\"DestinationVaultName\":[\"vault- test-ConfigureCrossRegionBackup\"],\"DeleteAfterNumberOfDays\":[\"250\"], \"MoveToColdStorageAfterNumberOfDays\":[\"150\"]}}" \ --endpoint-url https://amscm-gamma.us-east-1.amazonaws.com TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it ConfigCrossRegionBackupPlanParams.json: aws amscm get-change-type-version --change-type-id "ct-0fqo03yizfnw6" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ConfigCrossRegionBackupPlanParams.json 2. Modify and save the ConfigCrossRegionBackupPlanParams file. { "DocumentName": "AWSManagedServices-ConfigureCrossRegionBackup", "Region": "us-east-1", "Parameters": { "BackupPlanName": [ "ConfigureCrossRegionBackup-Plan"], "RuleName": ["BackupRule1"], "DestinationRegion": [ "eu-west-1"], "DestinationVaultName": [ "vault-test-ConfigureCrossRegionBackup"], "DeleteAfterNumberOfDays": [ "250"], "MoveToColdStorageAfterNumberOfDays": [ "150"] } } 3. Output the RFC template to a file in your current folder; this example names it ConfigCrossRegionBackupPlanRfc.json: aws amscm create-rfc --generate-cli-skeleton > ConfigCrossRegionBackupPlanRfc.json 4. Modify and save the ConfigCrossRegionBackupPlanRfc.json file. For example, you can replace the contents with something like this: AWS Backup Version April 22, 2025 1415 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "ChangeTypeId": "ct-0fqo03yizfnw6", "ChangeTypeVersion": "1.0", "Title": "ConfigureCrossRegionBackup" } 5. Create the RFC, specifying the ConfigCrossRegionBackupPlanRfc file and the ConfigCrossRegionBackupPlanParams file: aws amscm create-rfc --cli-input-json file://ConfigCrossRegionBackupPlanRfc.json -- execution-parameters file://ConfigCrossRegionBackupPlanParams.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 AWS Backup, see AWS Backup: How It Works. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0fqo03yizfnw6. Example: Required Parameters { "DocumentName": "AWSManagedServices-ConfigureCrossRegionBackup", "Region": "us-east-1", "Parameters": { "BackupPlanName": [ "backup-vault" ], "RuleName": [ "Daily-Backup" ], "DestinationRegion": [ "eu-west-1" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-ConfigureCrossRegionBackup", AWS Backup Version April 22, 2025 1416 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters": { "BackupPlanName": [ "backup-vault" ], "RuleName": [ "Daily-Backup" ], "DestinationRegion": [ "eu-west-1" ], "DestinationVaultName": [ "ams-replication-vault" ], "DestinationEncryptionKeyArn": ["arn:aws:kms:us- east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"], "DeleteAfterNumberOfDays": [ "100" ], "MoveToColdStorageAfterNumberOfDays": [ "200" ] } } Backup Plan | Update (Review Required) Update an existing backup plan. Please note that any changes that you make to a backup plan have no effect on existing backups created by the backup plan. The changes apply only to backups that are created in the future. Full classification: Management | AWS Backup | Backup plan | Update (review required) Change Type Details Change type ID ct-1ay83wy4vxa3k Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Update AWS Backup plan (review required) Updating an AWS Backup plan with the console The following shows this change type in the AMS console. AWS Backup Version April 22, 2025 1417 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 |
ams-ct-402 | ams-ct.pdf | 402 | 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. AWS Backup Version April 22, 2025 1418 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. Updating 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: AWS Backup Version April 22, 2025 1419 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-1ay83wy4vxa3k" --change-type-version "1.0" --title "Update AWSBackup Plan" --execution-parameters ""{\"BackupPlanName \":\"PLAN_NAME\",\"ResourceTagKey\":\"TAG_KEY\",\"ResourceTagValue\": \"TAG_VALUE\",\"BackupRuleName\":\"RULE_NAME\",\"BackupRuleVault\":\"VAULT\", \"BackupRuleCompletionWindowMinutes\":120,\"BackupRuleScheduleExpression\":\"cron(0 1 ? * * *)\",\"BackupRuleDeleteAfterDays\":90,\"BackupRuleMoveToColdStorageAfterDays \":365,\"BackupRuleStartWindowMinutes\":60,\"BackupRuleRecoveryPointTagKey \":\"TAG_KEY\",\"BackupRuleRecoveryPointTagValue\":\"TAG_VALUE\, \"BackupRuleEnableContinuousBackup\":\"false\",\"BackupRuleCopyActionsDestVaultArn \":\"VAULT\",\"BackupRuleCAMoveToColdStorageAfterDays\":0, \"BackupRuleCopyActionsDeleteAfterDays\":90}"" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it UpdateBackupPlanParams.json: aws amscm get-change-type-version --change-type-id "ct-1ay83wy4vxa3k" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateBackupPlanParams.json 2. Modify and save the UpdateBackupPlanParams file. { "BackupPlanName": "MyCustomBackupPlan", "ResourceTagKey": "custom_backup_test", "ResourceTagValue": "true", "WindowsVSS": "disabled", "BackupRuleName": "BackupRule", "BackupRuleVault": "ams-custom-backups", "BackupRuleCompletionWindowMinutes": 1440, "BackupRuleScheduleExpression": "cron(0 2 ? * * *)", "BackupRuleDeleteAfterDays": 0, "BackupRuleMoveToColdStorageAfterDays": 0, "BackupRuleStartWindowMinutes": 180, "BackupRuleRecoveryPointTagKey": "test", "BackupRuleRecoveryPointTagValue": "test", "BackupRuleEnableContinuousBackup": "false", AWS Backup Version April 22, 2025 1420 AMS Advanced Change Type Reference AMS Advanced Change Type Details "BackupRuleCopyActionsDestVaultArn": "", "BackupRuleCAMoveToColdStorageAfterDays": 0, "BackupRuleCopyActionsDeleteAfterDays": 0 } 3. Output the RFC template to a file in your current folder; this example names it UpdateBackupPlanRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateBackupPlanRfc.json 4. Modify and save the UpdateBackupPlanRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1ay83wy4vxa3k", "Title": "Update AWS Backup Plan" } 5. Create the RFC, specifying the UpdateBackupPlanRfc file and the UpdateBackupPlanParams file: aws amscm create-rfc --cli-input-json file://UpdateBackupPlanRfc.json --execution- parameters file://UpdateBackupPlanParams.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 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. To learn more about AWS Backup, see AWS Backup: How It Works. Before creating backup plans, confirm supported resources at Feature availability by resource. AWS Backup Version April 22, 2025 1421 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-1ay83wy4vxa3k. Example: Required Parameters { "BackupPlanName": "MyCustomBackupPlan", "BackupRuleName": "BackupRule", "BackupRuleVault": "ams-custom-backups" } Example: All Parameters { "BackupPlanName": "MyCustomBackupPlan", "ResourceTagKey": "custom_backup_test", "ResourceTagValue": "true", "WindowsVSS": "disabled", "BackupRuleName": "BackupRule", "BackupRuleVault": "ams-custom-backups", "BackupRuleCompletionWindowMinutes": 1440, "BackupRuleScheduleExpression": "cron(0 2 ? * * *)", "BackupRuleDeleteAfterDays": 0, "BackupRuleMoveToColdStorageAfterDays": 0, "BackupRuleStartWindowMinutes": 180, "BackupRuleRecoveryPointTagKey": "test", "BackupRuleRecoveryPointTagValue": "test", "BackupRuleEnableContinuousBackup": "false", "BackupRuleCopyActionsDestVaultArn": "", "BackupRuleCAMoveToColdStorageAfterDays": 0, "BackupRuleCopyActionsDeleteAfterDays": 0, "Priority": "Medium" } Recovery Point | Delete Delete one or more recovery points (snapshots) from the |
ams-ct-403 | ams-ct.pdf | 403 | 22, 2025 1421 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-1ay83wy4vxa3k. Example: Required Parameters { "BackupPlanName": "MyCustomBackupPlan", "BackupRuleName": "BackupRule", "BackupRuleVault": "ams-custom-backups" } Example: All Parameters { "BackupPlanName": "MyCustomBackupPlan", "ResourceTagKey": "custom_backup_test", "ResourceTagValue": "true", "WindowsVSS": "disabled", "BackupRuleName": "BackupRule", "BackupRuleVault": "ams-custom-backups", "BackupRuleCompletionWindowMinutes": 1440, "BackupRuleScheduleExpression": "cron(0 2 ? * * *)", "BackupRuleDeleteAfterDays": 0, "BackupRuleMoveToColdStorageAfterDays": 0, "BackupRuleStartWindowMinutes": 180, "BackupRuleRecoveryPointTagKey": "test", "BackupRuleRecoveryPointTagValue": "test", "BackupRuleEnableContinuousBackup": "false", "BackupRuleCopyActionsDestVaultArn": "", "BackupRuleCAMoveToColdStorageAfterDays": 0, "BackupRuleCopyActionsDeleteAfterDays": 0, "Priority": "Medium" } Recovery Point | Delete Delete one or more recovery points (snapshots) from the specified vault. Use this change type to delete recovery points that were manually created, and recovery points that were created through a backup plan, and that are older than 30 days. The deletion of recovery points cannot be rolled back. AWS Backup Version April 22, 2025 1422 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Management | AWS Backup | Recovery point | Delete Change Type Details Change type ID ct-1r1vbr8ahr156 Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Delete AWS Backup recovery points Deleting recovery points 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. AWS Backup Version April 22, 2025 1423 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. Deleting recovery points 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. AWS Backup Version April 22, 2025 1424 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 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-1r1vbr8ahr156" --change-type-version "2.0" --title "AWS Backup Delete Recovery Points" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-DeleteRecoveryPoints\",\"Region\":\"us-east-1\",\"Parameters\": {\"BackupVaultName\":[\"ams-manual-backups\"],\"RecoveryPointArns\":[\"arn:aws:ec2:us- east-1::snapshot/snap-0000000000000000\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for |
ams-ct-404 | ams-ct.pdf | 404 | 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-1r1vbr8ahr156" --change-type-version "2.0" --title "AWS Backup Delete Recovery Points" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-DeleteRecoveryPoints\",\"Region\":\"us-east-1\",\"Parameters\": {\"BackupVaultName\":[\"ams-manual-backups\"],\"RecoveryPointArns\":[\"arn:aws:ec2:us- east-1::snapshot/snap-0000000000000000\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it DeleteRecoveryPointsParams.json: aws amscm get-change-type-version --change-type-id "ct-1r1vbr8ahr156" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeleteRecoveryPointsParams.json 2. Modify and save the DeleteRecoveryPointsParams file. { AWS Backup Version April 22, 2025 1425 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-DeleteRecoveryPoints", "Region": "us-east-1", "Parameters": { "BackupVaultName": [ "ams-manual-backups" ], "RecoveryPointArns": [ "arn:aws:backup:us-east-1:000000000000:recovery- point:24f48ec5-79a7-4a40-b992-d97583518f2f", "arn:aws:backup:us-east-1:000000000000:recovery-point:3b6a599e- b5a3-4028-87b3-be9a1fdc01e8" ] } } 3. Output the RFC template to a file in your current folder; this example names it DeleteRecoveryPointsRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteRecoveryPointsRfc.json 4. Modify and save the DeleteRecoveryPointsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1r1vbr8ahr156", "ChangeTypeVersion": "2.0", "Title": "AWS Backup Delete Recovery Points" } 5. Create the RFC, specifying the DeleteRecoveryPointsRfc file and the DeleteRecoveryPointsParams file: aws amscm create-rfc --cli-input-json file://DeleteRecoveryPointsRfc.json -- execution-parameters file://DeleteRecoveryPointsParams.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 1426 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note This CT is now at version 2.0. This reflects development to allow you to delete more than one recovery point at a time. To learn more about AWS Backup, see AWS Backup: How It Works. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1r1vbr8ahr156. Example: Required Parameters { "DocumentName": "AWSManagedServices-DeleteRecoveryPoints", "Region": "us-east-1", "Parameters": { "BackupVaultName": [ "backup-vault" ], "RecoveryPointArns": [ "arn:aws:backup:us-east-1:123456789012:recovery- point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45", "arn:aws:backup:us- east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D41" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-DeleteRecoveryPoints", "Region": "us-east-1", "Parameters": { "BackupVaultName": [ "backup-vault" ], "RecoveryPointArns": [ "arn:aws:backup:us-east-1:123456789012:recovery- point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45", "arn:aws:backup:us- east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D41" ] } } AWS Backup Version April 22, 2025 1427 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS Service Subcategory Change Type Items and Operations in the AWS Service Subcategory • Self-Provisioned Service | Add • Self-Provisioned Service | Add (Review Required) Self-Provisioned Service | Add Add a specific, allowed, AWS service to your AMS account. This CT validates prerequisites in the account and deploys a service with the default parameters. Not all Self-service provisioning services are supported, the ServiceName parameter for this CT lists the ones that are. For each service that you add, AMS creates a new role so you use the service without AMS management under the AMS Shared Responsibility model. Compliance is a shared responsibility and your AMS compliance status does not automatically apply to services or applications that you add in this way. Some AWS services do not have compliance certifications. For more information, see the AWS Services in Scope of AWS Assurance Program page. On that page, unless specifically excluded, features of each of the services are considered in scope of the assurance programs, and are reviewed and tested as part of our assessment when you submit this CT. Full classification: Management | AWS service | Self-provisioned service | Add Change Type Details Change type ID ct-1w8z66n899dct Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated AWS Service Version April 22, 2025 1428 AMS Advanced Change Type Reference Additional Information Add Self-Service Provisioning service Adding an AMS self-provisioned AWS service 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 |
ams-ct-405 | ams-ct.pdf | 405 | 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. AWS Service Version April 22, 2025 1429 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. Adding an AMS self-provisioned AWS service 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 AWS Service Version April 22, 2025 1430 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 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-1w8z66n899dct" --change-type-version "1.0" --title "Add new Self-provisioned service" --execution-parameters "{\"DocumentName \": \"AWSManagedServices-HandleCreateSSPSResources-Admin\",\"Region\": \"us-east-1\", \"Parameters\": {\"ServiceName\": \"AWS License Manager\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named AddSspsParameters.json. aws amscm get-change-type-version --change-type-id "ct-1w8z66n899dct" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AddSspsParameters.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-HandleCreateSSPSResources-Admin", "Region": "us-east-1", "Parameters": { "ServiceName": "AWS License Manager" } } 3. Output the RFC template to a file in your current folder; this example names it AddSspsRfc.json: aws amscm create-rfc --generate-cli-skeleton > AddSspsRfc.json 4. Modify and save the AddSspsRfc.json file. For example, you can replace the contents with something like this: AWS Service Version April 22, 2025 1431 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "ChangeTypeId": "ct-1w8z66n899dct", "ChangeTypeVersion": "1.0", "Title": "Add new Self-provisioned service" } 5. Create the RFC, specifying the SelfServeServiceRfc file and the SelfServeServiceParams file: aws amscm create-rfc --cli-input-json file://AddSspsRfc.json --execution- parameters file://AddSspsParameters.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 • The ServiceName field in the console lists the self-provisioned services supported by this CT. Limited to AMS-approved AWS services. For a list, see Setting Up Self-serve Services. • For self-provisioned services not supported by this CT, or for deployment with custom parameters, use the manual version: Management | AWS service | Self-Provisioned Service | Add (review required) (ct-3qe6io8t6jtny). Execution Input Parameters For detailed information about |
ams-ct-406 | ams-ct.pdf | 406 | 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 • The ServiceName field in the console lists the self-provisioned services supported by this CT. Limited to AMS-approved AWS services. For a list, see Setting Up Self-serve Services. • For self-provisioned services not supported by this CT, or for deployment with custom parameters, use the manual version: Management | AWS service | Self-Provisioned Service | Add (review required) (ct-3qe6io8t6jtny). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1w8z66n899dct. Example: Required Parameters { "DocumentName" : "AWSManagedServices-HandleCreateSSPSResources-Admin", "Region" : "us-east-1", "Parameters": { "ServiceName": "AWS License Manager" } } AWS Service Version April 22, 2025 1432 AMS Advanced Change Type Reference Example: All Parameters { AMS Advanced Change Type Details "DocumentName" : "AWSManagedServices-HandleCreateSSPSResources-Admin", "Region" : "us-east-1", "Parameters": { "ServiceName": "AWS License Manager", "SAMLProviders": "foo-saml-provider,bar-saml-provider", "IAMRole": "testing_role" } } Self-Provisioned Service | Add (Review Required) Add a specific, allowed, AWS service to your AMS account. AMS adds the necessary permissions to use the service to an existing IAM role that you specify, or creates a new role that allows you to use the service without AMS management under the AMS Shared Responsibility model. Compliance is a shared responsibility and your AMS compliance status does not automatically apply to services or applications that you add in this way. Some AWS services do not have compliance certifications. For more information, go to the AWS Services in Scope of AWS Assurance Program page. On that page, unless specifically excluded, features of each of the services are considered in scope of the assurance programs, and are reviewed and tested as part of the assessment. Full classification: Management | AWS service | Self-provisioned service | Add (review required) Change Type Details Change type ID ct-3qe6io8t6jtny Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual AWS Service Version April 22, 2025 1433 AMS Advanced Change Type Reference Additional Information AMS Advanced Change Type Details Add Self-Service Provisioning service (review required) Adding an AMS self-provisioned AWS service 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. • 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. AWS Service Version April 22, 2025 1434 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. Adding an AMS self-provisioned AWS service 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 |
ams-ct-407 | ams-ct.pdf | 407 | RFC or create a copy of it with the options at the top of the page. Adding an AMS self-provisioned AWS service 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 AWS Service Version April 22, 2025 1435 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 quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: All parameters: aws amscm create-rfc --title Add-Self-Serve-Service --change-type-id ct-3qe6io8t6jtny --change-type-version 1.0 --execution-parameters '{"ServiceName":"AWS Certificate Manager (ACM)","IAMRole":"arn:aws:iam::123456789012:role/customer_security_role", "SAMLProviders":"SAML_PROVIDER,SAML_PROVIDER"}' Only required parameters: aws amscm create-rfc --title add-self-serve-service --change-type-id ct-3qe6io8t6jtny --change-type-version 1.0 --execution-parameters '{"ServiceName":"AWS License Manager"}' TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named SelfServeServiceParams.json. aws amscm get-change-type-version --change-type-id "ct-3qe6io8t6jtny" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > SelfServeServiceParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "ServiceName": "AWS Certificate Manager (ACM)", "IAMRole": "arn:aws:iam::123456789012:role/customer_security_role", "SAMLProviders": "SAML_PROVIDER, SAML_PROVIDER" } AWS Service Version April 22, 2025 1436 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 SelfServeServiceRfc.json: aws amscm create-rfc --generate-cli-skeleton > SelfServeServiceRfc.json 4. Modify and save the SelfServeServiceRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-3qe6io8t6jtny", "ChangeTypeVersion": "1.0", "Title": "Self-Serve-Service-RFC" } 5. Create the RFC, specifying the SelfServeServiceRfc file and the SelfServeServiceParams file: aws amscm create-rfc --cli-input-json file://SelfServeServiceRfc.json --execution- parameters file://SelfServeServiceParams.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 automated deployment of most self-provisioned services with default roles, use: Management | AWS service | Self-provisioned service | Add (no review required) (ct-1w8z66n899dct). See Add Self-Service Provisioning service. UUse this "review required" change type (ct-3qe6io8t6jtny) for services not supported by ct-1w8z66n899dct or for deployments with custom parameters. • For a list of which self-provisioned services you can add using CloudFormation Ingest, see CloudFormation Ingest stack: supported resources. • 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. • The ServiceName parameter is limited to AMS-approved AWS services. For a list, see Setting Up Self-serve Services. AWS Service Version April 22, 2025 1437 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-3qe6io8t6jtny. Example: Required Parameters { "ServiceName": "AWS License Manager" } Example: All Parameters { "ServiceName": "AWS License Manager", "IAMRole": "arn:aws:iam::123456789012:role/myrole", "SAMLProviders": "foo-saml-provider", "Priority": "Medium" } Custom Stack Subcategory Change Type Items and Operations in the Custom Stack Subcategory • Stack from CloudFormation Template | Approve Changeset and Update • Stack from CloudFormation Template | Remediate Drift • Stack from CloudFormation Template | Remediate Drift (Review Required) • Stack from CloudFormation Template | Update Stack from CloudFormation Template | Approve Changeset and Update Approve and execute an existing ChangeSet to update a CloudFormation stack. This ChangeType is used primarily to approve and apply changes requested using the "Update CloudFormation stack" CT that would cause removal or replacement of resources, but can also be used to execute any existing ChangeSet to update CloudFormation stacks. Full classification: Management | Custom Stack | Stack from CloudFormation Template | Approve Changeset and Update |
ams-ct-408 | ams-ct.pdf | 408 | • Stack from CloudFormation Template | Remediate Drift • Stack from CloudFormation Template | Remediate Drift (Review Required) • Stack from CloudFormation Template | Update Stack from CloudFormation Template | Approve Changeset and Update Approve and execute an existing ChangeSet to update a CloudFormation stack. This ChangeType is used primarily to approve and apply changes requested using the "Update CloudFormation stack" CT that would cause removal or replacement of resources, but can also be used to execute any existing ChangeSet to update CloudFormation stacks. Full classification: Management | Custom Stack | Stack from CloudFormation Template | Approve Changeset and Update Custom Stack Version April 22, 2025 1438 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-1404e21baa2ox Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Approve a CloudFormation ingest stack changeset Approving and updating a CloudFormation ingest stack using the console To approve and update 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. Custom Stack Version April 22, 2025 1439 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. Approving and updating a CloudFormation ingest stack using the CLI To approve and update 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: Custom Stack Version April 22, 2025 1440 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. 1. Output the execution parameters JSON schema for this change type to a file in your current folder. This example names it CreateAsgParams.json: aws amscm create-rfc --change-type-id "ct-1404e21baa2ox" --change- type-version "1.0" --title "Approve Update" --execution-parameters file://PATH_TO_EXECUTION_PARAMETERS --profile saml 2. Modify and save the schema as follows: { "StackId": "STACK_ID", "VpcId": "VPC_ID", "ChangeSetName": "UPDATE-ef81e2bc-03f6-4b17-a3c7-feb700e78faa", "TimeoutInMinutes": 1080 } Tips Note If there are multiple resources in a stack, and you want to delete only a subset of the stack resources, use the CloudFormation Update CT; see CloudFormation Ingest Stack: Updating. You can also submit a Management | Other | Other | Update change |
ams-ct-409 | ams-ct.pdf | 409 | Output the execution parameters JSON schema for this change type to a file in your current folder. This example names it CreateAsgParams.json: aws amscm create-rfc --change-type-id "ct-1404e21baa2ox" --change- type-version "1.0" --title "Approve Update" --execution-parameters file://PATH_TO_EXECUTION_PARAMETERS --profile saml 2. Modify and save the schema as follows: { "StackId": "STACK_ID", "VpcId": "VPC_ID", "ChangeSetName": "UPDATE-ef81e2bc-03f6-4b17-a3c7-feb700e78faa", "TimeoutInMinutes": 1080 } Tips Note If there are multiple resources in a stack, and you want to delete only a subset of the stack resources, use the CloudFormation Update CT; see CloudFormation Ingest Stack: Updating. You can also submit a Management | Other | Other | Update change type and AMS engineers can help you craft the changeset, if needed. Custom Stack Version April 22, 2025 1441 AMS Advanced Change Type Reference AMS Advanced Change Type Details To learn more about AWS CloudFormation, see AWS CloudFormation. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1404e21baa2ox. Example: Required Parameters Example not available. Example: All Parameters Example not available. Stack from CloudFormation Template | Remediate Drift Remediate the drift (out-of-band changes) in a stack, bringing the stack in sync and enabling you to perform future updates using the available Update CTs. Note: up to 10 drifted resources will be remediated per RFC. Full classification: Management | Custom Stack | Stack from CloudFormation Template | Remediate drift Change Type Details Change type ID ct-3kinq0u4l33zf Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Custom Stack Version April 22, 2025 1442 AMS Advanced Change Type Reference Additional Information Remediate stack drift AMS Advanced Change Type Details Drift remediation supported resources (ct-3kinq0u4l33zf) These are the resources that are supported by the drift remediation change type, (ct-3kinq0u4l33zf). For remediation of any resource, use the "review required" (ct-34sxfo53yuzah) change type instead. AWS::EC2::Instance AWS::EC2::SecurityGroup AWS::EC2::VPC AWS::EC2::Subnet AWS::EC2::NetworkInterface AWS::EC2::EIP AWS::EC2::InternetGateway AWS::EC2::NatGateway AWS::EC2::NetworkAcl AWS::EC2::RouteTable AWS::EC2::Volume AWS::AutoScaling::AutoScalingGroup AWS::AutoScaling::LaunchConfiguration AWS::AutoScaling::LifecycleHook AWS::AutoScaling::ScalingPolicy AWS::AutoScaling::ScheduledAction AWS::ElasticLoadBalancing::LoadBalancer AWS::ElasticLoadBalancingV2::Listener AWS::ElasticLoadBalancingV2::ListenerRule AWS::ElasticLoadBalancingV2::LoadBalancer AWS::CloudWatch::Alarm Remediating Stack Drift with the Console Screenshot of this change type in the AMS console: Custom Stack Version April 22, 2025 1443 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. Custom Stack Version April 22, 2025 1444 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. Remediating Stack Drift 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 |
ams-ct-410 | ams-ct.pdf | 410 | 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: Custom Stack Version April 22, 2025 1445 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-3kinq0u4l33zf" --change-type-version "1.0" -- title "Remediate Stack Drift, no ops review" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-StartDriftRemediation\", \"Region\": \"us-east-1\", \"Parameters \": {\"StackName\": [\"stack-xxxxxxxxxxxxxxxxx\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it RemediateDriftNrrParams.json: aws amscm create-rfc --generate-cli-skeleton > RemediateDriftNrrParams.json 2. Modify and save the RemediateDriftNrrParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-StartDriftRemediation", "Region": "us-east-1", "Parameters": { "StackName": [ "stack-xxxxxxxxxxxxxxxxx" ] } } 3. Output the RFC template JSON file to a file; this example names it RemediateDriftNrrRfc.json: aws amscm create-rfc --generate-cli-skeleton > RemediateDriftNrrRfc.json 4. Modify and save the RemediateDriftNrrRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-3kinq0u4l33zf", "ChangeTypeVersion": "1.0", "Title": "Remediate stack drift, no ops review" } 5. Create the RFC, specifying the RemediateDriftNrrRfc file and the RemediateDriftNrrParams file: Custom Stack Version April 22, 2025 1446 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://RemediateDriftNrrRfc.json -- execution-parameters file://RemediateDriftNrrParams.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 Stack remediation modifies the stack template and/or parameter values. Once remediation is complete, you must update your local template repositories, or any automation, that would be updating the remediated stack, with the latest template and parameters provided in the RFC summary of the remeditation. It is very important to do this, because using the old template and/or parameters can cause destructive changes on the stack resources. For more details, including a list of Limitations, see Drift remediation FAQs. Note When using "review required" CTs, AMS recommends that you use the ASAP Scheduling option (choose ASAP in the console, leave start and end time blank in the API/CLI) as these CTs require an AMS operator to examine the RFC, and possibly communicate with you before it can be approved and run. If you schedule these RFCs, 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-3kinq0u4l33zf. Example: Required Parameters Example not available. Custom Stack Version April 22, 2025 1447 AMS Advanced Change Type Details AMS Advanced Change Type Reference Example: All Parameters { "DocumentName": "AWSManagedServices-StartDriftRemediation", "Region": "us-east-1", "Parameters": { "StackName": ["stack-a1b2c3d4e5f678900"], "DryRun": ["true"] } } Stack from CloudFormation Template | Remediate Drift (Review Required) Remediate the drift (out-of-band changes) in a stack, bringing the stack in sync and enabling you to perform future updates using the available Update CTs. Drift remediation can be performed on EC2 resource types. Full classification: Management | Custom Stack | Stack from CloudFormation Template | Remediate drift (review required) Change Type Details Change type ID ct-34sxfo53yuzah Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Remediate stack drift (review required) Remediating Stack Drift (review required) with the Console Screenshot of this change type in the AMS console: Custom Stack Version April 22, 2025 1448 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 |
ams-ct-411 | ams-ct.pdf | 411 | ID ct-34sxfo53yuzah Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Remediate stack drift (review required) Remediating Stack Drift (review required) with the Console Screenshot of this change type in the AMS console: Custom Stack Version April 22, 2025 1448 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. Custom Stack Version April 22, 2025 1449 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. Remediating Stack Drift (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: Custom Stack Version April 22, 2025 1450 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-34sxfo53yuzah" --change-type-version "1.0" --title "Remediate stack drift" --execution-parameters '{"StackName":"stack- a1b2c3d4e5f67890e","DryRun":false}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it RemediateDriftParams.json: aws amscm create-rfc --generate-cli-skeleton > RemediateDriftParams.json 2. Modify and save the RemediateDriftParams file. For example, you can replace the contents with something like this: { "StackName" : "stack-a1b2c3d4e5f67890e", "DryRun" : false } 3. Output the RFC template JSON file to a file; this example names it RemediateDriftRfc.json: aws amscm create-rfc --generate-cli-skeleton > RemediateDriftRfc.json 4. Modify and save the RemediateDriftRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-34sxfo53yuzah", "ChangeTypeVersion": "1.0", "Title": "Remediate stack drift" } 5. Create the RFC, specifying the RemediateDriftRfc file and the RemediateDriftParams file: aws amscm create-rfc --cli-input-json file://RemediateDriftRfc.json --execution- parameters file://RemediateDriftParams.json Custom Stack Version April 22, 2025 1451 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, |
ams-ct-412 | ams-ct.pdf | 412 | example names it RemediateDriftRfc.json: aws amscm create-rfc --generate-cli-skeleton > RemediateDriftRfc.json 4. Modify and save the RemediateDriftRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-34sxfo53yuzah", "ChangeTypeVersion": "1.0", "Title": "Remediate stack drift" } 5. Create the RFC, specifying the RemediateDriftRfc file and the RemediateDriftParams file: aws amscm create-rfc --cli-input-json file://RemediateDriftRfc.json --execution- parameters file://RemediateDriftParams.json Custom Stack Version April 22, 2025 1451 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 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. Note When using "review required" CTs, AMS recommends that you use the ASAP Scheduling option (choose ASAP in the console, leave start and end time blank in the API/CLI) as these CTs require an AMS operator to examine the RFC, and possibly communicate with you before it can be approved and run. If you schedule these RFCs, be sure to allow at least 24 hours. If approval does not happen before the scheduled start time, the RFC is rejected automatically. • There is an automated version of this change type that runs more quickly, though there are some limitations. For more details, see Stack | Remediate Drift. • Stack remediation modifies the stack template and/or parameter values. Once remediation is complete, you must update your local template repositories, or any automation, that would be updating the remediated stack, with the latest template and parameters provided in the RFC summary of the remeditation. It is very important to do this, because using the old template and/or parameters can cause destructive changes on the stack resources. For more details, see Drift remediation FAQs. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-34sxfo53yuzah. Custom Stack Version April 22, 2025 1452 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "StackName": "stack-a1b2c3d4e5f678900" } Example: All Parameters { "StackName": "stack-a1b2c3d4e5f678900", "DryRun": false, "Priority": "Medium" } Stack from CloudFormation Template | Update Update the template and/or parameters of a CFN stack. To only update the parameters in an existing stack a modified CFN template is not required, modified parameters can be provided instead. Values for existing parameters are overwritten, values for new parameters are added. To add, delete or modify a resource, or to change attributes not referenced through a parameter, use a modified CFN template. If the update would result in a resource in the stack being replaced or removed, the RFC fails and requires approval through the "Approve ChangeSet and update CloudFormation stack" CT (ct-1404e21baa2ox). Full classification: Management | Custom Stack | Stack from CloudFormation Template | Update Change Type Details Change type ID ct-361tlo1k7339x Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Custom Stack Version April 22, 2025 1453 AMS Advanced Change Type Reference Additional Information AMS Advanced Change Type Details Update AWS CloudFormation ingest stack Updating a CloudFormation ingest stack using the console To update 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. Custom Stack Version April 22, 2025 1454 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area |
ams-ct-413 | ams-ct.pdf | 413 | 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. Custom Stack Version April 22, 2025 1454 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. Updating a CloudFormation ingest stack using the CLI To update 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 Custom Stack Version April 22, 2025 1455 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. 1. Prepare the AWS CloudFormation template that you want to use to update 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: • Create and save the execution parameters JSON file, include the CloudFormation template parameters that you want. This example names it UpdateCfnParams.json. Example UpdateCfnParams.json file with inline parameter updates: { "StackId": "stack-yjjoo9aicjyqw4ro2", "VpcId": "VPC_ID", "CloudFormationTemplate": "{\"AWSTemplateFormatVersion\":\"2010-09-09\", \"Description\":\"Create a SNS topic\",\"Parameters\":{\"TopicName\":{\"Type \":\"String\"},\"DisplayName\":{\"Type\":\"String\"}},\"Resources\":{\"SnsTopic \":{\"Type\":\"AWS::SNS::Topic\",\"Properties\":{\"TopicName\":{\"Ref\": \"TopicName\"},\"DisplayName\":{\"Ref\":\"DisplayName\"}}}}}", "TemplateParameters": [ { "Key": "TopicName", "Value": "TopicNameCLI" }, { "Key": "DisplayName", "Value": "DisplayNameCLI" } ], "TimeoutInMinutes": 1440 } Example UpdateCfnParams.json file with S3 bucket endpoint containing an updated CloudFormation template: { "StackId": "stack-yjjoo9aicjyqw4ro2", "VpcId": "VPC_ID", Custom Stack Version April 22, 2025 1456 AMS Advanced Change Type Reference AMS Advanced Change Type Details "CloudFormationTemplateS3Endpoint": "s3_url", "TemplateParameters": [ { "Key": "TopicName", "Value": "TopicNameCLI" }, { "Key": "DisplayName", "Value": "DisplayNameCLI" } ], "TimeoutInMinutes": 1080 } 3. Create and save the RFC parameters JSON file with the following content. This example names it UpdateCfnRfc.json file. { "ChangeTypeId": "ct-361tlo1k7339x", "ChangeTypeVersion": "1.0", "Title": "cfn-ingest-template-update" } 4. Create the RFC, specifying the UpdateCfnRfc file and the UpdateCfnParams file: aws amscm create-rfc --cli-input-json file://UpdateCfnRfc.json --execution- parameters file://UpdateCfnParams.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 is now at version 2.0. Changes include removing the AutoApproveUpdateForResources parameter, which was used in version 1.0 of this CT, and adding two new parameters: AutoApproveRiskyUpdates and BypassDriftCheck. • 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. Custom Stack Version April 22, 2025 1457 AMS Advanced Change Type Reference AMS Advanced Change Type Details • All Parameter values for resources in the CloudFormation template must have a value, either through a default or a custom value through the parameters section of the CT. You can override the parameter value by structuring the CloudFormation template resources to reference a Parameters key. For examples |
ams-ct-414 | ams-ct.pdf | 414 | 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. Custom Stack Version April 22, 2025 1457 AMS Advanced Change Type Reference AMS Advanced Change Type Details • All Parameter values for resources in the CloudFormation template must have a value, either through a default or a custom value through the parameters section of the CT. You can override the parameter value by structuring the CloudFormation template resources to reference a Parameters key. For examples that show how to do, see CloudFormation ingest stack: CFN validator examples. IMPORTANT: Missing parameters not supplied explicitly in the form, default to the currently set values on the existing stack or template. • For a list of which self-provisioned services you can add using AWS CloudFormation Ingest, see CloudFormation Ingest Stack: Supported Resources. To learn more about AWS CloudFormation, see AWS CloudFormation. 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: • 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-361tlo1k7339x. Custom Stack Version April 22, 2025 1458 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "StackId": "stack-kiwonebfnadq08sol", "VpcId": "vpc-01234567890abcdef", "TimeoutInMinutes": 360 } Example: All Parameters Example not available. Directory Service Subcategory Change Type Items and Operations in the Directory Service Subcategory • Computer Object | Remove • Computer Object | Remove SPN • Directory | Accept Sharing • Directory | Create AD Trust • Directory | Share Directory • Directory | Unshare Directory • DNS | Add A Record • DNS | Add CNAME Record • DNS | Delete Conditional Forwarder • DNS | Remove Record • DNS | Update Cluster Permissions • DNS | Update Conditional Forwarder • DNS | Update Record Permission • Users and Groups | Add Group • Users and Groups | Add Group To Group • Users and Groups | Add User To Group • Users and Groups | Remove User from Group Directory Service Version April 22, 2025 1459 AMS Advanced Change Type Reference AMS Advanced Change Type Details Computer Object | Remove Remove a stale computer object from Microsoft Active Directory (AD) and the corresponding DNS A and PTR records from DNS. Removing the computer object will prevent anyone from raising access against this host using the AMS access control. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | Computer object | Remove Change Type Details Change type ID ct-3d0lrfb8eckuu Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Remove a computer object Removing a computer object from an AMS-managed AD with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 1460 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, |
ams-ct-415 | ams-ct.pdf | 415 | 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. Directory Service Version April 22, 2025 1461 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. Removing a computer object from an AMS-managed AD 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: Directory Service Version April 22, 2025 1462 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-3d0lrfb8eckuu" --change-type-version "1.0" --title "Remove Computer Object" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-RemoveADComputerObject-Admin\",\"Region\": \"us-east-1\", \"Parameters\": {\"ADComputerName\": [\"ABRACADABRA\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it ComputerObjectRemoveParams.json: aws amscm get-change-type-version --change-type-id "ct-3d0lrfb8eckuu" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ComputerObjectRemoveParams.json Modify and save the ComputerObjectRemoveParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-RemoveADComputerObject-Admin", "Region": "us-east-1", "Parameters": { "ADComputerName": [ "ABRACADABRA" ] } } 2. Output the RFC template to a file in your current folder; this example names it ComputerObjectRemoveRfc.json: aws amscm create-rfc --generate-cli-skeleton > ComputerObjectRemoveRfc.json 3. Modify and save the ComputerObjectRemoveRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-3d0lrfb8eckuu", Directory Service Version April 22, 2025 1463 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeVersion": "1.0", "Title": "Remove computer object" } 4. Create the RFC, specifying the ComputerObjectRemoveRfc file and the ComputerObjectRemoveParams file: aws amscm create-rfc --cli-input-json file://ComputerObjectRemoveRfc.json -- execution-parameters file://ComputerObjectRemoveParams.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 Directory Service, see the Directory Service Admin Guide. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3d0lrfb8eckuu. Example: Required Parameters { "DocumentName" : "AWSManagedServices-RemoveADComputerObject-Admin", "Region" : "us-east-1", "Parameters" : { "Hostname" : [ "ABRACADABRA" ] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-RemoveADComputerObject-Admin", "Region" : "us-east-1", "Parameters" : { Directory Service Version April 22, 2025 1464 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Hostname" : [ "ABRACADABRA" |
ams-ct-416 | ams-ct.pdf | 416 | the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For information about Directory Service, see the Directory Service Admin Guide. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3d0lrfb8eckuu. Example: Required Parameters { "DocumentName" : "AWSManagedServices-RemoveADComputerObject-Admin", "Region" : "us-east-1", "Parameters" : { "Hostname" : [ "ABRACADABRA" ] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-RemoveADComputerObject-Admin", "Region" : "us-east-1", "Parameters" : { Directory Service Version April 22, 2025 1464 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Hostname" : [ "ABRACADABRA" ] } } Computer Object | Remove SPN Remove the Service Principal Name (SPN) associated with a specified hostname or host alias in Microsoft Active Directory. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | Computer object | Remove SPN Change Type Details Change type ID ct-1078jhyxq32dp Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Remove a computer object's SPN Removing a computer object's SPN from an AMS-managed AD with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 1465 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. Directory Service Version April 22, 2025 1466 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. Removing a computer object's SPN from an AMS-managed AD 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: Directory Service Version April 22, 2025 1467 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-1078jhyxq32dp" --change-type-version "1.0" --title "Remove AD Computer SPN" --execution-parameters "{\"DocumentName |
ams-ct-417 | ams-ct.pdf | 417 | "{\"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: Directory Service Version April 22, 2025 1467 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-1078jhyxq32dp" --change-type-version "1.0" --title "Remove AD Computer SPN" --execution-parameters "{\"DocumentName \": \"AWSManagedServices-RemoveADComputerSPN-Admin\",\"Region\": \"us-east-1\", \"Parameters\": {\"Hostname\": [\"webserver\"], \"ServiceType\": [\"HOST\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it ComputerObjectRemoveSpnParams.json: aws amscm get-change-type-version --change-type-id "ct-1078jhyxq32dp" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ComputerObjectRemoveSpnParams.json Modify and save the ComputerObjectRemoveSpnParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-RemoveADComputerSPN-Admin", "Region": "us-east-1", "Parameters": { "Hostname": [ "webserver" ], "ServiceType": [ "HOST" ] } } 2. Output the RFC template to a file in your current folder; this example names it ComputerObjectRemoveSpnRfc.json: aws amscm create-rfc --generate-cli-skeleton > ComputerObjectRemoveSpnRfc.json 3. Modify and save the ComputerObjectRemoveSpnRfc.json file. For example, you can replace the contents with something like this: Directory Service Version April 22, 2025 1468 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1078jhyxq32dp", "Title": "Remove AD Computer SPN" } 4. Create the RFC, specifying the ComputerObjectRemoveSpnRfc file and the ComputerObjectRemoveSpnParams file: aws amscm create-rfc --cli-input-json file://ComputerObjectRemoveSpnRfc.json -- execution-parameters file://ComputerObjectRemoveSpnParams.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 Directory Service, see the Directory Service Admin Guide. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1078jhyxq32dp. Example: Required Parameters { "DocumentName": "AWSManagedServices-RemoveADComputerSPN-Admin", "Region": "us-east-1", "Parameters": { "Hostname": ["RDP-12345"], "ServiceType": ["HOST"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-RemoveADComputerSPN-Admin", Directory Service Version April 22, 2025 1469 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters": { "Hostname": ["RDP-12345"], "ServiceType": ["HOST"], "AliasName": ["Valid-Alias123"], "GroupManagedServiceAccountName": ["Valid-Name-456"], "Port": ["1122"] } } Directory | Accept Sharing Accept a directory sharing request sent from the directory owner account. This is run in the directory consumer account. Full classification: Management | Directory Service | Directory | Accept sharing Change Type Details Change type ID ct-13xvbj5pqg253 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Accept directory sharing request Accept a directory sharing request with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 1470 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. |
ams-ct-418 | ams-ct.pdf | 418 | 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. Directory Service Version April 22, 2025 1471 AMS Advanced Change Type Reference AMS Advanced Change Type Details Accept a directory sharing request 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: aws amscm create-rfc \ --change-type-id "ct-13xvbj5pqg253" \ --change-type-version "1.0" --title "AWS Directory Service accept directory sharing" \ --execution- parameters "{\"DocumentName\":\"AWSManagedServices-AcceptSharedDirectory\",\"Region \":\"eu-central-1\",\"Parameters\":{\"SharedDirectoryId\":[\"d-000000000\"], \"OwnerAccountId\":[\"000000000000\"]}}" Directory Service Version April 22, 2025 1472 AMS Advanced Change Type Reference AMS Advanced Change Type Details TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DirectorySharingParams.json: aws amscm get-change-type-version --change-type-id "ct-13xvbj5pqg253" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DirectorySharingParams.json Modify and save the DirectorySharingParams file. For example, you can replace the contents with something like this: { { "DocumentName": "AWSManagedServices-AcceptSharedDirectory", "Region": "eu-central-1", "Parameters": { "SharedDirectoryId": ["d-000000000"], "OwnerAccountId": ["000000000000"] } } 2. Output the RFC template to a file in your current folder; this example names it DirectorySharingRfc.json: aws amscm create-rfc --generate-cli-skeleton > DirectorySharingRfc.json 3. Modify and save the DirectorySharingRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-13xvbj5pqg253", "ChangeTypeVersion": "1.0", "Title": "AWS Directory Service accept directory sharing" } 4. Create the RFC, specifying the DirectorySharingRfc file and the DirectorySharingParams file: aws amscm create-rfc --cli-input-json file://DirectorySharingRfc.json --execution- parameters file://DirectorySharingParams.json Directory Service Version April 22, 2025 1473 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 Note This change type was originally classified as Management | Advanced stack components | Directory service | Accept sharing, and has now been moved to a more user friendly classification. The change type ID, ct-13xvbj5pqg253, has not changed. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-13xvbj5pqg253. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-AcceptSharedDirectory", "Region": "us-east-1", "Parameters": { "SharedDirectoryId": [ "d-12e456789f" ], "OwnerAccountId": [ "123456789012" ] } } Directory | Create AD Trust Create a one-way trust between On-Prem Domain and (AWS) Managed Active Directory. For multi- account landing zone (MALZ), use this change type in the shared services account. Before creating Directory Service Version April 22, 2025 1474 AMS Advanced Change Type Reference AMS Advanced Change Type Details the trust, you need to make sure that the following prerequisites are met: 1. You must create the AD trust first on the On-Prem Domain and save the trust password in the Secrets Manager. 2. You must set up a Managed Active Directory (MAD) Security Group with an outbound rule that allows all traffic to On-Prem CIDR ranges. Full classification: Management | Directory Service | Directory | Create AD trust Change Type Details Change type ID ct-0x6dylrnfjgz5 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create Active Directory Trust Adding an AD trust with the console The following shows this change |
ams-ct-419 | ams-ct.pdf | 419 | 1. You must create the AD trust first on the On-Prem Domain and save the trust password in the Secrets Manager. 2. You must set up a Managed Active Directory (MAD) Security Group with an outbound rule that allows all traffic to On-Prem CIDR ranges. Full classification: Management | Directory Service | Directory | Create AD trust Change Type Details Change type ID ct-0x6dylrnfjgz5 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create Active Directory Trust Adding an AD trust with the console The following shows this change type in the AMS console. How it works: Directory Service Version April 22, 2025 1475 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. Adding an AD trust 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. Directory Service Version April 22, 2025 1476 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-0x6dylrnfjgz5" --change-type-version "1.0" -- title "Create AD Trust" --execution-parameters ' {"DocumentName":"AWSManagedServices-CreateADTrust","Region":"ap- southeast-2","Parameters":{"DirectoryId":["d-976774e42f"],"RemoteDomainName": ["onprem.local"],"SecretArn":["arn:aws:secretsmanager:ap- southeast-2:996606605561:secret:customer-shared/CorrectTPW-BI79uu"],"TrustType": ["External"],"ConditionalForwarderIpAddresses":["10.153.28.39"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateADTrustParams.json: aws amscm get-change-type-version --change-type-id "ct-0x6dylrnfjgz5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateADTrustParams.json Directory Service Version April 22, 2025 1477 AMS Advanced Change Type Reference AMS Advanced Change Type Details Modify and save the CreateADTrustParams.json file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateADTrust", "Region": "ap-southeast-2", "Parameters": { "DirectoryId": [ "d-976774e42f" ], "RemoteDomainName": [ "onprem.local" ], "SecretArn": [ "arn:aws:secretsmanager:ap-southeast-2:996606605561:secret:customer-shared/ CorrectTPW-BI79uu" ], "TrustType": [ "External" ], "ConditionalForwarderIpAddresses": [ "10.153.28.39" ] } } 2. Output the RFC template to a file in your current folder; this example names it CreateADTrustRfc.json: aws amscm create-rfc --generate-cli-skeleton > |
ams-ct-420 | ams-ct.pdf | 420 | names it CreateADTrustParams.json: aws amscm get-change-type-version --change-type-id "ct-0x6dylrnfjgz5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateADTrustParams.json Directory Service Version April 22, 2025 1477 AMS Advanced Change Type Reference AMS Advanced Change Type Details Modify and save the CreateADTrustParams.json file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateADTrust", "Region": "ap-southeast-2", "Parameters": { "DirectoryId": [ "d-976774e42f" ], "RemoteDomainName": [ "onprem.local" ], "SecretArn": [ "arn:aws:secretsmanager:ap-southeast-2:996606605561:secret:customer-shared/ CorrectTPW-BI79uu" ], "TrustType": [ "External" ], "ConditionalForwarderIpAddresses": [ "10.153.28.39" ] } } 2. Output the RFC template to a file in your current folder; this example names it CreateADTrustRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateADTrustRfc.json 3. Modify and save the CreateADTrustRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-0x6dylrnfjgz5", "ChangeTypeVersion": "1.0", "Title": "Active Directory Trust" } 4. Create the RFC, specifying the CreateADTrustRfc file and the CreateADTrustParams file: Directory Service Version April 22, 2025 1478 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://CreateADTrustRfc.json --execution- parameters file://CreateADTrustParams.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 Directory Service, see the Directory Service Admin Guide. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0x6dylrnfjgz5. Example: Required Parameters { "DocumentName": "AWSManagedServices-CreateADTrust", "Region": "us-east-1", "Parameters": { "DirectoryId": "d-12e456789f", "RemoteDomainName": "onprem.local", "SecretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:customer- shared/adtrust", "TrustType": "External", "ConditionalForwarderIpAddresses": "10.153.28.39,10.153.28.40" } } Example: All Parameters { "DocumentName": "AWSManagedServices-CreateADTrust", "Region": "us-east-1", "Parameters": { "DirectoryId": "d-12e456789f", "RemoteDomainName": "onprem.local", "SecretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:customer- shared/adtrust", Directory Service Version April 22, 2025 1479 AMS Advanced Change Type Reference AMS Advanced Change Type Details "TrustType": "External", "ConditionalForwarderIpAddresses": "10.153.28.39,10.153.28.40" } } Directory | Share Directory Share a specified directory in your AWS account (directory owner) with another AWS account (directory consumer). Run this in your Shared Service account that has Managed Active Directory. This change type is only supported for multi-account landing zone (MALZ). Full classification: Management | Directory Service | Directory | Share directory Change Type Details Change type ID ct-369odosk0pd9w Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Share directory Share a directory with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 1480 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. Directory Service Version April 22, 2025 1481 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. Share a directory 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 |
ams-ct-421 | ams-ct.pdf | 421 | 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. Share a directory 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 1482 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-369odosk0pd9w" --change-type-version "1.0" --title "Share Directory" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-ShareDirectory\",\"Region\":\"ap-southeast-2\",\"Parameters\": {\"DirectoryId\":[\"d-123456ab7c\"],\"TargetAccountId\":[\"012345678912\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DirectorySharingParams.json: aws amscm get-change-type-version --change-type-id "ct-369odosk0pd9w" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DirectorySharingParams.json Modify and save the DirectorySharingParams.json file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-ShareDirectory", "Region": "us-east-1", "Parameters": { "DirectoryId": [ "d-123456ab7c" ], "TargetAccountId": [ "012345678912" ] } } 2. Output the RFC template to a file in your current folder; this example names it DirectorySharingRfc.json: aws amscm create-rfc --generate-cli-skeleton > DirectorySharingRfc.json 3. Modify and save the DirectorySharingRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-369odosk0pd9w", "ChangeTypeVersion": "1.0", Directory Service Version April 22, 2025 1483 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "Share Directory" } 4. Create the RFC, specifying the DirectorySharingRfc file and the DirectorySharingParams file: aws amscm create-rfc --cli-input-json file://DirectorySharingRfc.json --execution- parameters file://DirectorySharingParams.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 related CTs, see Directory Service Subcategory. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-369odosk0pd9w. Example: Required Parameters { "DocumentName": "AWSManagedServices-ShareDirectory", "Region": "us-east-1", "Parameters": { "DirectoryId": [ "d-0000000000" ], "TargetAccountId": [ "000000000000" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-ShareDirectory", "Region": "us-east-1", "Parameters": { Directory Service Version April 22, 2025 1484 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DirectoryId": [ "d-12e456789f" ], "TargetAccountId": [ "123456789012" ] } } Directory | Unshare Directory Stops the directory sharing between the directory owner and consumer accounts. Run this in your Shared Service account that has Managed Active Directory. This change type is only supported for multi-account landing zone (MALZ). Full classification: Management | Directory Service | Directory | Unshare directory Change Type Details Change type ID ct-2xd2anlb5hbzo Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Unshare directory Unshare a directory with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 1485 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 |
ams-ct-422 | ams-ct.pdf | 422 | 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 1486 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. Unshare a directory 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 1487 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-2xd2anlb5hbzo" --change-type-version "1.0" --title "Unshare Directory" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-ShareDirectory\",\"Region\":\"ap-southeast-2\",\"Parameters\": {\"DirectoryId\":[\"d-123456ab7c\"],\"UnshareTarget\":[\"012345678912\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DirectoryUnsharingParams.json: aws amscm get-change-type-version --change-type-id "ct-2xd2anlb5hbzo" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DirectoryUnsharingParams.json Modify and save the DirectoryUnsharingParams.json file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-UnshareDirectory", "Region": "us-east-1", "Parameters": { "DirectoryId": [ "d-123456ab7c" ], "UnshareTarget": [ "012345678912" ] } } 2. Output the RFC template to a file in your current folder; this example names it DirectoryUnsharingRfc.json: aws amscm create-rfc --generate-cli-skeleton > DirectoryUnsharingRfc.json 3. Modify and save the DirectoryUnsharingRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-2xd2anlb5hbzo", "ChangeTypeVersion": "1.0", Directory Service Version April 22, 2025 1488 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "Unshare Directory" } 4. Create the RFC, specifying the DirectoryUnsharingRfc file and the DirectoryUnsharingParams file: aws amscm create-rfc --cli-input-json file://DirectoryUnsharingRfc.json -- execution-parameters file://DirectoryUnsharingParams.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 related CTs, see Directory Service Subcategory. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2xd2anlb5hbzo. Example: Required Parameters { "DocumentName": "AWSManagedServices-UnshareDirectory", "Region": "us-east-1", "Parameters": { "DirectoryId": [ "d-0000000000" ], "UnshareTarget": [ "000000000000" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-UnshareDirectory", Directory Service Version April 22, 2025 1489 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters": { "DirectoryId": [ "d-12e456789f" ], "UnshareTarget": |
ams-ct-423 | ams-ct.pdf | 423 | 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 related CTs, see Directory Service Subcategory. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2xd2anlb5hbzo. Example: Required Parameters { "DocumentName": "AWSManagedServices-UnshareDirectory", "Region": "us-east-1", "Parameters": { "DirectoryId": [ "d-0000000000" ], "UnshareTarget": [ "000000000000" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-UnshareDirectory", Directory Service Version April 22, 2025 1489 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters": { "DirectoryId": [ "d-12e456789f" ], "UnshareTarget": [ "123456789012" ] } } DNS | Add A Record Add a new static DNS A record in AWS Managed Microsoft Active Directory (AD). For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | DNS | Add A record Change Type Details Change type ID ct-2w3rbmnny1qpo Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Add DNS "A" record Adding a DNS A record with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 1490 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. Directory Service Version April 22, 2025 1491 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. Adding a DNS A record 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 1492 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-2w3rbmnny1qpo" --change-type-version "1.0" --title "Add DNS A Record" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateDNSARecord-Admin\",\"Region\": \"us-east-1\",\"Parameters \": {\"RecordName\": [\"web-server\"], \"IPAddress\": [\"132.133.134.135\"]}}" TEMPLATE CREATE: 1. Output |
ams-ct-424 | ams-ct.pdf | 424 | 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 1492 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-2w3rbmnny1qpo" --change-type-version "1.0" --title "Add DNS A Record" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateDNSARecord-Admin\",\"Region\": \"us-east-1\",\"Parameters \": {\"RecordName\": [\"web-server\"], \"IPAddress\": [\"132.133.134.135\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it ArecordAddParams.json: aws amscm get-change-type-version --change-type-id "ct-2w3rbmnny1qpo" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ArecordAddParams.json Modify and save the ArecordAddParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateDNSARecord-Admin", "Region": "us-east-1", "Parameters": { "RecordName": [ "web-server" ], "IPAddress": [ "132.133.134.135" ] } } 2. Output the RFC template to a file in your current folder; this example names it ArecordAddRfc.json: aws amscm create-rfc --generate-cli-skeleton > ArecordAddRfc.json 3. Modify and save the ArecordAddRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-2w3rbmnny1qpo", "ChangeTypeVersion": "1.0", "Title": "AWS Directory Service add DNS A record" Directory Service Version April 22, 2025 1493 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 4. Create the RFC, specifying the ArecordAddRfc file and the ArecordAddParams file: aws amscm create-rfc --cli-input-json file://ArecordAddRfc.json --execution- parameters file://ArecordAddParams.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 For multi-account landing zone (MALZ), use this change type in the shared services account. For information about Directory Service, see the Directory Service Admin Guide. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2w3rbmnny1qpo. Example: Required Parameters { "DocumentName": "AWSManagedServices-CreateDNSARecord-Admin", "Region": "us-east-1", "Parameters": { "RecordName": ["web-server"], "IPAddress": ["123.1.2.3"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-CreateDNSARecord-Admin", "Region": "us-east-1", "Parameters": { Directory Service Version April 22, 2025 1494 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RecordName": ["web-server"], "IPAddress": ["123.1.2.3"], "TTLValue": ["01:00:01"] } } DNS | Add CNAME Record Create a new DNS CNAME record in AWS Managed Microsoft Active Directory (AD). CNAME records must always point to another domain name, never directly to an IP address. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | DNS | Add CNAME record Change Type Details Change type ID ct-2murl5xzbxoxf Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Add DNS CNAME record in AMS Note To create a CNAME record in AWS, see How do I create alias records for services hosted in AWS?. Adding a DNS CNAME record with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 1495 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 |
ams-ct-425 | ams-ct.pdf | 425 | 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 1496 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. Adding a DNS CNAME record 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 1497 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-2murl5xzbxoxf" --change-type-version "1.0" --title "Add DNS CNAME Record" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateDNSCnameRecord-Admin\",\"Region\": \"us-east-1\", \"Parameters\": {\"RecordName\": [\"host1.mycompany.com\"], \"RecordCname\": [\"web- server\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CnameRecordAddParams.json: aws amscm get-change-type-version --change-type-id "ct-2w3rbmnny1qpo" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CnameRecordAddParams.json Modify and save the CnameRecordAddParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateDNSCnameRecord-Admin", "Region": "us-east-1", "Parameters": { "RecordName": [ "host1.mycompany.com" ], "RecordCname": [ "web-server" ] } } 2. Output the RFC template to a file in your current folder; this example names it CnameRecordAddRfc.json: aws amscm create-rfc --generate-cli-skeleton > CnameRecordAddRfc.json 3. Modify and save the CnameRecordAddRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-2murl5xzbxoxf", "ChangeTypeVersion": "1.0", Directory Service Version April 22, 2025 1498 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "AWS Directory Service add DNS CNAME record" } 4. Create the RFC, specifying the CnameRecordAddRfc file and the CnameRecordAddParams file: aws amscm create-rfc --cli-input-json file://CnameRecordAddRfc.json --execution- parameters file://CnameRecordAddParams.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 multi-account landing zone (MALZ), use this change type in the Shared Services account. • For information about Directory Service, see the Directory Service Admin Guide. To learn about CNAME records, see CNAME record type. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2murl5xzbxoxf. Example: Required Parameters { "DocumentName": "AWSManagedServices-CreateDNSCnameRecord-Admin", "Region": "us-east-1", "Parameters": { "RecordName": ["hostname123.example.com"], "RecordCname": ["webserver"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-CreateDNSCnameRecord-Admin", "Region": "us-east-1", "Parameters": { Directory Service Version April 22, 2025 1499 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RecordName": ["hostname123.example.com"], "RecordCname": ["webserver"] } } DNS | Delete Conditional Forwarder Delete AD DNS conditional forwarder for a remote domain. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | DNS | Delete conditional forwarder Change Type Details Change type ID ct-1icghmq38rnsn Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Delete a DNS conditional forwarder Deleting DNS conditional forwarders with the console The following shows this change type in the AMS console. Directory |
ams-ct-426 | ams-ct.pdf | 426 | Advanced Change Type Details "RecordName": ["hostname123.example.com"], "RecordCname": ["webserver"] } } DNS | Delete Conditional Forwarder Delete AD DNS conditional forwarder for a remote domain. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | DNS | Delete conditional forwarder Change Type Details Change type ID ct-1icghmq38rnsn Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Delete a DNS conditional forwarder Deleting DNS conditional forwarders with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 1500 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. Directory Service Version April 22, 2025 1501 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. Deleting DNS conditional forwarders 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 1502 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-1icghmq38rnsn" --change-type-version "1.0" --title "AWSManagedServices-DeleteADDNSConditionalForwarder" --execution- parameters "{\"DocumentName\": \"AWSManagedServices-DeleteADDNSConditionalForwarder- Admin\",\"Region\": \"us-east-1\",\"Parameters\": {\"RemoteDomainName\": [\"test.forwarders.com\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CondForwardDeleteParams.json: aws amscm get-change-type-version --change-type-id "ct-1icghmq38rnsn" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CondForwardDeleteParams.json Modify and save the CondForwardDeleteParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-DeleteADDNSConditionalForwarder-Admin", "Region": "us-east-1", "Parameters": { "RemoteDomainName": [ "test.forwarders.com" ] } } 2. Output the RFC template to a file in your current folder; this example names it CondForwardDeleteRfc.json: aws amscm create-rfc --generate-cli-skeleton > CondForwardDeleteRfc.json 3. Modify and save the CondForwardDeleteRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1icghmq38rnsn", "Title": |
ams-ct-427 | ams-ct.pdf | 427 | for this change type to a file; this example names it CondForwardDeleteParams.json: aws amscm get-change-type-version --change-type-id "ct-1icghmq38rnsn" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CondForwardDeleteParams.json Modify and save the CondForwardDeleteParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-DeleteADDNSConditionalForwarder-Admin", "Region": "us-east-1", "Parameters": { "RemoteDomainName": [ "test.forwarders.com" ] } } 2. Output the RFC template to a file in your current folder; this example names it CondForwardDeleteRfc.json: aws amscm create-rfc --generate-cli-skeleton > CondForwardDeleteRfc.json 3. Modify and save the CondForwardDeleteRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1icghmq38rnsn", "Title": "Delete AD DNS Conditional Forwarder" Directory Service Version April 22, 2025 1503 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 4. Create the RFC, specifying the CondForwardDeleteRfc file and the CondForwardDeleteParams file: aws amscm create-rfc --cli-input-json file://CondForwardDeleteRfc.json --execution- parameters file://CondForwardDeleteParams.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 Directory Service, see the Directory Service Admin Guide. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1icghmq38rnsn. Example: Required Parameters { "DocumentName" : "AWSManagedServices-DeleteADDNSConditionalForwarder-Admin", "Region" : "us-east-1", "Parameters": { "RemoteDomainName": ["test.test1.com"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-DeleteADDNSConditionalForwarder-Admin", "Region" : "us-east-1", "Parameters": { "RemoteDomainName": ["test.test1.com"] } } Directory Service Version April 22, 2025 1504 AMS Advanced Change Type Reference DNS | Remove Record AMS Advanced Change Type Details Remove the specified DNS resource record name, either an A or CNAME, or pointer record (PTR), from the specified DNS zone. By default, only the static record is removed per specified RecordName for A or CNAME records. Use the RecordData parameter to remove duplicates if there are multiple records with the same Host Name (RecordType A), either dynamic or static. For a PTR record type, all the static and dynamic records will be removed. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | DNS | Remove record Change Type Details Change type ID ct-1icrtx8ydvdwe Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Remove record Removing a DNS record with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 1505 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. Directory Service Version April 22, 2025 1506 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. Removing a DNS record 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 |
ams-ct-428 | ams-ct.pdf | 428 | 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. Removing a DNS record 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. Directory Service Version April 22, 2025 1507 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-1icrtx8ydvdwe" --change-type-version "1.0" --title "Remove DNS Record" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-RemoveDNSRecord-Admin\",\"Region\": \"us-east-1\",\"Parameters\": {\"RecordName\": [\"web-server\"], \"RecordType\": [\"CNAME\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it RecordRemoveParams.json: aws amscm get-change-type-version --change-type-id "ct-1icrtx8ydvdwe" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > RecordRemoveParams.json Modify and save the RecordRemoveParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-RemoveDNSRecord-Admin", "Region": "us-east-1", "Parameters": { "RecordName": [ "web-server" ], "RecordType": [ "CNAME" ] } } 2. Output the RFC template to a file in your current folder; this example names it RecordRemoveRfc.json: aws amscm create-rfc --generate-cli-skeleton > RecordRemoveRfc.json Directory Service Version April 22, 2025 1508 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. Modify and save the RecordRemoveRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1icrtx8ydvdwe", "ChangeTypeVersion": "1.0", "Title": "Remove DNS record" } 4. Create the RFC, specifying the RecordRemoveRfc file and the RecordRemoveParams file: aws amscm create-rfc --cli-input-json file://RecordRemoveRfc.json --execution- parameters file://RecordRemoveParams.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 Directory Service, see the Directory Service Admin Guide. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1icrtx8ydvdwe. Example: Required Parameters { "DocumentName": "AWSManagedServices-RemoveDNSRecord-Admin", "Region": "us-east-1", "Parameters": { "RecordName": ["123.123.123.123"], "RecordType": ["PTR"] } } Example: All Parameters { Directory Service Version April 22, 2025 1509 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-RemoveDNSRecord-Admin", "Region": "us-east-1", "Parameters": { "RecordName": ["web-server"], "RecordType": ["CNAME"], "RecordData": ["123.123.123.123"] } } DNS | Update Cluster Permissions Grants full control to the Cluster object on the Listener object to bring the SQL Server Listener object online. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | DNS | Update cluster permissions Change Type Details Change type ID ct-03ytgoevfebjr Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update cluster permissions Updating cluster permissions with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 1510 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 |
ams-ct-429 | ams-ct.pdf | 429 | 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. Directory Service Version April 22, 2025 1511 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. Updating cluster permissions 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 1512 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-03ytgoevfebjr" --change-type-version "1.0" --title "Update Cluster Permissions" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-UpdateClusterDNSPermission-Admin\",\"Region\": \"us-east-1\", \"Parameters\": {\"ClusterName\": [\"EC2-SAMPLE-AGL\"],\"ClusterNodeComputerName\": [\"EC2SAMPLE-O1A1MR9\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it ClusterPermissionsUpdateParams.json: { "DocumentName": "AWSManagedServices-UpdateClusterDNSPermission-Admin", "Region": "us-east-1", "Parameters": { "ClusterName": ["EC2-SAMPLE-AGL"], "ClusterNodeComputerName": ["EC2SAMPLE-O1A1MR9"] } } 2. Output the RFC template to a file in your current folder; this example names it ClusterPermissionsUpdateRfc.json: aws amscm create-rfc --generate-cli-skeleton > ClusterPermissionsUpdateRfc.json 3. Modify and save the ClusterPermissionsUpdateRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-03ytgoevfebjr", "ChangeTypeVersion": "1.0", "Title": "Update Cluster Permissions" } 4. Create the RFC, specifying the ClusterPermissionsUpdateRfc file and the ClusterPermissionsUpdateParams file: aws amscm create-rfc --cli-input-json file://ClusterPermissionsUpdateRfc.json -- execution-parameters file://ClusterPermissionsUpdateParams.json Directory Service Version April 22, 2025 1513 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 additional information, see DirectoryService section. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-03ytgoevfebjr. Example: Required Parameters { "DocumentName": "AWSManagedServices-UpdateClusterDNSPermission-Admin", "Region": "us-east-1", "Parameters": { "ClusterName": ["EC2-O6G85G-AGL"], "ClusterNodeComputerName": ["EC2AMAZ-O6G3MR9"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-UpdateClusterDNSPermission-Admin", "Region": "us-east-1", "Parameters": { "ClusterName": ["EC2-O6G85G-AGL"], "ClusterNodeComputerName": ["EC2AMAZ-O6G3MR9"] } } DNS | Update Conditional Forwarder Update AD DNS conditional forwarder for a remote domain. For multi-account landing zone (MALZ), use this change type in the shared services |
ams-ct-430 | ams-ct.pdf | 430 | the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For additional information, see DirectoryService section. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-03ytgoevfebjr. Example: Required Parameters { "DocumentName": "AWSManagedServices-UpdateClusterDNSPermission-Admin", "Region": "us-east-1", "Parameters": { "ClusterName": ["EC2-O6G85G-AGL"], "ClusterNodeComputerName": ["EC2AMAZ-O6G3MR9"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-UpdateClusterDNSPermission-Admin", "Region": "us-east-1", "Parameters": { "ClusterName": ["EC2-O6G85G-AGL"], "ClusterNodeComputerName": ["EC2AMAZ-O6G3MR9"] } } DNS | Update Conditional Forwarder Update AD DNS conditional forwarder for a remote domain. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | DNS | Update conditional forwarder Directory Service Version April 22, 2025 1514 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-2fqmbyud166z9 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update a DNS conditional forwarder Updating DNS conditional forwarders 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. Directory Service Version April 22, 2025 1515 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. Updating DNS conditional forwarders 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: Directory Service Version April 22, 2025 1516 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-2fqmbyud166z9" --change-type-version "1.0" --title "AWSManagedServices-UpdateADDNSConditionalForwarder" --execution- parameters "{\"DocumentName\": \"AWSManagedServices-UpdateADDNSConditionalForwarder- Admin\",\"Region\": \"us-east-1\",\"Parameters\": {\"RemoteDomainName\": [\"test.forwarders.com\"], \"IpAddresses\": [\"10.0.0.3\", \"10.0.0.4"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CondForwardUpdateParams.json: aws amscm get-change-type-version --change-type-id "ct-2fqmbyud166z9" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CondForwardUpdateParams.json Modify and save the CondForwardUpdateParams file. For example, you can replace |
ams-ct-431 | ams-ct.pdf | 431 | 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-2fqmbyud166z9" --change-type-version "1.0" --title "AWSManagedServices-UpdateADDNSConditionalForwarder" --execution- parameters "{\"DocumentName\": \"AWSManagedServices-UpdateADDNSConditionalForwarder- Admin\",\"Region\": \"us-east-1\",\"Parameters\": {\"RemoteDomainName\": [\"test.forwarders.com\"], \"IpAddresses\": [\"10.0.0.3\", \"10.0.0.4"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CondForwardUpdateParams.json: aws amscm get-change-type-version --change-type-id "ct-2fqmbyud166z9" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CondForwardUpdateParams.json Modify and save the CondForwardUpdateParams file. For example, you can replace the contents with something like this: { Directory Service Version April 22, 2025 1517 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-UpdateADDNSConditionalForwarder-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 CondForwardUpdateRfc.json: aws amscm create-rfc --generate-cli-skeleton > CondForwardUpdateRfc.json 3. Modify and save the CondForwardUpdateRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-2fqmbyud166z9", "ChangeTypeVersion": "1.0", "Title": "Update conditional forwarders" } 4. Create the RFC, specifying the CondForwardUpdateRfc file and the CondForwardUpdateParams file: aws amscm create-rfc --cli-input-json file://CondForwardUpdateRfc.json --execution- parameters file://CondForwardUpdateParams.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 Directory Service, see the Directory Service Admin Guide. Directory Service Version April 22, 2025 1518 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-2fqmbyud166z9. Example: Required Parameters { "DocumentName" : "AWSManagedServices-UpdateADDNSConditionalForwarder-Admin", "Region" : "us-east-1", "Parameters": { "RemoteDomainName": ["test.test1.com"], "IPAddresses": ["10.0.0.1", "10.0.0.2"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-UpdateADDNSConditionalForwarder-Admin", "Region" : "us-east-1", "Parameters": { "RemoteDomainName": ["test.test1.com"], "IPAddresses": ["10.0.0.1", "10.0.0.2"] } } DNS | Update Record Permission Grant permissions to the computer object to update DNS records after failover. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | DNS | Update record permission Change Type Details Change type ID ct-1eft8s6vdhz0w Current version 1.0 Expected execution duration 60 minutes Directory Service Version April 22, 2025 1519 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update DNS record permission Updating DNS record permissions 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. • 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. Directory Service Version April 22, 2025 1520 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. Updating DNS record permissions with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution |
ams-ct-432 | ams-ct.pdf | 432 | 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. Updating DNS record permissions 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 Directory Service Version April 22, 2025 1521 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-1eft8s6vdhz0w" --change-type-version "1.0" --title "Update DNS Record" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-UpdateDNSRecordsPermission-Admin\",\"Region\": \"us-east-1\", \"Parameters\": {\"RecordNames\": [\"EC2CLUS-SAMPLE\",\"EC2SAmPL1-AWS\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UpdateDNSRecordsPermissionParams.json: aws amscm get-change-type-version --change-type-id "ct-1eft8s6vdhz0w" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateDNSRecordsPermissionParams.json Modify and save the UpdateDNSRecordsPermissionParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-UpdateDNSRecordsPermission-Admin", "Region": "us-east-1", "Parameters": { "RecordNames": ["EC2CLUS-SAMPLE","EC2SAmPL1-AWS"] } } 2. Output the RFC template to a file in your current folder; this example names it UpdateDNSRecordsPermissionRfc.json: Directory Service Version April 22, 2025 1522 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > UpdateDNSRecordsPermissionRfc.json 3. Modify and save the UpdateDNSRecordsPermissionRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1eft8s6vdhz0w", "Title": "Update DNS record" } 4. Create the RFC, specifying the UpdateDNSRecordsPermissionRfc file and the UpdateDNSRecordsPermissionParams file: aws amscm create-rfc --cli-input-json file://UpdateDNSRecordsPermissionRfc.json -- execution-parameters file://UpdateDNSRecordsPermissionParams.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-1eft8s6vdhz0w. Example: Required Parameters { "DocumentName": "AWSManagedServices-UpdateDNSRecordsPermission-Admin", "Region": "us-east-1", "Parameters": { "RecordNames": ["EC2CLUS-SAMPl1,EC2G90BI1-AWS"] } } Example: All Parameters { Directory Service Version April 22, 2025 1523 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-UpdateDNSRecordsPermission-Admin", "Region": "us-east-1", "Parameters": { "RecordNames": ["EC2CLUS-SAMPl1,EC2G90BI1-AWS"] } } Users and Groups | Add Group Create an Active Directory (AD) group in the AMS managed AD. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | Users and groups | Add group Change Type Details Change type ID ct-3eutt7grkict4 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Add Active Directory group Adding an AD group with the console The following shows this change type in the AMS console. Directory Service Version April 22, 2025 1524 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 |
ams-ct-433 | ams-ct.pdf | 433 | 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. Directory Service Version April 22, 2025 1525 AMS Advanced Change Type Reference AMS Advanced Change Type Details Adding an AD 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. 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-3eutt7grkict4" --change-type-version "1.0" --title "Create AD group" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateADGroup-Admin\",\"Region\":\"us-east-1\",\"Parameters\": {\"GroupName\":[\"my-group\"],\"GroupDescription\":[\"Group description\"],\"GroupScope \":[\"DomainLocal\"]}}" Directory Service Version April 22, 2025 1526 AMS Advanced Change Type Reference AMS Advanced Change Type Details TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it AdGroupAddParams.json: aws amscm get-change-type-version --change-type-id "ct-3eutt7grkict4" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AdGroupAddParams.json Modify and save the AdGroupAddParams file. For example, you can replace the contents with something like this: { "DocumentName" : "AWSManagedServices-CreateADGroup-Admin", "Region" : "us-east-1", "Parameters" : { "GroupName" : ["my-group"], "GroupDescription" : ["Group description"], "GroupScope" : ["DomainLocal"] } } 2. Output the RFC template to a file in your current folder; this example names it AdGroupAddRfc.json: aws amscm create-rfc --generate-cli-skeleton > AdGroupAddRfc.json 3. Modify and save the AdGroupAddRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3eutt7grkict4", "Title": "Create AD group" } 4. Create the RFC, specifying the AdGroupAddRfc file and the AdGroupAddParams file: aws amscm create-rfc --cli-input-json file://AdGroupAddRfc.json --execution- parameters file://AdGroupAddParams.json Directory Service Version April 22, 2025 1527 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 information about Directory Service, see the Directory Service Admin Guide. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3eutt7grkict4. Example: Required Parameters { "DocumentName" : "AWSManagedServices-CreateADGroup-Admin", "Region" : "us-east-1", "Parameters" : { "GroupName" : ["my-group"], "GroupDescription" : ["Group description"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateADGroup-Admin", |
ams-ct-434 | ams-ct.pdf | 434 | 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 information about Directory Service, see the Directory Service Admin Guide. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3eutt7grkict4. Example: Required Parameters { "DocumentName" : "AWSManagedServices-CreateADGroup-Admin", "Region" : "us-east-1", "Parameters" : { "GroupName" : ["my-group"], "GroupDescription" : ["Group description"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateADGroup-Admin", "Region" : "us-east-1", "Parameters" : { "GroupName" : ["my-group"], "GroupDescription" : ["Group description"], "GroupScope" : ["DomainLocal"] } } Users and Groups | Add Group To Group Add an Active Directory (AD) group in the trusted domain to an AD group in the AMS managed AD. For multi-account landing zone (MALZ), use this change type in the shared services account. Directory Service Version April 22, 2025 1528 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Management | Directory Service | Users and groups | Add group to group Change Type Details Change type ID ct-1i20abktsm05v Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Add an AD group to an AD group Adding an AD group to an AMS-managed AD group 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. • 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. Directory Service Version April 22, 2025 1529 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. Adding an AD group to an AMS-managed AD 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 Directory Service Version April 22, 2025 1530 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. |
ams-ct-435 | ams-ct.pdf | 435 | 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-1i20abktsm05v" --change-type-version "1.0" --title "Add AD group to AD group" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-AddADGroupToADGroup-Admin\",\"Region\":\"us-east-1\",\"Parameters \":{\"NestedGroupName\":[\"my-nested-group\"],\"GroupName\":[\"my-parent-group\"], \"TrustedDomainFQDN\":[\"my-domain.com\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it GroupToGroupAddParams.json: aws amscm get-change-type-version --change-type-id "ct-1i20abktsm05v" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > GroupToGroupAddParams.json Modify and save the GroupToGroupAddParams file. For example, you can replace the contents with something like this: { "DocumentName" : "AWSManagedServices-AddADGroupToADGroup-Admin", "Region" : "us-east-1", "Parameters" : { "NestedGroupName" : ["my-nested-group"], Directory Service Version April 22, 2025 1531 AMS Advanced Change Type Reference AMS Advanced Change Type Details "GroupName" : ["my-parent-group"], "TrustedDomainFQDN" : ["my-domain.com"] } } 2. Output the RFC template to a file in your current folder; this example names it GroupToGroupAddRfc.json: aws amscm create-rfc --generate-cli-skeleton > GroupToGroupAddRfc.json 3. Modify and save the GroupToGroupAddRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1i20abktsm05v", "ChangeTypeVersion": "1.0", "Title": "Add AD group to AD group" } 4. Create the RFC, specifying the GroupToGroupAddRfc file and the GroupToGroupAddParams file: aws amscm create-rfc --cli-input-json file://GroupToGroupAddRfc.json --execution- parameters file://GroupToGroupAddParams.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 Directory Service, see the Directory Service Admin Guide. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1i20abktsm05v. Example: Required Parameters { Directory Service Version April 22, 2025 1532 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName" : "AWSManagedServices-AddADGroupToADGroup-Admin", "Region" : "us-east-1", "Parameters" : { "NestedGroupName" : ["nested-group"], "GroupName" : ["parent-group"], "TrustedDomainFQDN" : ["my-test-domain.com"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-AddADGroupToADGroup-Admin", "Region" : "us-east-1", "Parameters" : { "NestedGroupName" : ["nested-group"], "GroupName" : ["parent-group"], "TrustedDomainFQDN" : ["my-test-domain.com"] } } Users and Groups | Add User To Group Add an Active Directory (AD) user to an AD group in the AMS managed AD. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | Users and groups | Add user to group Change Type Details Change type ID ct-24pi85mjtza8k Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Directory Service Version April 22, 2025 1533 AMS Advanced Change Type Reference Additional Information Add an AD user to an AD group Adding an AD user to an AMS-managed AD group 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. 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. Directory Service |
ams-ct-436 | ams-ct.pdf | 436 | 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. Directory Service Version April 22, 2025 1534 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 an AD user to an AMS-managed AD 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. INLINE CREATE: Directory Service Version April 22, 2025 1535 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-24pi85mjtza8k" --change-type-version "1.0" --title "Add AD user to AD group" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-AddADUserToGroup-Admin\",\"Region\":\"us-east-1\",\"Parameters \":{\"UserName\":[\"my-user\"],\"GroupName\":[\"my-group\"],\"DomainFQDN\":[\"my- domain.com\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UserToGroupAddParams.json: aws amscm get-change-type-version --change-type-id "ct-24pi85mjtza8k" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UserToGroupAddParams.json Modify and save the UserToGroupAddParams file. For example, you can replace the contents with something like this: { "DocumentName" : "AWSManagedServices-AddADUserToGroup-Admin", "Region" : "us-east-1", "Parameters" : { "UserName" : ["my-user"], "GroupName" : ["my-group"], "DomainFQDN" : ["my-domain.com"] } } 2. Output the RFC template to a file in your current folder; this example names it UserToGroupAddRfc.json: aws amscm create-rfc --generate-cli-skeleton > UserToGroupAddRfc.json 3. Modify and save the UserToGroupAddRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-24pi85mjtza8k", Directory Service Version April 22, 2025 1536 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeVersion": "1.0", "Title": "Add AD user to AD group" } 4. Create the RFC, specifying the UserToGroupAddRfc file and the UserToGroupAddParams file: aws amscm create-rfc --cli-input-json file://UserToGroupAddRfc.json --execution- parameters file://UserToGroupAddParams.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 Directory Service, see the Directory Service Admin Guide. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-24pi85mjtza8k. Example: Required Parameters { "DocumentName" : "AWSManagedServices-AddADUserToGroup-Admin", "Region" : "us-east-1", "Parameters" : { "UserName" : ["my-user"], "GroupName" : ["parent-group"], "DomainFQDN" : ["my-test-domain.com"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-AddADUserToGroup-Admin", "Region" : "us-east-1", "Parameters" : { "UserName" : ["my-user"], "GroupName" : ["parent-group"], Directory Service Version April 22, 2025 1537 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DomainFQDN" : ["my-test-domain.com"] } } Users and Groups | Remove User from Group Remove an Active Directory (AD) user from an AD group in the AMS managed AD. For multi- account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | Users and groups | Remove user from group Change Type Details Change type ID ct-2019s9y3nfml4 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information |
ams-ct-437 | ams-ct.pdf | 437 | Version April 22, 2025 1537 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DomainFQDN" : ["my-test-domain.com"] } } Users and Groups | Remove User from Group Remove an Active Directory (AD) user from an AD group in the AMS managed AD. For multi- account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Directory Service | Users and groups | Remove user from group Change Type Details Change type ID ct-2019s9y3nfml4 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Remove an AD user from an AD group Removing an AD user from an AMS-managed AD group with the console The following shows this change type in the AMS console. How it works: Directory Service Version April 22, 2025 1538 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. Removing an AD user from an AMS-managed AD 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. Directory Service Version April 22, 2025 1539 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-2019s9y3nfml4" --change-type-version "1.0" --title "Remove AD user from AD group" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-RemoveADUserFromGroup-Admin\",\"Region\":\"us-east-1\", \"Parameters\":{\"UserName\":[\"my-user\"],\"GroupName\":[\"my-group\"],\"DomainFQDN\": [\"my-domain.com\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UserFromGroupRemoveParams.json: aws amscm get-change-type-version --change-type-id "ct-2019s9y3nfml4" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UserFromGroupRemoveParams.json Directory Service Version April 22, 2025 1540 AMS Advanced Change Type Reference AMS Advanced Change Type Details Modify and save the UserFromGroupRemoveParams file. For example, you can replace the contents with something like this: { "DocumentName" : "AWSManagedServices-RemoveADUserFromGroup-Admin", "Region" : "us-east-1", "Parameters" : { "UserName" : ["my-user"], "GroupName" : ["my-group"], "DomainFQDN" : ["my-domain.com"] } } 2. |
ams-ct-438 | ams-ct.pdf | 438 | --title "Remove AD user from AD group" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-RemoveADUserFromGroup-Admin\",\"Region\":\"us-east-1\", \"Parameters\":{\"UserName\":[\"my-user\"],\"GroupName\":[\"my-group\"],\"DomainFQDN\": [\"my-domain.com\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UserFromGroupRemoveParams.json: aws amscm get-change-type-version --change-type-id "ct-2019s9y3nfml4" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UserFromGroupRemoveParams.json Directory Service Version April 22, 2025 1540 AMS Advanced Change Type Reference AMS Advanced Change Type Details Modify and save the UserFromGroupRemoveParams file. For example, you can replace the contents with something like this: { "DocumentName" : "AWSManagedServices-RemoveADUserFromGroup-Admin", "Region" : "us-east-1", "Parameters" : { "UserName" : ["my-user"], "GroupName" : ["my-group"], "DomainFQDN" : ["my-domain.com"] } } 2. Output the RFC template to a file in your current folder; this example names it UserFromGroupRemoveRfc.json: aws amscm create-rfc --generate-cli-skeleton > UserFromGroupRemoveRfc.json 3. Modify and save the UserFromGroupRemoveRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-2019s9y3nfml4", "ChangeTypeVersion": "1.0", "Title": "Remove AD user from AD group" } 4. Create the RFC, specifying the UserFromGroupRemoveRfc file and the UserFromGroupRemoveParams file: aws amscm create-rfc --cli-input-json file://UserFromGroupRemoveRfc.json -- execution-parameters file://UserFromGroupRemoveParams.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 Directory Service, see the Directory Service Admin Guide. Directory Service Version April 22, 2025 1541 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-2019s9y3nfml4. Example: Required Parameters { "DocumentName" : "AWSManagedServices-RemoveADUserFromGroup-Admin", "Region" : "us-east-1", "Parameters" : { "UserName" : ["my-user"], "GroupName" : ["my-group"], "DomainFQDN" : ["my-domain.com"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-RemoveADUserFromGroup-Admin", "Region" : "us-east-1", "Parameters" : { "UserName" : ["my-user"], "GroupName" : ["my-group"], "DomainFQDN" : ["my-domain.com"] } } Host Security Subcategory Change Type Items and Operations in the Host Security Subcategory • Malware Full System Scan | Disable (Review Required) • Trend Micro DSM | Add Login (Read-Only) • Trend Micro DSM | Add User (Review Required) • Trend Micro DSM | Exclude Files and Folders (Review Required) • Trend Micro DSM | Remove Trend Micro EPS Agent (Review Required) • Trend Micro DSM | Scan and Get Results (Review Required) • Trend Micro DSM | Update Agent Status (Review Required) Host Security Version April 22, 2025 1542 AMS Advanced Change Type Reference AMS Advanced Change Type Details Malware Full System Scan | Disable (Review Required) Use to disable periodic malware full system scan feature in all EC2 instances deployed in a single VPC. Full classification: Management | Host security | Malware full system scan | Disable (review required) Change Type Details Change type ID ct-1pybwg08h8qsz Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Disable malware scanning on a VPC Disabling malware scanning with the console The following shows this change type in the AMS console. Host Security Version April 22, 2025 1543 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 |
ams-ct-439 | ams-ct.pdf | 439 | 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. Disabling malware scanning 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. Host Security Version April 22, 2025 1544 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-1pybwg08h8qsz" --change-type-version "1.0" --title "Disable malware scanning" --execution-parameters "{\"VpcId\": \"VPC-ID\", \"Priority\": \"High\}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it DisableMalwareScanParams.json: aws amscm get-change-type-version --change-type-id "ct-1pybwg08h8qsz" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DisableMalwareScanParams.json Host Security Version April 22, 2025 1545 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Modify and save the DisableMalwareScanParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-TerminateStandaloneInstances", "Region": "us-east-1", "Confirmation": "terminate instances", "Parameters": { "InstanceIds": [ "i-1234567890abcdef0" ] } } 3. Output the RFC template to a file in your current folder; this example names it DisableMalwareScanRfc.json: aws amscm create-rfc --generate-cli-skeleton > DisableMalwareScanRfc.json 4. Modify and save the DisableMalwareScanRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "cct-1pybwg08h8qsz", "ChangeTypeVersion": "1.0", "Title": "Disable malware scanning" } 5. Create the RFC, specifying the DisableMalwareScanRfc file and the DisableMalwareScanParams file: aws amscm create-rfc --cli-input-json file://DisableMalwareScanRfc.json -- execution-parameters file://DisableMalwareScanParams.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. Host Security Version April 22, 2025 1546 AMS Advanced Change Type Reference AMS Advanced Change Type Details 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. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1pybwg08h8qsz. Example: Required Parameters { "VpcId": "vpc-28abd91e" } Example: All Parameters { "VpcId": "vpc-28abd91e", "Priority": "Medium" } Trend Micro DSM | Add Login (Read-Only) Request a read-only login to the Trend Micro console for your account. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Host security | Trend Micro DSM | Add login (read-only) Change Type Details Change type ID ct-0wspy4o646g9p Current version 2.0 Expected execution duration 60 minutes Host Security Version April 22, 2025 1547 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS approval Required Customer approval Not required Execution mode Automated Additional Information Add Trend Micro login (read only) Adding a Trend Micro login (read only) with the console The following |
ams-ct-440 | ams-ct.pdf | 440 | read-only login to the Trend Micro console for your account. For multi-account landing zone (MALZ), use this change type in the shared services account. Full classification: Management | Host security | Trend Micro DSM | Add login (read-only) Change Type Details Change type ID ct-0wspy4o646g9p Current version 2.0 Expected execution duration 60 minutes Host Security Version April 22, 2025 1547 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS approval Required Customer approval Not required Execution mode Automated Additional Information Add Trend Micro login (read only) Adding a Trend Micro login (read only) 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. • 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. Host Security Version April 22, 2025 1548 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. Adding a Trend Micro login (read only) 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 Host Security Version April 22, 2025 1549 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-0wspy4o646g9p" --change-type-version "2.0" --title "Trend Micro Console Access" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateEPSDSMReadOnlyUser\",\"Region\":\"us-east-1\",\"Parameters \":{\"Username\":[\"eps-dsm-read-only-user\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it AddTrendMicroLoginParams.json: aws amscm get-change-type-version --change-type-id "ct-0wspy4o646g9p" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AddTrendMicroLoginParams.json 2. Modify and save the AddTrendMicroLoginParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateEPSDSMReadOnlyUser", "Region": "us-east-1", "Parameters": { "Username": [ "eps-dsm-read-only-user" ] } } 3. Output the RFC template to a file in your current folder; this example names it AddTrendMicroLoginRfc.json: Host Security Version April 22, 2025 1550 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > AddTrendMicroLoginRfc.json 4. Modify and save |
ams-ct-441 | ams-ct.pdf | 441 | this example names it AddTrendMicroLoginParams.json: aws amscm get-change-type-version --change-type-id "ct-0wspy4o646g9p" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AddTrendMicroLoginParams.json 2. Modify and save the AddTrendMicroLoginParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateEPSDSMReadOnlyUser", "Region": "us-east-1", "Parameters": { "Username": [ "eps-dsm-read-only-user" ] } } 3. Output the RFC template to a file in your current folder; this example names it AddTrendMicroLoginRfc.json: Host Security Version April 22, 2025 1550 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > AddTrendMicroLoginRfc.json 4. Modify and save the AddTrendMicroLoginRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-0wspy4o646g9p", "Title": "Trend Micro Console Access" } 5. Create the RFC, specifying the AddTrendMicroLoginRfc file and the AddTrendMicroLoginParams file: aws amscm create-rfc --cli-input-json file://AddTrendMicroLoginRfc.json -- execution-parameters file://AddTrendMicroLoginParams.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. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0wspy4o646g9p. Example: Required Parameters { "DocumentName": "AWSManagedServices-CreateEPSDSMReadOnlyUser", "Region": "us-east-1", "Parameters": { Host Security Version April 22, 2025 1551 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Username": ["eps-dsm-read-only-user"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-CreateEPSDSMReadOnlyUser", "Region": "us-east-1", "Parameters": { "Username": ["eps-dsm-read-only-user"], "FullName": ["Alejandro Rosalez"], "Description": ["This user is created for eps read only access"] } } Trend Micro DSM | Add User (Review Required) Add a new DSM console user to the Trend Micro console for your account. Once the user is added, the associated password is created in the account and securely shared with the customer through the Secrets Manager. For multi-account landing zone (MALZ), use this change type in the Shared Services account. Full classification: Management | Host security | Trend Micro DSM | Add user (review required) Change Type Details Change type ID ct-24rl68y07m769 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Host Security Version April 22, 2025 1552 AMS Advanced Change Type Reference Additional Information Add Trend Micro user (review required) Adding a Trend Micro user 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. Host Security Version April 22, 2025 1553 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 |
ams-ct-442 | ams-ct.pdf | 442 | Host Security Version April 22, 2025 1553 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. Adding a Trend Micro user 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. Host Security Version April 22, 2025 1554 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-24rl68y07m769" --change-type-version "1.0" --title "Add user (review required)" --execution-parameters "{\"Username\": \"TestEpsUser\", \"RequiredPermissions\": \"Auditor\", \"Description\": \"Test Eps User for CT ct-24rl68y07m769 testing\", \"Priority\": \"Medium\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it AddTrendMicroUserRrParams.json: aws amscm get-change-type-version --change-type-id "ct-0wspy4o646g9p" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AddTrendMicroUserRrParams.json 2. Modify and save the AddTrendMicroUserRrParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "Username": "TestEpsUser", "RequiredPermissions": "Auditor", "Description": "Test Eps User add", "Priority": "Medium" } 3. Output the RFC template to a file in your current folder; this example names it AddTrendMicroUserRrRfc.json: aws amscm create-rfc --generate-cli-skeleton > AddTrendMicroUserRrRfc.json 4. Modify and save the AddTrendMicroUserRrRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-24rl68y07m769", Host Security Version April 22, 2025 1555 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "Trend Micro Console Access" } 5. Create the RFC, specifying the AddTrendMicroUserRrRfc file and the AddTrendMicroUserRrParams file: aws amscm create-rfc --cli-input-json file://AddTrendMicroUserRrRfc.json -- execution-parameters file://AddTrendMicroUserRrParams.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. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-24rl68y07m769. Example: Required Parameters Example not available. Example: All Parameters Example not available. Trend Micro DSM | Exclude Files and Folders (Review Required) Specify files and folders for Trend Micro DSM to ignore (exclude) when scanning; both real-time and on-demand scanning. Doing this might expose those files and folders to malware, but can optimize system resource utilization. Trend Micro DSM does not discover files and folders excluded from scanning, but details on excluded files and folders are included in reports Host Security Version April 22, 2025 1556 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Management | Host security | Trend Micro DSM | Exclude files and folders (review required) Change Type Details Change type ID ct-3va4bkrxb9z42 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Trend Micro, exclude files and folders (review required) Trend |
ams-ct-443 | ams-ct.pdf | 443 | can optimize system resource utilization. Trend Micro DSM does not discover files and folders excluded from scanning, but details on excluded files and folders are included in reports Host Security Version April 22, 2025 1556 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Management | Host security | Trend Micro DSM | Exclude files and folders (review required) Change Type Details Change type ID ct-3va4bkrxb9z42 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Trend Micro, exclude files and folders (review required) Trend Micro Exclude Files and Folders 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. Host Security Version April 22, 2025 1557 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. Trend Micro Exclude Files and Folders 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. Host Security Version April 22, 2025 1558 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-3va4bkrxb9z42" --change-type-version "1.0" -- title "Exclude files and/or folders from Trend Micro scanning" --execution-parameters '{"Region": "us-east-1","Parameters": {"InstanceId": "i-12345678901234567","FilePath": ["C:\\FolderA\\SubFolderB\\SubFolderC\\SubFolderC\\filename.jpg"],"FolderPath": ["D:\ \FolderA\\SubFolderB\\SubFolderC\\SubFolderC\\"]},"Priority": "Medium"}' TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it TMExcludeFilesFoldersRrParams.json: aws amscm get-change-type-version --change-type-id "ct-3va4bkrxb9z42" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > TMExcludeFilesFoldersRrParams.json 2. Modify and save the TMExcludeFilesFoldersRrParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { Host Security Version April 22, 2025 1559 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters":{ "InstanceId": "i-12345678901234567", "FilePath": [ "C:\\FolderA\\SubFolderB\\SubFolderC\\SubFolderC\ \filename.jpg" ], "FolderPath": [ "D:\\FolderA\\SubFolderB\\SubFolderC\\SubFolderC\\" ] }, "Priority": "Medium" } 3. Output |
ams-ct-444 | ams-ct.pdf | 444 | ["C:\\FolderA\\SubFolderB\\SubFolderC\\SubFolderC\\filename.jpg"],"FolderPath": ["D:\ \FolderA\\SubFolderB\\SubFolderC\\SubFolderC\\"]},"Priority": "Medium"}' TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it TMExcludeFilesFoldersRrParams.json: aws amscm get-change-type-version --change-type-id "ct-3va4bkrxb9z42" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > TMExcludeFilesFoldersRrParams.json 2. Modify and save the TMExcludeFilesFoldersRrParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { Host Security Version April 22, 2025 1559 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters":{ "InstanceId": "i-12345678901234567", "FilePath": [ "C:\\FolderA\\SubFolderB\\SubFolderC\\SubFolderC\ \filename.jpg" ], "FolderPath": [ "D:\\FolderA\\SubFolderB\\SubFolderC\\SubFolderC\\" ] }, "Priority": "Medium" } 3. Output the RFC template to a file in your current folder; this example names it TMExcludeFilesFoldersRrRfc.json: aws amscm create-rfc --generate-cli-skeleton > TMExcludeFilesFoldersRrRfc.json 4. Modify and save the TMExcludeFilesFoldersRrRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3va4bkrxb9z42", "Title": "Trend Micro Exclude Files and Folders" } 5. Create the RFC, specifying the TMExcludeFilesFoldersRrRfc file and the TMExcludeFilesFoldersRrParams file: aws amscm create-rfc --cli-input-json file://TMExcludeFilesFoldersRrRfc.json -- execution-parameters file://TMExcludeFilesFoldersRrParams.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. Host Security Version April 22, 2025 1560 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-3va4bkrxb9z42. Example: Required Parameters { "Region": "us-east-1", "Parameters":{ "InstanceId": "i-12345678901234567" }, "Priority": "Medium" } Example: All Parameters Example not available. Trend Micro DSM | Remove Trend Micro EPS Agent (Review Required) For Bring Your Own EPS (BYOEPS) only. Remove the Trend Micro EPS agent installed on your AMS- managed Elastic Compute Cloud (EC2) instance. Full classification: Management | Host security | Trend Micro DSM | Remove Trend Micro EPS agent (review required) Change Type Details Change type ID ct-2iz9nvw8zlhst Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Host Security Version April 22, 2025 1561 AMS Advanced Change Type Reference Additional Information Remove Trend Micro EPS agent (review required) Removing a Trend Micro DSM agent 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. Host Security Version April 22, 2025 1562 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. Removing a Trend Micro DSM agent |
ams-ct-445 | ams-ct.pdf | 445 | 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. Removing a Trend Micro DSM agent 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. Host Security Version April 22, 2025 1563 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-2iz9nvw8zlhst" --change-type-version "1.0" -- title "Remove agent" --execution-parameters "{\"Region\": \"us-east-1\", \"InstanceIds \": \"i-12345678901234567\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it RemoveTrendMicroEpsAgentRrParams.json: aws amscm get-change-type-version --change-type-id "ct-2iz9nvw8zlhst" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > RemoveTrendMicroEpsAgentRrParams.json 2. Modify and save the RemoveTrendMicroEpsAgentRrParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: All parameters: { "Region": "us-east-1", "InstanceId": ["i-12345678901234567"], "ShouldRebootAfterTrendUninstall": true, "Priority": "Medium" } Only required parameters: { "Region": "us-east-1", "InstanceId": ["i-12345678901234567"] } 3. Output the RFC template to a file in your current folder; this example names it RemoveTrendMicroEpsAgentRrRfc.json: Host Security Version April 22, 2025 1564 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > RemoveTrendMicroEpsAgentRrRfc.json 4. Modify and save the RemoveTrendMicroEpsAgentRrRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2iz9nvw8zlhst", "Title": "Remove Trend Micro EPS agent" } 5. Create the RFC, specifying the RemoveTrendMicroEpsAgentRrRfc file and the RemoveTrendMicroEpsAgentRrParams file: aws amscm create-rfc --cli-input-json file://RemoveTrendMicroEpsAgentRrRfc.json -- execution-parameters file://RemoveTrendMicroEpsAgentRrParams.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. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2iz9nvw8zlhst. Example: Required Parameters { "Region": "us-east-1", "InstanceId": ["i-12345678901234567"] } Host Security Version April 22, 2025 1565 AMS Advanced Change Type Reference Example: All Parameters { "Region": "us-east-1", "InstanceId": ["i-12345678901234567"], "ShouldRebootAfterTrendUninstall": true, "Priority": "Medium" } AMS Advanced Change Type Details Trend Micro DSM | Scan and Get Results (Review Required) Request a Trend Micro on-demand scan on all, or specified, Amazon Elastic Compute Cloud (EC2) instances in the account and get scan results in the form of a PDF attached in the response. Full classification: Management | Host security | Trend Micro DSM | Scan and get results (review required) Change Type Details Change type ID ct-08sgdn5zowyyl Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Trend Micro scan (review required) Request Trend Micro scan with the console The following shows this change type in the AMS console. Host Security Version April 22, 2025 1566 AMS Advanced Change Type Reference AMS Advanced Change Type |
ams-ct-446 | ams-ct.pdf | 446 | the account and get scan results in the form of a PDF attached in the response. Full classification: Management | Host security | Trend Micro DSM | Scan and get results (review required) Change Type Details Change type ID ct-08sgdn5zowyyl Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Trend Micro scan (review required) Request Trend Micro scan with the console The following shows this change type in the AMS console. Host Security Version April 22, 2025 1566 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. Host Security Version April 22, 2025 1567 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. Request Trend Micro scan 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: Host Security Version April 22, 2025 1568 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-08sgdn5zowyyl" --change-type- version "1.0" --title "Trend Micro scan and get report" --execution- parameters '{"Region": "us-east-1","Parameters": {"InstanceId": ["i-12345678901234567","i-12345678901234560"]},"Priority": "Medium"}' TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it RequestTrendMicroScanRrParams.json: aws amscm get-change-type-version --change-type-id "ct-08sgdn5zowyyl" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > RequestTrendMicroScanRrParams.json 2. Modify and save the RequestTrendMicroScanRrParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "Region": "us-east-1", "Parameters": { "InstanceId": [ "i-12345678901234567", "i-12345678901234560" ] }, "Priority": "Medium" } 3. Output the RFC template to a file in your current folder; this example names it RequestTrendMicroScanRrRfc.json: aws amscm create-rfc --generate-cli-skeleton > RequestTrendMicroScanRrRfc.json 4. Modify and save the RequestTrendMicroScanRrRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-08sgdn5zowyyl", "Title": |
ams-ct-447 | ams-ct.pdf | 447 | RequestTrendMicroScanRrParams.json: aws amscm get-change-type-version --change-type-id "ct-08sgdn5zowyyl" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > RequestTrendMicroScanRrParams.json 2. Modify and save the RequestTrendMicroScanRrParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "Region": "us-east-1", "Parameters": { "InstanceId": [ "i-12345678901234567", "i-12345678901234560" ] }, "Priority": "Medium" } 3. Output the RFC template to a file in your current folder; this example names it RequestTrendMicroScanRrRfc.json: aws amscm create-rfc --generate-cli-skeleton > RequestTrendMicroScanRrRfc.json 4. Modify and save the RequestTrendMicroScanRrRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-08sgdn5zowyyl", "Title": "Trend Micro scan and get report" } Host Security Version April 22, 2025 1569 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Create the RFC, specifying the RequestTrendMicroScanRrRfc file and the RequestTrendMicroScanRrParams file: aws amscm create-rfc --cli-input-json file://RequestTrendMicroScanRrRfc.json -- execution-parameters file://RequestTrendMicroScanRrParams.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. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-08sgdn5zowyyl. Example: Required Parameters { "Region": "us-east-1", "Parameters": { "InstanceId": [ "i-12345678901234567", "i-12345678901234560" ] }, "Priority": "Medium" } Example: All Parameters { "Region": "us-east-1", "Parameters": { Host Security Version April 22, 2025 1570 AMS Advanced Change Type Reference AMS Advanced Change Type Details "InstanceId": [ "i-12345678901234567", "i-12345678901234560" ] }, "Priority": "Medium" } Trend Micro DSM | Update Agent Status (Review Required) Start, stop, deactivate, or reactivate Trend Micro agent. Full classification: Management | Host security | Trend Micro DSM | Update agent status (review required) Change Type Details Change type ID ct-0biqnokj25gkd Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Update Trend Micro DSM agent status (review required) Updating a Trend Micro DSM agent status with the console The following shows this change type in the AMS console. Host Security Version April 22, 2025 1571 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. Host Security Version April 22, 2025 1572 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. Updating a Trend Micro DSM agent status 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 |
ams-ct-448 | ams-ct.pdf | 448 | RFC details, and the initial Run output. Host Security Version April 22, 2025 1572 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. Updating a Trend Micro DSM agent status 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: Host Security Version April 22, 2025 1573 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-0biqnokj25gkd" --change-type-version "1.0" --title "Update agent status" --execution-parameters "{\"Region\": \"us-east-1\", \"InstanceIds\": \"i-1234567890abcdef0\", \"Description\": \"Test Update agent for CT ct-0biqnokj25gkd testing\", \"Priority\": \"Medium\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it UpdateTrendMicroAgentStatusRrParams.json: aws amscm get-change-type-version --change-type-id "ct-0biqnokj25gkd" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateTrendMicroAgentStatusRrParams.json 2. Modify and save the UpdateTrendMicroAgentStatusRrParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "Region": "us-east-1", "InstanceIds": [ "i-1234567890abcdef0" ], "AgentAction": "Start", "Description": "Test Update agent for CT ct-0biqnokj25gkd testing", "Priority": "Medium" } 3. Output the RFC template to a file in your current folder; this example names it UpdateTrendMicroAgentStatusRrRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateTrendMicroAgentStatusRrRfc.json 4. Modify and save the UpdateTrendMicroAgentStatusRrRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0biqnokj25gkd", "Title": "Trend Micro Agent Update" Host Security Version April 22, 2025 1574 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 5. Create the RFC, specifying the UpdateTrendMicroAgentStatusRrRfc file and the UpdateTrendMicroAgentStatusRrParams file: aws amscm create-rfc --cli-input-json file://UpdateTrendMicroAgentStatusRrRfc.json --execution-parameters file://UpdateTrendMicroAgentStatusRrParams.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. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0biqnokj25gkd. Example: Required Parameters { "Region": "us-east-1", "InstanceIds": [ "i-1234567890abcdef0" ], "AgentAction": "Start" } Example: All Parameters { "Region": "us-east-1", "InstanceIds": [ "i-1234567890abcdef0" Host Security Version April 22, 2025 1575 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "AgentAction": "Start", "Description": "An Ample description", "Priority": "Medium" } Managed Account Subcategory Change Type Items and Operations in the Managed Account Subcategory • Automated IAM Provisioning With Read-Write Permissions | Enable (Review Required) • Automated IAM Provisioning With Read-Write Permissions | Update Custom Deny List (Review Required) • Developer Mode | Enable (Review Required) • Direct Change Mode | Enable • DNS | Migrate To Route 53 (Review Required) • Stack Access Duration | Override (Review Required) Automated IAM Provisioning With Read-Write Permissions | Enable (Review Required) Enable Automated IAM provisioning with read-write permissions in the account used to submit this CT. Once enabled, a new role 'AWSManagedServicesIAMProvisionAdminRole' is created in that account. Additionally, you can use three related change types (ct-1n9gfnog5x7fl, ct-1e0xmuy1diafq, ct-17cj84y7632o6) to create, update, or delete IAM roles and policies using Automated IAM provisioning with read-write permissions, which employs an automated review process with a predefined |
ams-ct-449 | ams-ct.pdf | 449 | Mode | Enable (Review Required) • Direct Change Mode | Enable • DNS | Migrate To Route 53 (Review Required) • Stack Access Duration | Override (Review Required) Automated IAM Provisioning With Read-Write Permissions | Enable (Review Required) Enable Automated IAM provisioning with read-write permissions in the account used to submit this CT. Once enabled, a new role 'AWSManagedServicesIAMProvisionAdminRole' is created in that account. Additionally, you can use three related change types (ct-1n9gfnog5x7fl, ct-1e0xmuy1diafq, ct-17cj84y7632o6) to create, update, or delete IAM roles and policies using Automated IAM provisioning with read-write permissions, which employs an automated review process with a predefined set of rules for IAM and AMS. Before using, we recommend a good familiarity with IAM rules. To confirm that an account has Automated IAM provisioning enabled, look for the IAM role 'AWSManagedServicesIAMProvisionAdminRole' in the IAM console for that account. Full classification: Management | Managed account | Automated IAM provisioning with read-write permissions | Enable (review required) Change Type Details Change type ID ct-1706xvvk6j9hf Managed Account Version April 22, 2025 1576 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Create IAM entity or policy Creating IAM entity or policy 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. Managed Account Version April 22, 2025 1577 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 IAM entity or 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: Managed Account Version April 22, 2025 1578 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 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-1n9gfnog5x7fl" --change-type- version "1.0" --title "Create role or policy" --execution-parameters '{"DocumentName":"AWSManagedServices-HandleAutomatedIAMProvisioningCreate- Admin","Region":"us-east-1","Parameters":{"ValidateOnly":"No"},"RoleDetails": {"Roles":[{"RoleName":"RoleTest01","Description":"This is a test role","AssumeRolePolicyDocument":"{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal": {"AWS":"arn:aws:iam::123456789012:root"},"Action":"sts:AssumeRole"}]}","ManagedPolicyArns": ["arn:aws:iam::123456789012:policy/policy01","arn:aws:iam::123456789012:policy/ policy02"],"Path":"/","MaxSessionDuration":"7200","PermissionsBoundary":"arn:aws:iam::123456789012:policy/ permission_boundary01","InstanceProfile":"No"}]},"ManagedPolicyDetails": {"Policies":[{"ManagedPolicyName":"TestPolicy01","Description":"This |
ams-ct-450 | ams-ct.pdf | 450 | 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-1n9gfnog5x7fl" --change-type- version "1.0" --title "Create role or policy" --execution-parameters '{"DocumentName":"AWSManagedServices-HandleAutomatedIAMProvisioningCreate- Admin","Region":"us-east-1","Parameters":{"ValidateOnly":"No"},"RoleDetails": {"Roles":[{"RoleName":"RoleTest01","Description":"This is a test role","AssumeRolePolicyDocument":"{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal": {"AWS":"arn:aws:iam::123456789012:root"},"Action":"sts:AssumeRole"}]}","ManagedPolicyArns": ["arn:aws:iam::123456789012:policy/policy01","arn:aws:iam::123456789012:policy/ policy02"],"Path":"/","MaxSessionDuration":"7200","PermissionsBoundary":"arn:aws:iam::123456789012:policy/ permission_boundary01","InstanceProfile":"No"}]},"ManagedPolicyDetails": {"Policies":[{"ManagedPolicyName":"TestPolicy01","Description":"This is customer policy","Path":"/test/","PolicyDocument":"{"Version":"2012-10-17","Statement": [{"Sid":"AllQueueActions","Effect":"Allow","Action":"sqs:ListQueues","Resource":"*","Condition": {"ForAllValues:StringEquals":{"aws:tagKeys":["temporary"]}}}]}"}]}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; example names it CreateIamResourceParams.json: Managed Account Version April 22, 2025 1579 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm get-change-type-version --change-type-id "ct-1n9gfnog5x7fl" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateIamResourceParams.json 2. Modify and save the CreateIamResourceParams file; example creates an IAM Role with policy documents pasted inline. { "DocumentName": "AWSManagedServices-HandleAutomatedIAMProvisioningCreate-Admin", "Region": "us-east-1", "Parameters": { "ValidateOnly": "No" }, "RoleDetails": { "Roles": [ { "RoleName": "RoleTest01", "Description": "This is a test role", "AssumeRolePolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\": [{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"}, \"Action\":\"sts:AssumeRole\"}]}", "ManagedPolicyArns": [ "arn:aws:iam::123456789012:policy/policy01", "arn:aws:iam::123456789012:policy/policy02" ], "Path": "/", "MaxSessionDuration": "7200", "PermissionsBoundary": "arn:aws:iam::123456789012:policy/ permission_boundary01", "InstanceProfile": "No" } ] }, "ManagedPolicyDetails": { "Policies": [ { "ManagedPolicyName": "TestPolicy01", "Description": "This is customer policy", "Path": "/test/", "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\": \"AllQueueActions\",\"Effect\":\"Allow\",\"Action\":\"sqs:ListQueues\",\"Resource Managed Account Version April 22, 2025 1580 AMS Advanced Change Type Reference AMS Advanced Change Type Details \":\"*\",\"Condition\":{\"ForAllValues:StringEquals\":{\"aws:tagKeys\":[\"temporary \"]}}}]}" } ] } } 3. Output the RFC template JSON file to a file named CreateIamResourceRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateIamResourceRfc.json 4. Modify and save the CreateIamResourceRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1n9gfnog5x7fl", "Title": "Create entity or policy (read-write permissions)" } 5. Create the RFC, specifying the CreateIamResourceRfc file and the CreateIamResourceParams file: aws amscm create-rfc --cli-input-json file://CreateIamResourceRfc.json -- execution-parameters file://CreateIamResourceParams.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 • After an IAM role is provisioned in your account, depending on the role and the policy document you attach to the role, you may need to onboard the role in your federation solution. • For information about AWS Identity and Access Management, see AWS Identity and Access Management (IAM) and for policy information, see Managed policies and inline policies. For information about AMS permissions, see Deploying IAM resources. Managed Account Version April 22, 2025 1581 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-1706xvvk6j9hf. Example: Required Parameters Example not available. Example: All Parameters { "SAMLIdentityProviderArns": ["arn:aws:iam::123456789012:saml-provider/customer- saml"], "IamEntityArns": ["arn:aws:iam::123456789012:role/test-role-one", "arn:aws:iam::123456789012:role/test-role-two"], "CustomerCustomDenyActionsList1": "ec2:Create*,ec2:Delete*,sso-admin:*,resource- explorer-2:*", "Priority": "High" } Automated IAM Provisioning With Read-Write Permissions | Update Custom Deny List (Review Required) Update the list of customer-defined denied actions for Automated IAM Provisioning. Make sure to provide the complete list of deny actions, including previously provisioned actions. The provided list replaces the previous list. Full classification: Management | Managed account | Automated IAM provisioning with read-write permissions | Update custom deny list (review required) Change Type Details Change type ID ct-2r9xvd3sdsic0 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Managed Account Version April 22, 2025 1582 AMS Advanced Change Type Reference AMS Advanced Change Type Details Customer approval Not required if submitter Execution mode Manual Additional Information Update custom deny list for AMS Automated IAM Provisioning Update custom deny list 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 Account Version April 22, 2025 1583 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 |
ams-ct-451 | ams-ct.pdf | 451 | page. Note that you cannot choose an older CT version with quick create. Managed Account Version April 22, 2025 1583 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. Update custom deny list 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 Account Version April 22, 2025 1584 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 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-2r9xvd3sdsic0" --change-type-version "1.0" -- title "Update custom deny list for Automated IAM Provisioning" --execution-parameters "{\"CustomerCustomDenyActionsList1\":\"ec2:RunInstances,s3:PutBucket,sagemaker:*\", \"Priority\":\"High\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named CustomerCustomDenyActionsList.json. aws amscm get-change-type-version --change-type-id "ct-2r9xvd3sdsic0" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CustomerCustomDenyActionsList.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CustomerCustomDenyActionsList", "Region": "us-east-1", "Parameters": { "CustomerCustomDenyActionsList1": "ec2:RunInstances,s3:PutBucket,sagemaker:*", "Priority": "High" } Managed Account Version April 22, 2025 1585 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 CustomerCustomDenyActionsListRfc.json: aws amscm create-rfc --generate-cli-skeleton > CustomerCustomDenyActionsListRfc.json 4. Modify and save the CustomerCustomDenyActionsListRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2r9xvd3sdsic0", "Title": "Update custom deny list for Automated IAM Provisioning" } 5. Create the RFC, specifying the CreateAcmPublicRfc file and the CreateAcmPublicParams file: aws amscm create-rfc --cli-input-json file://CustomerCustomDenyActionsListRfc.json --execution-parameters file://CustomerCustomDenyActionsListParams.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-2r9xvd3sdsic0. Example: Required Parameters Example not available. Example: All Parameters { "CustomerCustomDenyActionsList1": "ec2:Create*,ec2:Delete*,sso-admin:*,resource- explorer-2:*", "Priority": "High" Managed Account Version April 22, 2025 1586 AMS Advanced Change Type Reference AMS Advanced Change Type Details } Developer Mode | Enable (Review Required) Enable Developer Mode (Dev Mode). Dev mode provides you with elevated permissions, in AMS Plus accounts, to provision and update AWS resources outside of the AMS change management process. Dev mode does this by leveraging native AWS API calls within the AMS Virtual Private Cloud (VPC), enabling you to design and implement infrastructure and applications in your |
ams-ct-452 | ams-ct.pdf | 452 | for Change Type ct-2r9xvd3sdsic0. Example: Required Parameters Example not available. Example: All Parameters { "CustomerCustomDenyActionsList1": "ec2:Create*,ec2:Delete*,sso-admin:*,resource- explorer-2:*", "Priority": "High" Managed Account Version April 22, 2025 1586 AMS Advanced Change Type Reference AMS Advanced Change Type Details } Developer Mode | Enable (Review Required) Enable Developer Mode (Dev Mode). Dev mode provides you with elevated permissions, in AMS Plus accounts, to provision and update AWS resources outside of the AMS change management process. Dev mode does this by leveraging native AWS API calls within the AMS Virtual Private Cloud (VPC), enabling you to design and implement infrastructure and applications in your managed environment. When using an account that has Dev mode enabled, continuity management, patch management, and change management are provided for resources provisioned through the AMS change management process or by using an AMS Amazon Machine Image (AMI). However, these AMS management features are not offered for resources provisioned through native AWS APIs. Rather, you are responsible for monitoring infrastructure resources that are provisioned outside of the AMS change management process. Dev mode is limited to accounts with non-production workloads. With elevated permissions, you have an increased responsibility to ensure adherence to internal controls. Full classification: Management | Managed account | Developer mode | Enable (review required) Change Type Details Change type ID ct-3gjfayulf5hhs Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Enable Developer mode (review required) Enabling Developer mode (review required) with the console The following shows this change type in the AMS console. Managed Account Version April 22, 2025 1587 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. Managed Account Version April 22, 2025 1588 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. Enabling Developer mode (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. Managed Account Version April 22, 2025 1589 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE: Note |
ams-ct-453 | ams-ct.pdf | 453 | 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 Account Version April 22, 2025 1589 AMS Advanced Change Type Reference AMS Advanced Change Type Details 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-3gjfayulf5hhs" --change-type-version "1.0" -- title "RFC Title" --execution-parameters "{\"Enable\":\"Yes\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it EnableDevModeParams.json: aws amscm get-change-type-version --change-type-id "ct-3gjfayulf5hhs" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > EnableDevModeParams.json 2. Modify and save the EnableDevModeParams file. For example, you can replace the contents with something like this: {"Enable": "Yes"} 3. Output the RFC template JSON file to a file; this example names it EnableDevModeRfc.json: aws amscm create-rfc --generate-cli-skeleton > EnableDevModeRfc.json 4. Modify and save the EnableDevModeRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3gjfayulf5hhs", "Title": "Enable-Dev-Mode-RFC" } 5. Create the RFC, specifying the EnableDevModeRfc file and the EnableDevModeParams file: Managed Account Version April 22, 2025 1590 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://EnableDevModeRfc.json --execution- parameters file://EnableDevModeParams.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. Note When using "review required" CTs, AMS recommends that you use the ASAP Scheduling option (choose ASAP in the console, leave start and end time blank in the API/CLI) as these CTs require an AMS operator to examine the RFC, and possibly communicate with you before it can be approved and run. If you schedule these RFCs, be sure to allow at least 24 hours. If approval does not happen before the scheduled start time, the RFC is rejected automatically. • Resources that you create using developer mode can be managed by AMS only if they are created using AMS change management processes. • For more information about Developer mode, see AMS Developer Mode. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3gjfayulf5hhs. Example: Required Parameters Example not available. Managed Account Version April 22, 2025 1591 AMS Advanced Change Type Details AMS Advanced Change Type Reference Example: All Parameters { "Enable": "Yes", "Priority": "Medium" } Direct Change Mode | Enable Enable Direct Change mode (DCM). DCM grants native AWS access to provision and update AWS resources. The resources and changes to them are fully supported by AMS, including monitoring, patch, backup, and incident response management. Full classification: Management | Managed account | Direct Change mode | Enable Change Type Details Change type ID ct-3rd4781c2nnhp Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Enable Direct Change mode Enabling Direct Change mode with the Console Screenshot of this change type in the AMS console: Managed Account Version April 22, 2025 1592 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 |
ams-ct-454 | ams-ct.pdf | 454 | 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 Account Version April 22, 2025 1593 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. Enabling Direct Change mode 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 \ Managed Account Version April 22, 2025 1594 AMS Advanced Change Type Reference AMS Advanced Change Type Details --change-type-id "ct-3rd4781c2nnhp" \ --change-type-version "1.0" \ --title "Enable Direct Change Mode" \ --execution-parameters "{\"samlIdentityProviderArns\":\"arn:aws:iam::123456789123:saml- provider/valid-name\",\"iamEntityArns\":\"arn:aws:iam::123456789123:role/valid-role- name1\",\"awsServicePrincipals\":\"ec2.amazonaws.com\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it EnableDCMParams.json. aws amscm get-change-type-version --change-type-id "ct-3rd4781c2nnhp" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > EnableDCMParams.json 2. Modify and save the EnableDCMParams file. For example, you can replace the contents with something like this: { "samlIdentityProviderArns": "arn:aws:iam::123456789123:saml-provider/valid-name", "iamEntityArns": "arn:aws:iam::123456789123:role/valid-role-name, "awsServicePrincipals": "ec2.amazonaws.com" } 3. Output the RFC template JSON file to a file named EnableDCMRfc.json: aws amscm create-rfc --generate-cli-skeleton > EnableDCMRfc.json 4. Modify and save the EnableDCMRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3rd4781c2nnhp", "Title": "Enable-DCM-RFC" } 5. Create the RFC, specifying the EnableDCMRfc file and the EnableDCMParams file: aws amscm create-rfc --cli-input-json file://EnableDCMRfc.json --execution- parameters file://EnableDCMParams.json Managed Account Version April 22, 2025 1595 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 information about Direct Change mode, see Direct Change Mode. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3rd4781c2nnhp. Example: Required Parameters Example not available. Example: All Parameters { "SamlIdentityProviderArns": [ "SAML1", "SAML2" ], "AwsServicePrincipals": [ "Service1", "Service2" ], "IamEntityArns": [ "role1", "role2" ] } DNS | Migrate To Route 53 (Review Required) Change the DNS resolution |
ams-ct-455 | ams-ct.pdf | 455 | 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 Direct Change mode, see Direct Change Mode. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3rd4781c2nnhp. Example: Required Parameters Example not available. Example: All Parameters { "SamlIdentityProviderArns": [ "SAML1", "SAML2" ], "AwsServicePrincipals": [ "Service1", "Service2" ], "IamEntityArns": [ "role1", "role2" ] } DNS | Migrate To Route 53 (Review Required) Change the DNS resolution in your Amazon VPC by enabling Route 53 as the default DNS resolver for your SALZ account. This transition from Microsoft AD to Route 53 Resolver involves redirecting DNS traffic within your VPC through strategically implemented Route 53 Resolver Endpoints and Conditional Forwarders. These forwarders act as rules to intelligently route DNS queries, ensuring Managed Account Version April 22, 2025 1596 AMS Advanced Change Type Reference AMS Advanced Change Type Details seamless resolution for various destinations. It's essential to plan the migration during a scheduled maintenance window to minimize potential disruptions caused by DNS changes. Full classification: Management | Managed account | DNS | Migrate to Route 53 (review required) Change Type Details Change type ID ct-2tqi3kjcusen4 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Migrate AWS Managed Account DNS resolver to Route 53 for SALZ accounts (review required) Migrate AWS Managed Account DNS resolver to Route 53 (SALZ) with the console The following shows this change type in the AMS console. How it works: Managed Account Version April 22, 2025 1597 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. Migrate AWS Managed Account DNS resolver to Route 53 (SALZ) 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 Account Version April 22, 2025 1598 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 |
ams-ct-456 | ams-ct.pdf | 456 | 1598 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 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 --change-type-id "ct-2tqi3kjcusen4" --change-type-version "1.0" -- title "Migrate AWS managed Microsoft AD to Route 53 DNS resolver for SALZ accounts" -- execution-parameters "{}" All required and optional parameters: aws amscm create-rfc --change-type-id "ct-2tqi3kjcusen4" --change-type-version "1.0" -- title "Migrate AWS managed Microsoft AD to Route 53 DNS resolver for SALZ accounts" -- execution-parameters "{\"Priority\":\"Medium\"}" TEMPLATE CREATE: Managed Account Version April 22, 2025 1599 AMS Advanced Change Type Reference AMS Advanced Change Type Details 1. Output the execution parameters for this change type to a JSON file named CreateMigrateToRoute53RequiredParams.json. aws amscm get-change-type-version --change-type-id "ct-2tqi3kjcusen4" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateMigrateToRoute53RequiredParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "Priority": "Medium" } 3. Output the RFC template to a file in your current folder; this example names it CreateMigrateToRoute53RequiredRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateMigrateToRoute53RequiredRfc.json 4. Modify and save the CreateMigrateToRoute53RequiredRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-2tqi3kjcusen4", "ChangeTypeVersion": "1.0", "Title": "Migrate AWS managed Microsoft AD to Route 53 DNS resolver for SALZ accounts" } 5. Create the RFC, specifying the CreateMigrateToRoute53RequiredRfc file and the CreateMigrateToRoute53RequiredParams file: aws amscm create-rfc --cli-input-json file://CreateMigrateToRoute53RequiredRfc.json --execution-parameters file://CreateMigrateToRoute53RequiredParams.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 Account Version April 22, 2025 1600 AMS Advanced Change Type Reference AMS Advanced Change Type Details 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. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2tqi3kjcusen4. Example: Required Parameters Example not available. Example: All Parameters { "Priority": "Medium" } Stack Access Duration | Override (Review Required) Use to override maximum stack access time for all stacks in this account for single landing zone (SALZ) and for all stacks of the member accounts of an organization for multi-landing zone (MALZ). For multi-landing zone (MALZ), please raise a request for change (RFC) from shared-services account with this change type (CT) ID. Access can be overridden from a minimum of 1 hour to a maximum of 120 hours, default stack access is granted for 12 hours. Full classification: Management | Managed account | Stack access duration | Override (review required) Change Type Details Change type ID ct-0jb01cofkhwk1 Current version 1.0 Expected execution duration 360 minutes Managed Account Version April 22, 2025 1601 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Override Stack Access Duration (Review required) Override stack access duration 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 |
ams-ct-457 | ams-ct.pdf | 457 | 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 Account Version April 22, 2025 1602 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. Override stack access duration 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 Account Version April 22, 2025 1603 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 --title="Override Stack Access Duration" --description="Override Stack Access Duration" --ct-id="ct-0jb01cofkhwk1" --ct-version="1.0" --input- params="{\"TimeRequestedInHours\": 15,\"Priority\":\"High\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file. This example names it OverrideStackAccessDurationParameters.json: aws amscm get-change-type-version --change-type-id "ct-0jb01cofkhwk1" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > OverrideStackAccessDurationParameters.json 2. Modify and save the OverrideStackAccessDurationParameters.json file. For example, you can replace the contents with something like this: { "TimeRequestedInHours": 15, "Priority": "High" } 3. Output the RFC template JSON file to a file named OverrideStackAccessDuration.json: aws amscm create-rfc --generate-cli-skeleton > OverrideStackAccessDuration.json 4. Modify and save the OverrideStackAccessDuration.json file. For example, you can replace the contents with something like this: Managed Account Version April 22, 2025 1604 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0jb01cofkhwk1", "Title": "Override Stack Access Duration" } 5. Create the RFC: aws amscm create-rfc --cli-input-json file://OverrideStackAccessDuration.json -- execution-parameters file://OverrideStackAccessDurationParameters.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-0jb01cofkhwk1. Example: Required Parameters { "TimeRequestedInHours": 120 } Example: All Parameters { "TimeRequestedInHours": 15, "Priority": "High" } Managed Firewall Subcategory Change Type Items and Operations in the Managed Firewall Subcategory • Outbound (Palo Alto) | Add URLs • Outbound (Palo Alto) | Delete Allow List Managed Firewall Version April 22, 2025 1605 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Outbound (Palo Alto) | Delete Security Policy • Outbound |
ams-ct-458 | ams-ct.pdf | 458 | 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-0jb01cofkhwk1. Example: Required Parameters { "TimeRequestedInHours": 120 } Example: All Parameters { "TimeRequestedInHours": 15, "Priority": "High" } Managed Firewall Subcategory Change Type Items and Operations in the Managed Firewall Subcategory • Outbound (Palo Alto) | Add URLs • Outbound (Palo Alto) | Delete Allow List Managed Firewall Version April 22, 2025 1605 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Outbound (Palo Alto) | Delete Security Policy • Outbound (Palo Alto) | Remove URLs • Outbound (Palo Alto) | Update Security Policy Outbound (Palo Alto) | Add URLs Add allow list URLs for AMS managed Palo Alto firewall - Outbound. Full classification: Management | Managed Firewall | Outbound (Palo Alto) | Add URLs Change Type Details Change type ID ct-2b9q8339bj2sa Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Add URLs to managed Palo Alto outbound firewall Adding outbound URLs to your managed Palo Alto firewall with the Console Screenshot of this change type in the AMS console: Managed Firewall Version April 22, 2025 1606 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 1607 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. Adding outbound URLs to 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 1608 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-2b9q8339bj2sa" --change-type-version "2.0" -- title "Add URLs to Allow List" --execution-parameters "{ \"RequestType\": \"AddURLs\", \"Parameters\": { \"URLs\": |
ams-ct-459 | ams-ct.pdf | 459 | 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 1608 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-2b9q8339bj2sa" --change-type-version "2.0" -- title "Add URLs to Allow List" --execution-parameters "{ \"RequestType\": \"AddURLs\", \"Parameters\": { \"URLs\": [ \"amazon.com/\", \"*.website.com\\" ], "AllowListName": "CustomAllowList" } } " TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it AddPaUrlsParams.json. aws amscm get-change-type-version --change-type-id "ct-2b9q8339bj2sa" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AddPaUrlsParams.json 2. Modify and save the AddPaUrlsParams file. For example, you can replace the contents with something like this: { "RequestType": "AddURLs", "Parameters": { "URLs": [ "amazon.com/", "*.website.com/" ], "AllowListName": "CustomAllowList" } } 3. Output the RFC template JSON file to a file named AddPaUrlsRfc.json: aws amscm create-rfc --generate-cli-skeleton > AddPaUrlsRfc.json 4. Modify and save the AddPaUrlsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-2b9q8339bj2sa", "Title": "Add-Urls-RFC" } 5. Create the RFC, specifying the AddPaUrls Rfc file and the AddPaUrlsParams file: Managed Firewall Version April 22, 2025 1609 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://AddPaUrlsRfc.json --execution- parameters file://AddPaUrlsParams.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 has a new version and a new schema. Note If you are a Beta customer for AMS Palo Alto managed firewall, do not use this change type, it does not work with Beta accounts. Use the Management | Other | Other | Update (ct-0xdawir96cy7k) instead. To learn more about Palo Alto managed firewall in AMS, seeManaged Palo Alto egress firewall. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2b9q8339bj2sa. Example: Required Parameters Example not available. Example: All Parameters { "RequestType": "AddURLs", "Parameters": { "URLs": ["amazon.com/","*.amazon.com/","www.*.com/","amazon.co1m/","amazon.c- m/","ama-zon.com/","long.sub.domain.amazon.com/","long.sub.*.amazon.com/"], "AllowListName": "test_file" Managed Firewall Version April 22, 2025 1610 AMS Advanced Change Type Reference AMS Advanced Change Type Details } } Outbound (Palo Alto) | Delete Allow List Delete an allow list file for AMS managed Palo Alto firewall - Outbound. Full classification: Management | Managed Firewall | Outbound (Palo Alto) | Delete allow list Change Type Details Change type ID ct-2fzh1wckpl7f5 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Delete allow list from managed Palo Alto outbound firewall Deleting an allow list from your managed Palo Alto firewall with the Console Screenshot of this change type in the AMS console: Managed Firewall Version April 22, 2025 1611 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 |
ams-ct-460 | ams-ct.pdf | 460 | 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. Deleting an allow list from 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. Managed Firewall Version April 22, 2025 1612 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 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-2fzh1wckpl7f5" --change-type-version "1.0" -- title "Delete Allow List" --execution-parameters "{ \"RequestType\": \"DeleteAllowList \", \"Parameters\": { "AllowListName": "CustomAllowList" } } " TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DeleteAllowListParams.json. aws amscm get-change-type-version --change-type-id "ct-2mf36chtp1ejh" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeleteAllowListParams.json Managed Firewall Version April 22, 2025 1613 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Modify and save the DeleteAllowListParams file. For example, you can replace the contents with something like this: { "RequestType": "DeleteAllowList", "Parameters": { "AllowListName": "CustomAllowList" } } 3. Output the RFC template JSON file to a file named DeleteAllowListRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteAllowListRfc.json 4. Modify and save the DeleteAllowListRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2fzh1wckpl7f5", "Title": "Delete-Allow-List-RFC" } 5. Create the RFC, specifying the DeleteAllowList Rfc file and the DeleteAllowListParams file: aws amscm create-rfc --cli-input-json file://DeleteAllowListRfc.json --execution- parameters file://DeleteAllowListParams.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 If you are a Beta customer for AMS Palo Alto managed firewall, do not use this change type, it does not work with Beta accounts. Use the Management | Other | Other | Update (ct-0xdawir96cy7k) instead. Managed Firewall Version April 22, 2025 1614 AMS Advanced Change Type Reference AMS Advanced Change Type Details 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-2fzh1wckpl7f5. Example: Required Parameters Example not available. Example: All Parameters { "Parameters": { "AllowListName": "test_file" }, "RequestType": "DeleteAllowList" } Outbound (Palo Alto) | Delete Security Policy Delete a security policy for AMS managed Palo Alto firewall - Outbound. Full classification: Management | Managed Firewall | Outbound (Palo Alto) | Delete security policy Change Type Details Change type ID ct-1taxucdyi84iy Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Managed Firewall Version April 22, 2025 1615 AMS Advanced Change Type Reference Additional Information AMS Advanced Change Type Details Delete security policy from managed Palo Alto outbound firewall Deleting a security policy from your managed Palo Alto firewall 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 |
ams-ct-461 | ams-ct.pdf | 461 | Alto) | Delete security policy Change Type Details Change type ID ct-1taxucdyi84iy Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Managed Firewall Version April 22, 2025 1615 AMS Advanced Change Type Reference Additional Information AMS Advanced Change Type Details Delete security policy from managed Palo Alto outbound firewall Deleting a security policy from your managed Palo Alto firewall 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. Managed Firewall Version April 22, 2025 1616 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. Deleting a security policy from 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. Managed Firewall Version April 22, 2025 1617 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-1taxucdyi84iy" --change-type-version "1.0" --title "Delete Security Policy" --execution-parameters "{ \"RequestType\": \"DeleteSecurityPolicy\", \"Parameters\": { "SecurityPolicyName": "custom-sec- name" } } " TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DeleteSecurityPolicyParams.json. aws amscm get-change-type-version --change-type-id "ct-1taxucdyi84iy" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeleteSecurityPolicyParams.json 2. Modify and save the DeleteSecurityPolicyParams file. For example, you can replace the contents with something like this: { "RequestType": "DeleteSecurityPolicy", "Parameters": { "SecurityPolicyName": "custom-sec-name" } } 3. Output the RFC template JSON file to a file named DeleteSecurityPolicyRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteSecurityPolicyRfc.json 4. Modify and save the DeleteSecurityPolicyRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1taxucdyi84iy", "Title": "Delete-Security-Policy-RFC" Managed Firewall Version April 22, 2025 1618 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 5. Create the RFC, specifying the DeleteSecurityPolicy Rfc file and the DeleteSecurityPolicyParams file: aws |
ams-ct-462 | ams-ct.pdf | 462 | and save the DeleteSecurityPolicyParams file. For example, you can replace the contents with something like this: { "RequestType": "DeleteSecurityPolicy", "Parameters": { "SecurityPolicyName": "custom-sec-name" } } 3. Output the RFC template JSON file to a file named DeleteSecurityPolicyRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteSecurityPolicyRfc.json 4. Modify and save the DeleteSecurityPolicyRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1taxucdyi84iy", "Title": "Delete-Security-Policy-RFC" Managed Firewall Version April 22, 2025 1618 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 5. Create the RFC, specifying the DeleteSecurityPolicy Rfc file and the DeleteSecurityPolicyParams file: aws amscm create-rfc --cli-input-json file://DeleteSecurityPolicyRfc.json -- execution-parameters file://DeleteSecurityPolicyParams.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-1taxucdyi84iy. Example: Required Parameters Example not available. Example: All Parameters { "Parameters": { "SecurityPolicyName": "custom-sec-pol" }, "RequestType": "DeleteSecurityPolicy" } Outbound (Palo Alto) | Remove URLs Remove URLs from an allow list file for AMS managed Palo Alto firewall - Outbound. Full classification: Management | Managed Firewall | Outbound (Palo Alto) | Remove URLs Managed Firewall Version April 22, 2025 1619 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-2mf36chtp1ejh Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Remove URLS from managed Palo Alto outbound firewall Removing outbound URLs from your managed Palo Alto firewall 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. Managed Firewall Version April 22, 2025 1620 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. Removing outbound URLs from 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: Managed Firewall Version April 22, 2025 1621 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 \" : |
ams-ct-463 | ams-ct.pdf | 463 | 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: Managed Firewall Version April 22, 2025 1621 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 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-2mf36chtp1ejh" --change-type-version "2.0" --title "Remove URLs from Allow List" --execution-parameters "{ \"RequestType\": \"RemoveURLs\", \"Parameters\": { \"URLs\": [ \"amazon.com/\", \"*.website.com/\" ], "AllowListName": "CustomAllowList" } } " TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it RemovePaUrlsParams.json. aws amscm get-change-type-version --change-type-id "ct-2mf36chtp1ejh" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > RemovePaUrlsParams.json 2. Modify and save the RemovePaUrlsParams file. For example, you can replace the contents with something like this: { "RequestType": "RemoveURLs", "Parameters": { "URLs": [ Managed Firewall Version April 22, 2025 1622 AMS Advanced Change Type Reference AMS Advanced Change Type Details "amazon.com/", "*.website.com/" ], "AllowListName": "CustomAllowList" } } 3. Output the RFC template JSON file to a file named RemovePaUrlsRfc.json: aws amscm create-rfc --generate-cli-skeleton > RemovePaUrlsRfc.json 4. Modify and save the RemovePaUrlsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-2mf36chtp1ejh", "Title": "Remove-Urls-RFC" } 5. Create the RFC, specifying the RemovePaUrls Rfc file and the RemovePaUrlsParams file: aws amscm create-rfc --cli-input-json file://RemovePaUrlsRfc.json --execution- parameters file://RemovePaUrlsParams.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 has a new version and a new schema. 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-2mf36chtp1ejh. Managed Firewall Version April 22, 2025 1623 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters Example not available. Example: All Parameters { "Parameters": { "URLs": ["amazon.com/","*.amazon.com/","www.*.com/","amazon.co1m/","amazon.c- m/","ama-zon.com/","long.sub.domain.amazon.com/","long.sub.*.amazon.com/"], "AllowListName": "test_file" }, "RequestType": "RemoveURLs" } Outbound (Palo Alto) | Update Security Policy Update a security policy for AMS managed Palo Alto firewall - Outbound. Full classification: Management | Managed Firewall | Outbound (Palo Alto) | Update security policy Change Type Details Change type ID ct-0mss4i7neuj7f Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update security policy for managed Palo Alto outbound firewall Updating 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 1624 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 |
ams-ct-464 | ams-ct.pdf | 464 | 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 1625 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. Updating 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 1626 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-0mss4i7neuj7f" --change-type-version "1.0" --title "Update Security Policy" --execution-parameters "{ \"RequestType\": \"UpdateSecurityPolicy\", \"Parameters\": { "SecurityPolicyName": "custom-sec-name", "SourceAddressesToAdd": ["3.0.0.0"], "DestinationAddressesToAdd": ["4.0.0.0"], "AllowListsToAdd": [], "ServicePortsToAdd": { "TCPPortsToAdd": [30] "UDPPortsToAdd": [40] }, "SourceAddressesToRemove": [], "DestinationAddressesToRemove": [], "AllowListsToRemove": [], "ServicePortsToRemove": { "TCPPortsToRemove": [], "UDPPortsToRemove": [] }, "ActionType": "Allow", "EnablePolicy": aws amscm create-rfc --change-type-id "ct-0mss4i7neuj7f" --change-type-version "1.0" --title "Update Security Policy" --execution-parameters "{ \"RequestType\": \"UpdateSecurityPolicy\", \"Parameters\": { "SecurityPolicyName": "custom- sec-name", "SourceAddressesToAdd": ["3.0.0.0"], "DestinationAddressesToAdd": ["4.0.0.0"], "AllowListsToAdd": [], "ServicePortsToAdd": { "TCPPortsToAdd": [30] "UDPPortsToAdd": [40] }, "SourceAddressesToRemove": [SOURCE_ADDRESSES], "DestinationAddressesToRemove": [DEST_ADDRESSES], "AllowListsToRemove": [], "ServicePortsToRemove": { "TCPPortsToRemove": [TCP_PORT], "UDPPortsToRemove": [UDP_PORT] }, "ActionType": "Allow", "EnablePolicy": true } " } " TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UpdateSecurityPolicyParams.json. aws amscm get-change-type-version --change-type-id "ct-0mss4i7neuj7f" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateSecurityPolicyParams.json 2. Modify and save the UpdateSecurityPolicyParams file. For example, you can replace the contents with something like this: { "RequestType": "UpdateSecurityPolicy", "Parameters": { "SecurityPolicyName": "custom-sec-name", "SourceAddressesToAdd": ["3.0.0.0"], "DestinationAddressesToAdd": ["4.0.0.0"], "AllowListsToAdd": [], "ServicePortsToAdd": { "TCPPortsToAdd": [30], "UDPPortsToAdd": [40] }, "SourceAddressesToRemove": [], Managed Firewall Version April 22, 2025 1627 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DestinationAddressesToRemove": [], "AllowListsToRemove": [], "ServicePortsToRemove": { "TCPPortsToRemove": [], "UDPPortsToRemove": [] }, "ActionType": "Allow", "EnablePolicy": true } } 3. Output the RFC template JSON file to a file named UpdateSecurityPolicyRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateSecurityPolicyRfc.json 4. Modify and save the UpdateSecurityPolicyRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0mss4i7neuj7f", "Title": "Update-Security-Policy-RFC" } 5. Create the RFC, specifying the UpdateSecurityPolicy Rfc file and the UpdateSecurityPolicyParams file: aws amscm create-rfc --cli-input-json file://UpdateSecurityPolicyRfc.json -- execution-parameters file://UpdateSecurityPolicyParams.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-0mss4i7neuj7f. Managed Firewall Version April 22, 2025 1628 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters Example not available. Example: All Parameters { "Parameters": |
ams-ct-465 | ams-ct.pdf | 465 | execution-parameters file://UpdateSecurityPolicyParams.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-0mss4i7neuj7f. Managed Firewall Version April 22, 2025 1628 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters Example not available. Example: All Parameters { "Parameters": { "SecurityPolicyName": "custom-sec-pol", "SourceAddressesToAdd": ["10.0.0.1", "10.50.0.0/16"], "DestinationAddressesToAdd": ["1.1.1.1", "88.0.0.0/8", "amazon.com"], "ServicePortsToAdd": {"TCPPortsToAdd": [1000, 1200]}, "SourceAddressesToRemove": ["10.0.1.1", "10.80.55.0/24"], "DestinationAddressesToRemove": ["8.8.8.8", "7.60.33.155/32", "google.com"], "ServicePortsToRemove": {"TCPPortsToRemove": [9000, 3333]}, "ActionType": "Allow", "EnablePolicy": false }, "RequestType": "UpdateSecurityPolicy" } Managed Landing Zone Subcategory Change Type Items and Operations in the Managed Landing Zone Subcategory • Application Account | Confirm Offboarding • Application Account | Delete VPC • Management Account | Delete StackSets Stack (Review Required) • Management Account | Enable Developer Mode • Management Account | Move Account To OU • Management Account | Offboard Application Account • Management Account | Update StackSets Stack (Review Required) • Networking Account | Associate TGW Attachment • Networking Account | Disable TGW Propagation • Networking Account | Disassociate TGW Attachment • Networking Account | Enable TGW Propagation • Networking Account | Remove TGW Static Route Managed Landing Zone Version April 22, 2025 1629 AMS Advanced Change Type Reference AMS Advanced Change Type Details Application Account | Confirm Offboarding Confirm offboarding of the specified application account. Run this from the application account that you want off-boarded. Once this CT is executed successfully, login into the Management account of your MALZ environment and run the Offboard application account CT (ct-0vdiy51oyrhhm). After you successfully submit both CTs, AMS can't undo the offboarding, repurpose the account, or help you to remediate issues in the account. Full classification: Management | Managed landing zone | Application account | Confirm offboarding Change Type Details Change type ID ct-2wlfo2jxj2rkj Current version 1.0 Expected execution duration 3600 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Confirm offboarding Important After confirming your intent to offboard the application account, you have 48 hours to run the Management account: Offboard Application account change type (ct-0vdiy51oyrhhm). After 48 hours, the offboarding request fails and the process of confirming and then offboarding must be restarted. Application account: Confirming offboarding with the Console Screenshot of this change type in the AMS console: Managed Landing Zone Version April 22, 2025 1630 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 1631 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. Application account: Confirming offboarding with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC |
ams-ct-466 | ams-ct.pdf | 466 | 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 1631 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. Application account: Confirming offboarding 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 Application account. Managed Landing Zone Version April 22, 2025 1632 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-2wlfo2jxj2rkj" --change-type-version "1.0" -- title "Confirm Offboarding" --execution-parameters "{\"AccountID\": \"000000000000\", \"AccountEmail\": \"email@amazon.com\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it ConfirmAppAcctOffBParams.json: aws amscm get-change-type-version --change-type-id "ct-2wlfo2jxj2rkj" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ConfirmAppAcctOffBParams.json 2. Modify and save the ConfirmAppAcctOffBParams file. For example, you can replace the contents with something like this: { "AccountID": "000000000000", "AccountEmail": "email@amazon.com", } 3. Output the RFC template JSON file to a file; this example names it ConfirmAppAcctOffBRfc.json: aws amscm create-rfc --generate-cli-skeleton > ConfirmAppAcctOffBRfc.json 4. Modify and save the ConfirmAppAcctOffBRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2wlfo2jxj2rkj", "Title": "Confirm Offboarding" } Managed Landing Zone Version April 22, 2025 1633 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Create the RFC, specifying the ConfirmAppAcctOffBRfc file and the ConfirmAppAcctOffBParams file: aws amscm create-rfc --cli-input-json file://ConfirmAppAcctOffBRfc.json -- execution-parameters file://ConfirmAppAcctOffBParams.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 • The second step to offboarding the AMS multi-account landing zone Application account is to submit the Management account: Offboard Application account change type (ct-0vdiy51oyrhhm) from the application account within 48 hours of successfully running this change type confirming the intent to offboard. • For application accounts (other than Customer Managed), run this from the Application account that you want offboarded. After successful confirmation, run the Offboard application account CT (ct-0vdiy51oyrhhm) from the associated management account. Offboarding is intended for account closure and cannot be undone. • Do not use this CT for Customer Managed application accounts. Go directly to Offboard application account CT (ct-0vdiy51oyrhhm). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2wlfo2jxj2rkj. Example: Required Parameters { "RequestType": "OffboardingConfirmation", "Parameters": { "AccountId": "000000000000", "AccountEmail": "example@email.com" } } Managed Landing Zone Version April 22, 2025 1634 AMS Advanced Change Type Details AMS Advanced Change Type Reference Example: All Parameters { "RequestType": "OffboardingConfirmation", "Parameters": { "AccountId": "000000000000", "AccountEmail": "example@email.com" } } Application Account | Delete VPC Delete the virtual private cloud (VPC) in a managed landing zone application account. Full classification: Management | Managed landing zone | Application account | Delete VPC Change Type Details Change type ID ct-2paw0y79kvr3l Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Delete VPC Application account: deleting a VPC with the Console Screenshot of this change type in the AMS console: Managed Landing Zone Version April 22, 2025 1635 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. |
ams-ct-467 | ams-ct.pdf | 467 | | Delete VPC Change Type Details Change type ID ct-2paw0y79kvr3l Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Delete VPC Application account: deleting a VPC with the Console Screenshot of this change type in the AMS console: Managed Landing Zone Version April 22, 2025 1635 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 1636 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. Application account: deleting 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 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. Managed Landing Zone Version April 22, 2025 1637 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-2paw0y79kvr3l" --change-type-version "1.0" --title "Delete VPC" --execution-parameters "{\"VPCId\":\"VPC_ID\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DeleteAppAcctVpcParams.json: aws amscm get-change-type-version --change-type-id "ct-2paw0y79kvr3l" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeleteAppAcctVpcParams.json 2. Modify and save the DeleteAppAcctVpcParams file. For example, you can replace the contents with something like this: { "VPCId": "VPC_ID" } 3. Output the RFC template JSON file to a file; this example names it DeleteAppAcctVpcRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteAppAcctVpcRfc.json 4. Modify and save the DeleteAppAcctVpcRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion" : "1.0", "ChangeTypeId" : "ct-2paw0y79kvr3l", "Title" : "App-Acct-Vpc-RFC" } Managed Landing Zone Version April 22, 2025 1638 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Create the RFC, specifying the DeleteAppAcctVpcRfc file and the DeleteAppAcctVpcParams file: aws amscm create-rfc --cli-input-json file://DeleteAppAcctVpcRfc.json -- execution-parameters file://DeleteAppAcctVpcParams.json You receive the ID of the new RFC in the |
ams-ct-468 | ams-ct.pdf | 468 | "VPC_ID" } 3. Output the RFC template JSON file to a file; this example names it DeleteAppAcctVpcRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteAppAcctVpcRfc.json 4. Modify and save the DeleteAppAcctVpcRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion" : "1.0", "ChangeTypeId" : "ct-2paw0y79kvr3l", "Title" : "App-Acct-Vpc-RFC" } Managed Landing Zone Version April 22, 2025 1638 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Create the RFC, specifying the DeleteAppAcctVpcRfc file and the DeleteAppAcctVpcParams file: aws amscm create-rfc --cli-input-json file://DeleteAppAcctVpcRfc.json -- execution-parameters file://DeleteAppAcctVpcParams.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 VPCs, see Working with VPCs and subnets. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2paw0y79kvr3l. Example: Required Parameters Example not available. Example: All Parameters { "VPCId": "vpc-0078e69aa52274dea" } Management Account | Delete StackSets Stack (Review Required) Delete AWS CloudFormation (CFN) StackSets-created stacks and instances. Full classification: Management | Managed landing zone | Management account | Delete StackSets stack (review required) Change Type Details Change type ID ct-1yqy4frl5s8y8 Managed Landing Zone Version April 22, 2025 1639 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Delete a Stacksets stack Deleting a Stacksets stack 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 1640 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. Deleting 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 Managed Landing Zone Version April 22, 2025 1641 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. |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.