id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
---|---|---|---|
ams-ct-169 | ams-ct.pdf | 169 | RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Managed Landing Zone Version April 22, 2025 603 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-1urj94c3hdfu5" --change-type-version "1.0" --title "Create Application TGW route table" --execution-parameters "{\"TransitGatewayApplicationRouteTableName\":\"TABLE_NAME\", \"AddPresetStaticRoutes \": true}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateRouteTableParams.json: aws amscm get-change-type-version --change-type-id "ct-1urj94c3hdfu5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRouteTableParams.json 2. Modify and save the CreateRouteTableParams file. For example, you can replace the contents with something like this: { "TransitGatewayApplicationRouteTableName": "ROUTE_TABLE_NAME", "AddPresetStaticRoutes": true } 3. Output the RFC template JSON file to a file; this example names it CreateRouteTableRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRouteTableRfc.json 4. Modify and save the CreateRouteTableRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1urj94c3hdfu5", "Title": "Create-TG-Route-Table-RFC" } 5. Create the RFC, specifying the CreateRouteTableRfc file and the CreateRouteTableParams file: aws amscm create-rfc --cli-input-json file://CreateRouteTableRfc.json --execution- parameters file://CreateRouteTableParams.json Managed Landing Zone Version April 22, 2025 604 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. • This change type is manual. To use the automated version of this change type, see Networking Account | Create Application Route Table. • By default, the route table does not connect to on-premise network, but contains preset routes. To request connections to the on-premise network, submit a Deployment | Managed landing zone | Networking account | Add static route change type, with the route table ID, to add routes to it. If you set the AddPresetStaticRoutes parameter to False, the route table that created is empty and you must file a Deployment | Managed landing zone | Networking account | Add static route change type, with the route table ID, to add routes to it. • To learn more about AMS multi-account landing zone, see AWS Managed Services (AMS) Now Offers Managed Landing Zones. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3dscwaeyi6cup. Example: Required Parameters { "DocumentName": "AWSManagedServices-CreateTGWRouteTable", "Region": "us-east-1", "Parameters": { "TransitGatewayRouteTableName": "NewApplicationRouteTable1", "TransitGatewayId": "tgw-0123456789abcdefg", "TGWRouteTableType": "createApplicationRouteDomain" Managed Landing Zone Version April 22, 2025 605 AMS Advanced Change Type Reference AMS Advanced Change Type Details } } Example: All Parameters { "DocumentName": "AWSManagedServices-CreateTGWRouteTable", "Region": "us-east-1", "Parameters": { "TransitGatewayRouteTableName": "NewApplicationRouteTable", "TransitGatewayId": "tgw-0123456789abcdefg", "TGWRouteTableType": "createApplicationRouteDomain" } } Monitoring and Notification Subcategory Change Type Items and Operations in the Monitoring and Notification Subcategory • CloudWatch | Create Alarms • CloudWatch | Create LogGroup • GuardDuty IP Set | Create (Review Required) • GuardDuty Threat Intel Set | Create (Review Required) • SNS | Create (Topic and Subscription) • SQS | Create CloudWatch | Create Alarms Create one or more CloudWatch alarms. For detailed information on CloudWatch alarm properties, see AWS documentation "Creating CloudWatch Alarms". Full classification: Deployment | Monitoring and notification | CloudWatch | Create alarms Change Type Details Change type ID ct-361vpyun9a9dd Current version 1.0 Monitoring and Notification Version April 22, 2025 606 AMS Advanced Change Type Reference AMS Advanced Change Type Details Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create CloudWatch alarm Creating a CloudWatch alarm 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 |
ams-ct-170 | ams-ct.pdf | 170 | 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. Monitoring and Notification Version April 22, 2025 607 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a CloudWatch alarm 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: Monitoring and Notification Version April 22, 2025 608 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 --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-361vpyun9a9dd" --change-type-version "1.0" --title "Test Create CloudWatch Alarms" --execution-parameters "{\"Alarms\": [{\"ActionsEnabled\": true,\"AlarmActions\": [\"arn:aws:sns:us-east-1:000000000000:SNS-Topic\"],\"AlarmDescription\": \"Test alarm description.\",\"AlarmName\": \"Test alarm name\",\"ComparisonOperator\": \"GreaterThanThreshold\",\"DatapointsToAlarm\": 1,\"Dimensions\": [{\"Name\": \"InstanceId\",\"Value\": \"i-12345678901234567\"}],\"EvaluateLowSampleCountPercentile \": \"ignore\",\"EvaluationPeriods\": 2,\"InsufficientDataActions\": [\"arn:aws:sns:us- east-1:000000000000:SNS-Topic\"],\"MetricName\": \"TestMetric\",\"Namespace\": \"AWS/Test\",\"OkActions\": [\"arn:aws:sns:us-east-1:000000000000:SNS-Topic\"], \"Period\": 300,\"Statistic\": \"Average\",\"Threshold\": 85,\"TreatMissingData\": \"breaching\",\"Unit\": \"Percent\"}],\"Region\": \"us-east-1\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file in your current folder; this example names it CwAlarmsParams.json: aws amscm get-change-type-version --change-type-id "ct-361vpyun9a9dd" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CwAlarmsParams.json 2. Modify and save the CwAlarmsParams.json file. For example, you can replace the contents with something like this: { "Alarms": [ { "ActionsEnabled": true, "AlarmActions": ["arn:aws:sns:us-east-1:000000000000:SNS-Topic"], "AlarmDescription": "Test alarm description.", "AlarmName": "Test alarm name", "ComparisonOperator": "GreaterThanThreshold", "DatapointsToAlarm": 1, "Dimensions": [ { "Name": "InstanceId", "Value": "i-12345678901234567" } Monitoring and Notification Version April 22, 2025 609 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "EvaluateLowSampleCountPercentile": "ignore", "EvaluationPeriods": 2, "InsufficientDataActions": ["arn:aws:sns:us-east-1:000000000000:SNS-Topic"], "MetricName": "TestMetric", "Namespace": "AWS/Test", "OkActions": ["arn:aws:sns:us-east-1:000000000000:SNS-Topic"], "Period": 300, "Statistic": "Average", "Threshold": 85, "TreatMissingData": "breaching", "Unit": "Percent" } ], "Region": "us-east-1" } 3. Output the JSON template for CreateRfc to a file in your current folder; this example names it CwAlarmsRfc.json: aws amscm create-rfc --generate-cli-skeleton > CwAlarmsRfc.json 4. Modify and save the CwAlarmsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-361vpyun9a9dd", "Title": "CW-ALARMS-RFC" } 5. Create the RFC, specifying the CwAlarmsRfc file and the execution parameters file: aws amscm create-rfc --cli-input-json file://CwAlarmsRfc.json --execution- parameters file://CwAlarmsParams.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 |
ams-ct-171 | ams-ct.pdf | 171 | ], "Region": "us-east-1" } 3. Output the JSON template for CreateRfc to a file in your current folder; this example names it CwAlarmsRfc.json: aws amscm create-rfc --generate-cli-skeleton > CwAlarmsRfc.json 4. Modify and save the CwAlarmsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-361vpyun9a9dd", "Title": "CW-ALARMS-RFC" } 5. Create the RFC, specifying the CwAlarmsRfc file and the execution parameters file: aws amscm create-rfc --cli-input-json file://CwAlarmsRfc.json --execution- parameters file://CwAlarmsParams.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. Monitoring and Notification Version April 22, 2025 610 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips To learn more about CloudWatch, see Creating Amazon CloudWatch Alarms. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-361vpyun9a9dd. Example: Required Parameters Example not available. Example: All Parameters { "Alarms": [ { "ActionsEnabled": true, "AlarmActions": ["arn:aws:sns:us-east-1:000000000000:SNS-Topic"], "AlarmDescription": "Test alarm description.", "AlarmName": "Test alarm name", "ComparisonOperator": "GreaterThanThreshold", "DatapointsToAlarm": 1, "Dimensions": [ { "Name": "InstanceId", "Value": "i-12345678901234567" } ], "EvaluateLowSampleCountPercentile": "ignore", "EvaluationPeriods": 2, "InsufficientDataActions": ["arn:aws:sns:us-east-1:000000000000:SNS-Topic"], "MetricName": "TestMetric", "Namespace": "AWS/Test", "OkActions": ["arn:aws:sns:us-east-1:000000000000:SNS-Topic"], "Period": 300, "Statistic": "Average", "Threshold": 85, "TreatMissingData": "breaching", "Unit": "Percent" } Monitoring and Notification Version April 22, 2025 611 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "Region": "us-east-1" } CloudWatch | Create LogGroup Creates a CloudWatch LogGroup with optional subscription filter, up to 5 log streams and up to 5 metric filters. Full classification: Deployment | Monitoring and notification | CloudWatch | Create LogGroup Change Type Details Change type ID ct-0cyqd7laxyhlm Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Monitoring and Notification Version April 22, 2025 612 AMS Advanced Change Type Reference Additional Information Create CloudWatch LogGroup Creating a CloudWatch LogGroup with the console AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Monitoring and Notification Version April 22, 2025 613 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a CloudWatch LogGroup 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, |
ams-ct-172 | ams-ct.pdf | 172 | 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 Monitoring and Notification Version April 22, 2025 614 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm --profile saml --region us-east-1 create-rfc --change-type-id "ct-0cyqd7laxyhlm" --change-type-version "1.0" --title 'CloudWatch LogGroup' --description "CloudWatch LogGroup" --execution-parameters "{\"Description \":\"My Test LogGroup\",\"VpcId\":\"VPC_ID\",\"Name\":\"Test LogGroup\", \"StackTemplateId\":\"stm-8ian3plt5a6jbv7jt\",\"TimeoutInMinutes\":60,\"Parameters \": {\"LogGroupName\":\"customer-testloggroup\",\"LogStream1Name\":\"LogStream1\", \"SubscriptionFilterPattern\":\"test\",\"SubscriptionDestinationARN\": \"arn:aws:lambda:us-east-1:123456789012:function:test_lambda\",\"MetricFilter1Name\": \"test_metric_filter1\",\"MetricFilter1Namespace\":\"test_metric_filter1_namespace\", \"MetricFilter1Pattern\":\"{$.eventType=\\\"test_event\\\"}\",\"MetricFilter1Value\": \"10\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file in your current folder; this example names it CwLGParams.json: aws amscm get-change-type-version --change-type-id "ct-ct-0cyqd7laxyhlm" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CwLGParams.json 2. Modify and save the CwLGParams.json file. For example, you can replace the contents with something like this: { "Description": "Test CloudWatch Description", "VpcId": "VPC_ID", "StackTemplateId": "stm-8ian3plt5a6jbv7jt", "Name": "My_CW_Loggroup", "TimeoutInMinutes": 60, "Parameters": { "LogGroupName": "customer-testloggroup", Monitoring and Notification Version April 22, 2025 615 AMS Advanced Change Type Reference AMS Advanced Change Type Details "LogStream1Name": "LogStream1", "SubscriptionFilterPattern": "test", "SubscriptionDestinationARN": "arn:aws:lambda:us- east-1:123456789012:function:test_lambda", "MetricFilter1Name": "test_metric_filter1", "MetricFilter1Namespace": "test_metric_filter1_namespace", "MetricFilter1Pattern": "{$.eventType=\"test_event\"}", "MetricFilter1Value": "10" } } 3. Output the JSON template for CreateRfc to a file in your current folder; example names it CwLGRfc.json: aws amscm create-rfc --generate-cli-skeleton > CwLGRfc.json 4. Modify and save the CwLGRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0cyqd7laxyhlm", "Title": "CW-LG-RFC" } 5. Create the RFC, specifying the CwLGRfc file and the execution parameters file: aws amscm create-rfc --cli-input-json file://CwLGRfc.json --execution-parameters file://CwLGParams.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 CloudWatch, see Creating Amazon CloudWatch Alarms. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0cyqd7laxyhlm. Monitoring and Notification Version April 22, 2025 616 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "StackTemplateId": "stm-8ian3plt5a6jbv7jt", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "LogGroupName": "customer-testloggroup" } } Example: All Parameters { "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "StackTemplateId": "stm-8ian3plt5a6jbv7jt", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "LogGroupName":"customer-test", Monitoring and Notification Version April 22, 2025 617 AMS Advanced Change Type Reference AMS Advanced Change Type Details "LogGroupRetentionInDays":"7", "LogStream1Name":"logstream1", "LogStream2Name":"logstream2", "LogStream3Name":"logstream3", "LogStream4Name":"logstream4", "LogStream5Name":"logstream5", "SubscriptionFilterIAMroleARN":"arn:aws:iam::123456789012:role/example-role", "SubscriptionFilterPattern":"Error", "SubscriptionDestinationARN":"arn:aws:kinesis:us-east-1:123456789012:stream/ example-stream-name", "MetricFilter1Name":"metricfilter1", "MetricFilter1Namespace":"metricfilter1namespace", "MetricFilter1Pattern":"Error", "MetricFilter1Value":"10", "MetricFilter1DefaultValue":"1", "MetricFilter2Name":"metricfilter2", "MetricFilter2Namespace":"metricfilter2namespace", "MetricFilter2Pattern":"Error", "MetricFilter2Value":"20", "MetricFilter2DefaultValue":"1", "MetricFilter3Name":"metricfilter3", "MetricFilter3Namespace":"metricfilter3namespace", "MetricFilter3Pattern":"Error", "MetricFilter3Value":"30", "MetricFilter3DefaultValue":"1", "MetricFilter4Name":"metricfilter4", "MetricFilter4Namespace":"metricfilter4namespace", "MetricFilter4Pattern":"40", "MetricFilter4Value":"2", "MetricFilter4DefaultValue":"1", "MetricFilter5Name":"metricfilter5", "MetricFilter5Namespace":"metricfilter5namespace", "MetricFilter5Pattern":"Error", "MetricFilter5Value":"50", "MetricFilter5DefaultValue":"1" } } GuardDuty IP Set | Create (Review Required) Use to create an Amazon GuardDuty IPSet instance which is a list of trusted IP addresses that have been whitelisted for highly secure communication with your AWS environment. Monitoring and Notification Version April 22, 2025 618 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Deployment | Monitoring and notification | GuardDuty IP set | Create (review required) Change Type Details Change type ID ct-08avsj2e9mc7g Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Create GuardDuty IP set (review required) Creating an IP set for GuardDuty (review required) 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. Monitoring and Notification Version April 22, 2025 619 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Choose a popular change type (CT) in the default Browse change types view, |
ams-ct-173 | ams-ct.pdf | 173 | Not required if submitter Execution mode Manual Additional Information Create GuardDuty IP set (review required) Creating an IP set for GuardDuty (review required) 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. Monitoring and Notification Version April 22, 2025 619 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an IP set for GuardDuty (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. Monitoring and Notification Version April 22, 2025 620 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-08avsj2e9mc7g" --change-type-version "1.0" --title "Create Amazon GuardDuty IP Set" --execution-parameters "{\"Activate\": true, \"DetectorId\": \"00000000000000000000000000000000\", \"Format\": \"TXT\", \"Name \": \"trusted-ips\", \"IpSet\": \"https://s3.us-west-2.amazonaws.com/bucket-name/my- object-key\", \"Region\": \"us-east-1\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateGdIpSetParams.json. aws amscm get-change-type-version --change-type-id "ct-08avsj2e9mc7g" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateGdIpSetParams.json 2. Modify and save the CreateGdIpSetParams file. For example, you can replace the contents with something like this: { Monitoring and Notification Version April 22, 2025 621 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Activate": true, "DetectorId": "00000000000000000000000000000000", "Format": "TXT", "Name": "trusted-ips", "IpSet": "https://s3.us-west-2.amazonaws.com/bucket-name/my-object-key", "Region": "us-east-1" } 3. Output the RFC template JSON file to a file named CreateGdIpSetRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateGdIpSetRfc.json 4. Modify and save the CreateGdIpSetRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-08avsj2e9mc7g", "Title": "CREATE_GD_IP_SET" } 5. Create the RFC, specifying the CreateGdIpSet Rfc file and the CreateGdIpSetParams file: aws amscm create-rfc --cli-input-json file://CreateGdIpSetRfc.json --execution- parameters file://CreateGdIpSetParams.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 |
ams-ct-174 | ams-ct.pdf | 174 | "Format": "TXT", "Name": "trusted-ips", "IpSet": "https://s3.us-west-2.amazonaws.com/bucket-name/my-object-key", "Region": "us-east-1" } 3. Output the RFC template JSON file to a file named CreateGdIpSetRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateGdIpSetRfc.json 4. Modify and save the CreateGdIpSetRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-08avsj2e9mc7g", "Title": "CREATE_GD_IP_SET" } 5. Create the RFC, specifying the CreateGdIpSet Rfc file and the CreateGdIpSetParams file: aws amscm create-rfc --cli-input-json file://CreateGdIpSetRfc.json --execution- parameters file://CreateGdIpSetParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips This is a "review required" change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a "review required" change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. To learn more about Amazon GuardDuty and creating IP sets, see Amazon GuardDuty and CreateIPSet. Monitoring and Notification Version April 22, 2025 622 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-08avsj2e9mc7g. Example: Required Parameters { "Region": "us-east-1", "Name": "Sample IPSet", "IpSet": "https://s3.amazonaws.com/guarddutylists/sample.txt" } Example: All Parameters { "Activate": true, "DetectorId": "12abc34d567e8fa901bc2d34e56789f0", "Region": "us-east-1", "Name": "Sample IPSet", "IpSet": "https://s3.amazonaws.com/guarddutylists/sample.txt", "Format": "TXT", "Priority": "Medium" } GuardDuty Threat Intel Set | Create (Review Required) Use to create an Amazon GuardDuty ThreatIntelSet instance, which is a list of known malicious IP addresses that have been blacklisted for communication with your AWS environment. Full classification: Deployment | Monitoring and notification | GuardDuty threat intel set | Create (review required) Change Type Details Change type ID ct-25v6r7t8gvkq5 Current version 1.0 Expected execution duration 240 minutes Monitoring and Notification Version April 22, 2025 623 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Create GuardDuty Threat intel set (review required) Creating a Threat intel set for GuardDuty (review required) 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. Monitoring and Notification Version April 22, 2025 624 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. Creating a Threat intel set for GuardDuty (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 |
ams-ct-175 | ams-ct.pdf | 175 | submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a Threat intel set for GuardDuty (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 Monitoring and Notification Version April 22, 2025 625 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-25v6r7t8gvkq5" --change-type-version "1.0" --title "Create Amazon GuardDuty Threat Intel Set" --execution-parameters "{\"Activate\": true, \"DetectorId\": \"00000000000000000000000000000000\", \"Format \": \"TXT\", \"Name\": \"blacklisted-ips\", \"ThreatIntelSet\": \"https://s3.us- west-2.amazonaws.com/bucket-name/my-object-key\", \"Region\": \"us-east-1\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateGdThreatIntelSetParams.json. aws amscm get-change-type-version --change-type-id "ct-25v6r7t8gvkq5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateGdThreatIntelSetParams.json 2. Modify and save the CreateGdThreatIntelSetParams file. For example, you can replace the contents with something like this: { "Activate": true, "DetectorId": "00000000000000000000000000000000", "Format": "TXT", "Name": "blacklisted-ips", "ThreatIntelSet": "https://s3.us-west-2.amazonaws.com/bucket-name/my-object-key", "Region": "us-east-1" } 3. Output the RFC template JSON file to a file named CreateGdThreatIntelSetRfc.json: Monitoring and Notification Version April 22, 2025 626 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > CreateGdThreatIntelSetRfc.json 4. Modify and save the CreateGdThreatIntelSetRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-25v6r7t8gvkq5", "Title": "CREATE_GD_THREAT_INTEL_SET" } 5. Create the RFC, specifying the CreateGdIpSet Rfc file and the CreateGdThreatIntelSetParams file: aws amscm create-rfc --cli-input-json file://CreateGdThreatIntelSetRfc.json -- execution-parameters file://CreateGdThreatIntelSetParams.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 Amazon GuardDuty and creating Threat Intel sets, see Amazon Guard Duty and CreateThreatIntelSet. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-25v6r7t8gvkq5. Example: Required Parameters { Monitoring and Notification Version April 22, 2025 627 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Name": "Sample Threat Intel Set", "ThreatIntelSet": "https://s3.amazonaws.com/guarddutylists/sample.txt" } Example: All Parameters { "Activate": true, "DetectorId": "12abc34d567e8fa901bc2d34e56789f0", "Region": "us-east-1", "Name": "Sample Threat Intel Set", "ThreatIntelSet": "https://s3.amazonaws.com/guarddutylists/sample.txt", "Format": "TXT", "Priority": "Medium" } SNS | Create (Topic and Subscription) Create an SNS topic and up to five subscriptions. Full classification: Deployment | Monitoring and notification | SNS | Create (topic and subscription) Change Type Details Change type ID ct-3dfnglm4ombbs Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Monitoring and Notification Version April 22, 2025 628 AMS Advanced Change Type Reference Additional Information Create SNS topic and subscription Creating an SNS topic and subscription (up to 5) with the Console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular |
ams-ct-176 | ams-ct.pdf | 176 | Additional Information Create SNS topic and subscription Creating an SNS topic and subscription (up to 5) with the Console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Monitoring and Notification Version April 22, 2025 629 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an SNS topic and subscription (up to 5) 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 Monitoring and Notification Version April 22, 2025 630 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-3dfnglm4ombbs" --change-type-version "1.0" --title "CREATE_SNS_TOPIC" --execution-parameters "{\"Description\": \"SNS_TOPIC_DESCRIPTION\",\"VpcId\":\"VPC_ID\",\"Name\":\"SNS_TOPIC_NAME\", \"StackTemplateId\":\"stm-eakrsalqo9m62tpun\",\"TimeoutInMinutes\":60,\"Parameters\": {\"TopicName\":\"mytopic-cli\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateSnsTopicSubParams.json. aws amscm get-change-type-version --change-type-id "ct-3dfnglm4ombbs" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateSnsTopicSubParams.json 2. Modify and save the CreateSnsTopicSubParams file. For example, you can replace the contents with something like this: { "Description": "SnsTopicSub-Create", "VpcId": "VPC_ID", "Name": "My-SnsTopicSub", "Parameters":{ "TopicName": "mytopic-cli-all-params", "DisplayName": "testsns", "Subscription1Protocol": "email", "Subscription1Endpoint": "abc@xyz.com", "Subscription1RawMessageDelivery": "false", "Subscription2Protocol": "sms", "Subscription2Endpoint": "+61500444777", "Subscription2RawMessageDelivery": "false", Monitoring and Notification Version April 22, 2025 631 AMS Advanced Change Type Reference AMS Advanced Change Type Details "KmsMasterKeyId": "arn:aws:kms:us-east-1:123456789101:key/ cfe0542d-3be9-4166-9eac-d0cd6af61445" } } 3. Output the RFC template JSON file to a file named CreateSnsTopicSubRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateSnsTopicSubRfc.json 4. Modify and save the CreateSnsTopicSubRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3dfnglm4ombbs", "Title": "SnsTopicSub-Create-RFC" } 5. Create the RFC, specifying the CreateSnsTopicSub Rfc file and the CreateSnsTopicSubParams file: aws amscm create-rfc --cli-input-json file://CreateSnsTopicSubRfc.json -- execution-parameters file://CreateSnsTopicSubParams.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 |
ams-ct-177 | ams-ct.pdf | 177 | Change Type Details "KmsMasterKeyId": "arn:aws:kms:us-east-1:123456789101:key/ cfe0542d-3be9-4166-9eac-d0cd6af61445" } } 3. Output the RFC template JSON file to a file named CreateSnsTopicSubRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateSnsTopicSubRfc.json 4. Modify and save the CreateSnsTopicSubRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3dfnglm4ombbs", "Title": "SnsTopicSub-Create-RFC" } 5. Create the RFC, specifying the CreateSnsTopicSub Rfc file and the CreateSnsTopicSubParams file: aws amscm create-rfc --cli-input-json file://CreateSnsTopicSubRfc.json -- execution-parameters file://CreateSnsTopicSubParams.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 Simple Notification Service (SNS) and creating SNS topics and subscriptions, see Amazon Simple Notification Service. Also see Getting Started with Amazon SNS. For pricing information, see Amazon SNS pricing. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3dfnglm4ombbs. Example: Required Parameters { Monitoring and Notification Version April 22, 2025 632 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description" : "Creates SNS Topic using random Topic name with no input or parameter given.", "VpcId" : "vpc-12345678901234567", "Name" : "TestStack", "StackTemplateId" : "stm-eakrsalqo9m62tpun", "TimeoutInMinutes" : 60, "Parameters" : { } } Example: All Parameters { "Description" : "Creates just SNS Topic per the given name", "VpcId" : "vpc-12345678", "Name" : "TestStack", "Tags" : [ { "Key" : "foo", "Value" : "bar" } ], "StackTemplateId" : "stm-eakrsalqo9m62tpun", "TimeoutInMinutes" : 60, "Parameters" : { "TopicName" : "MySNSTopic", "DisplayName" : "", "Subscription1Endpoint" : "", "Subscription1RawMessageDelivery" : "false", "Subscription2Endpoint" : "", "Subscription2RawMessageDelivery" : "false", "Subscription3Endpoint" : "", "Subscription3RawMessageDelivery" : "false", "Subscription4Endpoint" : "", "Subscription4RawMessageDelivery" : "false", "Subscription5Endpoint" : "", "Subscription5RawMessageDelivery" : "false", "KmsMasterKeyId" : "" } } Monitoring and Notification Version April 22, 2025 633 AMS Advanced Change Type Reference AMS Advanced Change Type Details SQS | Create Use to create an Amazon Simple Queue Service instance for messages to be shared by system components. Full classification: Deployment | Monitoring and notification | SQS | Create Change Type Details Change type ID ct-1vbv99ko7bsrq Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create SQS queue Creating an SQS queue with the Console Screenshot of this change type in the AMS console: Monitoring and Notification Version April 22, 2025 634 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. Monitoring and Notification Version April 22, 2025 635 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an SQS queue 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 |
ams-ct-178 | ams-ct.pdf | 178 | and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an SQS queue 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: Monitoring and Notification Version April 22, 2025 636 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-1vbv99ko7bsrq" --change-type-version "1.0" -- title "Create Amazon SQS Queue" --execution-parameters "{\"Description\": \"SQS-Queue- Create-RFC\", \"VpcId\": \"VPC_ID\", \"StackTemplateId\": \"stm-s1ejpr80000000000\", \"Name\": \"MySqsQueue\", \"Tags\": [{\"Key\": \"my-tag-1\", \"Value\": \"my-tag- value-1\"}, {\"Key\": \"my-tag-2\", \"Value\": \"my-tag-value-2\"}], \"TimeoutInMinutes \": 60, \"Parameters\": {\"SQSDelaySeconds\": 0, \"SQSMaximumMessageSize\": 262144, \"SQSMessageRetentionPeriod\": 345600, \"SQSQueueName\": \"MyQueueName\", \"SQSReceiveMessageWaitTimeSeconds\": 0, \"SQSVisibilityTimeout\": 60}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it CreateSqsInstanceParams.json. aws amscm get-change-type-version --change-type-id "ct-1vbv99ko7bsrq" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateSqsInstanceParams.json 2. Modify and save the CreateSqsInstanceParams file. For example, you can replace the contents with something like this: { "Description": "SQS-Queue-Create-RFC", "VpcId": "VPC_ID", "StackTemplateId": "stm-s1ejpr80000000000", "Name": "MySqsQueue", "Tags": [{ "Key": "my-tag-1", "Value": "my-tag-value-1" }, { "Key": "my-tag-2", "Value": "my-tag-value-2" }], "TimeoutInMinutes": 60, "Parameters": { "SQSDelaySeconds": 0, "SQSMaximumMessageSize": 262144, "SQSMessageRetentionPeriod": 345600, Monitoring and Notification Version April 22, 2025 637 AMS Advanced Change Type Reference AMS Advanced Change Type Details "SQSQueueName": "MyQueueName", "SQSReceiveMessageWaitTimeSeconds": 0, "SQSVisibilityTimeout": 60 } } 3. Output the RFC template JSON file to a file named CreateSqsInstanceRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateSqsInstanceRfc.json 4. Modify and save the CreateSqsInstanceRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1vbv99ko7bsrq", "Title": "Sqs-Instance-Create-RFC" } 5. Create the RFC, specifying the CreateSqsInstance Rfc file and the CreateSqsInstanceParams file: aws amscm create-rfc --cli-input-json file://CreateSqsInstanceRfc.json -- execution-parameters file://CreateSqsInstanceParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon Simple Queue Service (SQS), see Amazon Simple Queue Service. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1vbv99ko7bsrq. Example: Required Parameters { "Description": "This is a test description", Monitoring and Notification Version April 22, 2025 638 AMS Advanced Change Type Reference AMS Advanced Change Type Details "VpcId": "vpc-01234567890abcdef", "StackTemplateId": "stm-s1ejpr80000000000", "Name": "Test Stack", "TimeoutInMinutes": 60, "Parameters": { "SQSQueueName": "mytestsqs" } } Example: All Parameters { "Description": "This is a test description", "VpcId": "vpc-12345678", "StackTemplateId": "stm-s1ejpr80000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "SQSDelaySeconds": 0, "SQSMaximumMessageSize": 262144, "SQSMessageRetentionPeriod": 345600, "SQSQueueName": "mytestsqs", "SQSReceiveMessageWaitTimeSeconds": 0, "SQSVisibilityTimeout": 0 } } Patching Subcategory Change Type Items and Operations in the Patching Subcategory • SSM Patch Baseline | Create (Amazon Linux 2) • SSM Patch Baseline | Create (Amazon Linux) Patching Version April 22, 2025 639 AMS Advanced Change Type Reference AMS Advanced Change Type Details • SSM Patch Baseline | Create (CentOS) • SSM Patch Baseline | Create (Red Hat) • SSM Patch Baseline | Create (Windows) • SSM Patch Window | Create SSM Patch Baseline | Create (Amazon Linux 2) Create an AWS Systems Manager (SSM) patch baseline to define which patches are approved for installation on your instances for Amazon Linux 2 OS. Specify existing instance "Patch Group" tag values for the patch baseline. The patch baseline is an SSM resource that you can manage with the SSM console. Full classification: Deployment | Patching | SSM patch baseline | Create (Amazon Linux 2) Change Type Details Change |
ams-ct-179 | ams-ct.pdf | 179 | | Create (CentOS) • SSM Patch Baseline | Create (Red Hat) • SSM Patch Baseline | Create (Windows) • SSM Patch Window | Create SSM Patch Baseline | Create (Amazon Linux 2) Create an AWS Systems Manager (SSM) patch baseline to define which patches are approved for installation on your instances for Amazon Linux 2 OS. Specify existing instance "Patch Group" tag values for the patch baseline. The patch baseline is an SSM resource that you can manage with the SSM console. Full classification: Deployment | Patching | SSM patch baseline | Create (Amazon Linux 2) Change Type Details Change type ID ct-18fzkt86jmw1s Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create for Amazon Linux 2 Creating an SSM Linux2 patch baseline with the Console Screenshot of this change type in the AMS console: Patching Version April 22, 2025 640 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. Patching Version April 22, 2025 641 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. In the AWS Console, you can view the patch baselines you created at Systems Manager --> Patch Manager --> Patch Baselines. Creating an SSM Linux 2 patch baseline 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: Patching Version April 22, 2025 642 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 --title Patch-Baseline-Create-AL2-RFC --change-type-id ct-18fzkt86jmw1s --change-type-version 1.0 --execution-parameters ' {"ApprovalRules": [{"ApproveAfterDays": 7, "Classification": ["Security"], "Severity": ["All"]}], "OperatingSystem": "Amazon Linux 2", "Name": "TestBaselineAmazonLinux2", "PatchGroupTagValues": ["MyAmazonLinux2PatchGroup"]}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateAL2PatchBaselineParams.json: aws amscm get-change-type-version --change-type-id "ct-2taqdgegqthjr" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAL2PatchBaselineParams.json |
ams-ct-180 | ams-ct.pdf | 180 | 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 --title Patch-Baseline-Create-AL2-RFC --change-type-id ct-18fzkt86jmw1s --change-type-version 1.0 --execution-parameters ' {"ApprovalRules": [{"ApproveAfterDays": 7, "Classification": ["Security"], "Severity": ["All"]}], "OperatingSystem": "Amazon Linux 2", "Name": "TestBaselineAmazonLinux2", "PatchGroupTagValues": ["MyAmazonLinux2PatchGroup"]}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateAL2PatchBaselineParams.json: aws amscm get-change-type-version --change-type-id "ct-2taqdgegqthjr" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAL2PatchBaselineParams.json 2. Modify and save the CreateAL2PatchBaselineParams file, make sure to modify these parameters to meet your specific needs. In this example, all critical security updates are approved for installation five days after release. Patches related to vulnerability ID CVE-2017-5754 are approved immediately even if they are not a critical severity. Finally, example-pkg-0.710.10-2.7.abcd.x86_64 will not be installed, even if it matches an approval rule. { "ApprovalRules":[{ "ApproveAfterDays": 5, "Severity": [ "Critical" ], "Classification": [ "Security" ] }], "ApprovedPatches":["CVE-2017-5754"], "Description": "Patch Baseline", "Name": "PatchBaseline-Unit-test", "OperatingSystem": "Amazon Linux 2", Patching Version April 22, 2025 643 AMS Advanced Change Type Reference AMS Advanced Change Type Details "PatchGroupTagValues": [ "test1" ], "RejectedPatches":["example-pkg-0.710.10-2.7.abcd.x86_64"], "Tags": [ { "Key":"patchGroupAL2", "Value":"test1" } ] 3. Output the RFC template to a file in your current folder; this example names it CreateAL2PatchBaselineRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateAL2PatchBaselineRfc.json 4. Modify and save the CreateAL2PatchBaselineRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-18fzkt86jmw1s", "Title": "Patch-Baseline-Create-AL2-RFC" } 5. Create the RFC, specifying the CreateAL2PatchBaselineRfc file and the CreateAL2PatchBaselineParams file: aws amscm create-rfc --cli-input-json file://CreateAL2PatchBaselineRfc.json -- execution-parameters file://CreateAL2PatchBaselineParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the SSM patch baseline, look in the execution output: Use the stack_id to view the patch baseline in the Systems Manager console. Patching Version April 22, 2025 644 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note There are five change types for creating an SSM patch baseline, for the various operating systems. Important At least one of ApprovalRules or ApprovedPatches is required. If you create a patch baseline, it must have at least one approval rule and/or approved patch defined. An approval rule allows you to specify which classification (for example, SecurityUpdates) and severity (for example, Critical) patches will be installed. In your approval rules, you can define how many days after a patch is released it may be installed. A patch specified in the approved patches list will be installed irrespective of whether it is matched by an approval rule. Finally, items in the rejected patches list will exclude those patches from being installed, even if they match an approval rule and/or approved patch. For more information, see About predefined and custom patch baselines. To create an SSM patch window, see Create SSM Patch Window. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-18fzkt86jmw1s. Example: Required Parameters Example not available. Example: All Parameters Example not available. Patching Version April 22, 2025 645 AMS Advanced Change Type Reference AMS Advanced Change Type Details SSM Patch Baseline | Create (Amazon Linux) Create an AWS Systems Manager (SSM) patch baseline to define which patches are approved for installation on your instances for Amazon Linux OS. Specify existing instance "Patch Group" tag values for the patch baseline. The patch baseline is an SSM resource that you can manage with the SSM console. Full classification: Deployment | Patching | SSM patch baseline | Create (Amazon Linux) Change Type Details Change type ID ct-2taqdgegqthjr Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create for Amazon Linux Creating an SSM Amazon Linux patch baseline with the Console Screenshot of this change type in the AMS console: Patching Version April 22, 2025 646 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. |
ams-ct-181 | ams-ct.pdf | 181 | 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. Patching Version April 22, 2025 647 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. In the AWS Console, you can view the patch baselines you created at Systems Manager --> Patch Manager --> Patch Baselines. Creating an SSM Amazon Linux patch baseline 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: Patching Version April 22, 2025 648 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: Amazon Linux: aws amscm create-rfc --title Patch-Baseline-Create-AL-RFC --change-type-id ct-2taqdgegqthjr --change-type-version 1.0 --execution-parameters '{"ApprovalRules": [{"ApproveAfterDays": 7, "Classification": ["Security"], "Severity": ["All"]}], "OperatingSystem": "Amazon Linux", "Name": "TestBaselineAmazonLinux", "PatchGroupTagValues": ["MyAmazonLinuxPatchGroup"]}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateALPatchBaselineParams.json: aws amscm get-change-type-version --change-type-id "ct-2taqdgegqthjr" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateALPatchBaselineParams.json 2. Modify and save the CreateALPatchBaselineParams file, make sure to modify these parameters to meet your specific needs. In this example, all critical security updates are approved for installation five days after release. Patches related to vulnerability ID CVE-2017-5754 are approved immediately even if they are not a critical severity. Finally, example-pkg-0.710.10-2.7.abcd.x86_64 will not be installed, even if it matches an approval rule. { "ApprovalRules":[{ "ApproveAfterDays": 5, "Severity": [ "Critical" ], "Classification": [ "Security" ] }], "ApprovedPatches":["CVE-2017-5754"], "Description": "Patch Baseline", Patching Version April 22, 2025 649 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Name": "PatchBaseline-Unit-test", "OperatingSystem": "Amazon Linux", "PatchGroupTagValues": [ "test1" ], "RejectedPatches":["example-pkg-0.710.10-2.7.abcd.x86_64"], "Tags": [ { "Key":"patchGroupAL", "Value":"test1" } ] 3. Output the RFC template to a file in your current folder; this example names it CreateALPatchBaselineRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateALPatchBaselineRfc.json 4. Modify and save the CreateALPatchBaselineRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2taqdgegqthjr", "Title": "Patch-Baseline-Create-AL-RFC" } 5. Create the RFC, specifying the CreateALPatchBaselineRfc file |
ams-ct-182 | ams-ct.pdf | 182 | ], "Classification": [ "Security" ] }], "ApprovedPatches":["CVE-2017-5754"], "Description": "Patch Baseline", Patching Version April 22, 2025 649 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Name": "PatchBaseline-Unit-test", "OperatingSystem": "Amazon Linux", "PatchGroupTagValues": [ "test1" ], "RejectedPatches":["example-pkg-0.710.10-2.7.abcd.x86_64"], "Tags": [ { "Key":"patchGroupAL", "Value":"test1" } ] 3. Output the RFC template to a file in your current folder; this example names it CreateALPatchBaselineRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateALPatchBaselineRfc.json 4. Modify and save the CreateALPatchBaselineRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2taqdgegqthjr", "Title": "Patch-Baseline-Create-AL-RFC" } 5. Create the RFC, specifying the CreateALPatchBaselineRfc file and the CreateALPatchBaselineParams file: aws amscm create-rfc --cli-input-json file://CreateALPatchBaselineRfc.json -- execution-parameters file://CreateALPatchBaselineParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the SSM patch baseline, look in the execution output: Use the stack_id to view the patch baseline in the Systems Manager console. Patching Version April 22, 2025 650 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note There are five change types for creating an SSM patch baseline, for the various operating systems. Important At least one of ApprovalRules or ApprovedPatches is required. If you create a patch baseline, it must have at least one approval rule and/or approved patch defined. An approval rule allows you to specify which classification (for example, SecurityUpdates) and severity (for example, Critical) patches will be installed. In your approval rules, you can define how many days after a patch is released it may be installed. A patch specified in the approved patches list will be installed irrespective of whether it is matched by an approval rule. Finally, items in the rejected patches list will exclude those patches from being installed, even if they match an approval rule and/or approved patch. For more information, see About predefined and custom patch baselines. To create an SSM patch window, see Create SSM Patch Window. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2taqdgegqthjr. Example: Required Parameters Example not available. Example: All Parameters Example not available. Patching Version April 22, 2025 651 AMS Advanced Change Type Reference AMS Advanced Change Type Details SSM Patch Baseline | Create (CentOS) Create an AWS Systems Manager (SSM) patch baseline to define which patches are approved for installation on your instances for CentOS. Specify existing instance "Patch Group" tag values for the patch baseline. The patch baseline is an SSM resource that you can manage with the SSM console. Full classification: Deployment | Patching | SSM patch baseline | Create (CentOS) Change Type Details Change type ID ct-2nyeguspp2g1l Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create for CentOS Creating an SSM CentOS patch baseline with the Console Screenshot of this change type in the AMS console: Patching Version April 22, 2025 652 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 |
ams-ct-183 | ams-ct.pdf | 183 | 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. In the AWS Console, you can view the patch baselines you created at Systems Manager --> Patch Manager --> Patch Baselines. Creating an SSM CentOS patch baseline with the CLI How it works: Patching Version April 22, 2025 653 AMS Advanced Change Type Reference AMS Advanced Change Type Details 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: CentOS: aws amscm create-rfc --title Patch-Baseline-Create-Centos-RFC --change-type-id ct-2nyeguspp2g1l --change-type-version 1.0 --execution-parameters '{"ApprovalRules": [{"ApproveAfterDays": 7, "Classification": ["All"], "Severity": ["All"]}], "OperatingSystem": "CentOS", "Name": "TestBaselineCentOS", "PatchGroupTagValues": ["MyCentOSPatchGroup"]}' TEMPLATE CREATE: Patching Version April 22, 2025 654 AMS Advanced Change Type Reference AMS Advanced Change Type Details 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateCentosPatchBaselineParams.json: aws amscm get-change-type-version --change-type-id "ct-2taqdgegqthjr" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateCentosPatchBaselineParams.json 2. Modify and save the CreateCentosPatchBaselineParams file. See examples below; make sure to modify these parameters to meet your specific needs. In this example, all updates are approved for installation five days after release. The package example-pkg-0.710.10-2.7.abcd.x86_64 will not be installed. { "ApprovalRules":[{ "ApproveAfterDays": 5, "Severity": [ "All" ], "Classification": [ "All" ] }], "Description": "Patch Baseline", "Name": "PatchBaseline-Unit-test", "OperatingSystem": "CentOS", "PatchGroupTagValues": [ "test1" ], "RejectedPatches":["example-pkg-0.710.10-2.7.abcd.x86_64"], "Tags": [ { "Key":"patchGroupCent", "Value":"test1" } ] 3. Output the RFC template to a file in your current folder; this example names it CreateCentosPatchBaselineRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateCentosPatchBaselineRfc.json Patching Version April 22, 2025 655 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the CreateCentosPatchBaselineRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2nyeguspp2g1l", "Title": "Patch-Baseline-Create-Centos-RFC" } 5. Create the RFC, specifying the CreateCentosPatchBaselineRfc file and the CreateCentosPatchBaselineParams file: aws amscm create-rfc --cli-input-json file://CreateCentosPatchBaselineRfc.json -- execution-parameters file://CreateCentosPatchBaselineParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the SSM patch baseline, look in the execution output: Use the stack_id to view the patch baseline in the Systems Manager console. Tips Note There are five change types for creating an SSM patch baseline, for the various operating systems. Note Because CentOS default repos do not provide update notice metadata, all updates are categorized as non-security, with no classification or severity info. As a result, you must specify Classification:All and Severity:All for any CentOS patch baseline. If you do not allow non-security updates in your CentOS baseline, no updates of any type will be installed from default repos. For more detail, see How security patches are selected. Patching Version April 22, 2025 656 AMS Advanced Change Type Reference AMS Advanced Change Type Details Important At least one of ApprovalRules or ApprovedPatches is required. If you create a patch baseline, it must have at least one approval rule and/or approved patch defined. An |
ams-ct-184 | ams-ct.pdf | 184 | are categorized as non-security, with no classification or severity info. As a result, you must specify Classification:All and Severity:All for any CentOS patch baseline. If you do not allow non-security updates in your CentOS baseline, no updates of any type will be installed from default repos. For more detail, see How security patches are selected. Patching Version April 22, 2025 656 AMS Advanced Change Type Reference AMS Advanced Change Type Details Important At least one of ApprovalRules or ApprovedPatches is required. If you create a patch baseline, it must have at least one approval rule and/or approved patch defined. An approval rule allows you to specify which classification (for example, SecurityUpdates) and severity (for example, Critical) patches will be installed. In your approval rules, you can define how many days after a patch is released it may be installed. A patch specified in the approved patches list will be installed irrespective of whether it is matched by an approval rule. Finally, items in the rejected patches list will exclude those patches from being installed, even if they match an approval rule and/or approved patch. For more information, see About predefined and custom patch baselines. To create an SSM patch window, see Create SSM Patch Window. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2nyeguspp2g1l. Example: Required Parameters Example not available. Example: All Parameters Example not available. SSM Patch Baseline | Create (Red Hat) Create an AWS Systems Manager (SSM) patch baseline to define which patches are approved for installation on your instances for RHEL OS. Specify existing instance "Patch Group" tag values for the patch baseline. The patch baseline is an SSM resource that you can manage with the SSM console. Full classification: Deployment | Patching | SSM patch baseline | Create (Red Hat) Patching Version April 22, 2025 657 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-3ebotglihggse Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create for RHEL Creating an SSM RHEL patch baseline 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. Patching Version April 22, 2025 658 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. In the AWS Console, you can view the patch baselines you created at Systems Manager --> Patch Manager --> Patch Baselines. Creating an SSM RHEL patch baseline 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-ct-185 | ams-ct.pdf | 185 | the AWS Console, you can view the patch baselines you created at Systems Manager --> Patch Manager --> Patch Baselines. Creating an SSM RHEL patch baseline 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. Patching Version April 22, 2025 659 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 --title Patch-Baseline-Create-Rhel-RFC --change-type-id ct-3ebotglihggse --change-type-version 1.0 --execution-parameters '{"ApprovalRules": [{"ApproveAfterDays": 7, "Classification": ["Security"], "Severity": ["All"]}], "OperatingSystem": "Red Hat Enterprise Linux", "Name": "TestBaselineRHEL", "PatchGroupTagValues": ["MyRHELPatchGroup"]}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateRhelPatchBaselineParams.json: aws amscm get-change-type-version --change-type-id "ct-2taqdgegqthjr" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRhelPatchBaselineParams.json 2. Modify and save the CreateRhelPatchBaselineParams file. See examples below; make sure to modify these parameters to meet your specific needs. Patching Version April 22, 2025 660 AMS Advanced Change Type Reference AMS Advanced Change Type Details In this example, all critical security updates are approved for installation five days after release. Patches included in Red Hat Security Advisory RHSA-2018:0151 are approved immediately even if they are not a critical severity. Finally, example-pkg-0.710.10-2.7.abcd.x86_64 will not be installed, even if it matches an approval rule. { "ApprovalRules":[{ "ApproveAfterDays": 5, "Severity": [ "Critical" ], "Classification": [ "Security" ] }], "ApprovedPatches":["RHSA-2018:0151"], "Description": "Patch Baseline", "Name": "PatchBaseline-Unit-test", "OperatingSystem": "Red Hat Enterprise Linux", "PatchGroupTagValues": [ "test1" ], "RejectedPatches":["example-pkg-0.710.10-2.7.abcd.x86_64"], "Tags": [ { "Key":"patchGroupRhel", "Value":"test1" } ] 3. Output the RFC template to a file in your current folder; this example names it CreateRhelPatchBaselineRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRhelPatchBaselineRfc.json 4. Modify and save the CreateRhelPatchBaselineRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3ebotglihggse", Patching Version April 22, 2025 661 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "Patch-Baseline-Create-Rhel-RFC" } 5. Create the RFC, specifying the CreateRhelPatchBaselineRfc file and the CreateRhelPatchBaselineParams file: aws amscm create-rfc --cli-input-json file://CreateRhelPatchBaselineRfc.json -- execution-parameters file://CreateRhelPatchBaselineParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the SSM patch baseline, look in the execution output: Use the stack_id to view the patch baseline in the Systems Manager console. Tips Note There are five change types for creating an SSM patch baseline, for the various operating systems. Important At least one of ApprovalRules or ApprovedPatches is required. If you create a patch baseline, it must have at least one approval rule and/or approved patch defined. An approval rule allows you to specify which classification (for example, SecurityUpdates) and severity (for example, Critical) patches will be installed. In your approval rules, you can define how many days after a patch is released it may be installed. A patch specified in the approved patches list will be installed irrespective of whether it is matched by an approval rule. Finally, items in the rejected patches list will exclude those patches from being installed, even if they match an approval rule and/or approved patch. For more information, see About predefined and custom patch baselines. To create an SSM patch window, see Create SSM Patch Window. Patching Version April 22, 2025 662 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-3ebotglihggse. Example: Required Parameters Example not available. Example: All Parameters Example not available. SSM Patch Baseline | Create (Windows) Create an AWS Systems Manager (SSM) patch baseline to define which patches are approved for installation on your instances for Windows OS. Specify existing instance "Patch Group" tag |
ams-ct-186 | ams-ct.pdf | 186 | For more information, see About predefined and custom patch baselines. To create an SSM patch window, see Create SSM Patch Window. Patching Version April 22, 2025 662 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-3ebotglihggse. Example: Required Parameters Example not available. Example: All Parameters Example not available. SSM Patch Baseline | Create (Windows) Create an AWS Systems Manager (SSM) patch baseline to define which patches are approved for installation on your instances for Windows OS. Specify existing instance "Patch Group" tag values for the patch baseline. The patch baseline is an SSM resource that you can manage with the SSM console. Full classification: Deployment | Patching | SSM patch baseline | Create (Windows) Change Type Details Change type ID ct-0kbey7hb00atp Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Patching Version April 22, 2025 663 AMS Advanced Change Type Reference Additional Information Create for Windows Creating an SSM Windows patch baseline with the Console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 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. Patching Version April 22, 2025 664 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. In the AWS Console, you can view the patch baselines you created at Systems Manager --> Patch Manager --> Patch Baselines. Creating an SSM Windows patch baseline 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 Patching Version April 22, 2025 665 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 --title Patch-Baseline-Create-Win-RFC --change-type-id ct-0kbey7hb00atp --change-type-version 1.0 --execution-parameters '{"ApprovalRules": [{"ApproveAfterDays": 7, "Classification": ["SecurityUpdates"], "Severity": ["All"]}], "OperatingSystem": "Windows", "Name": "TestBaselineWindows", "PatchGroupTagValues": ["MyWindowsPatchGroup"]}' TEMPLATE CREATE: 1. |
ams-ct-187 | ams-ct.pdf | 187 | of the request (not Patching Version April 22, 2025 665 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 --title Patch-Baseline-Create-Win-RFC --change-type-id ct-0kbey7hb00atp --change-type-version 1.0 --execution-parameters '{"ApprovalRules": [{"ApproveAfterDays": 7, "Classification": ["SecurityUpdates"], "Severity": ["All"]}], "OperatingSystem": "Windows", "Name": "TestBaselineWindows", "PatchGroupTagValues": ["MyWindowsPatchGroup"]}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreateWinPatchBaselineParams.json: aws amscm get-change-type-version --change-type-id "ct-2taqdgegqthjr" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateWinPatchBaselineParams.json 2. Modify and save the CreateWinPatchBaselineParams file. See examples below; make sure to modify these parameters to meet your specific needs. In this example, all critical security updates are approved for installation five days after release. KB2032276 is approved immediately even if it is not a critical severity. Finally, KB2124261 will not be installed, even if it matches an approval rule. { "ApprovalRules":[{ "ApproveAfterDays": 5, "Severity": [ "Critical" ], "Classification": [ "SecurityUpdates" ] Patching Version April 22, 2025 666 AMS Advanced Change Type Reference AMS Advanced Change Type Details }], "ApprovedPatches":["KB2032276"], "Description": "Patch Baseline", "Name": "PatchBaseline-Unit-test", "OperatingSystem": "Windows", "PatchGroupTagValues": [ "test1" ], "RejectedPatches":["KB2124261"], "Tags": [ { "Key":"patchGroupWin", "Value":"test1" } ] 3. Output the RFC template to a file in your current folder; this example names it CreateWinPatchBaselineRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateWinPatchBaselineRfc.json 4. Modify and save the CreateWinPatchBaselineRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0kbey7hb00atp", "Title": "Patch-Baseline-Create-Win-RFC" } 5. Create the RFC, specifying the CreateWinPatchBaselineRfc file and the CreateWinPatchBaselineParams file: aws amscm create-rfc --cli-input-json file://CreateWinPatchBaselineRfc.json -- execution-parameters file://CreateWinPatchBaselineParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. To view the SSM patch baseline, look in the execution output: Use the stack_id to view the patch baseline in the Systems Manager console. Patching Version April 22, 2025 667 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note There are five change types for creating an SSM patch baseline, for the various operating systems. Important At least one of ApprovalRules or ApprovedPatches is required. If you create a patch baseline, it must have at least one approval rule and/or approved patch defined. An approval rule allows you to specify which classification (for example, SecurityUpdates) and severity (for example, Critical) patches will be installed. In your approval rules, you can define how many days after a patch is released it may be installed. A patch specified in the approved patches list will be installed irrespective of whether it is matched by an approval rule. Finally, items in the rejected patches list will exclude those patches from being installed, even if they match an approval rule and/or approved patch. For more information, see About predefined and custom patch baselines. To create an SSM patch window, see Create SSM Patch Window. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0kbey7hb00atp. Example: Required Parameters Example not available. Example: All Parameters Example not available. Patching Version April 22, 2025 668 AMS Advanced Change Type Reference AMS Advanced Change Type Details SSM Patch Window | Create Create an AWS Systems Manager (SSM) patch window for patching to take place on instances with the specified PatchGroup. The patch window is an SSM resource that you can manage with the SSM console. Full classification: Deployment | Patching | SSM patch window | Create Change Type Details Change type ID ct-0el2j07llrxs7 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create SSM Patch Window Creating an SSM patch window with the Console Screenshot of this change type in the AMS console: Patching Version April 22, 2025 669 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 |
ams-ct-188 | ams-ct.pdf | 188 | 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an SSM patch window 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. Patching Version April 22, 2025 670 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 --title my-test-patchwindow --changetype-id ct-0el2j07llrxs7 -- change-type-version 1.0 --execution-parameters '{"Cutoff":2, "Description":"Test", "Duration":24, "MaxConcurrency":"10", "MaxErrors":"12", "NotificationEmails": ["test@supertest.com"], "PatchGroup":"test-patch-group", "Schedule":"cron(0 3 ? * 6L *)", "ScheduleTimeZone": "Africa/Harare"}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it CreatePatchWindowParams.json: aws amscm get-change-type-version --change-type-id "ct-0el2j07llrxs7" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreatePatchWindowParams.json Patching Version April 22, 2025 671 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Modify and save the CreatePatchWindowParams file. { "Cutoff": 23, "Description": "Required param given test", "Duration": 24, "EndDate": "2008-09-15T15:53:00Z", "MaxConcurrency": "10", "MaxErrors": "12", "Name": "Test1", "NotificationEmails": ["email@example.com"], "PatchGroup": "Prod", "Schedule": "cron(0 3 ? * 6L *)", "ScheduleTimeZone": "Africa/Harare", "ScheduleOffset": "0", "StartDate": "2008-09-15T15:53:00Z" } 3. Output the RFC template to a file in your current folder; this example names it CreatePatchWindowRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreatePatchWindowRfc.json 4. Modify and save the CreatePatchWindowRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0el2j07llrxs7", "Title": "Patch-Window-Create-RFC" } 5. Create the RFC, specifying the CreatePatchWindowRfc file and the CreatePatchWindowParams file: aws amscm create-rfc --cli-input-json file://CreatePatchWindowRfc.json --execution- parameters file://CreatePatchWindowParams.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. Patching Version April 22, 2025 672 AMS Advanced Change Type Reference AMS Advanced Change Type Details 6. To view the SSM patch baseline, look in the execution output: Use the stack_id to view the patch baseline in the Systems |
ams-ct-189 | ams-ct.pdf | 189 | "ChangeTypeId": "ct-0el2j07llrxs7", "Title": "Patch-Window-Create-RFC" } 5. Create the RFC, specifying the CreatePatchWindowRfc file and the CreatePatchWindowParams file: aws amscm create-rfc --cli-input-json file://CreatePatchWindowRfc.json --execution- parameters file://CreatePatchWindowParams.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. Patching Version April 22, 2025 672 AMS Advanced Change Type Reference AMS Advanced Change Type Details 6. To view the SSM patch baseline, look in the execution output: Use the stack_id to view the patch baseline in the Systems Manager console. Tips • To learn more about AWS SSM patch windows, see "Maintenance Window" at Patching your Windows EC2 instances using AWS Systems Manager Patch Manager. • To create an SSM patch baseline, see SSM Patch Window | Create. To update a custom Maintenance Window, see Updating an SSM Patch Window. To delete a custom Maintenance Window, see Delete stack. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0el2j07llrxs7. Example: Required Parameters Example not available. Example: All Parameters { "Cutoff": 23, "Description": "Required param given test", "Duration": 24, "EndDate": "2008-09-15T15:53:00Z", "MaxConcurrency": "10", "MaxErrors": "12", "Name": "Test1", "NotificationEmails": ["email1@example.com"], "PatchGroup": "Prod", "Schedule": "cron(0 0 0 ? * 3#2 *)", "ScheduleOffset": 1, "ScheduleTimeZone": "Africa/Harare", "StartDate": "2008-09-15T15:53:00Z" } Patching Version April 22, 2025 673 AMS Advanced Change Type Reference AMS Advanced Change Type Details Standalone Resources Subcategory Change Type Items and Operations in the Standalone Resources Subcategory • EC2 Instance | Create For WIGS (Review Required) EC2 Instance | Create For WIGS (Review Required) Create an Amazon Elastic Compute Cloud (EC2) instance for use with Workload Ingest (WIGS) change type (ct-257p9zjk14ija). For information, see AMS documentation on WIGS in the AMS Application Developer's Guide. Full classification: Deployment | Standalone resources | EC2 instance | Create for WIGS (review required) Change Type Details Change type ID ct-36emj2uapfbu8 Current version 2.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Create for WIGS (Review Required) Creating an instance for WIGS with the console The following shows this change type in the AMS console. Standalone Resources Version April 22, 2025 674 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. Standalone Resources Version April 22, 2025 675 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an instance for WIGS 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: |
ams-ct-190 | ams-ct.pdf | 190 | cancel the RFC or create a copy of it with the options at the top of the page. Creating an instance for WIGS 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: Standalone Resources Version April 22, 2025 676 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-36emj2uapfbu8" --change-type-version "2.0" --title "Create Pre-Ingestion Instance" --execution-parameters "{\"InstanceVpcId \": \"vpc-1234567890abcdef0\",\"InstanceAmiId\": \"ami-1234567890abcdef0\", \"InstanceEBSOptimized\": false,\"InstanceRootVolumeSize\": 60,\"InstanceNameTagValue \": \"temp-wigs\",\"InstanceType\": \"t3.large\",\"InstanceSubnetId\": \"subnet-0bb1c79de3EXAMPLE\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it CreateEc2PreIngestParams.json: aws amscm get-change-type-version --change-type-id "ct-36emj2uapfbu8" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateEc2PreIngestParams.json 2. Modify and save the CreateEc2PreIngestParams file. For example, you can replace the contents with something like this: { "InstanceVpcId": "vpc-1234567890abcdef0", "InstanceAmiId": "ami-1234567890abcdef0", "InstanceEBSOptimized": false, "InstanceRootVolumeSize": 60, "InstanceSubnetId": "subnet-1234567890abcdef0", "InstanceType": "t3.large", "InstanceNameTagValue": "temp-wigs", } } 3. Output the RFC template to a file in your current folder; this example names it CreateEc2PreIngestRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateEc2PreIngestRfc.json 4. Modify and save the CreateEc2PreIngestRfc.json file. For example, you can replace the contents with something like this:. Standalone Resources Version April 22, 2025 677 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-36emj2uapfbu8", "Title": "Create Pre-Ingestion Instance" } 5. Create the RFC, specifying the CreateEc2PreIngestRfc file and the CreateEc2PreIngestParams file: aws amscm create-rfc --cli-input-json file://CreateEc2PreIngestRfc.json -- execution-parameters file://CreateEc2PreIngestParams.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 use the AWS Marketplace AMI, you must subscribe to the AMI from your AWS Marketplace account and agree to the terms of the AMI. AMS can't perform these actions for you because, as a buyer, you perform these actions yourself. If you need additional IAM permissions for these actions, use the Identity and Access Management (IAM) | Create EC2 Instance Profile change type in a separate RFC to request them. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-36emj2uapfbu8. Example: Required Parameters { "InstanceVpcId": "vpc-1234567890abcdef0", "InstanceAmiId": "ami-1234567890abcdef0", "InstanceSubnetId": "subnet-1234567890abcdef0" } Example: All Parameters { Standalone Resources Version April 22, 2025 678 AMS Advanced Change Type Reference AMS Advanced Change Type Details "InstanceVpcId": "vpc-1234567890abcdef0", "InstanceAmiId": "ami-1234567890abcdef0", "InstanceEBSOptimized": false, "InstanceRootVolumeSize": 60, "InstanceSubnetId": "subnet-1234567890abcdef0", "InstanceType": "t3.large", "InstanceNameTagValue": "temp-wigs", "Priority": "Medium" } Standard Stacks Subcategory Change Type Items and Operations in the Standard Stacks Subcategory • High Availability One-Tier Stack | Create • High Availability One-Tier Stack | Create (With ELB) • High Availability Two-Tier Stack | Create High Availability One-Tier Stack | Create Use to create an Application Load Balancer and an Auto Scaling Group. Full classification: Deployment | Standard stacks | High availability one-tier stack | Create Change Type Details Change type ID ct-09t6q7j9v5hrn Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Standard Stacks Version April 22, 2025 679 AMS Advanced Change Type Reference Additional Information AMS Advanced Change Type Details High availability one-tier stacks: Creating Creating a high availability one-tier stack 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. |
ams-ct-191 | ams-ct.pdf | 191 | Information AMS Advanced Change Type Details High availability one-tier stacks: Creating Creating a high availability one-tier stack 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. 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. Standard Stacks Version April 22, 2025 680 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a high availability one-tier stack with the CLI How it works: 1. Use the Template Create method (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. TEMPLATE CREATE: Standard Stacks Version April 22, 2025 681 AMS Advanced Change Type Reference AMS Advanced Change Type Details 1. Output the execution parameters JSON schema for this change type to a file in your current folder; this example names it CreateOnetierStackParams.json. aws amscm get-change-type-version --change-type-id "ct-09t6q7j9v5hrn" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateOnetierStackParams.json 2. Modify the schema, replacing the variables as appropriate. { "Description": "HA-One-Tier-Stack", "Name": "One-Tier-Stack", "TimeoutInMinutes": "360", "VpcId": "VPC_ID", "ApplicationLoadBalancer": { "SubnetIds": [ "SUBNET_ID", "SUBNET_ID" ] }, "AutoScalingGroup": { "AmiId": "AMI-ID" "SubnetIds": [ "SUBNET_ID", "SUBNET_ID" ] } } 3. Output the CreateRfc JSON template to a file in your current folder; example names it CreateOnetierStackRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateOnetierStackRfc.json 4. Modify the RFC template as appropriate and save it. Reset the start and end times for a scheduled RFC, or leave off for an ASAP RFC. { "ChangeTypeVersion": 2.0", "ChangeTypeId": "ct-09t6q7j9v5hrn", "Title": "HA-One-Tier-RFC", "RequestedStartTime": "2019-04-28T22:45:00Z", Standard Stacks Version April 22, 2025 682 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RequestedEndTime": "2019-04-28T22:45:00Z" } 5. Create the RFC, specifying the CreateOnetierStackRfc.json file and the CreateOnetierStackParams.json execution parameters file: aws amscm create-rfc --cli-input-json file://CreateOnetierStackRfc.json -- execution-parameters file://CreateOnetierStackParams.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 is a large provisioning of resources, especially if you add UserData. The load balancer Amazon resource name (ARN) can be found through the Load Balancer page of the EC2 console by searching with the load balancer stack ID returned in the RFC execution output. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type |
ams-ct-192 | ams-ct.pdf | 192 | file://CreateOnetierStackParams.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 is a large provisioning of resources, especially if you add UserData. The load balancer Amazon resource name (ARN) can be found through the Load Balancer page of the EC2 console by searching with the load balancer stack ID returned in the RFC execution output. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-09t6q7j9v5hrn. Example: Required Parameters { "VpcId": "vpc-1234567890abcdef0", "TimeoutInMinutes": 360, "ApplicationLoadBalancer": { "SubnetIds": ["subnet-01234567890abcdef", "subnet-01234567891abcdef"] }, "AutoScalingGroup": { "AmiId": "ami-01234567890abcdef", "SubnetIds": ["subnet-01234567890abcdef", "subnet-01234567891abcdef"] }, "Description": "This stack contains an ALB and an ASG.", "Name": "High availability one-tier stack" Standard Stacks Version April 22, 2025 683 AMS Advanced Change Type Reference AMS Advanced Change Type Details } Example: All Parameters { "VpcId": "vpc-12345678", "TimeoutInMinutes": 360, "DatabaseStackId": "stack-0123456789abcdefg", "Description": "This stack contains an ALB and an ASG.", "Name": "High availability one-tier stack", "Tags": [ { "Key": "Foo", "Value": "Bar" } ], "TimeoutInMinutes": 60, "VpcId": "vpc-01234567", "ApplicationLoadBalancer": { "HealthCheckHealthyThreshold": 2, "HealthCheckIntervalInSeconds": 10, "HealthCheckTargetPath": "/", "HealthCheckTargetPort": 80, "HealthCheckTargetProtocol": "HTTPS", "HealthCheckTimeoutSeconds": 5, "HealthCheckUnhealthyThreshold": 2, "InstancePort": 80, "InstanceProtocol": "HTTP", "LoadBalancerCookieExpirationPeriodInSeconds": 3600, "LoadBalancerPort": 80, "LoadBalancerAccessCIDRRange": "1.2.3.4/0", "LoadBalancerProtocol": "HTTP", "LoadBalancerSslPolicy": "ELBSecurityPolicy-2016-08", "Public": false, "SSLCertificateId": "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012.", "SubnetIds": ["subnet-a0b1c2d3", "subnet-e4f5g6h7"], "ValidHTTPCode": "200" }, "AutoScalingGroup": { "AmiId": "ami-01234567", "CooldownInSeconds": 300, "DesiredCapacity": 1, Standard Stacks Version April 22, 2025 684 AMS Advanced Change Type Reference AMS Advanced Change Type Details "EBSOptimized": false, "HealthCheckGracePeriodInSeconds": 1800, "HealthCheckType": "EC2", "IAMInstanceProfile": "customer-mc-ec2-instance-profile", "InstanceDetailedMonitoring" : true, "InstanceRootVolumeIops" : 0, "InstanceRootVolumeName": "/dev/xvda", "InstanceRootVolumeSizeInGiB" : 20, "InstanceRootVolumeType" : "standard", "InstanceType": "m4.large", "MaxInstances": 1, "MinInstances": 1, "ScaleMetricName": "CPUUtilization", "ScaleDownPolicyCooldownInSeconds": 300, "ScaleDownPolicyEvaluationPeriods": 4, "ScaleDownPolicyPeriod": 60, "ScaleDownPolicyScalingAdjustment": -1, "ScaleDownPolicyStatistic": "Average", "ScaleDownPolicyThreshold": 35, "ScaleUpPolicyCooldownInSeconds": 300, "ScaleUpPolicyEvaluationPeriods": 2, "ScaleUpPolicyPeriod": 60, "ScaleUpPolicyScalingAdjustment": 1, "ScaleUpPolicyStatistic": "Average", "ScaleUpPolicyThreshold": 75, "SubnetIds": ["subnet-a0b1c2d3", "subnet-e4f5g6h7"], "UserData": ["#!/bin/bash","echo hello"] } } High Availability One-Tier Stack | Create (With ELB) Create a stack with an Auto Scaling Group, and an Elastic Load Balancer (ELB) with up to two listeners, integrated with an existing security group that you specify. Full classification: Deployment | Standard stacks | High availability one-tier stack | Create (with ELB) Change Type Details Change type ID ct-3w4lxdl3pqxob Standard Stacks Version April 22, 2025 685 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information High availability one-tier Stacks: Creating (with ELB) Creating a high availability one-tier stack with an ELB 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. Standard Stacks Version April 22, 2025 686 AMS Advanced Change Type Reference AMS Advanced Change Type Details To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a high availability one-tier stack with an ELB with the CLI How it works: 1. Use the Template Create method (you create two JSON files, one for the RFC parameters and |
ams-ct-193 | ams-ct.pdf | 193 | configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a high availability one-tier stack with an ELB with the CLI How it works: 1. Use the Template Create method (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 Standard Stacks Version April 22, 2025 687 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm --profile saml --region us-east-1 create-rfc --change-type-id "ct-3w4lxdl3pqxob" --change-type-version "1.0" --title 'Test - HA' --description "Test Stack" --execution-parameters "{\"Description\":\"DESCRIPTION\",\"VpcId \":\"VPC_ID\",\"Name\":\"TestStack\",\"StackTemplateId\":\"stm-g7rc538l62r4c23nb \",\"TimeoutInMinutes\":60,\"AutoScaling\":{\"AmiId\":\"AMI_ID\",\"SubnetIds\": [\"SUBNET_ID\"]},\"LoadBalancer\":{\"SecurityGroups\":\"SG_ID\",\"SubnetIds\": [\"SUBNET_ID\"]},\"Listener1\":{\"Port\":\"443\",\"Protocol\":\"HTTPS\",\"InstancePort \":\"443\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file in your current folder; this example names it CreateOnetierElbStackParams.json. aws amscm get-change-type-version --change-type-id "ct-3w4lxdl3pqxob" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateOnetierElbStackParams.json 2. Modify the schema, replacing the variables as appropriate. { "Description" : "DESCRIPTION", "VpcId" : "VPC_ID", "Name" : "TestStack", Standard Stacks Version April 22, 2025 688 AMS Advanced Change Type Reference AMS Advanced Change Type Details "StackTemplateId" : "stm-g7rc538l62r4c23nb", "TimeoutInMinutes" : 60, "AutoScaling" : { "AmiId" : "AMI_ID", "SubnetIds": ["SUBNET_ID"] }, "LoadBalancer" : { "SecurityGroups" : "SG_ID", "SubnetIds" : ["SUBNET_ID"] }, "Listener1" : { "Port" : "443", "Protocol" : "HTTPS", "InstancePort" : "443" } } 3. Output the CreateRfc JSON template to a file in your current folder; example names it CreateOnetierElbStackRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateOnetierElbStackRfc.json 4. Modify the RFC template as appropriate and save it. Reset the start and end times for a scheduled RFC, or leave off for an ASAP RFC. { "ChangeTypeVersion": 1.0", "ChangeTypeId": "ct-3w4lxdl3pqxob", "Title": "HA-One-Tier-ELB-RFC", "RequestedStartTime": "2019-04-28T22:45:00Z", "RequestedEndTime": "2019-04-28T22:45:00Z" } 5. Create the RFC, specifying the CreateOnetierElbStackRfc.json file and the CreateOnetierElbStackParams.json execution parameters file: aws amscm create-rfc --cli-input-json file://CreateOnetierElbStackRfc.json -- execution-parameters file://CreateOnetierElbStackParams.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. Standard Stacks Version April 22, 2025 689 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note This is a large provisioning of resources, especially if you add UserData. The load balancer Amazon Resource Name (ARN) can be found through the Load Balancer page of the EC2 console by searching with the load balancer stack ID returned in the RFC execution output. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3w4lxdl3pqxob. Example: Required Parameters { "Description" : "Test description", "VpcId" : "vpc-12345678901234567", "Name" : "TestStack", "StackTemplateId" : "stm-g7rc538l62r4c23nb", "TimeoutInMinutes" : 60, "AutoScaling" : { "AmiId" : "ami-12345678901234567", "SubnetIds": ["subnet-12345678"] }, "LoadBalancer" : { "SecurityGroups" : "sg-12345678901234567", "SubnetIds" : ["subnet-12345678901234567"] }, "Listener1" : { "Port" : "443", "Protocol" : "HTTPS", "InstancePort" : "443" } } Example: All Parameters { "Description" : "Test description", "VpcId" : "vpc-12345678", Standard Stacks Version April 22, 2025 690 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Name" : "TestStack", "Tags" : [ { "Key" : "foo", "Value" : "bar" } ], "StackTemplateId" : "stm-g7rc538l62r4c23nb", "TimeoutInMinutes" : 60, "AutoScaling" : { "AmiId" : "ami-12345678", "InstanceType" : "m4.large", "RootVolumeIops" : "100", "RootVolumeName" : "/dev/xvda", "RootVolumeSize" : 100, "RootVolumeType" : "gp2", "EBSOptimized" : "false", "MaxInstances" : "1", "MinInstances" : "2", "IAMInstanceProfile" : "customer-mc-ec2-instance-profile", "SubnetIds": ["subnet-12345678"], "UserData": ["touch /tmp/test.out"], "MaxBatchSize" : 1, "MinInstancesInService" : 1, "HealthCheckType" : "EC2", "HealthCheckGracePeriod" : "600", "DetailedMonitoring" : "true", "Cooldown" : "300", "ScaleMetricName" : "CPUUtilization", "ScaleUpPolicyCooldown" : "60", "ScaleUpPolicyEvaluationPeriods" : "2", "ScaleUpPolicyPeriod" : "60", "ScaleUpPolicyScalingAdjustment" : "2", "ScaleUpPolicyStatistic" : "Average", "ScaleUpPolicyThreshold" : "75", "ScaleDownPolicyCooldown" : |
ams-ct-194 | ams-ct.pdf | 194 | "Name" : "TestStack", "Tags" : [ { "Key" : "foo", "Value" : "bar" } ], "StackTemplateId" : "stm-g7rc538l62r4c23nb", "TimeoutInMinutes" : 60, "AutoScaling" : { "AmiId" : "ami-12345678", "InstanceType" : "m4.large", "RootVolumeIops" : "100", "RootVolumeName" : "/dev/xvda", "RootVolumeSize" : 100, "RootVolumeType" : "gp2", "EBSOptimized" : "false", "MaxInstances" : "1", "MinInstances" : "2", "IAMInstanceProfile" : "customer-mc-ec2-instance-profile", "SubnetIds": ["subnet-12345678"], "UserData": ["touch /tmp/test.out"], "MaxBatchSize" : 1, "MinInstancesInService" : 1, "HealthCheckType" : "EC2", "HealthCheckGracePeriod" : "600", "DetailedMonitoring" : "true", "Cooldown" : "300", "ScaleMetricName" : "CPUUtilization", "ScaleUpPolicyCooldown" : "60", "ScaleUpPolicyEvaluationPeriods" : "2", "ScaleUpPolicyPeriod" : "60", "ScaleUpPolicyScalingAdjustment" : "2", "ScaleUpPolicyStatistic" : "Average", "ScaleUpPolicyThreshold" : "75", "ScaleDownPolicyCooldown" : "300", "ScaleDownPolicyEvaluationPeriods" : "4", "ScaleDownPolicyPeriod" : "60", "ScaleDownPolicyScalingAdjustment" : "-1", "ScaleDownPolicyStatistic" : "Average", "ScaleDownPolicyThreshold" : "35" }, "LoadBalancer" : { "Name" : "testLoadBalancer", Standard Stacks Version April 22, 2025 691 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Public" : "false", "SecurityGroups" : "sg-12345678", "SubnetIds" : ["subnet-12345678"], "AccessLogInterval" : "60", "ConnectionDrainingTimeout" : 60, "IdleTimeout" : 60, "CrossZone" : "true", "HealthCheckHealthyThreshold" : "2", "HealthCheckInterval" : "10", "HealthCheckTarget" : "TCP:80", "HealthCheckTimeout" : "5", "HealthCheckUnhealthyThreshold" : "10", "LBCookieExpirationPeriod" : "2", "LBCookieStickinessPolicyName" : "LBCOOKIE", "AppCookieName": "APPCookie", "AppCookiePolicyName": "AppCookiePolicy" }, "Listener1" : { "InstancePort" : "80", "InstanceProtocol" : "HTTP", "Port" : "443", "Protocol" : "HTTPS", "SSLCertificateId" : "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" }, "Listener2" : { "InstancePort" : "8080", "InstanceProtocol" : "HTTP", "Port" : "8443", "Protocol" : "HTTPS", "SSLCertificateId" : "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" } } High Availability Two-Tier Stack | Create Creates a stack consisting of an Auto Scaling group, an RDS DB instance, and a load balancer (ELB). Optionally allows for application deployment with CodeDeploy by also creating a CodeDeploy application and deployment group both named the value given for ApplicationName. All resource parameters can be configured. Full classification: Deployment | Standard stacks | High availability two-tier stack | Create Standard Stacks Version April 22, 2025 692 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-06mjngx5flwto Current version 3.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create high availability two-tier stacks Creating a high availability two-tier stack 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. Standard Stacks Version April 22, 2025 693 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a high availability two-tier stack with the CLI How it works: 1. Use the Template Create method (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. Standard Stacks Version April 22, 2025 694 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 |
ams-ct-195 | ams-ct.pdf | 195 | the Template Create method (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. Standard Stacks Version April 22, 2025 694 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. TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file in your current folder; this example names it Create2tierStackParams.json. aws amscm get-change-type-version --change-type-id "ct-06mjngx5flwto" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > Create2tierStackParams.json 2. Modify the schema, replacing the variables as appropriate. { "Description": "HA two tier stack", "Name": "Two-Tier-Stack", "TimeoutInMinutes": 360, "VpcId": "VPC-ID", "AutoScalingGroup": { "AmiId": "AMI-ID", "SubnetIds": [ "Subnet-ID", "Subnet-ID" ] }, "Database": { "DBName": "DB_Name", "DBEngine": "postgres", Standard Stacks Version April 22, 2025 695 AMS Advanced Change Type Reference AMS Advanced Change Type Details "EngineVersion": "9.6.3", "LicenseModel": "postgresql-license", "MasterUsername": "masterusername", "SubnetIds": [ "Subnet-ID", "Subnet-ID" ] }, "LoadBalancer": { "SubnetIds": [ "Subnet-ID", "Subnet-ID" ] } } 3. Output the CreateRfc JSON template to a file in your current folder; example names it Create2tierStackRfc.json: aws amscm create-rfc --generate-cli-skeleton > Create2tierStackRfc.json 4. Modify the RFC template as appropriate and save it. Reset the start and end times for a scheduled RFC, or leave off for an ASAP RFC. { "ChangeTypeVersion": 3.0", "ChangeTypeId": "ct-06mjngx5flwto", "Title": "HA-2-Tier-RFC", "RequestedStartTime": "2019-04-28T22:45:00Z", "RequestedEndTime": "2019-04-28T22:45:00Z" } 5. Create the RFC, specifying the Create2tierStackRfc.json file and the Create2tierStackParams.json execution parameters file: aws amscm create-rfc --cli-input-json file://Create2tierStackRfc.json --execution- parameters file://Create2tierStackParams.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. Standard Stacks Version April 22, 2025 696 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note This is a large provisioning of resources, especially if you add UserData. The load balancer Amazon resource name (ARN) can be found through the Load Balancer page of the EC2 console by searching with the load balancer stack ID returned in the RFC execution output. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-06mjngx5flwto. Example: Required Parameters { "Description": "My stack", "TimeoutInMinutes": 60, "VpcId": "vpc-01234567890abcdef", "Name": "MyStack", "AutoScalingGroup": { "AmiId" : "ami-01234567890abcdef", "SubnetIds": ["subnet-01234567890abcdef", "subnet-01234567891abcdef"] }, "LoadBalancer": { "SubnetIds": ["subnet-01234567890abcdef", "subnet-01234567891abcdef"] }, "Database": { "DBName": "main", "DBEngine": "MySQL", "EngineVersion": "4.5.6", "LicenseModel": "general-public-license", "MasterUsername": "admin", "MasterUserPassword": "adminpass", "SubnetIds": ["subnet-01234567890abcdef", "subnet-01234567891abcdef"] } } Example: All Parameters { Standard Stacks Version April 22, 2025 697 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description": "My stack", "VpcId": "vpc-12345678", "TimeoutInMinutes": 60, "Name": "MyStack", "Tags": [ { "Key": "Foo", "Value": "Bar" } ], "AutoScalingGroup": { "AmiId": "ami-12341234", "Cooldown": 120, "DesiredCapacity": 1, "EBSOptimized": false, "HealthCheckGracePeriod": 600, "IAMInstanceProfile": "foo", "InstanceDetailedMonitoring": true, "InstanceRootVolumeIops": 0, "InstanceRootVolumeName": "/dev/xvda", "InstanceRootVolumeSize": 30, "InstanceRootVolumeType": "gp2", "InstanceType": "m3.medium", "MaxInstances": 1, "MinInstances": 1, "ScaleDownPolicyCooldown": 300, "ScaleDownPolicyEvaluationPeriods": 4, "ScaleDownPolicyPeriod": 60, "ScaleDownPolicyScalingAdjustment": -1, "ScaleDownPolicyStatistic": "Average", "ScaleDownPolicyThreshold": 35, "ScaleMetricName": "CPUUtilization", "ScaleUpPolicyCooldown": 60, "ScaleUpPolicyEvaluationPeriods": 2, "ScaleUpPolicyPeriod": 60, "ScaleUpPolicyScalingAdjustment": 2, "ScaleUpPolicyStatistic": "Average", "ScaleUpPolicyThreshold": 75, "SubnetIds": ["subnet-a0b1c2d3", "subnet-e4f5g6h7"], "UserData": ["#!/bin/bash","echo hello"] }, "LoadBalancer": { "SubnetIds": ["subnet-a0b1c2d3", "subnet-a0b2c9d8"], "HealthCheckInterval": 10, Standard Stacks Version April 22, 2025 698 AMS Advanced Change Type Reference AMS Advanced Change Type Details "HealthCheckTarget": "HTTP:80/index.html", "HealthCheckTimeout": 10, "Public": false, "AccessCIDRRange": "1.2.3.4/0" }, "Database": { "AllocatedStorage": 100, "BackupRetentionPeriod": 7, "Backups": true, "DBEngine": "postgres", "DBName": "my_db", "EngineVersion": "9.5.2", "InstanceType": "db.m3.medium", "IOPS": 0, "LicenseModel": "postgresql-license", "MasterUsername": "myadminuser", "MasterUserPassword": "!#$%&')*+,-.0:;=>?AZ[\\^_`a{|~", "MultiAZ": false, "Port": 5432, "PreferredBackupWindow": "22:00-23:00", "PreferredMaintenanceWindow": "wed:03:32-wed:04:02", "StorageEncrypted": false, "StorageType": "gp2", "SubnetIds": ["subnet-a0b1c2d3", "subnet-a0b2c9d8"] }, "Application": { "ApplicationName": "MyApplication", "DeploymentConfigName": "CodeDeployDefault.OneAtATime" }, "EnforceIMDSv2": "optional" } Management Category Change Type Subcategories in the Management Category • Access Subcategory • Advanced Stack Components Subcategory • AMS Resource Scheduler Subcategory • Applications Subcategory • AWS Backup Subcategory Management Version April 22, 2025 699 AMS Advanced Change Type Reference AMS Advanced Change Type Details • AWS Service Subcategory • Custom Stack Subcategory • Directory Service Subcategory • Host Security Subcategory • Managed Account Subcategory • Managed Firewall Subcategory • Managed Landing Zone Subcategory • Monitoring and Notification Subcategory • Other Subcategory • Patching Subcategory • Standalone Resources Subcategory • Standard Stacks Subcategory • Trusted Remediator Subcategory |
ams-ct-196 | ams-ct.pdf | 196 | "EnforceIMDSv2": "optional" } Management Category Change Type Subcategories in the Management Category • Access Subcategory • Advanced Stack Components Subcategory • AMS Resource Scheduler Subcategory • Applications Subcategory • AWS Backup Subcategory Management Version April 22, 2025 699 AMS Advanced Change Type Reference AMS Advanced Change Type Details • AWS Service Subcategory • Custom Stack Subcategory • Directory Service Subcategory • Host Security Subcategory • Managed Account Subcategory • Managed Firewall Subcategory • Managed Landing Zone Subcategory • Monitoring and Notification Subcategory • Other Subcategory • Patching Subcategory • Standalone Resources Subcategory • Standard Stacks Subcategory • Trusted Remediator Subcategory Access Subcategory Change Type Items and Operations in the Access Subcategory • Stack Admin Access | Grant • Stack Admin Access | Update • Stack Read-Only Access | Grant • Stack Read-Only Access | Update Stack Admin Access | Grant Request admin access for one or more users for one or more stacks. The maximum access time is 12 hours. Full classification: Management | Access | Stack admin access | Grant Change Type Details Change type ID ct-1dmlg9g1l91h6 Access Version April 22, 2025 700 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 3.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Request administrative access Requesting administrator access 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. Access Version April 22, 2025 701 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. Requesting administrator access with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. 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 Access Version April 22, 2025 702 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml amscm create-rfc --change-type-id "ct-1dmlg9g1l91h6" --change-type- version "3.0" --title "Stack-Admin-Access-QC" |
ams-ct-197 | ams-ct.pdf | 197 | schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml amscm create-rfc --change-type-id "ct-1dmlg9g1l91h6" --change-type- version "3.0" --title "Stack-Admin-Access-QC" --execution-parameters "{\"DomainFQDN \":\"TEST.com\",\"StackIds\":[\"stack-01234567890abcdef\"],\"TimeRequestedInHours\":1, \"Usernames\":[\"TEST\"],\"VpcId\":\"VPC_ID\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it GrantAdminAccessParams.json: aws amscm get-change-type-version --change-type-id "ct-1dmlg9g1l91h6" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > GrantAdminAccessParams.json Modify and save the GrantAdminAccessParams file. For example, you can replace the contents with something like this: { "DomainFQDN": "mycorpdomain.acme.com", "StackIds": [STACK_ID, STACK_ID], "TimeRequestedInHours": 12, "Username": ["USERNAME", "USERNAME"], "VpcId": "VPC_ID" Access Version April 22, 2025 703 AMS Advanced Change Type Reference AMS Advanced Change Type Details } Note that the TimeRequestedInHours option defaults to one hour. You can request up to twelve hours. 2. Output the RFC template to a file in your current folder; this example names it GrantAdminAccessRfc.json: aws amscm create-rfc --generate-cli-skeleton > GrantAdminAccessRfc.json 3. Modify and save the GrantAdminAccessRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1dmlg9g1l91h6", "ChangeTypeVersion": "3.0", "Title": "Request-Admin-Access-to-EC2-RFC" } 4. Create the RFC, specifying the GrantAdminAccessRfc file and the GrantAdminAcessParams file: aws amscm create-rfc --cli-input-json file://GrantAdminAccessRfc.json --execution- parameters file://GrantAdminAccessParams.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. To log in to the instance through a bastion, follow the next procedure, Instance access examples. Tips Note You can submit an update to your access request before it expires. For information, see Stack Admin Access | Update. To log in to an instance that is part of an ASG, you request access to the ASG stack, which gives you access to all associated instances. Access Version April 22, 2025 704 AMS Advanced Change Type Reference AMS Advanced Change Type Details For an example about requesting ReadOnly access, see ReadOnly access: requesting. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1dmlg9g1l91h6. Example: Required Parameters { "DomainFQDN": "test.domain.com", "StackIds": ["stack-12345678901234567"], "Usernames": ["AD_User_Name1"], "VpcId": "vpc-12345678" } Example: All Parameters { "DomainFQDN": "test.domain.com", "StackIds": ["stack-12345678901234567"], "TimeRequestedInHours": 1, "Usernames": ["AD_User_Name1"], "VpcId": "vpc-12345678" } Stack Admin Access | Update Update admin access for one or more users for one or more stacks. The maximum access time is 12 hours. Full classification: Management | Access | Stack admin access | Update Change Type Details Change type ID ct-0ikpop8zqhkxg Current version 3.0 Expected execution duration 60 minutes Access Version April 22, 2025 705 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update administrative access Updating administrator access 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. Access Version April 22, 2025 706 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 |
ams-ct-198 | ams-ct.pdf | 198 | 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 administrator access with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. 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 Access Version April 22, 2025 707 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 --profile saml amscm create-rfc --change-type-id "ct-0ikpop8zqhkxg" --change-type- version "3.0" --title "Stack-Admin-Update-QC" --execution-parameters "{\"DomainFQDN \":\"TEST.com\",\"StackIds\":[\"stack-01234567890abcdef\"],\"TimeRequestedInHours\":1, \"Usernames\":[\"TEST\"],\"VpcId\":\"VPC_ID\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UpdateAdminAccessParams.json: aws amscm get-change-type-version --change-type-id "ct-0ikpop8zqhkxg" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateAdminAccessParams.json Modify and save the UpdateAdminAccessParams file. For example, you can replace the contents with something like this: { "DomainFQDN": "mycorpdomain.acme.com", "StackIds": [STACK_ID, STACK_ID], "TimeRequestedInHours": 12, "Usernames": ["USERNAME", "USERNAME"], "VpcId": "VPC_ID" } Note that the TimeRequestedInHours option defaults to one hour. You can request up to twelve hours. Access Version April 22, 2025 708 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Output the RFC template to a file in your current folder; this example names it UpdateAdminAccessRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateAdminAccessRfc.json 3. Modify and save the UpdateAdminAccessRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-0ikpop8zqhkxg", "ChangeTypeVersion": "3.0", "Title": "Update-Admin-Access-to-EC2-RFC" } 4. Create the RFC, specifying the UpdateAdminAccessRfc file and the UpdateAdminAcessParams file: aws amscm create-rfc --cli-input-json file://UpdateAdminAccessRfc.json --execution- parameters file://UpdateAdminAccessParams.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. To log in to the instance through a bastion, follow the next procedure, Instance access examples. Tips Note To log in to an instance that is part of an EC2 Auto Scaling group (ASG), you request access to the ASG stack, which gives you access to all associated instances. For a walkthrough on updating ReadOnly access, see ReadOnly Access: updating. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0ikpop8zqhkxg. Access Version April 22, 2025 709 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "DomainFQDN": "test.domain.com", "StackIds": ["stack-12345678901234567"], "Usernames": ["AD_User_Name1"], "VpcId": "vpc-12345678" } Example: All Parameters { "DomainFQDN": "test.domain.com", "StackIds": ["stack-12345678901234567"], "TimeRequestedInHours": 1, "Usernames": ["AD_User_Name1"], "VpcId": "vpc-12345678" } Stack Read-Only Access | Grant Request Read-Only access for one or more users for one or more stacks. The maximum access time is 12 hours. Full classification: Management | Access | Stack read-only access | Grant Change Type Details Change type ID ct-199h35t7uz6jl Current version 3.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Access Version April 22, 2025 710 AMS Advanced |
ams-ct-199 | ams-ct.pdf | 199 | Change Type Details Example: Required Parameters { "DomainFQDN": "test.domain.com", "StackIds": ["stack-12345678901234567"], "Usernames": ["AD_User_Name1"], "VpcId": "vpc-12345678" } Example: All Parameters { "DomainFQDN": "test.domain.com", "StackIds": ["stack-12345678901234567"], "TimeRequestedInHours": 1, "Usernames": ["AD_User_Name1"], "VpcId": "vpc-12345678" } Stack Read-Only Access | Grant Request Read-Only access for one or more users for one or more stacks. The maximum access time is 12 hours. Full classification: Management | Access | Stack read-only access | Grant Change Type Details Change type ID ct-199h35t7uz6jl Current version 3.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Access Version April 22, 2025 710 AMS Advanced Change Type Reference Additional Information Request ReadOnly access Requesting ReadOnly access 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. Access Version April 22, 2025 711 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. Requesting ReadOnly access with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. 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 Access Version April 22, 2025 712 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 --profile saml amscm create-rfc --change-type-id "ct-199h35t7uz6jl" --change-type- version "3.0" --title "Stack-RO-Access-QC" --execution-parameters "{\"DomainFQDN\": \"TEST.com\",\"StackIds\":[\"stack-01234567890abcdef\"],\"TimeRequestedInHours\":1, \"Usernames\":[\"TEST\"],\"VpcId\":\"VPC_ID\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it GrantReadOnlyAccessParams.json: aws amscm get-change-type-version --change-type-id "ct-199h35t7uz6jl" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > GrantReadOnlyAccessParams.json Modify and save the GrantReadOnlyAccessParams file. For example, you can replace the contents with something like this: { "DomainFQDN": "mycorpdomain.acme.com", "StackIds": [STACK_ID, STACK_ID], "TimeRequestedInHours": 12, "Usernames": ["USERNAME", "USERNAME"], "VpcId": "VPC_ID" } Note that the TimeRequestedInHours option defaults to one hour. You can request up to twelve hours. 2. Output the RFC template to a file in your current folder; this example names it GrantReadOnlyAccessRfc.json: Access Version April 22, 2025 |
ams-ct-200 | ams-ct.pdf | 200 | CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it GrantReadOnlyAccessParams.json: aws amscm get-change-type-version --change-type-id "ct-199h35t7uz6jl" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > GrantReadOnlyAccessParams.json Modify and save the GrantReadOnlyAccessParams file. For example, you can replace the contents with something like this: { "DomainFQDN": "mycorpdomain.acme.com", "StackIds": [STACK_ID, STACK_ID], "TimeRequestedInHours": 12, "Usernames": ["USERNAME", "USERNAME"], "VpcId": "VPC_ID" } Note that the TimeRequestedInHours option defaults to one hour. You can request up to twelve hours. 2. Output the RFC template to a file in your current folder; this example names it GrantReadOnlyAccessRfc.json: Access Version April 22, 2025 713 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > GrantReadOnlyAccessRfc.json 3. Modify and save the GrantReadOnlyAccessRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-199h35t7uz6jl", "ChangeTypeVersion": "3.0", "Title": "Request-ReadOnly-Access-to-EC2-RFC" } 4. Create the RFC, specifying the GrantReadOnlyAccessRfc file and the GrantReadOnlyAcessParams file: aws amscm create-rfc --cli-input-json file://GrantReadOnlyAccessRfc.json -- execution-parameters file://GrantReadOnlyAccessParams.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. To log in to the instance through a bastion, follow the next procedure, Instance access examples. Tips Note You can submit an update to your access request before it expires. For details, see Stack Read-Only Access | Update. To log into an instance that is part of an EC2 Auto Scaling group (ASG), you request access to the ASG stack, which gives you access to all associated instances. For a walkthrough on requesting Admin access, see Admin Access: requesting. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-199h35t7uz6jl. Access Version April 22, 2025 714 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "DomainFQDN": "test.domain.com", "StackIds": ["stack-12345678901234567"], "Usernames": ["AD_User_Name1"], "VpcId": "vpc-12345678" } Example: All Parameters { "DomainFQDN": "test.domain.com", "StackIds": ["stack-12345678901234567"], "TimeRequestedInHours": 1, "Usernames": ["AD_User_Name1"], "VpcId": "vpc-12345678" } Stack Read-Only Access | Update Update read only access for one or more users for one or more stacks. The maximum access time is 12 hours. Full classification: Management | Access | Stack read-only access | Update Change Type Details Change type ID ct-3kh1wiizlne1i Current version 3.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Access Version April 22, 2025 715 AMS Advanced Change Type Reference Additional Information Update ReadOnly access Updating ReadOnly access 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. Access Version April 22, 2025 716 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 ReadOnly access with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template |
ams-ct-201 | ams-ct.pdf | 201 | 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 ReadOnly access with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. 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 Access Version April 22, 2025 717 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 --profile saml amscm create-rfc --change-type-id "ct-3kh1wiizlne1i" --change-type- version "3.0" --title "Stack-RO-Update-QC" --execution-parameters "{\"DomainFQDN\": \"TEST.com\",\"StackIds\":[\"stack-01234567890abcdef\"],\"TimeRequestedInHours\":1, \"Usernames\":[\"TEST\"],\"VpcId\":\"VPC_ID\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UpdateReadOnlyAccessParams.json: aws amscm get-change-type-version --change-type-id "ct-3kh1wiizlne1i" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateReadOnlyAccessParams.json Modify and save the UpdateReadOnlyAccessParams.json file. For example, you can replace the contents with something like this: { "DomainFQDN": "mycorpdomain.acme.com", "StackIds": [STACK_ID, STACK_ID], "TimeRequestedInHours": 12, "Usernames": ["USERNAME", "USERNAME"], "VpcId": "VPC_ID" } Note that the TimeRequestedInHours option defaults to one hour. You may request up to twelve hours. 2. Output the RFC template to a file in your current folder; this example names it UpdateReadOnlyAccessRfc.json: Access Version April 22, 2025 718 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > UpdateReadOnlyAccessRfc.json 3. Modify and save the UpdateReadOnlyAccessRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-3kh1wiizlne1i", "ChangeTypeVersion": "3.0", "Title": "Update-ReadOnly-Access-to-EC2-RFC" } 4. Create the RFC, specifying the UpdateReadOnlyAccessRfc file and the UpdateReadOnlyAcessParams file: aws amscm create-rfc --cli-input-json file://UpdateReadOnlyAccessRfc.json -- execution-parameters file://UpdateReadOnlyAccessParams.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. To log in to the instance through a bastion, follow the next procedure, Instance access examples. Tips For an example about updating Admin access, see Admin access: updating. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3kh1wiizlne1i. Example: Required Parameters { "DomainFQDN": "test.domain.com", "StackIds": ["stack-12345678901234567"], "Usernames": ["AD_User_Name1"], "VpcId": "vpc-12345678" } Access Version April 22, 2025 719 AMS Advanced Change Type Details AMS Advanced Change Type Reference Example: All Parameters { "DomainFQDN": "test.domain.com", "StackIds": ["stack-12345678901234567"], "TimeRequestedInHours": 1, "Usernames": ["AD_User_Name1"], "VpcId": "vpc-12345678" } Advanced Stack Components Subcategory Change Type Items and Operations in the Advanced Stack Components Subcategory • ACM | Delete Certificate • AMI | Deregister • AMI | Encrypt • AMI | Share • Application Load Balancer | Add Listener Certificate • Application Load Balancer | Remove Listener Certificate • Application Load Balancer | Update • Auto Scaling Group | Update • Bastions | Add CIDR Ingress (Review Required) • Bastions | Update Instance or Session Counts (Review Required) • Bastions | Update Instance Size (Review Required) • Database Migration Service (DMS) | Start Replication Task • Database Migration Service (DMS) | Stop Replication Task • Directory Service | Accept Sharing • DNS (Private) | Update • DNS (Public) | Update • EBS Snapshot | Archive • EBS Snapshot | Delete • EBS Snapshot | Delete (Review Required) • EBS Snapshot | Share Advanced Stack Components Version April 22, 2025 720 AMS Advanced Change Type Reference AMS Advanced Change Type Details • EBS Volume | Attach • EBS Volume | Delete • EBS Volume | Detach • EBS Volume | Encrypt EBS By Default • EBS Volume | Modify • EBS Volume | Update • EC2 Instance Stack | Associate Private IP Addresses (Review |
ams-ct-202 | ams-ct.pdf | 202 | Task • Directory Service | Accept Sharing • DNS (Private) | Update • DNS (Public) | Update • EBS Snapshot | Archive • EBS Snapshot | Delete • EBS Snapshot | Delete (Review Required) • EBS Snapshot | Share Advanced Stack Components Version April 22, 2025 720 AMS Advanced Change Type Reference AMS Advanced Change Type Details • EBS Volume | Attach • EBS Volume | Delete • EBS Volume | Detach • EBS Volume | Encrypt EBS By Default • EBS Volume | Modify • EBS Volume | Update • EC2 Instance Stack | Associate Private IP Addresses (Review Required) • EC2 Instance Stack | Change Hostname (Linux) • EC2 Instance Stack | Change Hostname (Windows) • EC2 Instance Stack | Change Time Zone • EC2 Instance Stack | Enable Detailed Monitoring (Review Required) • EC2 Instance Stack | Encrypt Instance Volumes • EC2 Instance Stack | Gather Log4j Information • EC2 Instance Stack | Reboot • EC2 Instance Stack | Replace Instance Profile • EC2 Instance Stack | Resize • EC2 Instance Stack | Restore Volumes • EC2 Instance Stack | Start • EC2 Instance Stack | Stop • EC2 Instance Stack | Update • EC2 Instance Stack | Update (With Additional Volumes) • EC2 Instance Stack | Update DeleteOnTermination (Review Required) • EC2 Instance Stack | Update Instance Detailed Monitoring • EC2 Instance Stack | Update Termination Protection • Identity and Access Management (IAM) | Delete Account Alias • Identity and Access Management (IAM) | Delete Entity or Policy (Read-Write Permissions) • Identity and Access Management (IAM) | Delete Entity or Policy (Review Required) • Identity and Access Management (IAM) | Delete or Deactivate Access Key • Identity and Access Management (IAM) | Delete SAML Identity Provider • Identity and Access Management (IAM) | Reset Service-Specific Credentials Advanced Stack Components Version April 22, 2025 721 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Identity and Access Management (IAM) | Update Account Alias • Identity and Access Management (IAM) | Update Entity or Policy (Read-Write Permissions) • Identity and Access Management (IAM) | Update Entity or Policy (Review Required) • Identity and Access Management (IAM) | Update MaxSessionDuration • Identity and Access Management (IAM) | Update SAML Identity Provider • KMS Alias | Delete • KMS Key | Delete (Review Required) • KMS Key | Enable Rotation • KMS Key | Share (Review Required) • KMS Key | Update (Review Required) • Load Balancer (ELB) Stack | Replace Listener Certificate • Load Balancer (ELB) Stack | Update • Network Load Balancer | Add Listener Certificate • Network Load Balancer | Remove Listener Certificate • Network Load Balancer | Update • RDS Database Stack | Reboot • RDS Database Stack | Restore To Point In Time • RDS Database Stack | Rotate DB Certificate • RDS Database Stack | Start Aurora Cluster • RDS Database Stack | Start DB Instance • RDS Database Stack | Stop Aurora Cluster • RDS Database Stack | Stop DB Instance • RDS Database Stack | Update • RDS Database Stack | Update (For Aurora) • RDS Database Stack | Update Deletion Protection • RDS Database Stack | Update Enhanced Monitoring • RDS Database Stack | Update Instance Type • RDS Database Stack | Update Maintenance Window (Review Required) • RDS Database Stack | Update Master User Password • RDS Database Stack | Update MultiAZ Setting Advanced Stack Components Version April 22, 2025 722 AMS Advanced Change Type Reference AMS Advanced Change Type Details • RDS Database Stack | Update Performance Insights (Review Required) • RDS Database Stack | Update Storage • RDS Snapshot | Delete • RDS Snapshot | Share • Redshift | Pause Cluster • Redshift | Resume Cluster • Route 53 Resolver | Associate VPC With Resolver Rule • Route 53 Resolver | Disassociate Resolver Rules from VPC • S3 Storage | Add Event Notification • S3 Storage | Add Replication Rule • S3 Storage | Delete Policy (Review Required) • S3 Storage | Manage Lifecycle Configuration • S3 Storage | Receive Replication Replica • S3 Storage | Update • S3 Storage | Update Encryption • S3 Storage | Update Policy (Review Required) • S3 Storage | Update Versioning • Security Group | Associate • Security Group | Authorize Egress Rule • Security Group | Authorize Ingress Rule • Security Group | Delete • Security Group | Delete (Review Required) • Security Group | Disassociate • Security Group | Revoke Egress Rule • Security Group | Revoke Ingress Rule • Security Group | Update (Review Required) • Stack | Delete • Stack Patching Configuration | Update • Tag | Bulk Update • Tag | Bulk Update (Review Required) Advanced Stack Components Version April 22, 2025 723 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Tag |
ams-ct-203 | ams-ct.pdf | 203 | Versioning • Security Group | Associate • Security Group | Authorize Egress Rule • Security Group | Authorize Ingress Rule • Security Group | Delete • Security Group | Delete (Review Required) • Security Group | Disassociate • Security Group | Revoke Egress Rule • Security Group | Revoke Ingress Rule • Security Group | Update (Review Required) • Stack | Delete • Stack Patching Configuration | Update • Tag | Bulk Update • Tag | Bulk Update (Review Required) Advanced Stack Components Version April 22, 2025 723 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Tag | Delete • Tag | Delete (Review Required) • Tag | Update • Tag | Update (Review Required) • Target Group | Attach Instances • Target Group | Detach Instances • Target Group | Update (For ALB) • Target Group | Update (For NLB) ACM | Delete Certificate Delete an AWS Certificate Manager (ACM) certificate that is currently not in use and not managed by AMS. Full classification: Management | Advanced stack components | ACM | Delete certificate Change Type Details Change type ID ct-1q8q56cmwqj9m Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Delete ACM certificate Deleting an ACM with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 724 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Advanced Stack Components Version April 22, 2025 725 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 an ACM certificate with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 726 AMS Advanced Change Type Reference AMS Advanced Change Type |
ams-ct-204 | ams-ct.pdf | 204 | type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 726 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-1q8q56cmwqj9m" --change-type-version "1.0" --title "Delete an ACM Certificate" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-DeleteACMCertificate\",\"Region\": \"us-east-1\",\"Parameters \": {\"CertificateARN\": [\"arn:aws:acm:us-east-1:123456789012:certificate/c96c73cd- d082-4fa9-bbf2-09d8600d84ad\"]}}" TEMPLATE CREATE: 1. Save the execution parameters to a JSON file named DeleteCertificateParameters.json. { "DocumentName": "AWSManagedServices-DeleteACMCertificate", "Region": "us-east-1", "Parameters": { "CertificateARN": [ "arn:aws:acm:us-east-1:123456789012:certificate/c96c73cd-d082-4fa9- bbf2-09d8600d84ad" ] } } 2. Output the RFC template to a file in your current folder; this example names it DeleteCertificateRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteCertificateRfc.json 3. Modify and save the DeleteCertificateRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1q8q56cmwqj9m", "ChangeTypeVersion": "1.0", "Title": "Delete an ACM Certificate" } 4. Create the RFC, specifying the CreateAcmRfc file and the CreateAcmParams file: aws amscm create-rfc --cli-input-json file://DeleteCertificateRfc.json -- execution-parameters file://DeleteCertificateParams.json Advanced Stack Components Version April 22, 2025 727 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 To learn more about ACM certificates, see What Is AWS Certificate Manager? and ACM Certificate Characteristics. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1q8q56cmwqj9m. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName" : "AWSManagedServices-DeleteACMCertificate", "Region" : "us-east-1", "Parameters": { "CertificateARN": ["arn:aws:acm:us- east-1:111111111111:certificate/1111aaaa-11aa-11aa-11aa-111111aaaaaa"] } } AMI | Deregister Deregister one or multiple Amazon Machine Images (AMI)s and optionally delete all associated snapshots. Once deregistered the AMI or AMIs can't be used for launching new instances. Full classification: Management | Advanced stack components | AMI | Deregister Change Type Details Change type ID ct-26vhhlj9jmlpf Advanced Stack Components Version April 22, 2025 728 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Delete or deregister multiple AMIs Deregistering AMIs 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. Advanced Stack Components Version April 22, 2025 729 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. Deregistering AMIs 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 |
ams-ct-205 | ams-ct.pdf | 205 | 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. Deregistering AMIs with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Advanced Stack Components Version April 22, 2025 730 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc \ --change-type-id "ct-26vhhlj9jmlpf" \ --change-type-version "2.0" --title "Deregister multiple AMIs" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- BulkDeleteOrDeregisterAMI\",\"Region\":\"us-east-1\",\"Parameters\":{\"ImageIds\": [\"ami-0acd76831a2016e19\",\"ami-08a711de1cfa05910\"],\"DeleteSnapshots\":[false]}}" Note To delete instead of deregister, change the value of DeleteSnapshots to [true]. TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DeregisterAmiParams.json: aws amscm get-change-type-version --change-type-id "ct-26vhhlj9jmlpf" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeregisterAmiParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 731 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "DocumentName": "AWSManagedServices-BulkDeleteOrDeregisterAMI", "Region": "us-east-1", "Parameters": { "ImageIds": [ "ami-0acd76831a2016e19", "ami-08a711de1cfa05910" ], "DeleteSnapshots":[false] } } 3. Output the RFC template JSON file; this example names it DeregisterAmiRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeregisterAmiRfc.json 4. Modify and save the DeregisterAmiRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-26vhhlj9jmlpf", "Title": "Deregister multiple AMIs" } 5. Create the RFC, specifying the DeregisterAmiRfc file and the DeregisterAmiParams file: aws amscm create-rfc --cli-input-json file://DeregisterAmiRfc.json --execution- parameters file://DeregisterAmiParams.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 deregistering AMIs, see Deregister your Linux AMI. Advanced Stack Components Version April 22, 2025 732 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-26vhhlj9jmlpf. Example: Required Parameters { "DocumentName": "AWSManagedServices-BulkDeleteOrDeregisterAMI", "Region": "us-east-1", "Parameters" : { "ImageIds": [ "ami-01234567891234501", "ami-01234567891234501", "ami-01234567891234501", "ami-01234567891234501", "ami-01234567891234501" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-BulkDeleteOrDeregisterAMI", "Region": "us-east-1", "Parameters" : { "ImageIds": [ "ami-01234567891234501", "ami-01234567891234501", "ami-01234567891234501", "ami-01234567891234501", "ami-01234567891234501" ], "DeleteSnapshots": [ false ] } } Advanced Stack Components Version April 22, 2025 733 AMS Advanced Change Type Reference AMS Advanced Change Type Details AMI | Encrypt Use to create a custom AMI with an encrypted EBS snapshot, which protects data at rest. When the encrypted AMI is launched, the corresponding EBS volume is encrypted. Full classification: Management | Advanced stack components | AMI | Encrypt Change Type Details Change type ID ct-3u9yd8jznb2zd Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Encrypt AMIs Encrypting an AMI with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 734 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 |
ams-ct-206 | ams-ct.pdf | 206 | console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 734 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 735 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. Encrypting an AMI with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 736 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 --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-3u9yd8jznb2zd" --change-type-version "2.0" --title "Test-AMI-Encrypt-QC" -- execution-parameters "{\"VpcId\":\"VPC_ID\", \"AmiId\":\"AMI_ID\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type; this example names it EncryptAmiParams.json: aws amscm get-change-type-version --change-type-id "ct-3u9yd8jznb2zd" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > EncryptAmiParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "VpcId": "VPC_ID", "AmiId": "AMI_ID" } 3. Output the RFC template JSON file; this example names it EncryptAmiRfc.json: aws amscm create-rfc --generate-cli-skeleton > EncryptAmiRfc.json 4. Modify and save the EncryptAmiRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-3u9yd8jznb2zd", "ChangeTypeVersion": "2.0", "Title": "AMI-Encrypt-RFC", "RequestedStartTime": "2016-12-05T14:20:00Z", "RequestedEndTime": "2016-12-05T16:20:00Z" } 5. Create the RFC, specifying the EncryptAmiRfc file and the EncryptAmiParams file: Advanced Stack Components Version April 22, 2025 737 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://EncryptAmiRfc.json --execution- parameters file://EncryptAmiParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note This change type does not support encrypting an AMI that is already encrypted. To learn more |
ams-ct-207 | ams-ct.pdf | 207 | "2.0", "Title": "AMI-Encrypt-RFC", "RequestedStartTime": "2016-12-05T14:20:00Z", "RequestedEndTime": "2016-12-05T16:20:00Z" } 5. Create the RFC, specifying the EncryptAmiRfc file and the EncryptAmiParams file: Advanced Stack Components Version April 22, 2025 737 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://EncryptAmiRfc.json --execution- parameters file://EncryptAmiParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note This change type does not support encrypting an AMI that is already encrypted. To learn more about AWS AMI encryption, see AMIs with Encrypted Snapshots. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3u9yd8jznb2zd. Example: Required Parameters { "AmiId" : "ami-01234567890abcdef", "VpcId" : "vpc-01234567890abcdef" } Example: All Parameters { "AmiId" : "ami-12345678", "VpcId" : "vpc-12345678", "KmsKeyId": "a3ccc020-abcd-1234-8d69-2f060c3c1234" } AMI | Share Share an AMI with multiple AMS accounts or Organizational Units (OUs). Advanced Stack Components Version April 22, 2025 738 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Management | Advanced stack components | AMI | Share Change Type Details Change type ID ct-1eiczxw8ihc18 Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Share AMIs Sharing an AMI with the console The following shows this change type in the AMS console. How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. Advanced Stack Components Version April 22, 2025 739 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. Sharing an AMI 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 740 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 |
ams-ct-208 | ams-ct.pdf | 208 | 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-1eiczxw8ihc18" --change-type-version "2.0" --title "Share AMI" --execution-parameters "{ \"DocumentName\": \"AWSManagedServices- ShareAMI\", \"Region\": \"us-east-1\", \"Parameters\": { \"ImageId\": \"amiid\" , \"OrganizationalUnitARNs\": \"ouarn\" } }" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it ShareAmiParams.json: aws amscm get-change-type-version --change-type-id "ct-1eiczxw8ihc18" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ShareAmiParams.json 2. Modify and save the execution parameters JSON file. The JSON for only the required parameters and for all the parameters are shown. For example, you can replace the contents with something like this: Only required parameters: { Advanced Stack Components Version April 22, 2025 741 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-ShareAMI", "Region": "us-east-1", "Parameters": { "ImageId": "amiid" } } All parameters: { "DocumentName": "AWSManagedServices-ShareAMI", "Region": "us-east-1", "Parameters": { "AccountIds": "awsaccountid", "ImageId": "amiid", "OrganizationalUnitARNs": "ouarn", "ShareSnapshots": "false" } } 3. Output the RFC template JSON file; this example names it ShareAmiRfc.json: aws amscm create-rfc --generate-cli-skeleton > ShareAmiRfc.json 4. Modify and save the ShareAmiRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-1eiczxw8ihc18", "Title": "Share" } 5. Create the RFC, specifying the ShareAmiRfc file and the ShareAmiParams file: aws amscm create-rfc --cli-input-json file://ShareAmiRfc.json --execution- parameters file://ShareAmiParams.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 742 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips • An AMS AMI can't be shared to a non-AMS account. This change type copies an AMI from the source AWS Region to the same Region in the destination account. You must be onboarded to AMS in the destination AWS Region of the specified TargetAwsAccountId, or the shared AMI is unusable in the target account. • Additionally, encrypted AMIs can't be shared between accounts without the involvement of the AD administrator and an AMS Operations Engineer. If you want to do this, file a Management | Other | Other | Create (ct-1e1xtak34nx76) with AMS with the AMI ID, account information, and full details. • This change type is now at version 2.0. Important When sharing a custom AMI that you created from an instance in your AMS account, ensure that the AMI is usable in the new account. In particular, the instance used to create the AMI must have been separated from its domain. For more information, see Create an AMI. To learn more about sharing AMIs, see Sharing an AMI with specific AWS accounts. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1eiczxw8ihc18. Example: Required Parameters { "DocumentName": "AWSManagedServices-ShareAMI", "Region": "us-east-1", "Parameters": { "ImageId": "ami-12345678" } } Example: All Parameters { Advanced Stack Components Version April 22, 2025 743 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-ShareAMI", "Region": "us-east-1", "Parameters": { "ImageId": "ami-12345678", "AccountIds": "123456789012", "OrganizationalUnitARNs": "arn:aws:organizations::111111111111:organization/o- rkw1234jc5", "ShareSnapshots": true } } Application Load Balancer | Add Listener Certificate Add a certificate to the specified Application Load Balancer (ALB) listener. Use the RemediateStackDrift parameter for the automation to try to remediate drift, if it is introduced. Full classification: Management | Advanced stack components | Application Load Balancer | Add listener certificate Change Type Details Change type ID ct-3g6fq83nxg1a7 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Add ALB listener certificate Adding a listener certificate to an ALB with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 744 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 |
ams-ct-209 | ams-ct.pdf | 209 | in the AMS console. Advanced Stack Components Version April 22, 2025 744 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. Advanced Stack Components Version April 22, 2025 745 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 listener certificate to an ALB with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 746 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-3g6fq83nxg1a7" --change-type-version "1.0" --title "Add listener certificate ALB" --execution-parameters "{\"DocumentName \": \"AWSManagedServices-AddCertificateToElbv2Listener\",\"Region\": \"us- east-1\",\"Parameters\":{\"ListenerArn\":[\"arn:aws:elasticloadbalancing:us- east-1:123456789012:listener/app/testalb/fc656bcb5cacb3ae/a0c0da77f9b1461e\"], \"CertificateArn\":[\"arn:aws:acm:us-east-1:123456789012:certificate/ ecb242e8-3da5-4da6-813c-17040f086fba\"],\"IsDefault\":[\"False\"],\"RemediateStackDrift \":[\"True\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file. For example, you can replace the contents with something like this: aws amscm get-change-type-version --change-type-id "ct-3g6fq83nxg1a7" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AddAlbListenerCertParams.json 2. Modify and save the AddAlbListenerCertParams file. For example: { "DocumentName": "AWSManagedServices-AddCertificateToElbv2Listener", "Region": "us-east-1", "Parameters": { "ListenerArn": [ "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/ testalb/fc656bcb5cacb3ae/a0c0da77f9b1461e" ], "CertificateArn": [ "arn:aws:acm:us-east-1:123456789012:certificate/ ecb242e8-3da5-4da6-813c-17040f086fba" ], "IsDefault": [ "False" ], "RemediateStackDrift": [ Advanced Stack Components Version April 22, 2025 747 AMS Advanced Change Type Reference AMS Advanced Change Type Details "True" ] } } 3. Output the RFC template to a file in your current folder. For example, you can replace the contents with something like this: aws amscm create-rfc --generate-cli-skeleton > AddAlbListenerCertRfc.json 4. Modify and save the AddAlbListenerCertRfc.json file. For example: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3g6fq83nxg1a7", "Title": "ALB-Add-Listener-Cert-RFC" } 5. Create the RFC, specifying the AddAlbListenerCertRfc file and the AddAlbListenerCertParams file: aws amscm create-rfc --cli-input-json file://AddAlbListenerCertRfc.json -- execution-parameters file://AddAlbListenerCertParams.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 |
ams-ct-210 | ams-ct.pdf | 210 | 3. Output the RFC template to a file in your current folder. For example, you can replace the contents with something like this: aws amscm create-rfc --generate-cli-skeleton > AddAlbListenerCertRfc.json 4. Modify and save the AddAlbListenerCertRfc.json file. For example: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3g6fq83nxg1a7", "Title": "ALB-Add-Listener-Cert-RFC" } 5. Create the RFC, specifying the AddAlbListenerCertRfc file and the AddAlbListenerCertParams file: aws amscm create-rfc --cli-input-json file://AddAlbListenerCertRfc.json -- execution-parameters file://AddAlbListenerCertParams.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 Application Load Balancers, see What Is an Application Load Balancer? Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3g6fq83nxg1a7. Example: Required Parameters { "DocumentName": "AWSManagedServices-AddCertificateToElbv2Listener", "Region": "us-east-1", Advanced Stack Components Version April 22, 2025 748 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Parameters": { "CertificateArn": [ "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" ], "ListenerArn": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load- balancer/50dc6c495c0c9188/50dc6c495c0c9188" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-AddCertificateToElbv2Listener", "Region": "us-east-1", "Parameters": { "CertificateArn": [ "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" ], "IsDefault": [ "True" ], "ListenerArn": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load- balancer/50dc6c495c0c9188/50dc6c495c0c9188" ], "RemediateStackDrift": [ "False" ] } } Application Load Balancer | Remove Listener Certificate Remove a certificate from the specified Application Load Balancer (ALB) listener. Use the RemediateStackDrift parameter for the automation to try to remediate drift, if it is introduced. Full classification: Management | Advanced stack components | Application Load Balancer | Remove listener certificate Advanced Stack Components Version April 22, 2025 749 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-0tpbr6lfa3zng Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Remove ALB listener certificate Removing a listener certificate from an ALB 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. Advanced Stack Components Version April 22, 2025 750 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. Removing a listener certificate from an ALB 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 751 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 |
ams-ct-211 | ams-ct.pdf | 211 | 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 751 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-0tpbr6lfa3zng" --change-type-version "1.0" --title "Remove listener certificate ALB" --execution-parameters "{\"DocumentName \": \"AWSManagedServices-RemoveCertificateToElbv2Listener\",\"Region\": \"us- east-1\",\"Parameters\":{\"ListenerArn\":[\"arn:aws:elasticloadbalancing:us- east-1:123456789012:listener/app/testalb/fc656bcb5cacb3ae/a0c0da77f9b1461e\"], \"CertificateArn\":[\"arn:aws:acm:us-east-1:123456789012:certificate/ ecb242e8-3da5-4da6-813c-17040f086fba\"],\"IsDefault\":[\"False\"],\"RemediateStackDrift \":[\"True\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file. For example, you can replace the contents with something like this: aws amscm get-change-type-version --change-type-id "ct-0tpbr6lfa3zng" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > RemoveAlbListenerCertParams.json 2. Modify and save the RemoveAlbListenerCertParams file. For example: Advanced Stack Components Version April 22, 2025 752 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "DocumentName": "AWSManagedServices-RemoveCertificateToElbv2Listener", "Region": "us-east-1", "Parameters": { "ListenerArn": [ "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/ testalb/fc656bcb5cacb3ae/a0c0da77f9b1461e" ], "CertificateArn": [ "arn:aws:acm:us-east-1:123456789012:certificate/ ecb242e8-3da5-4da6-813c-17040f086fba" ], "IsDefault": [ "False" ], "RemediateStackDrift": [ "True" ] } } 3. Output the RFC template to a file in your current folder. For example, you can replace the contents with something like this: aws amscm create-rfc --generate-cli-skeleton > RemoveAlbListenerCertRfc.json 4. Modify and save the RemoveAlbListenerCertRfc.json file. For example: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0tpbr6lfa3zng", "Title": "ALB-Remove-Listener-Cert-RFC" } 5. Create the RFC, specifying the RemoveAlbListenerCertRfc file and the RemoveAlbListenerCertParams file: aws amscm create-rfc --cli-input-json file://RemoveAlbListenerCertRfc.json -- execution-parameters file://RemoveAlbListenerCertParams.json Advanced Stack Components Version April 22, 2025 753 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 To learn more about AWS Application Load Balancers, see What Is an Application Load Balancer? Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0tpbr6lfa3zng. Example: Required Parameters { "DocumentName": "AWSManagedServices-RemoveCertificateFromElbv2Listener", "Region": "us-east-1", "Parameters": { "CertificateArn": [ "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" ], "ListenerArn": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load- balancer/50dc6c495c0c9188/50dc6c495c0c9188" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-RemoveCertificateFromElbv2Listener", "Region": "us-east-1", "Parameters": { "CertificateArn": [ "arn:aws:acm:us- east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" ], "ListenerArn": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load- balancer/50dc6c495c0c9188/50dc6c495c0c9188" Advanced Stack Components Version April 22, 2025 754 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "RemediateStackDrift": [ "False" ] } } Application Load Balancer | Update Update the properties of an existing AWS Application Load Balancer (ALB) that was created by version 3.0 CT: ct-111r1yayblnw4. Full classification: Management | Advanced stack components | Application Load Balancer | Update Change Type Details Change type ID ct-1a1zzgi2nb83d Current version 3.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update application load balancer (ALB) Updating an ALB with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 755 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. |
ams-ct-212 | ams-ct.pdf | 212 | 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. Advanced Stack Components Version April 22, 2025 756 AMS Advanced Change Type Reference AMS Advanced Change Type Details Updating an ALB 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 --title Test-Update-ALB --change-type-id ct-1a1zzgi2nb83d --change-type-version 3.0 --execution-parameters '{"Description":"Updating Test ALB","VpcId":"VPC_ID","StackTemplateId":"stm-sd7uv500000000000","Name":"Test- Application-LoadBalancer","TimeoutInMinutes":360,"Parameters": {"TargetGroupHealthCheckPath": "/myAppHealth"}}' Advanced Stack Components Version April 22, 2025 757 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 JSON file. For example, you can replace the contents with something like this: aws amscm get-change-type-version --change-type-id "ct-111r1yayblnw4" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateAlbParams.json 2. Modify and save the UpdateAlbParams file. For example: { "Description": "ALB-Update", "VpcId": "VPC_ID", "Name": "My-ALB", "StackTemplateId": "stm-sd7uv500000000000", "TimeoutInMinutes" : 360, "Parameters": { "LoadBalancerSecurityGroups": [ "sg-1234567890abcdef0" ], "LoadBalancerSubnetIds": [ "subnet-1234567890abcdef0", "subnet-1234567890abcdef1" ], "LoadBalancerDeletionProtection": "false", "LoadBalancerIdleTimeout": "60", "Listener1Port": "443", "Listener1Protocol": "HTTPS", "Listener1SSLCertificateArn": "arn:aws:acm:ap- southeast-2:012345678912:certificate/e23c3545-e92d-4542-83b8-63483505b5a5", "Listener1SSLPolicy": "ELBSecurityPolicy-TLS-1-2-Ext-2018-06", "Listener2Port": "8080", "Listener2Protocol": "HTTP", "TargetGroupHealthCheckInterval": "10", "TargetGroupHealthCheckPath": "/thing/index.html", "TargetGroupHealthCheckPort": "8080", "TargetGroupHealthCheckProtocol": "HTTP", "TargetGroupHealthCheckTimeout": "10", "TargetGroupHealthyThreshold": "2", "TargetGroupUnhealthyThreshold": "10", "TargetGroupValidHTTPCode": "200", "TargetGroupDeregistrationDelayTimeout": "300", "TargetGroupSlowStartDuration": "30", Advanced Stack Components Version April 22, 2025 758 AMS Advanced Change Type Reference AMS Advanced Change Type Details "TargetGroupCookieExpirationPeriod": "20" } } 3. Output the RFC template to a file in your current folder. For example, you can replace the contents with something like this: aws amscm create-rfc --generate-cli-skeleton > UpdateAlbRfc.json 4. Modify and save the UpdateAlbRfc.json file. For example: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-111r1yayblnw4", "Title": "ALB-Update-RFC" } 5. Create the RFC, specifying the UpdateAlbRfc file and the UpdateAlbParams file: aws amscm create-rfc --cli-input-json file://UpdateAlbRfc.json --execution- parameters file://UpdateAlbParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note This change type is version 3.0, and can be used with the version 3.0 of the Create ALB change type (ct-111r1yayblnw4). To learn more about AWS Application Load Balancers, see What Is an Application Load Balancer? Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1a1zzgi2nb83d. Advanced Stack Components Version April 22, 2025 759 AMS Advanced Change Type Reference AMS Advanced |
ams-ct-213 | ams-ct.pdf | 213 | new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note This change type is version 3.0, and can be used with the version 3.0 of the Create ALB change type (ct-111r1yayblnw4). To learn more about AWS Application Load Balancers, see What Is an Application Load Balancer? Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1a1zzgi2nb83d. Advanced Stack Components Version April 22, 2025 759 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "VpcId": "vpc-1234567890abcdef0", "StackId": "stack-1234567890abcdef0", "Parameters": {} } Example: All Parameters { "VpcId": "vpc-12345678", "StackId": "stack-1234567890abcdef0", "Parameters": { "LoadBalancerSecurityGroups": ["sg-12345678"], "LoadBalancerSubnetIds": ["subnet-12345678", "subnet-12345688"], "LoadBalancerDeletionProtection": "false", "LoadBalancerIdleTimeout": "60", "Listener1Port": "443", "Listener1Protocol": "HTTPS", "Listener1SSLCertificateArn": "arn:aws:acm:ap-southeast-2:012345678912:certificate/ e23c3545-e92d-4542-83b8-63483505b5a5", "Listener1SSLPolicy": "ELBSecurityPolicy-TLS-1-2-Ext-2018-06", "Listener2Port": "8080", "Listener2Protocol": "HTTP", "TargetGroupHealthCheckInterval": "10", "TargetGroupHealthCheckPath": "/thing/index.html", "TargetGroupHealthCheckPort": "8080", "TargetGroupHealthCheckProtocol": "HTTP", "TargetGroupHealthCheckTimeout": "10", "TargetGroupHealthyThreshold": "2", "TargetGroupUnhealthyThreshold": "10", "TargetGroupValidHTTPCode": "200", "TargetGroupDeregistrationDelayTimeout": "300", "TargetGroupSlowStartDuration": "30", "TargetGroupCookieExpirationPeriod": "20" } } Advanced Stack Components Version April 22, 2025 760 AMS Advanced Change Type Reference AMS Advanced Change Type Details Auto Scaling Group | Update Update an Auto Scaling Group and associated launch configuration created with CT ct-2tylseo8rxfsc, version 2.0. Full classification: Management | Advanced stack components | Auto scaling group | Update Change Type Details Change type ID ct-3fi2cx8b83iua Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update Auto Scaling groups Updating an Auto Scaling group with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 761 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 762 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 Auto Scaling 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: Advanced Stack Components Version April |
ams-ct-214 | ams-ct.pdf | 214 | 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 763 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 --profile saml --region us-east-1 create-rfc --change-type-id "ct-3fi2cx8b83iua" --change-type-version "2.0" --title "Test-Update ASG" --description "Test Update" --execution-parameters "{\"VpcId\":\"VPC_ID\",\"StackId\":\"STACK_ID\", \"Parameters\":{\"ASGAmiId\":\"AMI_ID\",\"ASGInstanceType\":\"m3.medium\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file in your current folder; this example names it UpdateAsgParams.json: aws amscm get-change-type-version --change-type-id "ct-3fi2cx8b83iua" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateAsgParams.json Note Scripts are newline-delimited (separate with literal: "\n"), also, scripts entered as UserData are executed as the "root" user and do not need to use the "sudo" command. The RFC waits up to six hours for all of the UserData script commands to execute before returning a final status of success or failure. 2. Modify and save the file. For example, you can replace the contents with something like this: { "VpcId": "VPC_ID", "StackId": "STACK_ID", "Parameters": { "ASGAmiId": "AMI_ID", "ASGInstanceType": "m3.medium" } } 3. Output the JSON template for UpdateRfc to a file in your current folder; example names it UpdateAsgRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateAsgRfc.json Advanced Stack Components Version April 22, 2025 764 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the JSON file as follows. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-3fi2cx8b83iua", "Title": "ASG-Update-Stack-RFC" } 5. Create the RFC, specifying the UpdateAsgRfc file and the execution parameters file: aws amscm create-rfc --cli-input-json file://UpdateAsgRfc.json --execution- parameters file://UpdateAsgParams.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 is a version 2.0 change type and can be used to update Auto Scaling groups A(SG) created with the corresponding version 2.0 create change type, ct-2tylseo8rxfsc. To learn more, see Amazon Auto Scaling. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3fi2cx8b83iua. Example: Required Parameters Example not available. Example: All Parameters { Advanced Stack Components Version April 22, 2025 765 AMS Advanced Change Type Reference AMS Advanced Change Type Details "VpcId": "vpc-12345678", "StackId": "stack-12345678901234567", "Parameters": { "ASGAmiId": "ami-a0b1c2d3", "ASGCooldown": 300, "ASGDesiredCapacity": 1, "ASGEBSOptimized": "false", "ASGIAMInstanceProfile": "customer-mc-ec2-instance-profile", "ASGInstanceDetailedMonitoring": "false", "ASGInstanceRootVolumeIops": 0, "ASGInstanceRootVolumeSize": 8, "ASGInstanceRootVolumeType": "standard", "ASGInstanceType": "m3.medium", "ASGLoadBalancerNames": ["elb1"], "ASGMaxInstances": 1, "ASGMinInstances": 1, "ASGHealthCheckGracePeriod": 600, "ASGHealthCheckType":"EC2", "ASGScaleDownMetricName": "CPUUtilization", "ASGScaleDownPolicyCooldown": 300, "ASGScaleDownPolicyEvaluationPeriods": 4, "ASGScaleDownPolicyPeriod": 60, "ASGScaleDownPolicyScalingAdjustment": -1, "ASGScaleDownPolicyStatistic": "Average", "ASGScaleDownPolicyThreshold": 35, "ASGScaleUpMetricName": "CPUUtilization", "ASGScaleUpPolicyCooldown": 60, "ASGScaleUpPolicyEvaluationPeriods": 2, "ASGScaleUpPolicyPeriod": 60, "ASGScaleUpPolicyScalingAdjustment": 2, "ASGScaleUpPolicyStatistic": "Average", "ASGScaleUpPolicyThreshold": 75, "ASGSubnetIds": ["subnet-a0b1c2d3", "subnet-e4f5g6h7"], "ASGUserData": "#!/bin/bash\npwd\nls -ltrh\necho \"Hello, World\"" } } Bastions | Add CIDR Ingress (Review Required) Add RDP or SSH bastion ingress Classless Inter-Domain Routing (CIDR) allow lists. Full classification: Management | Advanced stack components | Bastions | Add CIDR ingress (review required) Advanced Stack Components Version April 22, 2025 766 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-36zubwzxp44a4 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Add CIDR ingress (review required) ct-36zubwzxp44a4 Adding bastion CIDR ingress with the console The following shows this change type in the AMS console. How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. Advanced Stack Components Version April 22, 2025 767 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 |
ams-ct-215 | ams-ct.pdf | 215 | 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 767 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. Adding bastion CIDR ingress 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 768 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-36zubwzxp44a4" --change-type-version "1.0" --title "Add CIDR ingress" --execution-parameters "{\"BastionType\": \"RDP Bastion\", \"[\"10.0.0.1/24\",\"10.20.0.4/25\",\"10.0.0.6/25\"]\": \"10\", \"ASGMinCount\": \"10\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it AddBastionCidrIngressParams.json: aws amscm get-change-type-version --change-type-id "ct-36zubwzxp44a4" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AddBastionCidrIngressParams.json 2. Modify and save the AddBastionCidrIngressParams file. { "BastionType": "RDP Bastion", "IngressCIDRAddresses": ["10.113.44.1/22", "10.113.56.1/22"], "Priority": "Medium" Advanced Stack Components Version April 22, 2025 769 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 AddBastionCidrIngressRfc.json: aws amscm create-rfc --generate-cli-skeleton > AddBastionCidrIngressRfc.json 4. Modify and save the AddBastionCidrIngressRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-36zubwzxp44a4", "Title": "Add Bastion CIDR Ingress" } 5. Create the RFC, specifying the AddBastionCidrIngressRfc file and the AddBastionCidrIngressParams file: aws amscm create-rfc --cli-input-json file://AddBastionCidrIngressRfc.json -- execution-parameters file://AddBastionCidrIngressParams.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, see Authorize inbound traffic for your Linux instances. • 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 |
ams-ct-216 | ams-ct.pdf | 216 | 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, see Authorize inbound traffic for your Linux instances. • 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-36zubwzxp44a4. Advanced Stack Components Version April 22, 2025 770 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "BastionType": "RDP Bastion", "IngressCIDRAddresses": ["10.113.44.1/22"] } Example: All Parameters { "BastionType": "RDP Bastion", "IngressCIDRAddresses": ["10.113.44.1/22", "10.113.56.1/22"], "Priority": "Medium" } Bastions | Update Instance or Session Counts (Review Required) Update the number of RDP and SSH Bastion instances. Optionally update the session count of RDP Bastions. Full classification: Management | Advanced stack components | Bastions | Update instance or session counts (review required) Change Type Details Change type ID ct-1962s5oczal9z Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Advanced Stack Components Version April 22, 2025 771 AMS Advanced Change Type Reference Additional Information AMS Advanced Change Type Details Update bastion instance or session counts (review required) ct-1962s5oczal9z Updating bastion instance or session counts 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. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 772 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. Updating bastion instance or session counts with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack |
ams-ct-217 | ams-ct.pdf | 217 | ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 773 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: SSH Bastion Update Example aws amscm create-rfc --change-type-id "ct-1962s5oczal9z" --change-type-version "1.0" --title "Update instance or session counts" --execution-parameters "{\"BastionType\": \"SSH Bastion\", \"ASGMaxCount\": \"10\", \"ASGMinCount\": \"10\", \"ASGDesiredCount \": \"10\"}" RDP Bastion Update Example aws amscm create-rfc --change-type-id "ct-1962s5oczal9z" --change-type-version "1.0" --title "Update instance or session counts" --execution-parameters "{\"BastionType\": \"RDP Bastion\", \"RDPBastionDesiredMaximumSessions\": \"50\", \"RDPBastionDesiredMinimumSessions\": \"20\"}" RDP Bastion Update Example with ASG aws amscm create-rfc --change-type-id "ct-1962s5oczal9z" --change-type-version "1.0" --title "Update instance or session counts" --execution-parameters "{\"BastionType\": \"RDP Bastion\", \"ASGMaxCount\": \"10\", \"ASGMinCount\": \"10\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it UpdateBastionInstSesCountsParams.json: aws amscm get-change-type-version --change-type-id "ct-1962s5oczal9z" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateBastionInstSesCountsParams.json 2. Modify and save the UpdateBastionInstSesCountsParams file. { "BastionType": "RDP Bastion", "RDPBastionDesiredMaximumSessions": 10, Advanced Stack Components Version April 22, 2025 774 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RDPBastionDesiredMinimumSessions": 2, "ASGMaxCount": 4, "ASGMinCount": 0, "ASGDesiredCount": 2, "Priority": "Medium" } 3. Output the RFC template to a file in your current folder; this example names it UpdateBastionInstSesCountsRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateBastionInstSesCountsRfc.json 4. Modify and save the UpdateBastionInstSesCountsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1962s5oczal9z", "Title": "Update Bastion Instance or Session Count" } 5. Create the RFC, specifying the UpdateBastionInstSesCountsRfc file and the UpdateBastionInstSesCountsParams file: aws amscm create-rfc --cli-input-json file://UpdateBastionInstSesCountsRfc.json -- execution-parameters file://UpdateBastionInstSesCountsParams.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 bastions, see Linux Bastion Hosts on AWS. • 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. Advanced Stack Components Version April 22, 2025 775 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-1962s5oczal9z. Example: Required Parameters { "BastionType": "RDP Bastion" } Example: All Parameters { "BastionType": "RDP Bastion", "RDPBastionDesiredMaximumSessions": 10, "RDPBastionDesiredMinimumSessions": 2, "ASGMaxCount": 4, "ASGMinCount": 0, "ASGDesiredCount": 2, "Priority": "Medium" } Bastions | Update Instance Size (Review Required) Update the instance size for an RDP or SSH customer bastion in an AMS account. Full classification: Management | Advanced stack components | Bastions | Update instance size (review required) Change Type Details Change type ID ct-2x14cv67uym46 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Advanced Stack Components Version April 22, 2025 776 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution mode Manual Additional Information Update bastion instance size (review required) ct-2x14cv67uym46 Updating bastion instance size 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 |
ams-ct-218 | ams-ct.pdf | 218 | 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 777 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 bastion instance size with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Advanced Stack Components Version April 22, 2025 778 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-2x14cv67uym46" --change-type-version "1.0" -- title "Update instance size" --execution-parameters "{\"InstanceType\": \"t3.medium\", \"BastionType\": \"RDP Bastion\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it UpdateBastionInstSizeParams.json: aws amscm get-change-type-version --change-type-id "ct-2x14cv67uym46" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateBastionInstSizeParams.json 2. Modify and save the UpdateBastionInstSizeParams file. { "BastionType": "RDP Bastion", "InstanceType": "t3.medium", "Priority": "Medium" } 3. Output the RFC template to a file in your current folder; this example names it UpdateBastionInstSizeRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateBastionInstSizeRfc.json 4. Modify and save the UpdateBastionInstSizeRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", Advanced Stack Components Version April 22, 2025 779 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-2x14cv67uym46", "Title": "Update Bastion Instance Size" } 5. Create the RFC, specifying the UpdateBastionInstSizeRfc file and the UpdateBastionInstSizeParams file: aws amscm create-rfc --cli-input-json file://UpdateBastionInstSizeRfc.json -- execution-parameters file://UpdateBastionInstSizeParams.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 bastions, see Linux Bastion Hosts on AWS. • 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 |
ams-ct-219 | ams-ct.pdf | 219 | 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 bastions, see Linux Bastion Hosts on AWS. • 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-2x14cv67uym46. Example: Required Parameters { "BastionType": "RDP Bastion", "InstanceType": "t3.medium" } Example: All Parameters { "BastionType": "RDP Bastion", "InstanceType": "t3.medium", Advanced Stack Components Version April 22, 2025 780 AMS Advanced Change Type Reference "Priority": "Medium" } AMS Advanced Change Type Details Database Migration Service (DMS) | Start Replication Task Start a new Database Migration Service (DMS) replication task, or a task in a stopped or failed state. Full classification: Management | Advanced stack components | Database Migration Service (DMS) | Start replication task Change Type Details Change type ID ct-1yq7hhqse71yg Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Start AWS DMS replication task Starting a AWS DMS replication task with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 781 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Advanced Stack Components Version April 22, 2025 782 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. Starting a AWS DMS replication task 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 |
ams-ct-220 | ams-ct.pdf | 220 | returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 783 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-1yq7hhqse71yg" --change-type-version "1.0" --title "Start DMS Replication Task" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-StartDmsTask\",\"Region\":\"us-east-1\",\"Parameters\": {\"ReplicationTaskArn\":[\"TASK_ARN\"],\"StartReplicationTaskType\":[\"start- replication\"],\"CdcStartPosition\":[\"\"],\"CdcStopPosition\":[\"\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it StartDmsRtParams.json: aws amscm get-change-type-version --change-type-id "ct-1yq7hhqse71yg" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > StartDmsRtParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-StartDmsTask", "Region": "us-east-1", "Parameters": { "ReplicationTaskArn": [ "TASK_ARN" ], "StartReplicationTaskType": [ "start-replication" ], "CdcStartPosition": [ "" ], "CdcStopPosition": [ "" ] } } 3. Output the JSON template to a file in your current folder; this example names it StartDmsRtRfc.json: aws amscm create-rfc --generate-cli-skeleton > StartDmsRtRfc.json Advanced Stack Components Version April 22, 2025 784 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the StartDmsRtRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1yq7hhqse71yg", "ChangeTypeVersion": "1.0", "Title": "Start DMS Replication Task" } 5. Create the RFC, specifying the execution parameters file and the StartDmsRtRfc file: aws amscm create-rfc --cli-input-json file://StartDmsRtRfc.json --execution- parameters file://StartDmsRtParams.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 You can start a AWS DMS replication task, using the AMS console or the AMS API/CLI. For more information, see Working with AWS DMS Tasks. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1yq7hhqse71yg. Example: Required Parameters { "DocumentName": "AWSManagedServices-StartDmsTask", "Region": "us-east-1", "Parameters": { "ReplicationTaskArn": ["arn:aws:dms:us- east-1:123456789000:task:3FBZMUE4QNZNMD7DMWXXOSCCM4"], "StartReplicationTaskType": ["start-replication"] } } Advanced Stack Components Version April 22, 2025 785 AMS Advanced Change Type Reference Example: All Parameters AMS Advanced Change Type Details { "DocumentName": "AWSManagedServices-StartDmsTask", "Region": "us-east-1", "Parameters": { "ReplicationTaskArn": ["arn:aws:dms:us- east-1:123456789000:task:3FBZMUE4QNZNMD7DMWXXOSCCM4"], "StartReplicationTaskType": ["start-replication"], "CdcStartPosition": ["2019-01-01T01:00:00"], "CdcStopPosition": ["server_time:2019-01-02T01:00:00"] } } Database Migration Service (DMS) | Stop Replication Task Stop a Database Migration Service (DMS) replication task. The specified task must be in the running state. Full classification: Management | Advanced stack components | Database Migration Service (DMS) | Stop replication task Change Type Details Change type ID ct-1vd3y4ygbqmfk Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 786 AMS Advanced Change Type Reference Additional Information Stop AWS DMS replication task Stopping a AWS DMS replication task with the Console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 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 |
ams-ct-221 | ams-ct.pdf | 221 | RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 787 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. Stopping a AWS DMS replication task with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 788 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-1vd3y4ygbqmfk" --change-type-version "1.0" --title "Stop DMS Replication Task" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-StopDmsTask\",\"Region\":\"us-east-1\",\"Parameters\": {\"ReplicationTaskArn\":[\"TASK_ARN\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it StopDmsRtParams.json: aws amscm get-change-type-version --change-type-id "ct-1vd3y4ygbqmfk" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > StopDmsRtParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-StopDmsTask", "Region": "us-east-1", "Parameters": { "ReplicationTaskArn": [ "TASK_ARN" ] } } 3. Output the JSON template to a file in your current folder; this example names it StopDmsRtRfc.json: aws amscm create-rfc --generate-cli-skeleton > StopDmsRtRfc.json 4. Modify and save the StopDmsRtRfc.json file. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 789 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-1vd3y4ygbqmfk", "ChangeTypeVersion": "1.0", "Title": "Stop DMS Replication Task" } 5. Create the RFC, specifying the execution parameters file and the StopDmsRtRfc file: aws amscm create-rfc --cli-input-json file://StopDmsRtRfc.json --execution- parameters file://StopDmsRtParams.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 You can stop a DMS replication task, using the AMS console or the AMS API/CLI. For more information, see Working with AWS DMS Tasks. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1vd3y4ygbqmfk. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-StopDmsTask", "Region": "us-east-1", "Parameters": { "ReplicationTaskArn": ["arn:aws:dms:us- east-1:123456789000:task:3FBZMUE4QNZNMD7DMWXXOSCCM4"] } } Advanced Stack Components Version April 22, 2025 790 AMS Advanced Change Type Reference AMS Advanced Change Type Details Directory Service | Accept Sharing Accept a directory sharing request sent from the directory owner account. This is run in the directory consumer account. Full classification: Management | Advanced stack components | Directory Service | 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 |
ams-ct-222 | ams-ct.pdf | 222 | "us-east-1", "Parameters": { "ReplicationTaskArn": ["arn:aws:dms:us- east-1:123456789000:task:3FBZMUE4QNZNMD7DMWXXOSCCM4"] } } Advanced Stack Components Version April 22, 2025 790 AMS Advanced Change Type Reference AMS Advanced Change Type Details Directory Service | Accept Sharing Accept a directory sharing request sent from the directory owner account. This is run in the directory consumer account. Full classification: Management | Advanced stack components | Directory Service | 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. 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 791 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. 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. Advanced Stack Components Version April 22, 2025 792 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-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\"]}}" 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: Advanced Stack Components Version April 22, 2025 793 AMS Advanced Change Type Reference AMS Advanced Change Type Details { { "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. |
ams-ct-223 | ams-ct.pdf | 223 | 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: Advanced Stack Components Version April 22, 2025 793 AMS Advanced Change Type Reference AMS Advanced Change Type Details { { "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 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. Advanced Stack Components Version April 22, 2025 794 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-13xvbj5pqg253. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-AcceptSharedDirectory", "Region": "us-east-1", "Parameters": { "SharedDirectoryId": [ "d-12e456789f" ], "OwnerAccountId": [ "123456789012" ] } } DNS (Private) | Update Update an existing Route 53 DNS Hosted Zone with the supplied resource record set. Full classification: Management | Advanced stack components | DNS (private) | Update Change Type Details Change type ID ct-1d55pi44ff21u Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Advanced Stack Components Version April 22, 2025 795 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution mode Automated Additional Information Update private DNS Route 53 Updating a private DNS Route 53 hosted zone with the console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. Advanced Stack Components Version April 22, 2025 796 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 a private DNS Route 53 hosted zone 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 |
ams-ct-224 | ams-ct.pdf | 224 | execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Updating a private DNS Route 53 hosted zone with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status Advanced Stack Components Version April 22, 2025 797 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-1d55pi44ff21u" \ --change-type-version "2.0" --title "Update Private DNS Record" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- CreateAddRoute53Resources\",\"Region\":\"ap-southeast-2\",\"Parameters\":{\"StackId \":\"stack-9iwwljjcfunnrahof\",\"RecordSet\":[\"{\\\"RecordSet\\\":[{\\\"Name\\\":\\ \"test15.domain.com\\\",\\\"Type\\\":\\\"A\\\",\\\"TTL\\\":600,\\\"ResourceRecords\\\": [\\\"10.1.1.1\\\",\\\"10.1.2.2\\\"]},{\\\"Name\\\":\\\"test16.domain.com\\\",\\\"Type\\ \":\\\"CNAME\\\",\\\"TTL\\\":600,\\\"ResourceRecords\\\":[\\\"amazon.com\\\"]}]}\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named UpdateDnsPrivateParams.json. aws amscm get-change-type-version --change-type-id "ct-1d55pi44ff21u" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateDnsPrivateParams.json 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateAddRoute53Resources", "Region": "ap-southeast-2", "Parameters": { "HostedZoneId": "Z0188399KN0JJOZLTEXM", "RecordSet": [ Advanced Stack Components Version April 22, 2025 798 AMS Advanced Change Type Reference AMS Advanced Change Type Details "{\"RecordSet\":[{\"Name\":\"test20.domain.com\",\"Type\":\"A\",\"TTL\":600, \"ResourceRecords\":[\"10.1.1.1\",\"10.1.2.2\"]},{\"Name\":\"test15.domain.com\", \"Type\":\"CNAME\",\"TTL\":600,\"ResourceRecords\":[\"amazon.com\"]}]}" ] } } 3. Output the JSON template to a file in your current folder; this example names it UpdateDnsPrivateRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateDnsPrivateRfc.json 4. Modify and save the UpdateDnsPrivateRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1d55pi44ff21u ", "ChangeTypeVersion": "2.0", "Title": "Update Private Hosted Zone" } 5. Create the RFC, specifying the execution parameters file and the UpdateDnsPrivateRfc file: aws amscm create-rfc --cli-input-json file://UpdateDnsPrivateRfc.json --execution- parameters file://UpdateDnsPrivateParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • This CT fails if the specified RecordSet contains more than 500 resource records (RRs), or if the CloudFormation template surpasses the maximum body of 51,200 bytes. • You can add up to 50 tags, but to do so you must enable the Additional configuration view. • To learn more, see Working with Private Hosted Zones. Advanced Stack Components Version April 22, 2025 799 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-1d55pi44ff21u. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateAddRoute53Resources", "Region" : "us-east-1", "Parameters": { "StackId": "", "HostedZoneId": "Z12345678901234567890", "RecordSet": [ "{\"RecordSet\":[{\"Name\":\"test1.mydomain.com\",\"Type\":\"A\",\"TTL\":\"600\", \"ResourceRecords\":[\"10.1.1.1\",\"10.1.2.2\"]},{\"Name\":\"test3.mydomain.com \",\"Type\":\"CNAME\",\"TTL\":\"600\",\"ResourceRecords\":[\"amazon.com\"]}, {\"Name\":\"test4.mydomain.com\",\"Type\":\"A\",\"AliasTarget\":{\"DNSName\": \"d1i3674zujyzy1.cloudfront.net\",\"EvaluateTargetHealth\":true,\"HostedZoneId \":\"Z2FDTNDATAQYW2\"}},{\"Name\":\"weighted.mydomain.com\",\"Weight\":200, \"SetIdentifier\":\"Example-Set-Identifier-1\",\"Type\":\"A\",\"AliasTarget\": {\"DNSName\":\"d1i3674zujyzy1.cloudfront.net\",\"EvaluateTargetHealth\":true, \"HostedZoneId\":\"Z2FDTNDATAQYW2\"}},{\"Name\":\"geolocationexample.mydomain.com \",\"SetIdentifier\":\"Example-GeoLocation-Identifier-1\",\"GeoLocation\": {\"CountryCode\":\"US\",\"SubdivisionCode\":\"WA\"},\"Type\":\"A\",\"AliasTarget \":{\"DNSName\":\"d1i3674zujyzy1.cloudfront.net\",\"EvaluateTargetHealth\":true, \"HostedZoneId\":\"Z2FDTNDATAQYW2\"}},{\"Name\":\"examplelatency.mydomain.com\", \"SetIdentifier\":\"Example-Latency-Identifier-1\",\"Region\":\"ap-southeast-2\", \"Type\":\"A\",\"TTL\":\"600\",\"ResourceRecords\":[\"10.1.1.1\",\"10.1.2.2\"]}, {\"Name\":\"examplemultivalue.mydomain.com\",\"SetIdentifier\":\"Example- MultiValue-Identifier-1\",\"MultiValueAnswer\":true,\"Type\":\"A\",\"TTL\":\"600\", \"ResourceRecords\":[\"10.1.1.1\"]}]}" ] } } DNS (Public) | Update Update an existing Route 53 DNS Hosted Zone with the supplied resource record set. Advanced Stack Components Version April 22, 2025 800 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Management | Advanced stack components | DNS (public) | Update Change Type Details Change type ID ct-1hzofpphabs3i Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update public DNS Route 53 Updating a Route 53 public hosted zone 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 801 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 |
ams-ct-225 | ams-ct.pdf | 225 | 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 801 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. Updating a Route 53 public hosted zone 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 802 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-1hzofpphabs3i" \ --change-type-version "2.0" --title "Update Public DNS Record" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- CreateAddRoute53Resources\",\"Region\":\"ap-southeast-2\",\"Parameters\":{\"StackId \":\"stack-6zelfurs8yojlvn1i\",\"RecordSet\":[\"{\\\"RecordSet\\\":[{\\\"Name\\\":\\ \"test15.domain.com\\\",\\\"Type\\\":\\\"A\\\",\\\"TTL\\\":600,\\\"ResourceRecords\\\": [\\\"10.1.1.1\\\",\\\"10.1.2.2\\\"]},{\\\"Name\\\":\\\"test16.domain.com\\\",\\\"Type\\ \":\\\"CNAME\\\",\\\"TTL\\\":600,\\\"ResourceRecords\\\":[\\\"amazon.com\\\"]}]}\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file named UpdateDnsPublicParams.json. aws amscm get-change-type-version --change-type-id "ct-1hzofpphabs3i" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateDnsPublicParams.json Advanced Stack Components Version April 22, 2025 803 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Modify and save the execution parameters JSON file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateAddRoute53Resources", "Region": "ap-southeast-2", "Parameters": { "StackId": "stack-6zelfurs8yojlvn1i", "RecordSet": [ "{\"RecordSet\":[{\"Name\":\"test15.domain.com\",\"Type\":\"A\",\"TTL\":600, \"ResourceRecords\":[\"10.1.1.1\",\"10.1.2.2\"]},{\"Name\":\"test16.domain.com\", \"Type\":\"CNAME\",\"TTL\":600,\"ResourceRecords\":[\"amazon.com\"]}]}" ] } } 3. Output the JSON template to a file in your current folder; this example names it UpdateDnsPublicRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateDnsPublicRfc.json 4. Modify and save the UpdateDnsPublicRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1hzofpphabs3i", "ChangeTypeVersion": "2.0", "Title": "Update Public Hosted Zone" } 5. Create the RFC, specifying the execution parameters file and the UpdateDnsPublicRfc file: aws amscm create-rfc --cli-input-json file://UpdateDnsPublicRfc.json --execution- parameters file://UpdateDnsPublicParams.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 804 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note You can |
ams-ct-226 | ams-ct.pdf | 226 | example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1hzofpphabs3i", "ChangeTypeVersion": "2.0", "Title": "Update Public Hosted Zone" } 5. Create the RFC, specifying the execution parameters file and the UpdateDnsPublicRfc file: aws amscm create-rfc --cli-input-json file://UpdateDnsPublicRfc.json --execution- parameters file://UpdateDnsPublicParams.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 804 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note You can add up to 50 tags, but to do so you must enable the Additional configuration view. To learn more, see Working with Public Hosted Zones. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1hzofpphabs3i. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateAddRoute53Resources", "Region" : "us-east-1", "Parameters": { "StackId": "stack-k9hasbgx6eh4d5mab", "RecordSet": [ "{\"RecordSet\":[{\"Name\":\"test1.mydomain.com\",\"Type\":\"A\",\"TTL\":\"600\", \"ResourceRecords\":[\"10.1.1.1\",\"10.1.2.2\"]},{\"Name\":\"test3.mydomain.com \",\"Type\":\"CNAME\",\"TTL\":\"600\",\"ResourceRecords\":[\"amazon.com\"]}, {\"Name\":\"test4.mydomain.com\",\"Type\":\"A\",\"AliasTarget\":{\"DNSName\": \"d1i3674zujyzy1.cloudfront.net\",\"EvaluateTargetHealth\":true,\"HostedZoneId \":\"Z2FDTNDATAQYW2\"}},{\"Name\":\"weighted.mydomain.com\",\"Weight\":200, \"SetIdentifier\":\"Example-Set-Identifier-1\",\"Type\":\"A\",\"AliasTarget\": {\"DNSName\":\"d1i3674zujyzy1.cloudfront.net\",\"EvaluateTargetHealth\":true, \"HostedZoneId\":\"Z2FDTNDATAQYW2\"}},{\"Name\":\"geolocationexample.mydomain.com \",\"SetIdentifier\":\"Example-GeoLocation-Identifier-1\",\"GeoLocation\": {\"CountryCode\":\"US\",\"SubdivisionCode\":\"WA\"},\"Type\":\"A\",\"AliasTarget \":{\"DNSName\":\"d1i3674zujyzy1.cloudfront.net\",\"EvaluateTargetHealth\":true, \"HostedZoneId\":\"Z2FDTNDATAQYW2\"}},{\"Name\":\"examplelatency.mydomain.com\", \"SetIdentifier\":\"Example-Latency-Identifier-1\",\"Region\":\"ap-southeast-2\", Advanced Stack Components Version April 22, 2025 805 AMS Advanced Change Type Reference AMS Advanced Change Type Details \"Type\":\"A\",\"TTL\":\"600\",\"ResourceRecords\":[\"10.1.1.1\",\"10.1.2.2\"]}, {\"Name\":\"examplemultivalue.mydomain.com\",\"SetIdentifier\":\"Example- MultiValue-Identifier-1\",\"MultiValueAnswer\":true,\"Type\":\"A\",\"TTL\":\"600\", \"ResourceRecords\":[\"10.1.1.1\"]}]}" ] } } EBS Snapshot | Archive Archive Elastic Block Store (EBS) snapshots. The maximum number of EBS snapshots that can be archived concurrently depends on the 'In-progress snapshot archives per account' AWS Service Quota. Snapshots that are in the 'completed' state, storage tier is 'standard', or belonging to the current owner account, can be archived. Snapshots created by the AWS Backup service, used by AMIs, or shared with other accounts, cannot be archived. If you specify snapshots that are invalid, or the archival in-progress quota limit is reached, the RFC fails. Full classification: Management | Advanced stack components | EBS snapshot | Archive Change Type Details Change type ID ct-059ewa92tc2i1 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 806 AMS Advanced Change Type Reference Additional Information Archive EBS snapshot Archiving EBS Snapshots with the Console AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 807 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. Archiving EBS Snapshots with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters |
ams-ct-227 | ams-ct.pdf | 227 | it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 808 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-059ewa92tc2i1" --change-type-version "1.0" --title "Archive an EBS Snapshot" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-ArchiveEBSSnapshot\",\"Region\": \"us-east-1\",\"Parameters\": {\"SnapshotId\": [\"snap-1234567890abcdef0\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it ArchiveEbsSnpshtParams.json: aws amscm get-change-type-version --change-type-id "ct-059ewa92tc2i1" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ArchiveEbsSnpshtParams.json 2. Modify and save the ArchiveEbsSnpshtParams file. For example, you can replace the contents with something like this: >{ "DocumentName": "AWSManagedServices-ArchiveEBSSnapshot", "Region": "us-east-1", "Parameters": { "SnapshotId": [ "snap-1234567890abcdef0" ] } } 3. Output the RFC template JSON file to a file; this example names it ArchiveEbsSnpshtRfc.json: aws amscm create-rfc --generate-cli-skeleton > ArchiveEbsSnpshtRfc.json 4. Modify and save the ArchiveEbsSnpshtRfc.json file. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 809 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0wspy4o646g9p", "Title": "Archive an EBS Snapshot" } 5. Create the RFC, specifying the ArchiveEbsSnpshtRfc file and the ArchiveEbsSnpshtParams file: aws amscm create-rfc --cli-input-json file://ArchiveEbsSnpshtRfc.json --execution- parameters file://ArchiveEbsSnpshtParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon EBS snapshots, see Amazon EBS Snapshots. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-059ewa92tc2i1. Example: Required Parameters { "DocumentName": "AWSManagedServices-ArchiveEBSSnapshots", "Region": "us-east-1", "Parameters": { "SnapshotIds": [ "snap-1234567890abcdef0" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-ArchiveEBSSnapshots", "Region": "us-east-1", "Parameters": { "SnapshotIds": [ Advanced Stack Components Version April 22, 2025 810 AMS Advanced Change Type Reference AMS Advanced Change Type Details "snap-1234567890abcdef0" ] } } EBS Snapshot | Delete Delete Elastic Block Store (EBS) snapshots. Because deleted snapshots cannot be restored, it's a best practice to schedule this RFC with enough lead to time to cancel the operation, if needed. At least one parameter must be specified. Note: If you use multiple parameters, only snapshots that match all the specified parameters are deleted. Snapshots created by AWS Backup service or used by AMIs cannot be deleted. If using the SnapshotCreationDate or SnapshotTag parameters, snapshots created within the last 30 days are not eligible for deletion. If a snapshot fails to delete, then the execution fails. You can optionally receive a failed snapshots report in an S3 bucket. You can delete up to 1000 snapshots in one execution. Full classification: Management | Advanced stack components | EBS snapshot | Delete Change Type Details Change type ID ct-30bfiwxjku1nu Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 811 AMS Advanced Change Type Reference Additional Information Delete EBS snapshot Deleting EBS snapshots with the Console AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select |
ams-ct-228 | ams-ct.pdf | 228 | 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 812 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. Deleting EBS snapshots with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Advanced Stack Components Version April 22, 2025 813 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Note that the DocumentName in version 1 is AWSManagedServices-DeleteEBSSnapshot; in version 2 it is AWSManagedServices-DeleteEBSSnapshots. These examples are for version 2. Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: With only SnapshotIds specified: aws amscm create-rfc --change-type-id "ct-30bfiwxjku1nu" --change-type-version "2.0" --title "Delete EBS snapshot" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-DeleteEBSSnapshots\",\"Region\":\"us-east-1\",\"Confirmation\": \"delete permanently\",\"Parameters\":{\"SnapshotIds\":[\"snap-0123456789abcdef0\", \"snap-0123456789abcdef1\"]}}" With up to 1000 snapshots listed in an S3 file specified: aws amscm create-rfc --change-type-id "ct-30bfiwxjku1nu" --change-type-version "2.0" --title "Delete EBS Snapshots" --execution-parameters ""{\"DocumentName\": \"AWSManagedServices-DeleteEBSSnapshots\",\"Region\":\"us-east-1\",\"Confirmation\": \"delete permanently\",\"Parameters\":{\"SnapshotIdCsvUrl\":[\"PRE-SIGNED_S3_URL\"]}}" Delete up to 1000 snapshots older than 2020-01-31 and tagged with Delete:True: aws amscm create-rfc --change-type-id "ct-30bfiwxjku1nu" --change-type-version "2.0" --title "Delete EBS Snapshots" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-DeleteEBSSnapshots\",\"Region\":\"us-east-1\",\"Confirmation\": \"delete permanently\",\"Parameters\":{\"StartDate\":[\"2020-01-31\"],\"Tag\":[{\"Key \":\"Delete\",\"Value\":\"True\"}]}}" Delete up to 1000 snapshots older than 2020-01-31 for which source volumes no longer exist: aws amscm create-rfc --change-type-id "ct-30bfiwxjku1nu" --change-type-version "2.0" --title "Delete EBS Snapshots" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-DeleteEBSSnapshots\",\"Region\":\"us-east-1\",\"Confirmation Advanced Stack Components Version April 22, 2025 814 AMS Advanced Change Type Reference AMS Advanced Change Type Details \":\"delete permanently\",\"Parameters\":{\"StartDate\":[\"2020-01-31\"], \"SnapshotsWithoutVolumes\":[\"True\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DeleteEbsSnpshtParams.json: aws amscm get-change-type-version --change-type-id "ct-30bfiwxjku1nu" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeleteEbsSnpshtParams.json 2. Modify and save the DeleteEbsSnpshtParams file. For example, you can replace the contents with something like this: With only SnapshotIds specified: { "DocumentName": "AWSManagedServices-DeleteEBSSnapshots", "Region": "us-east-1", "Confirmation": "delete permanently", "Parameters" : { "SnapshotIds": [ "snap-0123456789abcdef0", "snap-0123456789abcdef1" ] } } With up to 1000 snapshots listed in an S3 file specified: { "DocumentName": "AWSManagedServices-DeleteEBSSnapshots", "Region": "us-east-1", "Confirmation": "delete permanently", "Parameters": { "SnapshotIdCsvUrl": [ "PRE-SIGNED_S3_URL" ] } }} Advanced Stack Components Version April 22, 2025 |
ams-ct-229 | ams-ct.pdf | 229 | parameters JSON schema for this change type to a file; this example names it DeleteEbsSnpshtParams.json: aws amscm get-change-type-version --change-type-id "ct-30bfiwxjku1nu" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeleteEbsSnpshtParams.json 2. Modify and save the DeleteEbsSnpshtParams file. For example, you can replace the contents with something like this: With only SnapshotIds specified: { "DocumentName": "AWSManagedServices-DeleteEBSSnapshots", "Region": "us-east-1", "Confirmation": "delete permanently", "Parameters" : { "SnapshotIds": [ "snap-0123456789abcdef0", "snap-0123456789abcdef1" ] } } With up to 1000 snapshots listed in an S3 file specified: { "DocumentName": "AWSManagedServices-DeleteEBSSnapshots", "Region": "us-east-1", "Confirmation": "delete permanently", "Parameters": { "SnapshotIdCsvUrl": [ "PRE-SIGNED_S3_URL" ] } }} Advanced Stack Components Version April 22, 2025 815 AMS Advanced Change Type Reference AMS Advanced Change Type Details Delete up to 1000 snapshots older than 2020-01-31 and tagged with Delete:True: { "DocumentName": "AWSManagedServices-DeleteEBSSnapshots", "Region": "us-east-1", "Confirmation": "delete permanently", "Parameters": { "StartDate": [ "2020-01-31" ], "Tag": [ {"Key":"Delete","Value":"True"} ] } } Delete up to 1000 snapshots older than 2020-01-31 for which source volumes no longer exist: { "DocumentName": "AWSManagedServices-DeleteEBSSnapshots", "Region": "us-east-1", "Confirmation": "delete permanently", "Parameters": { "StartDate": [ "2020-01-31" ], "SnapshotsWithoutVolumes": [ "True" ] } } 3. Output the RFC template JSON file to a file; this example names it DeleteEbsSnpshtRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteEbsSnpshtRfc.json 4. Modify and save the DeleteEbsSnpshtRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", Advanced Stack Components Version April 22, 2025 816 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-30bfiwxjku1nu", "Title": "EBS-Snapshot-Delete-RFC" } 5. Create the RFC, specifying the DeleteEbsSnpshtRfc file and the DeleteEbsSnpshtParams file: aws amscm create-rfc --cli-input-json file://DeleteEbsSnpshtRfc.json --execution- parameters file://DeleteEbsSnpshtParams.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 more than one parameter is used, only snapshots matching all used parameters are deleted. Snapshots created less than 60 days ago cannot be deleted. To delete snapshots less than 60 days old, use the Management | Other | Other | Update change type (ct-0xdawir96cy7k) or a service request and an AMS engineer will assist you. Additionally, this CT can’t delete snapshots used by AMIs or created by AWS Backup service. Note This change type is now at version 2.0 because new parameters were added to give more flexibility in determining which snapshots would be deleted. The DocumentName in version 1 is AWSManagedServices-DeleteEBSSnapshot; in version 2 it is AWSManagedServices- DeleteEBSSnapshots. To learn more about Amazon EBS snapshots, see Amazon EBS Snapshots. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-30bfiwxjku1nu. Advanced Stack Components Version April 22, 2025 817 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "DocumentName": "AWSManagedServices-DeleteEBSSnapshots", "Region": "us-east-1", "Confirmation": "delete permanently", "Parameters" : {} } Example: All Parameters { "DocumentName": "AWSManagedServices-DeleteEBSSnapshots", "Region": "us-east-1", "Confirmation": "delete permanently", "Parameters": { "SnapshotIds": [ "snap-01234567891234501", "snap-01234567891234502", "snap-01234567891234503", "snap-01234567891234504", "snap-01234567891234505", "snap-01234567891234506", "snap-01234567891234507", "snap-01234567891234508", "snap-01234567891234509", "snap-01234567891234510" ], "SnapshotIdCsvUrl": [ "https://s3.us-east-1.amazonaws.com/my-bucket-0123456789/snapshots.txt? X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ABCDEFGHIJKLMNOPRSTU %2F20200821%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200821T000453Z&X- Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Security- Token=0123456789uX2VjEGgaCXVzLWVhc3QtMSJGMEQCICDq9VkeEyrvJsAbzTrb7QDMfFHY28C8BxgK0WQyKTzmAiA1fIAoUwqAgIRZAN4NvVztgR6yNDjNXqTmjisUAKxOUSqeAghREAIaDDA4ODg2MDEwMDA5OSIMW3BVuq3o4SXDrKbGKvsB0wQYDEnXKaFPdRkcFt08KkY4EsDlP2oprD2Q1JUrkvnBrU92s %2FNNGywqpsnm8GqkqyYfQlfzzPLhWgt9hMBHnEIkhY4sSGmYrRuwOwB%2B187y3imfCReNYrkhbR2SykMO %2BRgFy2buoGXpWBYmWH2pT9IV2aTlKHj9hk7cdCfGfjpIfPYpdXPEoMY%2F1L8BdT94MgwpOqFvKBCpt %2Fhy%2BG3EP6E1KWZK9Re%2BnIpTTzpKMXSM6HAlnl5JfOHWPm8DK6c4IwTPJtvlrJFSFYwYdFU3tO %2FRQmXdVgS8H1LH3ug8tMN3y1SP0uHGub7pM4dcLqOGOTWN6%2F8cofyB33gw9pz8%2BQU6ngFQqBiQIowdj4y35%2FacxKMQmtR6VR7EbJ1hQTFT5xdeFn %2FAv0yWidW3MiWr%2Bhc4sBSnol %2FjfDoWx4g4LzAyJlaz51UGsCqlqWbxSODyslqu5jSnk0On0gRdHHCi8zSkwn4ornnFzsEuMDaigIFdvbkfF8q7eFMy8QNCPZHd1mrGVan %2FJxxFFh6yI9QF6H4bzIB1UzE0x%2FohCbQBZtda7Q%3D%3D&X-Amz- Signature=01234567890fa9d3ebbf26fb5773017de2cc9bc10b50616f04d7932aad5e5473" ], Advanced Stack Components Version April 22, 2025 818 AMS Advanced Change Type Reference AMS Advanced Change Type Details "SnapshotCreationDate": [ "2020-01-31" ], "SnapshotTag": [ "{\"Key\":\"Delete\",\"Value\":\"True\"}" ], "SnapshotsWithoutVolumes": [ "False" ], "S3Bucket": [ "s3://my-bucket-0123456789" ] } } EBS Snapshot | Delete (Review Required) Delete Elastic Block Store (EBS) snapshots. Once snapshots are deleted, they cannot be restored. Consider scheduling this RFC in case you decide to cancel the operation. If your snapshot is older than 30 days, we encourage you to use the automated CT (ct-30bfiwxjku1nu) for snapshot deletion, as it streamlines the process. However, if you are using the SnapshotCreationDate or SnapshotTag parameters, snapshots created within the last 30 days or snapshots is associated with any AMIs or created by AWS Backup service, use this manual CT option to ensure the correct snapshots are deleted. Full classification: Management | Advanced stack components | EBS Snapshot | Delete (Review Required) Change Type Details Change type ID ct-1vrnixswq1uwf Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Advanced Stack Components Version April 22, 2025 819 AMS Advanced Change Type Reference Additional Information Delete EBS snapshot (Review Required) AMS Advanced Change Type Details Use when you need extra help or communications about the snapshots to delete. Deleting EBS snapshots with the Console (Review Required) 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 |
ams-ct-230 | ams-ct.pdf | 230 | Change Type Reference Additional Information Delete EBS snapshot (Review Required) AMS Advanced Change Type Details Use when you need extra help or communications about the snapshots to delete. Deleting EBS snapshots with the Console (Review Required) How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 820 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 EBS snapshots with the CLI (Review Requied) How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 821 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-1vrnixswq1uwf" --change-type-version "1.0" -- title "Delete EBS Snapshot (Review Required)" --execution-parameters "{\"SnapshotIds\": [\"snap-0a1b2c3d4e5f67890\",\"snap-1a2b3c4d5e6f78901\"], \"AMI\": \"No\", \"Region\": \"us-east-1\", \"Priority\": \"Medium\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DeleteEbsSnpshtRrParams.json: aws amscm get-change-type-version --change-type-id "ct-1vrnixswq1uwf" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeleteEbsSnpshtRrParams.json 2. Modify and save the DeleteEbsSnpshtRrParams file. For example, you can replace the contents with something like this: { "SnapshotIds": [ "snap-0a1b2c3d4e5f67890", "snap-1a2b3c4d5e6f78901" ], "AMI": "No", "Region": "us-east-1", "Priority": "Medium" } 3. Output the RFC template JSON file to a file; this example names it DeleteEbsSnpshtRrRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteEbsSnpshtRrRfc.json 4. Modify and save the DeleteEbsSnpshtRrRfc.json file. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 822 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1vrnixswq1uwf", "Title": "EBS-Snapshot-Delete-RR-RFC" } 5. Create the RFC, specifying the DeleteEbsSnpshtRrRfc file and the DeleteEbsSnpshtRrParams file: aws amscm create-rfc --cli-input-json file://DeleteEbsSnpshtRrRfc.json -- execution-parameters file://DeleteEbsSnpshtRrParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and |
ams-ct-231 | ams-ct.pdf | 231 | --generate-cli-skeleton > DeleteEbsSnpshtRrRfc.json 4. Modify and save the DeleteEbsSnpshtRrRfc.json file. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 822 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1vrnixswq1uwf", "Title": "EBS-Snapshot-Delete-RR-RFC" } 5. Create the RFC, specifying the DeleteEbsSnpshtRrRfc file and the DeleteEbsSnpshtRrParams file: aws amscm create-rfc --cli-input-json file://DeleteEbsSnpshtRrRfc.json -- execution-parameters file://DeleteEbsSnpshtRrParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon EBS snapshots, see Amazon EBS Snapshots. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1vrnixswq1uwf. Example: Required Parameters { "Region": "us-east-1" } Example: All Parameters Example not available. EBS Snapshot | Share Share an Elastic Block Store (EBS) snapshot with another AMS account. If the destination account is onboarded in a different AMS Region, use change type ID ct-3lkbpansfv69k in the destination account to copy shared snapshot across regions. Only snapshots encrypted with managed KMS keys can be shared. Full classification: Management | Advanced stack components | EBS snapshot | Share Advanced Stack Components Version April 22, 2025 823 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-3gg0id58rn82h Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Share EBS snapshot Sharing EBS Snapshots 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. Advanced Stack Components Version April 22, 2025 824 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. Sharing EBS Snapshots 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 825 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 |
ams-ct-232 | ams-ct.pdf | 232 | 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-3gg0id58rn82h" --change-type-version "2.0" --title "Share EBS snapshot" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-ShareEBSSnapshot\",\"Region\":\"ap-southeast-2\",\"Parameters\": {\"AccountId\":[\"ACCOUNT_ID\"],\"SnapshotId\":[\"SNAP_ID\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it ShareEbsSnpshtParams.json: aws amscm get-change-type-version --change-type-id "ct-3gg0id58rn82h" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ShareEbsSnpshtParams.json 2. Modify and save the ShareEbsSnpshtParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-ShareEBSSnapshot", "Region": "us-east-1", "Parameters": { Advanced Stack Components Version April 22, 2025 826 AMS Advanced Change Type Reference AMS Advanced Change Type Details "AccountId": [ "ACCOUNT_ID" ], "SnapshotId": [ "SNAPSHOT_ID" ] } } 3. Output the RFC template JSON file to a file; this example names it ShareEbsSnpshtRfc.json: aws amscm create-rfc --generate-cli-skeleton > ShareEbsSnpshtRfc.json 4. Modify and save the ShareEbsSnpshtRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-3gg0id58rn82h", "Title": "EBS-Share-RFC" } 5. Create the RFC, specifying the ShareEbsSnpshtRfc file and the ShareEbsSnpshtParams file: aws amscm create-rfc --cli-input-json file://ShareEbsSnpshtRfc.json --execution- parameters file://ShareEbsSnpshtParams.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 A typical use for the EBS snapshot share and copy CTs would be: 1. In account A, use the EBS snapshot share CT to share the snapshot with account B. 2. In account B, use the Copy EBS snapshot CT to copy the snapshot to the AWS Region for account B. Advanced Stack Components Version April 22, 2025 827 AMS Advanced Change Type Reference AMS Advanced Change Type Details Important This change type version, 2.0, limits snapshot sharing to only snapshots encrypted with managed KMS keys. Additionally, several parameters were removed, TargetParameterName, Targets, MaxConcurrency, and MaxErrors; and one new parameter was introduced, SourceSnapshotId. To learn more about Amazon EBS snapshots, see Amazon EBS Snapshots. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3gg0id58rn82h. Example: Required Parameters { "DocumentName": "AWSManagedServices-ShareEBSSnapshot", "Region": "us-east-1", "Parameters": { "SnapshotId": [ "snap-1234567890abcdef0" ], "AccountId": [ "012345678912" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-ShareEBSSnapshot", "Region": "us-east-1", "Parameters": { "SnapshotId": [ "snap-1234567890abcdef0" ], "AccountId": [ "012345678912" Advanced Stack Components Version April 22, 2025 828 AMS Advanced Change Type Reference AMS Advanced Change Type Details ] } } EBS Volume | Attach Attach an EBS volume to an EC2 instance. This change type provides an option that attempts to remediate drift in the CloudFormation stack where the volume is being attached, but that option, RemediateStackDrift, does not work on volumes created using the CloudFormation ingest change type (ct-36cn2avfrrj9v). Full classification: Management | Advanced stack components | EBS Volume | Attach Change Type Details Change type ID ct-34jldf2qihaic Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 829 AMS Advanced Change Type Reference Additional Information Attach EBS volume Attaching EBS Volumes with the Console AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC |
ams-ct-233 | ams-ct.pdf | 233 | Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 830 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. Attaching EBS Volumes with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 831 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-34jldf2qihaic" --change-type-version "1.0" --title "Attach EBS Volume" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-AttachEBSVolume\",\"Region\":\"us-east-1\",\"Parameters\": {\"VolumeId\":[\"vol-1234567890abcdef0\"],\"InstanceId\":[\"i-1234567890abcdef0\"], \"RemediateStackDrift\":[\"False\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it AttachEbsVolParams.json: aws amscm get-change-type-version --change-type-id "ct-34jldf2qihaic" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AttachEbsVolParams.json 2. Modify and save the AttachEbsVolParams file. For example, you can replace the contents with something like this: { "DocumentName" : "AWSManagedServices-AttachEBSVolume", "Region" : "us-east-1", "Parameters" : { "VolumeId" : [ "vol-1234567890abcdef0" ], "InstanceId" : [ "i-1234567890abcdef0" ], "RemediateStackDrift" : [ "False" ] } } 3. Output the RFC template JSON file to a file; this example names it AttachEbsVolRfc.json: Advanced Stack Components Version April 22, 2025 832 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > AttachEbsVolRfc.json 4. Modify and save the AttachEbsVolRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-34jldf2qihaic", "Title": "EBS-Volumes-Attach-RFC" } 5. Create the RFC, specifying the AttachEbsVolRfc file and the AttachEbsVolParams file: aws amscm create-rfc --cli-input-json file://AttachEbsVolRfc.json --execution- parameters file://AttachEbsVolParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon EBS volumes, see Amazon Elastic Block Store. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-34jldf2qihaic. Example: Required Parameters { "DocumentName" : "AWSManagedServices-AttachEBSVolume", "Region" : "us-east-1", "Parameters" : { "VolumeId" : [ "vol-1234567890abcdef0" ], "InstanceId" : [ "i-1234567890abcdef0" ], Advanced Stack Components Version April 22, 2025 833 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RemediateStackDrift" : [ "False" ] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-AttachEBSVolume", "Region" : "us-east-1", "Parameters" : { "VolumeId" : [ "vol-1234567890abcdef0" ], "InstanceId" : |
ams-ct-234 | ams-ct.pdf | 234 | not start. Tips To learn more about Amazon EBS volumes, see Amazon Elastic Block Store. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-34jldf2qihaic. Example: Required Parameters { "DocumentName" : "AWSManagedServices-AttachEBSVolume", "Region" : "us-east-1", "Parameters" : { "VolumeId" : [ "vol-1234567890abcdef0" ], "InstanceId" : [ "i-1234567890abcdef0" ], Advanced Stack Components Version April 22, 2025 833 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RemediateStackDrift" : [ "False" ] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-AttachEBSVolume", "Region" : "us-east-1", "Parameters" : { "VolumeId" : [ "vol-1234567890abcdef0" ], "InstanceId" : [ "i-1234567890abcdef0" ], "DeviceName" : [ "/dev/sdf" ], "RemediateStackDrift" : [ "False" ] } } EBS Volume | Delete Delete Elastic Block Store (EBS) volumes in an available state. Volumes that are not attached to an instance are in an available state and can be deleted. Full classification: Management | Advanced stack components | EBS Volume | Delete Change Type Details Change type ID ct-3e3h8u0sp5z80 Current version 2.0 Expected execution duration 60 minutes Advanced Stack Components Version April 22, 2025 834 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS approval Required Customer approval Not required Execution mode Automated Additional Information Delete EBS volume Deleting EBS Volumes 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. Advanced Stack Components Version April 22, 2025 835 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. Deleting EBS Volumes with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Advanced Stack Components Version April 22, 2025 836 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-3e3h8u0sp5z80" --change-type-version "2.0" --title "Delete Ebs Volumes" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-DeleteEBSVolumesV2\",\"Region\":\"us-east-1\",\"Parameters\": {\"VolumeIds\":[\"vol-01234567891234501\",\"vol-01234567891234502\"],\"CreateBackup\": \"true\", \"DeleteStackVolume\":\"true\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type |
ams-ct-235 | ams-ct.pdf | 235 | Components Version April 22, 2025 836 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-3e3h8u0sp5z80" --change-type-version "2.0" --title "Delete Ebs Volumes" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-DeleteEBSVolumesV2\",\"Region\":\"us-east-1\",\"Parameters\": {\"VolumeIds\":[\"vol-01234567891234501\",\"vol-01234567891234502\"],\"CreateBackup\": \"true\", \"DeleteStackVolume\":\"true\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DeleteEbsVolParams.json: aws amscm get-change-type-version --change-type-id "ct-3e3h8u0sp5z80" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeleteEbsVolParams.json 2. Modify and save the DeleteEbsVolParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-DeleteEBSVolumes", "Region": "us-east-1", "Parameters": { "VolumeIds": [ "vol-01234567891234501", "vol-01234567891234502" ], "CreateBackup": [ true ], "DeleteStackVolume": [ true ] Advanced Stack Components Version April 22, 2025 837 AMS Advanced Change Type Reference AMS Advanced Change Type Details } } 3. Output the RFC template JSON file to a file; this example names it DeleteEbsVolRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteEbsVolRfc.json 4. Modify and save the DeleteEbsVolRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-3e3h8u0sp5z80", "Title": "EBS-Volumes-Delete-RFC" } 5. Create the RFC, specifying the DeleteEbsVolRfc file and the DeleteEbsVolParams file: aws amscm create-rfc --cli-input-json file://DeleteEbsVolRfc.json --execution- parameters file://DeleteEbsVolParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon EBS volumes, see Amazon Elastic Block Store. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3e3h8u0sp5z80. Example: Required Parameters { "DocumentName": "AWSManagedServices-DeleteEBSVolumesV2", "Region": "us-east-1", "Parameters": { "VolumeIds": [ "vol-01234567891234501", Advanced Stack Components Version April 22, 2025 838 AMS Advanced Change Type Reference AMS Advanced Change Type Details "vol-01234567891234502", "vol-01234567891234503", "vol-01234567891234504", "vol-01234567891234505", "vol-01234567891234506", "vol-01234567891234507", "vol-01234567891234508", "vol-01234567891234509", "vol-01234567891234510" ], "CreateBackup": true, "DeleteStackVolume": true } } Example: All Parameters { "DocumentName": "AWSManagedServices-DeleteEBSVolumesV2", "Region": "us-east-1", "Parameters": { "VolumeIds": [ "vol-01234567891234501", "vol-01234567891234502", "vol-01234567891234503", "vol-01234567891234504", "vol-01234567891234505", "vol-01234567891234506", "vol-01234567891234507", "vol-01234567891234508", "vol-01234567891234509", "vol-01234567891234510", "vol-01234567891234511", "vol-01234567891234512", "vol-01234567891234513", "vol-01234567891234514", "vol-01234567891234515", "vol-01234567891234516", "vol-01234567891234517", "vol-01234567891234518", "vol-01234567891234519", "vol-01234567891234520" ], Advanced Stack Components Version April 22, 2025 839 AMS Advanced Change Type Reference AMS Advanced Change Type Details "CreateBackup": true, "DeleteStackVolume": true } } EBS Volume | Detach Detach an EBS volume from an EC2 instance. This change type provides an option that attempts to remediate drift in the CloudFormation stack where the volume is being detached, but that option, RemediateStackDrift, does not work on volumes created using the CloudFormation ingest change type (ct-36cn2avfrrj9v). Full classification: Management | Advanced stack components | EBS Volume | Detach Change Type Details Change type ID ct-2d55p1d7z6w3d Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 840 AMS Advanced Change Type Reference Additional Information Detach EBS volume Detaching EBS Volumes with the Console AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 841 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. |
ams-ct-236 | ams-ct.pdf | 236 | to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 841 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. Detaching EBS Volumes with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 842 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-2d55p1d7z6w3d" --change-type-version "1.0" --title "Detach EBS Volume" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-DetachEBSVolume\",\"Region\":\"us-east-1\",\"Parameters\": {\"VolumeId\":[\"vol-1234567890abcdef0\"],\"RemediateStackDrift\":[\"False\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DetachEbsVolParams.json: aws amscm get-change-type-version --change-type-id "ct-2d55p1d7z6w3d" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DetachEbsVolParams.json 2. Modify and save the DetachEbsVolParams file. For example, you can replace the contents with something like this: { "DocumentName" : "AWSManagedServices-DetachEBSVolume", "Region" : "us-east-1", "Parameters" : { "VolumeId" : [ "vol-1234567890abcdef0" ], "RemediateStackDrift" : [ "False" ] } } 3. Output the RFC template JSON file to a file; this example names it DetachEbsVolRfc.json: aws amscm create-rfc --generate-cli-skeleton > DetachEbsVolRfc.json 4. Modify and save the DetachEbsVolRfc.json file. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 843 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2d55p1d7z6w3d", "Title": "EBS-Volumes-Detach-RFC" } 5. Create the RFC, specifying the DetachEbsVolRfc file and the DetachEbsVolParams file: aws amscm create-rfc --cli-input-json file://DetachEbsVolRfc.json --execution- parameters file://DetachEbsVolParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon EBS volumes, see Amazon Elastic Block Store. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2d55p1d7z6w3d. Example: Required Parameters { "DocumentName" : "AWSManagedServices-DetachEBSVolume", "Region" : "us-east-1", "Parameters" : { "VolumeId" : [ "vol-1234567890abcdef0" ] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-DetachEBSVolume", "Region" : "us-east-1", Advanced Stack Components Version April 22, 2025 844 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Parameters" : { "VolumeId" : [ "vol-1234567890abcdef0" ], "RemediateStackDrift" : [ "False" ] } } EBS Volume | Encrypt EBS By Default Set Amazon Elastic Block Store (EBS) to enforce the encryption. After you enable encryption by default, the EBS volumes that you create and snapshot copies are always encrypted, either using the KMS key configured as default for EBS encryption or the key that you specified when you created each volume. Full classification: Management | Advanced stack components | EBS Volume | Encrypt EBS by default Change Type Details Change type ID ct-0vevjppj9eta4 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Encrypt EBS volumes by default Set default EBS volume encryption for EC2 |
ams-ct-237 | ams-ct.pdf | 237 | Store (EBS) to enforce the encryption. After you enable encryption by default, the EBS volumes that you create and snapshot copies are always encrypted, either using the KMS key configured as default for EBS encryption or the key that you specified when you created each volume. Full classification: Management | Advanced stack components | EBS Volume | Encrypt EBS by default Change Type Details Change type ID ct-0vevjppj9eta4 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Encrypt EBS volumes by default Set default EBS volume encryption for EC2 instances with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 845 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Advanced Stack Components Version April 22, 2025 846 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. Set default EBS volume encryption for EC2 instances 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 847 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --change-type-id "ct-0vevjppj9eta4" --change-type-version "1.0" --title "Encrypt EBS by default" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-EncryptEBSByDefault\",\"Region\":\"us-east-1\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it EncryptEbsByDefaultParams.json: aws amscm get-change-type-version --change-type-id "ct-0vevjppj9eta4" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > EncryptEbsByDefaultParams.json 2. Modify and save the EncryptEbsByDefaultParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-EncryptEBSByDefault", "Region": "us-east-1" } 3. Output the RFC template to a file in your current folder; this example names it EncryptEbsByDefaultRfc.json: aws amscm create-rfc --generate-cli-skeleton > EncryptEbsByDefaultRfc.json 4. Modify |
ams-ct-238 | ams-ct.pdf | 238 | "ct-0vevjppj9eta4" --change-type-version "1.0" --title "Encrypt EBS by default" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-EncryptEBSByDefault\",\"Region\":\"us-east-1\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it EncryptEbsByDefaultParams.json: aws amscm get-change-type-version --change-type-id "ct-0vevjppj9eta4" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > EncryptEbsByDefaultParams.json 2. Modify and save the EncryptEbsByDefaultParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-EncryptEBSByDefault", "Region": "us-east-1" } 3. Output the RFC template to a file in your current folder; this example names it EncryptEbsByDefaultRfc.json: aws amscm create-rfc --generate-cli-skeleton > EncryptEbsByDefaultRfc.json 4. Modify and save the EncryptEbsByDefaultRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0vevjppj9eta4", "Title": "Encrypt EBS by default" } 5. Create the RFC, specifying the EncryptEbsByDefaultRfc file and the EncryptEbsByDefaultParams file: aws amscm create-rfc --cli-input-json file://EncryptEbsByDefaultRfc.json -- execution-parameters file://EncryptEbsByDefaultParams.json Advanced Stack Components Version April 22, 2025 848 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 After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default AWS KMS key or the KMS key that you specified when you created each volume. This CT can only run in Networking and Shared Services multi-account landing zone accounts. To learn more about doing this, see enable-ebs-encryption-by-default. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0vevjppj9eta4. Example: Required Parameters { "DocumentName" : "AWSManagedServices-EncryptEBSByDefault", "Region" : "us-east-1" } Example: All Parameters { "DocumentName" : "AWSManagedServices-EncryptEBSByDefault", "Region" : "us-east-1" } EBS Volume | Modify Modify EBS Volumes that are not attached to an EC2 instance in an Auto Scaling group. If you resize the volume, then you may need to extend the OS file system on the volume to use any newly Advanced Stack Components Version April 22, 2025 849 AMS Advanced Change Type Reference AMS Advanced Change Type Details allocated space. If a drift is introduced in the CloudFormation stack that was used to create the volume, then the automation can try to remediate the stack drift for stacks that are not created using CloudFormation ingest change type (ct-36cn2avfrrj9v). Full classification: Management | Advanced stack components | EBS Volume | Modify Change Type Details Change type ID ct-1wle0ai4en6km Current version 2.0 Expected execution duration 280 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Modify EBS volume Modifying an EBS Volume with the Console Screenshot of this change type, in the AMS console: Advanced Stack Components Version April 22, 2025 850 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. Modifying an EBS Volume with the CLI How it |
ams-ct-239 | ams-ct.pdf | 239 | 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. Modifying an EBS Volume with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. Advanced Stack Components Version April 22, 2025 851 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-1wle0ai4en6km" --change-type-version "2.0" --title "Modify EBS Volume" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-ModifyEBSVolumes\",\"Region\":\"us-east-1\",\"Parameters \":{\"VolumeIds\":[\"vol-1234567890abcdef1\",\"vol-1234567890abcdef2\", \"vol-1234567890abcdef3\",\"vol-1234567890abcdef4\",\"vol-1234567890abcdef5\"], \"CreateSnapshot\":[\"False\"],\"VolumeType\":[\"gp3\"],\"VolumeSize\":[\"40\"],\"Iops \":[\"3000\"],\"Throughput\":[\"200\"],\"RemediateStackDrift\":[\"False\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it ModifyEBSVolumeParams.json: Advanced Stack Components Version April 22, 2025 852 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm get-change-type-version --change-type-id "ct-1wle0ai4en6km" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ModifyEBSVolumeParams.json 2. Modify and save the ModifyEBSVolumeParams file. { "DocumentName" : "AWSManagedServices-ModifyEBSVolumes", "Region" : "us-east-1", "Parameters" : { "VolumeIds" : [ "vol-1234567890abcdef1", "vol-1234567890abcdef2", "vol-1234567890abcdef3", "vol-1234567890abcdef4", "vol-1234567890abcdef5" ], "CreateSnapshot" : [ "False" ], "VolumeType" : [ "gp3" ], "VolumeSize" : [ "40" ], "Iops" : [ "3000" ], "Throughput" : [ "200" ], "RemediateStackDrift" : [ "False" ] } } 3. Output the RFC template to a file in your current folder; this example names it ModifyEBSVolumeRfc.json: Advanced Stack Components Version April 22, 2025 853 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > ModifyEBSVolumeRfc.json 4. Modify and save the ModifyEBSVolumeRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-1wle0ai4en6km", "Title": "Modify EBS Volume" } 5. Create the RFC, specifying the ModifyEBSVolumeRfc file and the ModifyEBSVolumeParams file: aws amscm create-rfc --cli-input-json file://ModifyEBSVolumeRfc.json --execution- parameters file://ModifyEBSVolumeParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon EBS, see Amazon Elastic Block Store (EBS). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1wle0ai4en6km. Example: Required Parameters { "DocumentName": "AWSManagedServices-ModifyEBSVolumes", "Region": "us-east-1", "Parameters": { "VolumeIds": [ "vol-1234567890abcdef0" ] } } Advanced Stack Components Version April 22, 2025 854 AMS Advanced Change Type Reference Example: All Parameters { "DocumentName": "AWSManagedServices-ModifyEBSVolumes", AMS Advanced Change Type Details "Region": "us-east-1", "Parameters": { "VolumeIds": [ "vol-01234567891234501", "vol-01234567891234502", "vol-01234567891234503", "vol-01234567891234504", "vol-01234567891234505", "vol-01234567891234506", "vol-01234567891234507", "vol-01234567891234508", "vol-01234567891234509", "vol-01234567891234510", "vol-01234567891234511", "vol-01234567891234512", "vol-01234567891234513", "vol-01234567891234514", "vol-01234567891234515", "vol-01234567891234516", "vol-01234567891234517", "vol-01234567891234518", "vol-01234567891234519", "vol-01234567891234520" ], "CreateSnapshot": [ "False" ], "VolumeType": [ "gp3" ], "VolumeSize": [ "40" ], "Iops": [ "3000" ], "Throughput": [ "200" ], "RemediateStackDrift": [ Advanced Stack Components Version April 22, 2025 855 AMS Advanced Change Type Reference AMS Advanced Change Type Details "False" ] } } EBS Volume | Update Modify the properties of an existing Elastic Block Store (EBS) volume stack created using CT id ct-16xg8qguovg2w, version 1.0. No service interruption is expected during the update. Full classification: Management | Advanced stack components | EBS Volume | Update Change Type Details Change type ID ct-2y6q4vco4miyp Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 856 AMS Advanced Change Type Reference Additional Information Update EBS volume Updating EBS Volumes with the Console |
ams-ct-240 | ams-ct.pdf | 240 | Advanced Change Type Details "False" ] } } EBS Volume | Update Modify the properties of an existing Elastic Block Store (EBS) volume stack created using CT id ct-16xg8qguovg2w, version 1.0. No service interruption is expected during the update. Full classification: Management | Advanced stack components | EBS Volume | Update Change Type Details Change type ID ct-2y6q4vco4miyp Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 856 AMS Advanced Change Type Reference Additional Information Update EBS volume Updating EBS Volumes with the Console AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 857 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. Updating EBS Volumes with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 858 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-2y6q4vco4miyp" --change-type- version "1.0" --title "Update EBS Volume" --execution-parameters "{\"VpcId\": \"vpc-0a60eb65b4EXAMPLE\",\"StackId\": \"stack-1234567890abcdef0\",\"Parameters\": {\"Volume1Iops\": \"3500\",\"Volume1Throughput\": \"200\",\"Volume2Type\": \"gp3\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UpdateEbsParams.json: aws amscm get-change-type-version --change-type-id "ct-2y6q4vco4miyp" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateEbsParams.json 2. Modify and save the UpdateEbsParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "VpcId": "vpc-0a60eb65b4EXAMPLE", "StackId": "stack-1234567890abcdef0", "Parameters": { "Volume1Iops": "3500", "Volume1Throughput": "200", "Volume2Type": "gp3" } } 3. Output the RFC template JSON file to a file; this example names it UpdateEbsRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateEbsRfc.json 4. Modify and save the UpdateEbsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", Advanced |
ams-ct-241 | ams-ct.pdf | 241 | example names it UpdateEbsParams.json: aws amscm get-change-type-version --change-type-id "ct-2y6q4vco4miyp" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateEbsParams.json 2. Modify and save the UpdateEbsParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "VpcId": "vpc-0a60eb65b4EXAMPLE", "StackId": "stack-1234567890abcdef0", "Parameters": { "Volume1Iops": "3500", "Volume1Throughput": "200", "Volume2Type": "gp3" } } 3. Output the RFC template JSON file to a file; this example names it UpdateEbsRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateEbsRfc.json 4. Modify and save the UpdateEbsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", Advanced Stack Components Version April 22, 2025 859 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-2y6q4vco4miyp", "Title": "Update EBS volume" } 5. Create the RFC, specifying the UpdateEbsRfc file and the UpdateEbsParams file: aws amscm create-rfc --cli-input-json file://UpdateEbsRfc.json --execution- parameters file://UpdateEbsParams.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 detailed information on creating RFCs, see Creating a Request for change (RFC); for an explanation of common RFC parameters, see RFC common parameters. To learn more about Amazon EBS, see Amazon Elastic Block Store (EBS). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2y6q4vco4miyp. Example: Required Parameters { "VpcId": "vpc-1234567890abcdef0", "StackId": "stack-a1b2c3d4e5f67890e", "Parameters": {} } Example: All Parameters { "VpcId": "vpc-1234567890abcdef0", "StackId": "stack-a1b2c3d4e5f67890e", "Parameters": { "Volume1Iops": "3000", "Volume1Throughput": "125", Advanced Stack Components Version April 22, 2025 860 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Volume1Size": "100", "Volume1Type": "gp3", "Volume2Iops": "3000", "Volume2Throughput": "125", "Volume2Size": "100", "Volume2Type": "gp3", "Volume3Iops": "3000", "Volume3Throughput": "125", "Volume3Size": "100", "Volume3Type": "gp3", "Volume4Iops": "3000", "Volume4Throughput": "125", "Volume4Size": "100", "Volume4Type": "gp3", "Volume5Iops": "3000", "Volume5Throughput": "125", "Volume5Size": "100", "Volume5Type": "gp3" } } EC2 Instance Stack | Associate Private IP Addresses (Review Required) Associate one or more secondary private IP addresses to the specified network interface. Full classification: Management | Advanced stack components | EC2 instance stack | Associate private IP addresses (review required) Change Type Details Change type ID ct-1pvlhug439gl2 Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Advanced Stack Components Version April 22, 2025 861 AMS Advanced Change Type Reference Additional Information AMS Advanced Change Type Details Associate private IP addresses (review required) ct-1pvlhug439gl2 Associate private IP addresses 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. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 862 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a pre-ingest instance 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 |
ams-ct-242 | ams-ct.pdf | 242 | Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. 5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating a pre-ingest instance with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 863 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --title="Associate Private IP Addresses" --description="Associate Private IP Addresses" --ct-id="ct-1pvlhug439gl2" --ct-version="1.0" --input- params="{\"NetworkInterfaceId\":\"eni-0123456789abcdef0\",\"PrivateIpAddresses\": [\"10.0.0.82\",\"10.0.0.83\"]}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it AssociatePrivateIPAddressesParams.json: aws amscm get-change-type-version --change-type-id "ct-1pvlhug439gl2" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > AssociatePrivateIPAddressesParams.json 2. Modify and save the AssociatePrivateIPAddressesParams file. For example, you can replace the contents with something like this: { "NetworkInterfaceId": "eni-0123456789abcdef0", "PrivateIpAddresses": ["10.0.0.82", "10.0.0.83"] } } 3. Output the RFC template to a file in your current folder; this example names it AssociatePrivateIPAddressesRfc.json: aws amscm create-rfc --generate-cli-skeleton > AssociatePrivateIPAddressesRfc.json 4. Modify and save the AssociatePrivateIPAddressesRfc.json file. For example, you can replace the contents with something like this:. { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1pvlhug439gl2", "Title": "Associate Private IP Addresses" Advanced Stack Components Version April 22, 2025 864 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 5. Create the RFC, specifying the AssociatePrivateIPAddressesRfc file and the AssociatePrivateIPAddressesParams file: aws amscm create-rfc --cli-input-json file://AssociatePrivateIPAddressesRfc.json --execution-parameters file://AssociatePrivateIPAddressesParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about Amazon EC2 IP addresses, see Amazon EC2 instance IP addressing. If needed, see EC2 instance stack create fail. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1pvlhug439gl2. Example: Required Parameters { "NetworkInterfaceId": "eni-0123456789abcdef0", "PrivateIpAddresses": ["10.0.0.82"] } Example: All Parameters { "NetworkInterfaceId": "eni-0123456789abcdef0", "PrivateIpAddresses": ["10.0.0.82", "10.0.0.83"], "Priority": "High" } EC2 Instance Stack | Change Hostname (Linux) Change the hostname of an EC2 Linux instance. If no hostname is provided, then the hostname is randomized. Advanced Stack Components Version April 22, 2025 865 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Management | Advanced stack components | EC2 instance stack | Change hostname (Linux) Change Type Details Change type ID ct-2781aqd6f6svs Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Change hostname (Linux) Changing the hostname for a Linux EC2 instance 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. Advanced Stack Components Version April 22, 2025 866 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, |
ams-ct-243 | ams-ct.pdf | 243 | 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. Changing the hostname for a Linux EC2 instance 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 867 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-2781aqd6f6svs" --change-type-version "2.0" --title "Change Linux hostname" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-ChangeHostname\",\"Region\": \"us-east-1\",\"Parameters\": {\"InstanceId\": [\"i-1234567890abcdef0\"],\"Hostname\": [\"01234567890abcd\"], \"Platform\": [\"linux\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it ChangeLinuxHostnameParams.json: aws amscm get-change-type-version --change-type-id "ct-2781aqd6f6svs" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ChangeLinuxHostnameParams.json 2. Modify and save the ChangeLinuxHostnameParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 868 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-ChangeHostname", "Region": "us-east-1", "Parameters": { "InstanceId": [ "i-1234567890abcdef0" ], "Hostname": [ "01234567890abcd" ], "Platform" : ["linux"] } }} 3. Output the RFC template to a file in your current folder; this example names it ChangeLinuxHostnameRfc.json: aws amscm create-rfc --generate-cli-skeleton > ChangeLinuxHostnameRfc.json 4. Modify and save the ChangeLinuxHostnameRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-2781aqd6f6svs", "Title": "Change Linux Hostname" } 5. Create the RFC, specifying the ChangeLinuxHostnameRfc file and the ChangeLinuxHostnameParams file: aws amscm create-rfc --cli-input-json file://ChangeLinuxHostnameRfc.json -- execution-parameters file://ChangeLinuxHostnameParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note This change type is at a new version, 2.0, and is now automated (version 1.0 was execution mode=manual). There are additional parameters, notably DocumentName and Platform. Advanced Stack Components Version April 22, 2025 869 AMS Advanced Change Type Reference AMS Advanced Change Type Details To learn more about doing this, see Changing the hostname of your |
ams-ct-244 | ams-ct.pdf | 244 | create-rfc --cli-input-json file://ChangeLinuxHostnameRfc.json -- execution-parameters file://ChangeLinuxHostnameParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note This change type is at a new version, 2.0, and is now automated (version 1.0 was execution mode=manual). There are additional parameters, notably DocumentName and Platform. Advanced Stack Components Version April 22, 2025 869 AMS Advanced Change Type Reference AMS Advanced Change Type Details To learn more about doing this, see Changing the hostname of your Amazon Linux instance. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2781aqd6f6svs. Example: Required Parameters { "DocumentName" : "AWSManagedServices-ChangeHostname", "Region" : "us-east-1", "Parameters" : { "InstanceId" : [ "i-1234567890abcdef0" ], "Platform" : [ "linux" ] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-ChangeHostname", "Region" : "us-east-1", "Parameters" : { "InstanceId" : [ "i-1234567890abcdef0" ], "Hostname" : [ "testhostname" ], "Platform" : [ "linux" ] } } EC2 Instance Stack | Change Hostname (Windows) Change the hostname of an EC2 Windows instance. Note that the instance will be rebooted. Advanced Stack Components Version April 22, 2025 870 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classification: Management | Advanced stack components | EC2 instance stack | Change hostname (Windows) Change Type Details Change type ID ct-0h3p576mj4rqm Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Change hostname (Windows) Changing the hostname for a Windows EC2 instance with the console The following shows this change type in the AMS console. How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. Advanced Stack Components Version April 22, 2025 871 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. Changing the hostname for a Windows EC2 instance 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 872 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, |
ams-ct-245 | ams-ct.pdf | 245 | 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 872 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-0h3p576mj4rqm" --change-type-version "1.0" --title "Change Windows Hostname" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-ChangeHostname\",\"Region\":\"us-east-1\",\"Parameters\": {\"InstanceId\":[\"i-12345678901234567\"],\"Hostname\":[\"myhost\"],\"Platform\": [\"windows\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it ChangeWindowsHostnameParams.json: aws amscm get-change-type-version --change-type-id "ct-0h3p576mj4rqm" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ChangeWindowsHostnameParams.json 2. Modify and save the ChangeWindowsHostnameParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "DocumentName" : "AWSManagedServices-ChangeHostname", Advanced Stack Components Version April 22, 2025 873 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region" : "us-east-1", "Parameters" : { "InstanceId" : [ "i-12345678901234567" ], "Hostname" : [ "myhost" ], "Platform" : [ "windows" ] } } 3. Output the RFC template to a file in your current folder; this example names it ChangeWindowsHostnameRfc.json: aws amscm create-rfc --generate-cli-skeleton > ChangeWindowsHostnameRfc.json 4. Modify and save the ChangeWindowsHostnameRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0h3p576mj4rqm", "Title": "Change Windows Hostname" } 5. Create the RFC, specifying the ChangeWindowsHostnameRfc file and the ChangeWindowsHostnameParams file: aws amscm create-rfc --cli-input-json file://ChangeWindowsHostnameRfc.json -- execution-parameters file://ChangeWindowsHostnameParams.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 EC2 for Windows, see the EC2 User Guide for Windows. Advanced Stack Components Version April 22, 2025 874 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-0h3p576mj4rqm. Example: Required Parameters { "DocumentName" : "AWSManagedServices-ChangeHostname", "Region" : "us-east-1", "Parameters" : { "InstanceId" : [ "i-12345678901234567" ], "Hostname" : [ "testhostname" ], "Platform" : [ "windows" ] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-ChangeHostname", "Region" : "us-east-1", "Parameters" : { "InstanceId" : [ "i-12345678901234567" ], "Hostname" : [ "testhostname" ], "Platform" : [ "windows" ] } } Advanced Stack Components Version April 22, 2025 875 AMS Advanced Change Type Reference AMS Advanced Change Type Details EC2 Instance Stack | Change Time Zone Change the time zone of an EC2 instance. To reboot the EC2 instance after changing the time zone, set Reboot = true. Full classification: Management | Advanced stack components | EC2 instance stack | Change time zone Change Type Details Change type ID ct-3g9dbtun44mal Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Change time zone on instance Changing an EC2 instance time zone with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 876 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 |
ams-ct-246 | ams-ct.pdf | 246 | 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 877 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. Changing an EC2 instance time zone with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 878 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-3g9dbtun44mal" --change-type-version "1.0" --title "Change time zone" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-SetInstanceTimeZone\",\"Region\":\"us-east-1\",\"Parameters\": {\"InstanceId\":\"i-1234567890abcdef0\",\"Reboot\":\"True\",\"TimeZone\":\"Australia/ Sydney (AUS Eastern Standard Time)\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it ChangeEC2TimezoneParams.json: aws amscm get-change-type-version --change-type-id "ct-3g9dbtun44mal" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ChangeEC2TimezoneParams.json 2. Modify and save the ChangeEC2TimezoneParams file. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-SetInstanceTimeZone", "Region": "us-east-1", "Parameters": { "InstanceId": "i-1234567890abcdef0", "Reboot": "True", "TimeZone": "Australia/Sydney (AUS Eastern Standard Time)" } } 3. Output the RFC template to a file in your current folder; this example names it ChangeEC2TimezoneRfc.json: aws amscm create-rfc --generate-cli-skeleton > ChangeEC2TimezoneRfc.json 4. Modify and save the ChangeEC2TimezoneRfc.json file. For example, you can replace the contents with something like this:. { Advanced Stack Components Version April 22, 2025 879 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3g9dbtun44mal", "Title": "Change EC2 Instance Time Zone" } 5. Create the RFC, specifying the ChangeEC2TimezoneRfc file and the ChangeEC2TimezoneParams file: aws amscm create-rfc --cli-input-json file://ChangeEC2TimezoneRfc.json -- execution-parameters file://ChangeEC2TimezoneParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about Amazon EC2, see Amazon Elastic Compute Cloud Documentation. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3g9dbtun44mal. Example: Required Parameters { "DocumentName": "AWSManagedServices-SetInstanceTimeZone", "Region": "us-east-1", "Parameters": { "InstanceId": "i-1234567890abcdef0", "Reboot": "False", "TimeZone": "Australia/Sydney (AUS Eastern Standard Time)" } } Example: All Parameters { "DocumentName": "AWSManagedServices-SetInstanceTimeZone", "Region": "us-east-1", Advanced Stack Components Version April 22, 2025 880 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Parameters": { "InstanceId": "i-1234567890abcdef0", "Reboot": "True", "TimeZone": "Australia/Sydney (AUS Eastern Standard Time)" } } EC2 Instance Stack | Enable Detailed Monitoring (Review Required) Enable detailed monitoring for the specified EC2 instance. Detailed monitoring incurs |
ams-ct-247 | ams-ct.pdf | 247 | Documentation. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3g9dbtun44mal. Example: Required Parameters { "DocumentName": "AWSManagedServices-SetInstanceTimeZone", "Region": "us-east-1", "Parameters": { "InstanceId": "i-1234567890abcdef0", "Reboot": "False", "TimeZone": "Australia/Sydney (AUS Eastern Standard Time)" } } Example: All Parameters { "DocumentName": "AWSManagedServices-SetInstanceTimeZone", "Region": "us-east-1", Advanced Stack Components Version April 22, 2025 880 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Parameters": { "InstanceId": "i-1234567890abcdef0", "Reboot": "True", "TimeZone": "Australia/Sydney (AUS Eastern Standard Time)" } } EC2 Instance Stack | Enable Detailed Monitoring (Review Required) Enable detailed monitoring for the specified EC2 instance. Detailed monitoring incurs a charge. EC2 detailed monitoring provides more frequent metrics, published at one-minute intervals, instead of the five-minute intervals used in Amazon EC2 basic monitoring. Full classification: Management | Advanced stack components | EC2 instance stack | Enable detailed monitoring (review required) Change Type Details Change type ID ct-211l2gxvsrrhy Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Additional Information Enable Detailed Monitoring Enable detailed monitoring with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 881 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 882 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. Enable detailed monitoring with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 883 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-211l2gxvsrrhy" --change-type-version "1.0" --title "Enable Detailed Monitoring" --execution-parameters "{\"InstanceIds\": [\"i-1234567890abcdef0\",\"i-1234567890abcdef1\"]}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it EnableDetailedMonitoringParams.json: |
ams-ct-248 | ams-ct.pdf | 248 | all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 883 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-211l2gxvsrrhy" --change-type-version "1.0" --title "Enable Detailed Monitoring" --execution-parameters "{\"InstanceIds\": [\"i-1234567890abcdef0\",\"i-1234567890abcdef1\"]}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it EnableDetailedMonitoringParams.json: aws amscm get-change-type-version --change-type-id "ct-211l2gxvsrrhy" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > EnableDetailedMonitoringParams.json 2. Modify and save the EnableDetailedMonitoringParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "InstanceIds": ["i-0cc489fa851c31a21","i-0cc489fa851c31a22"] } 3. Output the RFC template to a file in your current folder; this example names it EnableDetailedMonitoringRfc.json: aws amscm create-rfc --generate-cli-skeleton > EnableDetailedMonitoringRfc.json 4. Modify and save the EnableDetailedMonitoringRfc file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-211l2gxvsrrhy", "Title": "Enable Detailed Monitoring" } 5. Create the RFC, specifying the EnableDetailedMonitoringRfc file and the EnableDetailedMonitoringParams file: Advanced Stack Components Version April 22, 2025 884 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://EnableDetailedMonitoringRfc.json -- execution-parameters file://EnableDetailedMonitoringParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about Amazon EC2, including size recommendations, see Amazon Elastic Compute Cloud Documentation. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-211l2gxvsrrhy. Example: Required Parameters { "InstanceIds": ["i-1234567890abcdef0","i-1234567890abceef1"] } Example: All Parameters { "InstanceIds": ["i-1234567890abcdef0","i-1234567890abceef1"] } EC2 Instance Stack | Encrypt Instance Volumes Encrypt Elastic Block Store (EBS) volumes attached to an EC2 instance Full classification: Management | Advanced stack components | EC2 instance stack | Encrypt instance volumes Change Type Details Change type ID ct-0hahohe17csnc Advanced Stack Components Version April 22, 2025 885 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 Encrypt Amazon EC2 instance volumes Encrypting Amazon EC2 instance volumes 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. Advanced Stack Components Version April 22, 2025 886 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. Encrypting Amazon EC2 instance volumes 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 |
ams-ct-249 | ams-ct.pdf | 249 | 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. Encrypting Amazon EC2 instance volumes with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Advanced Stack Components Version April 22, 2025 887 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-0hahohe17csnc" --change-type-version "1.0" --title "AWSManagedServices-EncryptInstanceVolumes" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-EncryptInstanceVolumes\",\"Region \": \"us-east-1\",\"Parameters\": {\"InstanceId\": [\"i-0a458848bc91a1b7b\"], \"VolumeIds\": [\"vol-02f576d0e8c5c51e8\", \"vol-0090e02379b9880d9\"], \"KMSKeyId\": [\"7103a217-2489-481e-976c-0375efc5f606\"], \"DeleteStaleNonEncryptedSnapshotBackups \": [\"False\"], \"CopyTagsToNewEncryptedVolumes\": [\"False\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it EncryptEC2sParams.json: aws amscm get-change-type-version --change-type-id "ct-0hahohe17csnc" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > EncryptEC2sParams.json 2. Modify and save the EncryptEC2sParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-EncryptInstanceVolumes", "Region": "us-east-1", "Parameters": { "InstanceId": [ Advanced Stack Components Version April 22, 2025 888 AMS Advanced Change Type Reference AMS Advanced Change Type Details "i-0a458848bc91a1b7b"], "VolumeIds": [ "vol-02f576d0e8c5c51e8", "vol-0090e02379b9880d9"], "KMSKeyId": [ "7103a217-2489-481e-976c-0375efc5f606"], "DeleteStaleNonEncryptedSnapshotBackups": [ "False"], "CopyTagsToNewEncryptedVolumes": ["True"] } } 3. Output the RFC template to a file in your current folder; this example names it EncryptEC2sRfc.json: aws amscm create-rfc --generate-cli-skeleton > EncryptEC2sRfc.json 4. Modify and save the EncryptEC2sRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0hahohe17csnc", "Title": "EC2-Encrypt-RFC" } 5. Create the RFC, specifying the EncryptEC2sRfc file and the EncryptEC2sParams file: aws amscm create-rfc --cli-input-json file://EncryptEC2sRfc.json --execution- parameters file://EncryptEC2sParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • For more information about encrypting Amazon EC2 instance volumes, see Encryption best practices for Amazon EC2and Amazon EBS • For more information about Amazon EC2, including size recommendations, see Amazon Elastic Compute Cloud Documentation. Advanced Stack Components Version April 22, 2025 889 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-0hahohe17csnc. Example: Required Parameters { "DocumentName" : "AWSManagedServices-EncryptInstanceVolumes", "Region" : "us-east-1", "Parameters": { "InstanceId": ["i-1234567890abcdef0"], "VolumeIds": ["vol-1234567890abcdef0", "vol-1234567890abcdef1"], "KMSKeyId": ["1234abcd-12ab-34cd-56ef-1234567890ab"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-EncryptInstanceVolumes", "Region" : "us-east-1", "Parameters": { "InstanceId": ["i-1234567890abcdef0"], "VolumeIds": ["vol-1234567890abcdef0", "vol-1234567890abcdef1"], "KMSKeyId": ["mrk-c280f426a06049f0bd3f998242ae2f70"], "DeleteStaleNonEncryptedSnapshotBackups": ["False"], "CopyTagsToNewEncryptedVolumes": ["True"] } } EC2 Instance Stack | Gather Log4j Information Generates a report identifying Log4j2 occurrences on the specified EC2 instances. This is a best- effort report and some occurrences may go undetected from the report. Full classification: Management | Advanced stack components | EC2 instance stack | Gather log4j information Change Type Details Change type ID ct-19f40lfm5umy8 Advanced Stack Components Version April 22, 2025 890 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 Other Other CTs Gather Log4j Info on multiple EC2 instances 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 |
ams-ct-250 | ams-ct.pdf | 250 | Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update Other Other CTs Gather Log4j Info on multiple EC2 instances 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. Advanced Stack Components Version April 22, 2025 891 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. Gather Log4j Info on multiple EC2 instances with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Advanced Stack Components Version April 22, 2025 892 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: Version 2.0: Scan all instances: aws amscm create-rfc --change-type-id "ct-19f40lfm5umy8" --change-type-version "2.0" --title "Log4j Investigation" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-GatherLog4jInformation\",\"Region\":\"us-east-1\",\"Parameters\": {\"S3Bucket\":[\"s3://BUCKET_NAME\"]},\"TargetParameterName\": \"InstanceId\",\"Targets \": [{\"Key\": \"AWS::EC2::Instance\",\"Values\": [\"*\"]}],\"MaxConcurrency\": \"10\", \"MaxErrors\": \"100%\"}" Scan a list of instances: aws amscm create-rfc --change-type-id "ct-19f40lfm5umy8" --change-type-version "2.0" --title "Log4j Investigation" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-GatherLog4jInformation\",\"Region\":\"us-east-1\",\"Parameters\": {\"S3Bucket\":[\"s3://BUCKET_NAME\"]},\"TargetParameterName\": \"InstanceId\",\"Targets \": [{\"Key\": \"ParameterValues\",\"Values\": [\"INSTANCE_ID_1\",\"INSTANCE_ID_2\", \"INSTANCE_ID_3\",\"INSTANCE_ID_4\",\"INSTANCE_ID_5\"]}],\"MaxConcurrency\": \"10\", \"MaxErrors\": \"100%\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it GatherLog4jInfoParams.json: Advanced Stack Components Version April 22, 2025 893 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm get-change-type-version --change-type-id "ct-19f40lfm5umy8" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > GatherLog4jInfoParams.json 2. Modify and save the GatherLog4jInfoParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: Version 2.0: Scan all instances: { "DocumentName": "AWSManagedServices-GatherLog4jInformation", "Region": "us-east-1", "Parameters": { "S3Bucket": [ "s3://BUCKET_NAME" ] }, "TargetParameterName": "InstanceId", "Targets": [ { "Key": "AWS::EC2::Instance", "Values": [ "*" ] } ], "MaxConcurrency": "10", "MaxErrors": "100%" } Scan a list of instances: { "DocumentName": "AWSManagedServices-GatherLog4jInformation", "Region": "us-east-1", "Parameters": { "S3Bucket": [ "s3://BUCKET_NAME" ] Advanced Stack Components Version April 22, 2025 894 AMS Advanced Change Type Reference AMS |
ams-ct-251 | ams-ct.pdf | 251 | --change-type-id "ct-19f40lfm5umy8" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > GatherLog4jInfoParams.json 2. Modify and save the GatherLog4jInfoParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: Version 2.0: Scan all instances: { "DocumentName": "AWSManagedServices-GatherLog4jInformation", "Region": "us-east-1", "Parameters": { "S3Bucket": [ "s3://BUCKET_NAME" ] }, "TargetParameterName": "InstanceId", "Targets": [ { "Key": "AWS::EC2::Instance", "Values": [ "*" ] } ], "MaxConcurrency": "10", "MaxErrors": "100%" } Scan a list of instances: { "DocumentName": "AWSManagedServices-GatherLog4jInformation", "Region": "us-east-1", "Parameters": { "S3Bucket": [ "s3://BUCKET_NAME" ] Advanced Stack Components Version April 22, 2025 894 AMS Advanced Change Type Reference AMS Advanced Change Type Details }, "TargetParameterName": "InstanceId", "Targets": [ { "Key": "ParameterValues", "Values": [ "INSTANCE_ID_1", "INSTANCE_ID_2", "INSTANCE_ID_3", "INSTANCE_ID_4", "INSTANCE_ID_5" ] } ], "MaxConcurrency": "10", "MaxErrors": "100%" } 3. Output the RFC template to a file in your current folder; this example names it GatherLog4jInfoRfc.json: aws amscm create-rfc --generate-cli-skeleton > GatherLog4jInfoRfc.json 4. Modify and save the GatherLog4jInfoRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-19f40lfm5umy8", "Title": "Log4j Investigation" } 5. Create the RFC, specifying the GatherLog4jInfoRfc file and the GatherLog4jInfoParams file: aws amscm create-rfc --cli-input-json file://GatherLog4jInfoRfc.json --execution- parameters file://GatherLog4jInfoParams.json Advanced Stack Components Version April 22, 2025 895 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips This change type scans the specified EC2 instance for packages containing an impacted version of the Apache Log4j Java class. This functionality produces a best-effort report, some occurrences may go undetected or mis-identified. AWS CloudShell is a browser-based shell that makes it easy to securely manage, explore, and interact with your AWS resources. AWS CloudShell is pre-authenticated with your console credentials when you log in. Common development and operations tools are pre-installed, so no local installation or configuration is required. With AWS CloudShell, you can quickly run scripts with the AWS Command Line Interface (AWS CLI), experiment with AWS service APIs using the AWS SDKs, or use a range of other tools to be productive. You can use AWS CloudShell right from your browser at no additional cost. Note You can use the CloudShell AWS console from any other, or the closest, AWS Region where it is available, to perform the aggregation. For example, to perform the aggregation of data stored in the Virginia region, open a CloudShell in the "US East(Virginia) us-east-1" AWS Region in the AWS Console and follow the instructions given next. The report data includes information about Java Archives (JAR Files), found within the specified environment that contain the vulnerable JndiLookup class. AMS recommends upgrading impacted libraries to the latest available version, which can be downloaded directly from Apache at Download Apache Log4j 2. Additionally, we scan for Web Application Resource (WAR), Enterprise Archive (EAR), Jupiter Encrypted XML (JPI), Hemera Technologies (HPI), and ZIP files. To aggregate all the generated CSV files and build a single report with AWS CloudShell: 1. From any page or AWS Region in the AWS Management Console, open the AWS CloudShell to run the script shown next. Ensure that you are logged into the AWS Management Console with the AWSManagedServicesReadOnlyRole role. # Specify the S3 bucket and AWS region that contains the individual CSV files: BUCKET_NAME="YOUR BUCKET HERE" BUCKET_REGION="THE BUCKET REGION HERE" # Aggregate the CSV files: mkdir -p log4j-report Advanced Stack Components Version April 22, 2025 896 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws s3 cp s3://$BUCKET_NAME/ams/log4j-scan/ ./log4j-report --recursive --include "*.csv" echo "aws_account_id,region,scan_time,instance_id,scan_type,location" > log4j- report/report.csv for i in `find log4j-report -type f \( -iname "*.csv" ! -iname "report.csv" \)`; do awk 'FNR > 1' $i >> log4j-report/report.csv; done # Upload the report to the same S3 bucket: file_name="report_$(date -d "today" +"%Y%m%d%H%M").csv" aws s3 cp log4j-report/report.csv s3://$BUCKET_NAME/ams/log4j-reports/$file_name # Open the following URL and select \"Download\" to download the report: echo "Report uploaded to: https://s3.console.aws.amazon.com/s3/object/$BUCKET_NAME? region=$BUCKET_REGION&prefix=ams/log4j-reports/$file_name" The script outputs the S3 URL to download the report from. 2. Copy and open the URL and then choose Download Single-Account Landing Zone: Using the report If you are working in a single-account landing zone, the AWS CloudShell service is not available. However, you can still leverage the AWS CLI to perform the necessary steps. Follow this documentation, How do I grant my Active Directory users access to the API or AWS CLI with AD FS?, to configure CLI API Access through Active Directory Federation Services (ADFS) using IAM Roles. For Non-ADFS identity provider (IDP) implementations, visit How to Implement a General Solution for Federated API/CLI Access Using SAML 2.0. Using the above options, obtain CLI Credentials for the desired role, the default recommended role is the Customer_ReadOnly_Role. Then execute the script in Step 1 to generate the required CSV report. How to read the report The report contains the following columns: • scan_time: The time at which the instance scan was performed • |
ams-ct-252 | ams-ct.pdf | 252 | Directory users access to the API or AWS CLI with AD FS?, to configure CLI API Access through Active Directory Federation Services (ADFS) using IAM Roles. For Non-ADFS identity provider (IDP) implementations, visit How to Implement a General Solution for Federated API/CLI Access Using SAML 2.0. Using the above options, obtain CLI Credentials for the desired role, the default recommended role is the Customer_ReadOnly_Role. Then execute the script in Step 1 to generate the required CSV report. How to read the report The report contains the following columns: • scan_time: The time at which the instance scan was performed • instance_id: The EC2 instance ID • scan_type: The type of scan that was performed. For example, if the scan looked at in memory information, the scan_type will be MEMORY. If the filesystem was checked, the scan_type will be FILESYSTEM • location: The path to the match Advanced Stack Components Version April 22, 2025 897 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-19f40lfm5umy8. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-GatherLog4jInformation", "Region": "us-east-1", "Parameters": { "S3Bucket": [ "s3://test" ] }, "TargetParameterName": "InstanceId", "Targets": [ { "Key": "ParameterValues", "Values": [ "i-1234567890abcdef0", "i-1234567890abcdef1", "i-1234567890abcdef2", "i-1234567890abcdef3", "i-1234567890abcdef4" ] } ], "MaxConcurrency": "10", "MaxErrors": "100%" } EC2 Instance Stack | Reboot Use to reboot an EC2 instance. Full classification: Management | Advanced stack components | EC2 instance stack | Reboot Advanced Stack Components Version April 22, 2025 898 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-09qbhy7kvtxqw Current version 1.0 Expected execution duration 30 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Reboot instance Rebooting an EC2 istance 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. Advanced Stack Components Version April 22, 2025 899 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. Rebooting an EC2 instance 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 900 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 |
ams-ct-253 | ams-ct.pdf | 253 | 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 900 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-02u0hoaa9grat" --change-type-version "1.0" -- title "Reboot My EC2" --execution-parameters "{\"InstanceId\":\"INSTANCE_ID\"}" TEMPLATE CREATE: 1. Output the RFC template to a file in your current folder. This example names it RebootEC2Rfc.json. Note that since there is only one execution parameter for stopping (rebooting, or starting) an instance, the execution parameter can be in the schema JSON file itself and there is no need to create a separate execution parameters JSON file. aws amscm create-rfc --generate-cli-skeleton > StopInstanceRfc.json 2. Modify and save the RebootEC2Rfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-09qbhy7kvtxqw", Advanced Stack Components Version April 22, 2025 901 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "Reboot-My-EC2-RFC", "TimeoutInMinutes": 60, "ExecutionParameters": "{ \"InstanceId\":\"INSTANCE_ID\" }" } 3. Create the RFC: aws amscm create-rfc --cli-input-json file://RebootEC2Rfc.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 EC2, see the EC2 Documentation for your operation system. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-09qbhy7kvtxqw. Example: Required Parameters Example not available. Example: All Parameters Example not available. EC2 Instance Stack | Replace Instance Profile Replace the instance profile of an EC2 instance that is not part of an Auto Scaling group. This change may result in CloudFormation drift for any stacks that have this resource. Full classification: Management | Advanced stack components | EC2 instance stack | Replace instance profile Advanced Stack Components Version April 22, 2025 902 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-37kcp2v1mriu6 Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Replace instance profile Replacing an EC2 instance profile using the console The following shows this change type in the AMS console. How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. Advanced Stack Components Version April 22, 2025 903 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. |
ams-ct-254 | ams-ct.pdf | 254 | 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. Replacing an EC2 instance profile using 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 904 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-37kcp2v1mriu6" --change-type-version "1.0" --title "Replace Instance Profile" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-ReplaceInstanceProfile\",\"Region\":\"us-east-1\",\"Parameters \":{\"InstanceId\":[\"i-12345678901234567\"],\"InstanceProfile\":[\"customer-test- profile\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it ReplaceEC2InstanceParams.json: aws amscm get-change-type-version --change-type-id "ct-37kcp2v1mriu6" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ReplaceEC2InstanceParams.json 2. Modify and save the ReplaceEC2InstanceParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-ReplaceInstanceProfile", "Region": "us-east-1", Advanced Stack Components Version April 22, 2025 905 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Parameters": { "InstanceId": [ "i-12345678901234567" ], "InstanceProfile": [ "customer-test-profile" ] } } 3. Output the RFC template to a file in your current folder; this example names it ReplaceEC2InstanceRfc.json: aws amscm create-rfc --generate-cli-skeleton > ReplaceEC2InstanceRfc.json 4. Modify and save the ReplaceEC2InstanceRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-37kcp2v1mriu6", "Title": "Replace Instance Profile" } 5. Create the RFC, specifying the ReplaceEC2InstanceRfc file and the ReplaceEC2InstanceParams file: aws amscm create-rfc --cli-input-json file://ReplaceEC2InstanceRfc.json -- execution-parameters file://ReplaceEC2InstanceParams.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 on instance profiles, see Using instance profiles. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-37kcp2v1mriu6. Advanced Stack Components Version April 22, 2025 906 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "DocumentName" : "AWSManagedServices-ReplaceInstanceProfileV2", "Region" : "us-east-1", "Parameters" : { "InstanceId" : [ "i-1234567890abcdef0" ], "InstanceProfile" : [ "customer-test-profile" ] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-ReplaceInstanceProfileV2", "Region" : "us-east-1", "Parameters" : { "InstanceId" : [ "i-1234567890abcdef0" ], "InstanceProfile" : [ "customer-test-profile" ] } } EC2 Instance Stack | Resize Resize an existing EC2 instance in your account. The state of the instance can be either 'running' or 'stopped'. If 'running', the instance is stopped during the resize operation and returned to the initial state after the resizing is complete. Before resizing the instance, ensure that the instance's root volume is not an instance store volume. We highly recommended rigorous load and performance testing before, and after, making instance type changes, and that you also consider the pricing changes that result when instances are resized. Please be aware that this change may result in CloudFormation drift for any stacks that have this resource. Full classification: Management | Advanced stack components | EC2 instance stack | Resize Advanced |
ams-ct-255 | ams-ct.pdf | 255 | or 'stopped'. If 'running', the instance is stopped during the resize operation and returned to the initial state after the resizing is complete. Before resizing the instance, ensure that the instance's root volume is not an instance store volume. We highly recommended rigorous load and performance testing before, and after, making instance type changes, and that you also consider the pricing changes that result when instances are resized. Please be aware that this change may result in CloudFormation drift for any stacks that have this resource. Full classification: Management | Advanced stack components | EC2 instance stack | Resize Advanced Stack Components Version April 22, 2025 907 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-15mazjj88xc69 Current version 2.0 Expected execution duration 30 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Resize instance Resizing an EC2 instance 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. Advanced Stack Components Version April 22, 2025 908 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. Resizing an EC2 instance 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 909 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-15mazjj88xc69" --change-type-version "2.0" --title "Resize EC2 Instance" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-ResizeInstance\",\"Region\":\"ap-southeast-2\",\"Parameters \":{\"InstanceId\":[\"i-0db3254017174df45\"],\"InstanceType\":[\"t2.xlarge\"], \"CreateAMIBeforeResize\":[true]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it ResizeEC2Params.json: aws amscm get-change-type-version --change-type-id "ct-15mazjj88xc69" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ResizeEC2Params.json 2. Modify and save the ResizeEC2Params file. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 910 AMS Advanced Change |
ams-ct-256 | ams-ct.pdf | 256 | 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-15mazjj88xc69" --change-type-version "2.0" --title "Resize EC2 Instance" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-ResizeInstance\",\"Region\":\"ap-southeast-2\",\"Parameters \":{\"InstanceId\":[\"i-0db3254017174df45\"],\"InstanceType\":[\"t2.xlarge\"], \"CreateAMIBeforeResize\":[true]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it ResizeEC2Params.json: aws amscm get-change-type-version --change-type-id "ct-15mazjj88xc69" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > ResizeEC2Params.json 2. Modify and save the ResizeEC2Params file. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 910 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-ChangeInstanceType", "Region": "ap-southeast-2", "Parameters": { "InstanceId": [ "i-0db3254017174df45" ], "InstanceType": [ "t2.xlarge" ], "CreateAMIBeforeResize": [ true ] } } 3. Output the RFC template to a file in your current folder; this example names it ResizeEC2Rfc.json: aws amscm create-rfc --generate-cli-skeleton > ResizeEC2Rfc.json 4. Modify and save the ResizeEC2Rfc.json file. For example, you can replace the contents with something like this:. { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-15mazjj88xc69", "Title": "Resize EC2 Instance" } 5. Create the RFC, specifying the ResizeEC2Rfc file and the ResizeEC2Params file: aws amscm create-rfc --cli-input-json file://ResizeEC2Rfc.json --execution- parameters file://ResizeEC2Params.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 911 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note Changing instance size can result in CloudFormation drift for any stacks that reference the changed instances. For more information about Amazon EC2, including size recommendations, see Amazon Elastic Compute Cloud Documentation. Important You can create an AMI of the instance before the resize using the CreateAMIBeforeResize parameter. If you use this option, before you begin, prepare the EC2 instance that you will use to create the AMI. To avoid authentication issues from instances created from the new AMI, run these system commands on the instance after applying custom changes, and before you call the EC2 Instance Stack | Resize CT with the CreateAMIBeforeResize parameter. Linux Preparation for AMI Create Download and run the following script to prepare your instance for AMI creation. You must run this script as the root user. curl https://amazon-ams-us-east-1.s3.amazonaws.com/latest/linux/ prepare_instance_for_ami_and_shutdown.sh -o ./prepare_instance_for_ami_and_shutdown.sh chmod 744 prepare_instance_for_ami_and_shutdown.sh ./prepare_instance_for_ami_and_shutdown.sh The preceding script performs a shut down on the instance and connected users are logged out from the session. Windows Preparation for AMI Create Windows Powershell (run as Administrator): Invoke-AMSSysprep Advanced Stack Components Version April 22, 2025 912 AMS Advanced Change Type Reference AMS Advanced Change Type Details The instance is stopped and any connected user is logged out from the current Windows RDP session. For more info on creating AWS Windows AMIs, see Create a custom Windows AMI. UserData for AMI Create If you want to execute user data on the next boot from your AMI, do the following: • Make sure that the Registry Key HKEY_LOCAL_MACHINE\SOFTWARE\Amazon \ManagedServices\RunUserDataViaAMSBootModule is present. If this key isn't present, then user data isn't run the on the next boot. • To set user data to run on next boot, complete the following steps: 1. Start a Windows PowerShell under administrator privilege (run as administrator) 2. Run the following command: Install-AMSDependencies Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-15mazjj88xc69. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-ChangeInstanceType", "Region": "us-east-1", "Parameters": { "InstanceId": ["i-1234567890abababa"], "InstanceType": ["t3.xlarge"], "CreateAMIBeforeResize": [false] } } Advanced Stack Components Version April 22, 2025 913 AMS Advanced Change Type Reference AMS Advanced Change Type Details EC2 Instance Stack | Restore Volumes Replace the instance volumes from an existing backup image of the instance. To restore from snapshot, use version 1.0 of this Change Type. Full classification: Management | Advanced stack components | EC2 instance stack | Restore volumes Change Type Details Change type ID ct-0ffvihqwjvqj1 Current version 3.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Restore stack volumes Restoring EC2 instance volumes with the console The following shows this change type in the AMS console. How it works: Advanced Stack Components Version April 22, 2025 914 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 |
ams-ct-257 | ams-ct.pdf | 257 | How it works: Advanced Stack Components Version April 22, 2025 914 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. Restoring EC2 instance volumes with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Advanced Stack Components Version April 22, 2025 915 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-0ffvihqwjvqj1" --change-type-version "3.0" --title "Restore EC2 Volumes From Backup" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-ReplaceInstanceVolumesFromSnapshotsWithContext\",\"Region\":\"us- east-1\",\"Parameters\":{\"InstanceId\":[\"INSTANCE_ID\"],\"Backup\":[\"BACKUP\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it RestoreEC2VolsParams.json: aws amscm get-change-type-version --change-type-id "ct-0ffvihqwjvqj1" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > RestoreEC2VolsParams.json 2. Modify and save the RestoreEC2VolsParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 916 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "DocumentName": "AWSManagedServices- ReplaceInstanceVolumesFromSnapshotsWithContext", "Region": "us-east-1", "Parameters": { "InstanceId": [ "INSTANCE_ID" ], "Backup": [ "EC2_BACKUP_ARN" ] } } 3. Output the RFC template to a file in your current folder; this example names it RestoreEC2VolsRfc.json: aws amscm create-rfc --generate-cli-skeleton > RestoreEC2VolsRfc.json 4. Modify and save the RestoreEC2VolsRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-0ffvihqwjvqj1", "Title": "EC2-Restore-Volume-RFC" } 5. Create the RFC, specifying the RestoreEC2VolsRfc file and the RestoreEC2VolsParams file: aws amscm create-rfc --cli-input-json file://RestoreEC2VolsRfc.json --execution- parameters file://RestoreEC2VolsParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about Amazon EC2, including size recommendations, see Amazon Elastic Compute Cloud Documentation. Advanced Stack Components Version April 22, 2025 917 |
ams-ct-258 | ams-ct.pdf | 258 | file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-0ffvihqwjvqj1", "Title": "EC2-Restore-Volume-RFC" } 5. Create the RFC, specifying the RestoreEC2VolsRfc file and the RestoreEC2VolsParams file: aws amscm create-rfc --cli-input-json file://RestoreEC2VolsRfc.json --execution- parameters file://RestoreEC2VolsParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about Amazon EC2, including size recommendations, see Amazon Elastic Compute Cloud Documentation. Advanced Stack Components Version April 22, 2025 917 AMS Advanced Change Type Reference AMS Advanced Change Type Details For information on the automatic troubleshooting RFC created if this RFC fails, see EC2 instance volume restore fail Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0ffvihqwjvqj1. Example: Required Parameters { "DocumentName": "AWSManagedServices- ReplaceInstanceVolumesFromSnapshotsWithContext", "Region": "us-east-1", "Parameters": { "InstanceId": [ "i-12345678" ], "Backup": [ "ami-0ecdf967356c809c7" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices- ReplaceInstanceVolumesFromSnapshotsWithContext", "Region": "us-east-1", "Parameters": { "InstanceId": [ "i-12345678" ], "Backup": [ "ami-0ecdf967356c809c7" ], "KMSKeyId": [ "arn:aws:kms:us-east-1:123456789012:key/6f0a9efd-e1b7-41a2- b04c-75fd89d9dc17" ], "ChangeHostname" : ["False"], "SleepTime": [ Advanced Stack Components Version April 22, 2025 918 AMS Advanced Change Type Details AMS Advanced Change Type Reference "PT5M" ] } } EC2 Instance Stack | Start Start up to 50 stopped EC2 instances. Full classification: Management | Advanced stack components | EC2 instance stack | Start Change Type Details Change type ID ct-03t7kvuwx6rgr Current version 2.0 Expected execution duration 150 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Start stack Starting EC2 instances with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 919 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. Starting EC2 instances with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. Advanced Stack Components Version April 22, 2025 920 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 |
ams-ct-259 | ams-ct.pdf | 259 | 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-03t7kvuwx6rgr" --change-type-version "2.0" --title "Start EC2 Instances" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-StartInstances\",\"Region\":\"us-east-1\",\"Parameters\": {\"InstanceIds\":[\"i-1234567890abcdef0\", \"i-1234567890abcdef1\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it StartEC2Params.json: aws amscm get-change-type-version --change-type-id "ct-03t7kvuwx6rgr" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > StartEC2Params.json 2. Modify and save the StartEC2Params file. Advanced Stack Components Version April 22, 2025 921 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "DocumentName" : "AWSManagedServices-StartInstances", "Region" : "us-east-1", "Parameters" : { "InstanceIds" : [ "i-1234567890abcdef0", "i-1234567890abcdef1" ] } } 3. Output the RFC template to a file in your current folder; this example names it StartEC2Rfc.json: aws amscm create-rfc --generate-cli-skeleton > StartEC2Rfc.json 4. Modify and save the StartEC2Rfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-03t7kvuwx6rgr", "Title": "Start EC2 Instances" } 5. Create the RFC, specifying the StartEC2Rfc file and the StartEC2Params file: aws amscm create-rfc --cli-input-json file://StartEC2Rfc.json --execution- parameters file://StartEC2Params.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note This change type is now at version 2.0. The schema has been changed so you can start up to fifty EC2 instances. Advanced Stack Components Version April 22, 2025 922 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-03t7kvuwx6rgr. Example: Required Parameters { "DocumentName": "AWSManagedServices-StartInstances", "Region": "us-east-1", "Parameters": { "InstanceIds": [ "i-1234567890abcdef0" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-StartInstances", "Region": "us-east-1", "Parameters": { "InstanceIds": ["i-1234567890abcdef0"] } } EC2 Instance Stack | Stop Stop up to 50 running EC2 instances. If you specify an EC2 instance that is part of an Auto Scaling group (ASG), the instance is terminated and replaced by the ASG. If not part of an ASG, the instance remains stopped, in the account, until started or deleted. Full classification: Management | Advanced stack components | EC2 instance stack | Stop Change Type Details Change type ID ct-3mvvt2zkyveqj Current version 3.0 Expected execution duration 150 minutes Advanced Stack Components Version April 22, 2025 923 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS approval Required Customer approval Not required Execution mode Automated Additional Information Stop stack Stopping an EC2 instance 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. Advanced Stack Components Version April 22, 2025 924 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 |
ams-ct-260 | ams-ct.pdf | 260 | 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 924 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. Stopping an EC2 instance with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not Advanced Stack Components Version April 22, 2025 925 AMS Advanced Change Type Reference AMS Advanced Change Type Details the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-3mvvt2zkyveqj" --change-type-version "3.0" --title "Stop EC2 Instances" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-StopInstances\",\"Region\":\"us-east-1\",\"Parameters\": {\"InstanceIds\":[\"i-1234567890abcdef0\", \"i-1234567890abcdef1\"],\"ForceStop\": [\"false\"],\"StopASGInServiceInstances\":[\"false\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON file; this example names it StopEC2Params.json: aws amscm get-change-type-version --change-type-id "ct-3mvvt2zkyveqj" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > StopEC2Params.json 2. Modify and save the StopEC2Params file. { "DocumentName" : "AWSManagedServices-StopInstances", "Region" : "us-east-1", "Parameters" : { "InstanceIds" : [ "i-1234567890abcdef0", "i-1234567890abcdef1" ], "ForceStop": [ "false" ], "StopASGInServiceInstances": [ "false" ] } Advanced Stack Components Version April 22, 2025 926 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 StopEC2Rfc.json: aws amscm create-rfc --generate-cli-skeleton > StopEC2Rfc.json 4. Modify and save the StopEC2Rfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-3mvvt2zkyveqj", "Title": "Stop EC2 Instances" } 5. Create the RFC, specifying the StopEC2Rfc file and the StopEC2Params file: aws amscm create-rfc --cli-input-json file://StopEC2Rfc.json --execution-parameters file://StopEC2Params.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note This change type is now at version 3.0. The schema has been changed so you can stop up to fifty instances. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3mvvt2zkyveqj. Example: Required Parameters { Advanced Stack Components Version April 22, 2025 927 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-StopInstances", "Region": "us-east-1", "Parameters": { "InstanceIds": [ "i-1234567890abcdef0" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-StopInstances", "Region": "us-east-1", "Parameters": { "InstanceIds": [ "i-1234567890abcdef0" ], "ForceStop": [ "false" ], "StopASGInServiceInstances": [ "false" ] } } EC2 Instance Stack | Update Use to modify the properties of an EC2 instance created using CT id ct-14027q0sjyt1h, version 3.0. Full classification: Management | Advanced stack components | EC2 instance stack | Update Change Type Details Change type ID ct-38s4s4tm4ic4u Current version 3.0 Expected execution duration 60 minutes AWS approval Required Advanced Stack Components Version April 22, 2025 928 AMS Advanced Change Type Reference AMS Advanced Change Type Details Customer |
ams-ct-261 | ams-ct.pdf | 261 | [ "i-1234567890abcdef0" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-StopInstances", "Region": "us-east-1", "Parameters": { "InstanceIds": [ "i-1234567890abcdef0" ], "ForceStop": [ "false" ], "StopASGInServiceInstances": [ "false" ] } } EC2 Instance Stack | Update Use to modify the properties of an EC2 instance created using CT id ct-14027q0sjyt1h, version 3.0. Full classification: Management | Advanced stack components | EC2 instance stack | Update Change Type Details Change type ID ct-38s4s4tm4ic4u Current version 3.0 Expected execution duration 60 minutes AWS approval Required Advanced Stack Components Version April 22, 2025 928 AMS Advanced Change Type Reference AMS Advanced Change Type Details Customer approval Not required Execution mode Automated Additional Information Update instances Updating an EC2 instance 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. Advanced Stack Components Version April 22, 2025 929 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 EC2 instance with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status Advanced Stack Components Version April 22, 2025 930 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. Only specify the parameters you want to change. Absent parameters retain the existing values. 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 test-ec2-stack-update --change- type-id ct-38s4s4tm4ic4u --change-type-version 3.0 --execution- parameters '{"VpcId":"VPC_ID","StackId":"STACK_ID","Parameters": {"InstanceDetailedMonitoring":false,"InstanceEBSOptimized":false,"InstanceProfile":"customer- mc-ec2-instance-profile","InstanceType":"t2.small","InstanceUserData":"#!/bin/bash\ \npwd\\nls -ltrh\\necho \"Hello, World\""}}' TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it UpdateEC2Params.json: aws amscm get-change-type-version --change-type-id "ct-38s4s4tm4ic4u" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateEC2Params.json 2. Modify and save the UpdateEC2Params file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "VpcId": "VPC_ID", "StackId": "STACK_ID", "Parameters": { "InstanceDetailedMonitoring": false, "InstanceEBSOptimized": false, "InstanceProfile": "customer-mc-ec2-instance-profile", "InstanceType": "t2.small", "InstanceUserData": "#!/bin/bash\\npwd\\nls -ltrh\\necho \"Hello, World\"" Advanced Stack |
ams-ct-262 | ams-ct.pdf | 262 | this: aws amscm create-rfc --title test-ec2-stack-update --change- type-id ct-38s4s4tm4ic4u --change-type-version 3.0 --execution- parameters '{"VpcId":"VPC_ID","StackId":"STACK_ID","Parameters": {"InstanceDetailedMonitoring":false,"InstanceEBSOptimized":false,"InstanceProfile":"customer- mc-ec2-instance-profile","InstanceType":"t2.small","InstanceUserData":"#!/bin/bash\ \npwd\\nls -ltrh\\necho \"Hello, World\""}}' TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it UpdateEC2Params.json: aws amscm get-change-type-version --change-type-id "ct-38s4s4tm4ic4u" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateEC2Params.json 2. Modify and save the UpdateEC2Params file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "VpcId": "VPC_ID", "StackId": "STACK_ID", "Parameters": { "InstanceDetailedMonitoring": false, "InstanceEBSOptimized": false, "InstanceProfile": "customer-mc-ec2-instance-profile", "InstanceType": "t2.small", "InstanceUserData": "#!/bin/bash\\npwd\\nls -ltrh\\necho \"Hello, World\"" Advanced Stack Components Version April 22, 2025 931 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 UpdateEC2Rfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateEC2Rfc.json 4. Modify and save the UpdateEC2Rfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-38s4s4tm4ic4u", "Title": "EC2-Update-RFC" } 5. Create the RFC, specifying the UpdateEC2Rfc file and the UpdateEC2Params file: aws amscm create-rfc --cli-input-json file://UpdateEC2Rfc.json --execution- parameters file://UpdateEC2Params.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 is a version 3.0 change type and can be used to update EC2 instances created with the corresponding version 3.0 create change type, ct-14027q0sjyt1h. To learn more about Amazon EC2, including size recommendations, see Amazon Elastic Compute Cloud Documentation. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-38s4s4tm4ic4u. Advanced Stack Components Version April 22, 2025 932 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "VpcId": "vpc-1234567890abcdef0", "StackId": "stack-1234567890abcdef0", "Parameters": { } } Example: All Parameters { "VpcId": "vpc-12345678", "StackId": "stack-1234567890abcdef0", "Parameters": { "InstanceDetailedMonitoring": false, "InstanceEBSOptimized": false, "InstanceProfile": "customer-mc-ec2-instance-profile", "InstanceType": "t2.small", "InstanceUserData": "#!/bin/bash\\npwd\\nls -ltrh\\necho \"Hello, World\"" } } EC2 Instance Stack | Update (With Additional Volumes) Use to modify the properties of an EC2 instance created using CT id ct-1aqsjf86w6vxg, version 3.0. Full classification: Management | Advanced stack components | EC2 instance stack | Update (with additional volumes) Change Type Details Change type ID ct-1o1x2itfd6rk8 Current version 3.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Advanced Stack Components Version April 22, 2025 933 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution mode Automated Additional Information Update stack (with additional volumes) Updating an EC2 Instance and Additional Volumes with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. Advanced Stack Components Version April 22, 2025 934 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 EC2 Instance and Additional Volumes with the CLI How it works: 1. Use either the Inline Create |
ams-ct-263 | ams-ct.pdf | 263 | 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 EC2 Instance and Additional Volumes with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status Advanced Stack Components Version April 22, 2025 935 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 test-ec2-stack-with-additional-volumes- update --change-type-id ct-1o1x2itfd6rk8 --change-type-version 3.0 -- execution-parameters '{"VpcId":"VPC_ID","StackId":"STACK_ID","Parameters": {"InstanceDetailedMonitoring":false,"InstanceEBSOptimized":false,"InstanceProfile":"customer- mc-ec2-instance-profile","InstanceType":"t2.small","InstanceUserData":"#!/bin/bash\ \npwd\\nls -ltrh\\necho \"Hello, World\"","InstanceSecondaryPrivateIpAddressCount":1,"InstanceTerminationProtection":true,"Volume1Iops":100,"Volume1KmsKeyId":"12345678-1234-1234-1234-1234567890ab","Volume1Name":"/ dev/sdf","Volume1Size":100,"Volume1Type":"io1"}}' TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it UpdateEC2AVParams.json: aws amscm get-change-type-version --change-type-id "ct-1o1x2itfd6rk8" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateEC2AVParams.json 2. Modify and save the UpdateEC2AVParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "Description": "EC2-Update-1-Addl-Volumes", "VpcId": "VPC_ID", "Name": "My-EC2-1-Addl-Volume", "TimeoutInMinutes": 60, "Parameters": { "InstanceAmiId": "AMI_ID", "InstanceSubnetId": "SUBNET_ID", "Volume1Encrypted": "true", Advanced Stack Components Version April 22, 2025 936 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Volume1Iops": "IOPS" "Volume1KmsKeyId": "KMS_MASTER_KEY_ID", "Volume1Name": "xvdh" "Volume1Size": "2 GiB", "Volume1Snapshot": "SNAPSHOT_ID", "Volume1Type": "iol" } } 3. Output the RFC template to a file in your current folder; this example names it UpdateEC2AVRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateEC2AVRfc.json 4. Modify and save the UpdateEC2AVRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-1o1x2itfd6rk8", "Title": "EC2-Update-1-Addl-Volume-RFC" } 5. Create the RFC, specifying the UpdateEC2AVRfc file and the UpdateEC2AVParams file: aws amscm create-rfc --cli-input-json file://UpdateEC2AVRfc.json --execution- parameters file://UpdateEC2AVParams.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 is a version 3.0 change type and can be used to update EC2 instances created with the corresponding version 3.0 create change type, ct-1aqsjf86w6vxg. Advanced Stack Components Version April 22, 2025 937 AMS Advanced Change Type Reference AMS Advanced Change Type Details To learn more about Amazon EC2, including size recommendations, see Amazon Elastic Compute Cloud Documentation. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1o1x2itfd6rk8. Example: Required Parameters { "VpcId": "vpc-1234567890abcdef0", "StackId": "stack-1234567890abcdef0", "Parameters": { } } Example: All Parameters { "VpcId": "vpc-1234567890abcdef0", "StackId": "stack-1234567890abcdef0", "Parameters": { "InstanceDetailedMonitoring": false, "InstanceEBSOptimized": false, "InstanceProfile": "customer-mc-ec2-instance-profile", "InstanceType": "t2.small", "InstanceUserData": "#!/bin/bash\\npwd\\nls -ltrh\\necho \"Hello, World\"", "InstanceSecondaryPrivateIpAddressCount": 1, "InstanceTerminationProtection": true, "Volume1Iops": 100, "Volume1Name": "/dev/sdf", "Volume1Size": 100, "Volume1Snapshot": "snap-1234567890abcdef0", "Volume1Type": "io1", "Volume2Iops": 100, "Volume2Name": "/dev/sdg", "Volume2Size": 100, "Volume2Snapshot": "snap-1234567890abcdef0", "Volume2Type": "io1", "Volume3Iops": 100, "Volume3Name": "/dev/sdh", Advanced Stack Components Version April 22, 2025 938 AMS Advanced Change Type Details AMS Advanced Change Type Reference "Volume3Size": 100, "Volume3Snapshot": "snap-1234567890abcdef0", "Volume3Type": "io1", "Volume4Iops": 100, "Volume4Name": "/dev/sdi", "Volume4Size": 100, "Volume4Snapshot": "snap-1234567890abcdef0", "Volume4Type": "io1", "Volume5Iops": 100, "Volume5Name": "/dev/sdj", "Volume5Size": 100, "Volume5Snapshot": "snap-1234567890abcdef0", "Volume5Type": "io1" } } EC2 Instance Stack | Update DeleteOnTermination (Review Required) Update the EBS volume DeleteOnTermination property of the specified EC2 instance devices. Full classification: Management | Advanced stack components | EC2 instance stack | Update DeleteOnTermination (review required) Change Type Details Change type ID ct-2aaaqid7asjy6 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Advanced Stack Components Version April 22, 2025 939 AMS |
ams-ct-264 | ams-ct.pdf | 264 | "Volume3Size": 100, "Volume3Snapshot": "snap-1234567890abcdef0", "Volume3Type": "io1", "Volume4Iops": 100, "Volume4Name": "/dev/sdi", "Volume4Size": 100, "Volume4Snapshot": "snap-1234567890abcdef0", "Volume4Type": "io1", "Volume5Iops": 100, "Volume5Name": "/dev/sdj", "Volume5Size": 100, "Volume5Snapshot": "snap-1234567890abcdef0", "Volume5Type": "io1" } } EC2 Instance Stack | Update DeleteOnTermination (Review Required) Update the EBS volume DeleteOnTermination property of the specified EC2 instance devices. Full classification: Management | Advanced stack components | EC2 instance stack | Update DeleteOnTermination (review required) Change Type Details Change type ID ct-2aaaqid7asjy6 Current version 1.0 Expected execution duration 240 minutes AWS approval Required Customer approval Not required if submitter Execution mode Manual Advanced Stack Components Version April 22, 2025 939 AMS Advanced Change Type Reference Additional Information AMS Advanced Change Type Details Update the DeleteOnTermination option (review required) Updating the DeleteOnTermination option with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 940 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. Updating the DeleteOnTermination option with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 941 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-2aaaqid7asjy6" --change-type-version "1.0" --title "Update DeleteOnTermination" --execution-parameters "{\"InstanceId \": \"i-1234567890abcdef0\", \"DeviceNames\": [\"/dev/sda1\", \"/dev/xvda\"], \"DeleteOnTermination\": \"False\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it UpdateDeleteOnTerminationParams.json: aws amscm get-change-type-version --change-type-id "ct-2aaaqid7asjy6" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateDeleteOnTerminationParames.json 2. Modify and save the UpdateDeleteOnTerminationParams.json file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "InstanceId": "i-0cc489fa851c31a21", "DeviceNames": [ "/dev/sda1", "/dev/xvda" ], "DeleteOnTermination": "False" } 3. Output the RFC template to a file in your current folder; this example names it UpdateDeleteOnTerminationRfc.json: aws amscm |
ams-ct-265 | ams-ct.pdf | 265 | --title "Update DeleteOnTermination" --execution-parameters "{\"InstanceId \": \"i-1234567890abcdef0\", \"DeviceNames\": [\"/dev/sda1\", \"/dev/xvda\"], \"DeleteOnTermination\": \"False\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it UpdateDeleteOnTerminationParams.json: aws amscm get-change-type-version --change-type-id "ct-2aaaqid7asjy6" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateDeleteOnTerminationParames.json 2. Modify and save the UpdateDeleteOnTerminationParams.json file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "InstanceId": "i-0cc489fa851c31a21", "DeviceNames": [ "/dev/sda1", "/dev/xvda" ], "DeleteOnTermination": "False" } 3. Output the RFC template to a file in your current folder; this example names it UpdateDeleteOnTerminationRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateDeleteOnTerminationRfc.json 4. Modify and save the UpdateDeleteOnTerminationRfc.json file. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 942 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2aaaqid7asjy6", "Title": "Update DeleteOnTermination" } 5. Create the RFC, specifying the UpdateDeleteOnTerminationRfc.json file and the UpdateDeleteOnTerminationParams.json file: aws amscm create-rfc --cli-input-json file://UpdateDeleteOnTerminationRfc.json -- execution-parameters file://UpdateDeleteOnTerminationParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. 6. You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon EC2, including size recommendations, see Amazon Elastic Compute Cloud Documentation. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2aaaqid7asjy6. Example: Required Parameters { "InstanceId": "i-1234567890abcdef0", "DeviceNames": ["/dev/sda", "/dev/xvda"], "DeleteOnTermination": "True" } Example: All Parameters { Advanced Stack Components Version April 22, 2025 943 AMS Advanced Change Type Reference AMS Advanced Change Type Details "InstanceId": "i-1234567890abcdef0", "DeviceNames": ["/dev/sda", "/dev/xvda"], "DeleteOnTermination": "True" } EC2 Instance Stack | Update Instance Detailed Monitoring Update EC2 instances' detailed monitoring setting through direct API calls. The EC2 instances can be standalone or belong to a CloudFormation stack; in the latter case, the change might cause stack drift. To avoid causing stack drift, please use ct-38s4s4tm4ic4u instead, or ct-361tlo1k7339x if the EC2 instance was provisioned via CFN ingestion. Full classification: Management | Advanced stack components | EC2 instance stack | Update instance detailed monitoring Change Type Details Change type ID ct-0tmpmp1wpgkr9 Current version 1.0 Expected execution duration 10 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update detailed monitoring Updating EC2 instances with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 944 AMS Advanced Change Type Reference AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area. 4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output. Advanced Stack Components Version April 22, 2025 945 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 EC2 instances with the CLI How it works: |
ams-ct-266 | ams-ct.pdf | 266 | 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 945 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 EC2 instances 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 946 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --title "Update EC2 detailed monitoring" -update --change- type-id ct-0tmpmp1wpgkr9 --change-type-version 1.0 --execution-parameters '{"DocumentName":"AWSManagedServices-UpdateInstanceEnhancedMonitoring","Region":"us- east-1","Parameters":{"InstanceIds":["i-09d65b13db992e8d4","i-0cdbd78ad80d2378c"]}}' TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it UpdateEc2MonitoringParams.json: aws amscm get-change-type-version --change-type-id "ct-0tmpmp1wpgkr9" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateEc2MonitoringParams.json 2. Modify and save the UpdateEc2MonitoringParams file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-UpdateInstanceEnhancedMonitoring", "Region": "us-east-1", "Parameters": { "InstanceIds": [ "i-09d65b13db992e8d4", "i-0cdbd78ad80d2378c" ], "MonitoringValue": "enabled" } } 3. Output the RFC template to a file in your current folder; this example names it UpdateEc2MonitoringRfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateEc2MonitoringRfc.json 4. Modify and save the UpdateEc2MonitoringRfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0tmpmp1wpgkr9", "Title": "EC2 Update Detailed Monitoring" Advanced Stack Components Version April 22, 2025 947 AMS Advanced Change Type Reference AMS Advanced Change Type Details } 5. Create the RFC, specifying the UpdateEc2MonitoringRfc file and the UpdateEc2MonitoringParams file: aws amscm create-rfc --cli-input-json file://UpdateEc2MonitoringRfc.json -- execution-parameters file://UpdateEc2MonitoringParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about Amazon EC2, see Amazon Elastic Compute Cloud Documentation. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0tmpmp1wpgkr9. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-UpdateInstanceEnhancedMonitoring", "Region": "eu-west-1", "Parameters": { "InstanceIds": ["i-1234567890abcdef0", "i-b188560f"], "MonitoringValue": ["enabled"] } } EC2 Instance Stack | Update Termination Protection Update existing defined termination protection for EC2 instances. Full classification: Management | Advanced stack components | EC2 instance stack | Update termination protection Advanced Stack Components Version April 22, 2025 948 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-03ms1d7xrck8w Current version 1.0 Expected execution duration 10 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Update stack termination protection Updating an EC2 termination protection instance 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. Advanced Stack Components Version April 22, 2025 949 AMS Advanced Change Type Reference AMS Advanced Change Type Details To sort CTs, use the All change |
ams-ct-267 | ams-ct.pdf | 267 | AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. Advanced Stack Components Version April 22, 2025 949 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 an EC2 instance termination protection with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Advanced Stack Components Version April 22, 2025 950 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. Only specify the parameters you want to change. Absent parameters retain the existing values. 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-03ms1d7xrck8w" \ --change-type-version "1.0" \ --title "Enable termination protection on EC2 instance" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- ManageResourceTerminationProtection\",\"Region\":\"us-east-1\",\"Parameters\": {\"ResourceId\":[\"i-0d7e0c222654fc8f7\"],\"TerminationProtectionDesiredState\": [\"enabled\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON file; this example names it UpdateTermProEC2Params.json: aws amscm get-change-type-version --change-type-id "ct-38s4s4tm4ic4u" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateTermProEC2Params.json 2. Modify and save the UpdateTermProEC2Params file, retaining only the parameters that you want to change. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 951 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-ManageResourceTerminationProtection", "Region": "us-east-1", "Parameters": { "ResourceId": ["i-0d7e0c222654fc8f7"], "TerminationProtectionDesiredState": ["enabled"] } } 3. Output the RFC template to a file in your current folder; this example names it UpdateTermProEC2Rfc.json: aws amscm create-rfc --generate-cli-skeleton > UpdateTermProEC2Rfc.json 4. Modify and save the UpdateTermProEC2Rfc.json file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-03ms1d7xrck8w", "ChangeTypeVersion": "1.0", "Title": "Enable termination protection on EC2 instance" } 5. Create the RFC, specifying the UpdateTermProEC2Rfc file and the UpdateTermProEC2Params file: aws amscm create-rfc --cli-input-json file://UpdateTermProEC2Rfc.json --execution- parameters file://UpdateTermProEC2Params.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note There is a related CT for AWS CloudFormation stacks, RDS Database Stack | Create. To learn more |
ams-ct-268 | ams-ct.pdf | 268 | file. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-03ms1d7xrck8w", "ChangeTypeVersion": "1.0", "Title": "Enable termination protection on EC2 instance" } 5. Create the RFC, specifying the UpdateTermProEC2Rfc file and the UpdateTermProEC2Params file: aws amscm create-rfc --cli-input-json file://UpdateTermProEC2Rfc.json --execution- parameters file://UpdateTermProEC2Params.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note There is a related CT for AWS CloudFormation stacks, RDS Database Stack | Create. To learn more about termination protection, see How do I protect my data against accidental EC2 instance termination? Advanced Stack Components Version April 22, 2025 952 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-03ms1d7xrck8w. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-ManageResourceTerminationProtection", "Region": "eu-west-1", "Parameters": { "ResourceId": ["i-1234567890"], "TerminationProtectionDesiredState": ["enabled"] } } Identity and Access Management (IAM) | Delete Account Alias Delete an existing AWS account alias. Note that if you delete the account alias, any URL containing the account alias stops working. Full classification: Management | Advanced stack components | Identity and Access Management (IAM) | Delete account alias Change Type Details Change type ID ct-2rfzmkm6ugigh Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 953 AMS Advanced Change Type Reference Additional Information Delete IAM account alias Deleting IAM account alias with the console AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 954 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 IAM account alias with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID. Monitor the RFC: aws amscm get-rfc --rfc-id ID command. To check the change type version, use this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID Note You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. Advanced Stack Components Version April 22, 2025 955 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE: |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.