Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
ams-appguide-062	ams-appguide.pdf	62	Submitting an RFC). If the new CT is not pre-approved (you want to be sure that it is never run without explicit approval), then you will need to discuss its implementation with AMS each time you want to run it. Test the new CT Version September 13, 2024 185 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Quick starts Topics • AMS Resource Scheduler quick start • Setting up cross account backups (intra-Region) Using a combination of AMS change types, you can accomplish complex tasks. You can use the AMS change management system to set up AMS Resource Scheduler, for a multi- account landing zone (MALZ) or for a single-account landing zone (SALZ) account. The process varies. Also, to do ﬁle transfers and cross-account snapshots. AMS Resource Scheduler quick start Use this quick start guide to implement AMS Resource Scheduler, a tag-based instance scheduler to save cost in AMS Advanced. The AMS Resource Scheduler is based on the AWS Instance Scheduler. AMS Resource Scheduler terminology Before you begin, it's good to be familiar with the AMS Resource Scheduler terminology: • period: Each schedule must contain at least one period that deﬁnes the time(s) the instance should run. A schedule can contain more than one period. When more than one period is used in a schedule, the Resource Scheduler applies the appropriate start action when at least one of the period rules is true. • timezone: For a list of acceptable time zone values to be used in the DefaultTimezone parameter referenced later, see the TZ column of the List of TZ Database Time Zones. • hibernate: When set to true EC2 instances that are enabled for hibernation and meet hibernation requirements are hibernated (suspend-to-disk). Check the EC2 console to ﬁnd out if your instances are enabled for hibernation. Use hibernation for stopped Amazon EC2 instances running Amazon Linux. • enforced: When set to true, based on the schedule deﬁned, the Resource Scheduler stops a running resource if it's manually started outside of the running period, and it starts a resource if it's stopped manually during the running period. AMS Resource Scheduler quick start Version September 13, 2024 186 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • retain_running: When set to true, prevents the Resource Scheduler from stopping an instance at the end of a running period if the instance was manually started before the beginning of the period. For example, if an instance with a conﬁgured period that runs from 9 am to 5 pm is manually started before 9 am, the Resource Scheduler does not stop the instance at 5 pm. • ssm-maintenance-window: Add an AWS Systems Manager maintenance window as a running period to a schedule. When you specify the name of a maintenance window that exists in the same account and AWS Region as your deployed stack to schedule your Amazon EC2 instances, the Resource Scheduler will start the instance before the start of the maintenance window and stop the instance at the end of the maintenance window, if no other running period speciﬁes that the instance should run, and if the maintenance event is completed. The Resource Scheduler uses the AWS Lambda frequency you speciﬁed during initial conﬁguration to determine how long before the maintenance window to start your instance. If you set the Frequency AWS CloudFormation parameter to 10 minutes or less, the Resource Scheduler starts the instance 10 minutes before the maintenance window. If you set the frequency to greater than 10 minutes, the Resource Scheduler starts the instance the same number of minutes as the frequency you speciﬁed. For example, if you set the Systems Manager maintenance window frequency to 30 minutes, the Resource Schedulers starts the instance 30 minutes before the maintenance window. For more information, see AWS Systems Manager Maintenance Windows. • override-status: Temporarily override the Resource Scheduler's conﬁgured Schedule start and stop actions. If you set the ﬁeld to running, the Resource Scheduler starts, but not stops, the applicable instance. The instance runs until you stop it manually. If you set the override-status to stopped, the Resource Scheduler stops but not starts the applicable instance. The instance does not run until you manually start it. AMS Resource Scheduler implementation To deploy an AMS Resource scheduler solution, follow these steps. 1. Submit a Deployment \| AMS Resource Scheduler \| Solution \| Deploy (ct-0ywnhc8e5k9z5) RFC and provide the following parameters: • SchedulingActive: Yes to enable resource scheduling, No to disable. Default is Yes. • ScheduledServices: Enter a comma-separated list of services to schedule resources for. Valid values include a combination of autoscaling, ec2, and rds. Default is autoscaling,ec2,rds. AMS Resource Scheduler implementation Version September 13, 2024 187 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • TagName: The name of the Tag Key that associates
ams-appguide-063	ams-appguide.pdf	63	AMS Resource Scheduler implementation To deploy an AMS Resource scheduler solution, follow these steps. 1. Submit a Deployment \| AMS Resource Scheduler \| Solution \| Deploy (ct-0ywnhc8e5k9z5) RFC and provide the following parameters: • SchedulingActive: Yes to enable resource scheduling, No to disable. Default is Yes. • ScheduledServices: Enter a comma-separated list of services to schedule resources for. Valid values include a combination of autoscaling, ec2, and rds. Default is autoscaling,ec2,rds. AMS Resource Scheduler implementation Version September 13, 2024 187 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • TagName: The name of the Tag Key that associates resource schedule schemas with service resources. Default is Schedule. Note Your Resource Scheduler deployment will only operate on resources that have this tag. • DefaultTimezone: The name of the time zone, in the form US/Paciﬁc, to be used as the default time zone. Default is UTC. 2. After you receive a conﬁrmation that the RFC in step one executed successfully, you can submit the Period \| Add change type. 3. Finally, submit an RFC to add a schedule to the period that was created in step two. Use the Schedule \| Add change type. AMS Resource Scheduler implementation and usage FAQs Frequently asked questions about AMS Resource Scheduler. Q: What happens if I enable hibernation but the EC2 instance does not support it? A: Hibernation saves the contents from the instance memory (RAM) to your Amazon Elastic Block Store (Amazon EBS) root volume. If this ﬁeld is set to true, instances are hibernated when Resource Scheduler stops them. If you set Resource Scheduler to use hibernation but your instances are not enabled for hibernation or they do not meet the hibernation prerequisites, Resource Scheduler logs a warning and the instances are stopped without hibernation. For more information, see Hibernate Your Instance. Q: What happens if I set both override_status and enforced? A: If you set override_status to running and set enforced to true (prevents an instance from being manually started outside of a running period), Resource Scheduler stops the instance. If you set override_status to stopped, and set enforced to true (prevents an instance from being manually stopped during a running period), the Resource Scheduler restarts the instance. AMS Resource Scheduler implementation Version September 13, 2024 188 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note If enforced is false, the conﬁgured override behavior is applied. Q: After the AMS Resource Scheduler is deployed, how do I disable or enable the resource scheduler in my account? A: To disable or enable AMS Resource Scheduler: • To disable: Create an RFC using State \| Disable. Be sure to set the SchedulerState to DISABLE • To enable: Create an RFC using State \| Enable. Be sure to set the SchedulerState to ENABLE QWhat happens if the AMS Resource Scheduler period falls within my patching maintenance window? A: Resource Scheduler works based on its conﬁgured schedules. If it is conﬁgured to stop an instance while patching is in ﬂight, then it stops the instance unless the patching window is added as a period to the schedule before patching begins. In other words, Resource Scheduler does not auto-start any stopped instances for patching unless a designated period is conﬁgured. To avoid conﬂicts with your patching maintenance window, add the time window allocated for patching to the Resource Scheduler schedule as a period. To add a period to existing schedule, create an RFC using Period \| Add. Q If I need to have a diﬀerent schedule for diﬀerent EC2 instances, can I have more than one schedule setup inside of my account? A: Yes, you can create multiple schedules. Each schedule can have multiple periods based on the requirement. When AMS Resource Scheduler is enabled in the account, a Tag Key is conﬁgured. As an example, if the Tag Key is "Schedule", the Tag Value can diﬀer based on diﬀerent schedules which corresponds to AMS Resource Scheduler’s schedule name. To add a new schedule, you can create an RFC using the Management \| AMS Resource Scheduler \| Schedule \| Add (ct-2bxelbn765ive) change type, see Schedule \| Add. Q: Where can I ﬁnd all the diﬀerent change types that are supported for AMS Resource Scheduler? A: AMS has Resource Scheduler change types to deploy the AMS Resource Scheduler to your account; enable or disable it; deﬁne, add, update, and delete schedules and periods to use with it; and describe (get a detailed description of) the schedules and periods. AMS Resource Scheduler implementation Version September 13, 2024 189 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Setting up cross account backups (intra-Region) AWS Backup supports the ability to copy snapshots from one account to another within the same AWS Region as long as the two accounts are within the same AWS Organization. As
ams-appguide-064	ams-appguide.pdf	64	Scheduler? A: AMS has Resource Scheduler change types to deploy the AMS Resource Scheduler to your account; enable or disable it; deﬁne, add, update, and delete schedules and periods to use with it; and describe (get a detailed description of) the schedules and periods. AMS Resource Scheduler implementation Version September 13, 2024 189 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Setting up cross account backups (intra-Region) AWS Backup supports the ability to copy snapshots from one account to another within the same AWS Region as long as the two accounts are within the same AWS Organization. As an example, in AMS Advanced multi-account landing zone (MALZ), you can set up cross account snapshot copy within the same AWS Region using this quick-start. For more information, see AWS Backup and AWS Organizations bring cross-account backup feature You copy snapshots cross account for disaster recovery (DR). You might have requirements to keep snapshots within the same AWS Region, but across from the account boundaries, for data protection. Overview: At a high level, these are the steps for cross-account backups within AMS: • Create destination account to host backups in the AWS Region where your AMS landing zone is hosted (step 1) Setting up cross account backups (intra-Region) Version September 13, 2024 190 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Create a KMS key for encrypting backups in the destination account (step 3) • Create a backup vault in the destination account of the same region as your AMS Advanced landing zone (step 4) • Enable the cross account setting in your Management account (step 5) • Create or modify the source account backup plan and rule(s) (step 6) Note Ensure that both the source and destination accounts are in the same Region. If you want to copy your backups cross region, contact your CA or CSDM. To enable and set up cross-account backups: 1. Create a destination account to host backups; if you already have such an account, you can skip this step. To create the account, submit an RFC from your Management Payer account using the Deployment \| Managed landing zone \| Management account \| Create application account (with VPC) change type (ct-1zdasmc2ewzrs). 2. [Optional] If resources or snapshots are encrypted in the source account (for example, Prod), share the KMS key used for encryption with the destination account. To do this, submit an RFC using the Management \| Advanced stack components \| KMS key \| Update change type (ct-3ovo7px2vsa6n). 3. In the destination account, create a KMS Key to be used for Backup Vault encryption. To do this, submit an RFC using the Deployment \| Advanced stack components \| KMS key \| Create (auto) change type (ct-1d84keiri1jhg). 4. In the destination account, create a Backup Vault using the key created earlier. AWS Backup Vaults can be created by using the CFN ingest automated change type, Deployment \| Ingestion \| Stack from CloudFormation Template \| Create (ct-36cn2avfrrj9v). In the same request, the vault access policy needs to be modiﬁed to allow the source account(s) access to the vault. Here is an example policy: { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowSrcAccountPermissionsToCopy", Setting up cross account backups (intra-Region) Version September 13, 2024 191 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "Effect": "Allow", "Action": "backup:CopyIntoBackupVault", "Resource": "", "Principal": { "AWS": "arn:aws:iam::<source/prodAccount>:root" } } ] } Example CloudFormation template for a Backup Vault: { "Description": "Test infrastructure", "Resources": { "BackupVaultForTesting": { "Type": "AWS::Backup::BackupVault", "Properties": { "BackupVaultName": "backup-vault-for-test", "EncryptionKeyArn" : "arn:aws:kms:us-east-2:123456789012:key/227d8xxx- aefx-44ex-a09x-b90c487b4xxx", "AccessPolicy" : { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowSrcAccountPermissionsToCopy", "Effect": "Allow", "Action": "backup:CopyIntoBackupVault", "Resource": "", "Principal": { "AWS": ["arn:aws:iam::987654321098:root"] } } ] } } } } } 5. From your Management Payer account, enable Cross-Account backup. To do this, submit an RFC using the Management \| AWS Backup \| Backup plan \| Enable cross account copy (Management account) change type (ct-2yja7ihh30ply). Setting up cross account backups (intra-Region) Version September 13, 2024 192 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 6. Lastly, from the source account where backups are sourced, create the rule or rules of the backup plan that govern the backups to copy snapshots cross account. To do this, submit an RFC using the Deployment \| AWS Backup \| Backup plan \| Create change type(ct-2hyozbpa0sx0m). If you need to update an existing backup plan, submit an RFC using the Management \| Other \| Other \| Update change type (ct-0xdawir96cy7k) with this information: 1. The backup plan name as well as the rule name to be updated. 2. The destination/ICE account backup vault ARN. 3. The retention days/months you would like to keep the snapshots in the target ICE vault for. Setting up cross account backups (intra-Region) Version September 13, 2024 193 AMS Advanced Application Developer's Guide AMS Advanced
ams-appguide-065	ams-appguide.pdf	65	this, submit an RFC using the Deployment \| AWS Backup \| Backup plan \| Create change type(ct-2hyozbpa0sx0m). If you need to update an existing backup plan, submit an RFC using the Management \| Other \| Other \| Update change type (ct-0xdawir96cy7k) with this information: 1. The backup plan name as well as the rule name to be updated. 2. The destination/ICE account backup vault ARN. 3. The retention days/months you would like to keep the snapshots in the target ICE vault for. Setting up cross account backups (intra-Region) Version September 13, 2024 193 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tutorials Topics • Console Tutorial: High Availability Two Tier Stack (Linux/RHEL) • Console Tutorial: Deploying a Tier and Tie WordPress Website • CLI Tutorial: High Availability Two-Tier Stack (Linux/RHEL) • CLI Tutorial: Deploying a Tier and Tie WordPress Website The following tutorials detail the steps to creating a two-tier stack with the High Availability (ct-06mjngx5ﬂwto), using the CLI and using the Console and deploying a Linux or RHEL Amazon EC2 Auto Scaling group (ASG). A similar, tier-and-tie tutorial follows each (one for the Console and one for the CLI), that uses separate CTs, created in such an order that they allow you to tie together resources as they are created. Descriptions for all CT options, including ChangeTypeId can be found in the managedservices/ latest/ctref/ Change Type Reference. Console Tutorial: High Availability Two Tier Stack (Linux/RHEL) This section describes how to deploy a high availability (HA) WordPress site into an AMS environment using the AMS console. Note This deployment walkthrough has been tested in AMZN Linux and RHEL environments. Summary of tasks and required RFCs: 1. Create infrastructure (HA two-tier stack) 2. Create an S3 bucket for CodeDeploy applications 3. Create the WordPress application bundle and upload it to the S3 bucket 4. Deploy the application with CodeDeploy 5. Access the WordPress site and log in to validate the deployment 6. Tear down the deployment Console Tutorial: High Availability Two Tier Stack (Linux/RHEL) Version September 13, 2024 194 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Descriptions for all CT options, including ChangeTypeId, can be found in AMS Change Type Reference. Before You Begin The Deployment \| Advanced Stack Components \| High Availability Two Tier Stack \| Create CT creates an Auto Scaling group, a load balancer, a database, and a CodeDeploy application name and deployment group (with the same name that you give the application). For information on CodeDeploy see What is CodeDeploy? This walkthrough uses a High Availability Two-Tier Stack RFC that includes UserData and also describes how to create a WordPress bundle that CodeDeploy can deploy. The UserData shown in the example gets instance metadata such as instance ID, region, etc, from within a running instance by querying the EC2 instance metadata service available at http://169.254.169.254/latest/meta-data/. This line in the user data script: REGION=$(curl 169.254.169.254/latest/meta-data/placement/availability-zone/ \| sed 's/ [a-z]$//'), retrieves the availability zone name from the meta-data service into the $REGION variable for our supported regions, and uses it to complete the URL for the S3 bucket where the CodeDeploy agent is downloaded. The 169.254.169.254 IP is routable only within the VPC (all VPCs can query the service). For information about the service, see Instance Metadata and User Data. Note also that scripts entered as UserData are executed as the "root" user and do not need to use the "sudo" command. This walkthrough leaves the following parameters at the default value (shown): • Auto Scaling group: Cooldown=300, DesiredCapacity=2, EBSOptimized=false, HealthCheckGracePeriod=600, IAMInstanceProfile=customer-mc-ec2-instance- profile, InstanceDetailedMonitoring=true, InstanceRootVolumeIops=0, InstanceRootVolumeType=standard, InstanceType=m3.medium, MaxInstances=2, MinInstances=2, 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. • Load Balancer: HealthCheckInterval=30, HealthCheckTimeout=5. Before You Begin Version September 13, 2024 195 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Database: BackupRetentionPeriod=7, Backups=true, InstanceType=db.m3.medium, IOPS=0, MultiAZ=true, PreferredBackupWindow=22:00-23:00, PreferredMaintenanceWindow=wed:03:32-wed:04:02, StorageEncrypted=false, StorageEncryptionKey="", StorageType=gp2. • Application: DeploymentConfigName=CodeDeployDefault.OneAtATime. Variable Parameters: The Console provides an ASAP option for the start time and this walkthrough recommends using it. ASAP causes the RFC to be executed as soon as approvals are passed. Note There are many parameters that you might choose to set diﬀerently than as shown. The values for those parameters shown in the example have been tested but may not be right for you. Only required values are shown in the examples. Values in replaceable font should be changed as they are particular to your account. Create the Infrastructure This procedure utilizes the High availability two-tier stack CT followed by the Create S3 storage CT. Gathering the following data before you begin will make the deployment go more quickly. REQUIRED DATA HA STACK: • AutoScalingGroup: • UserData: This value is provided in this tutorial. It includes commands to set up the resource for CodeDeploy and start the CodeDeploy agent. • AMI-ID: This value
ams-appguide-066	ams-appguide.pdf	66	example have been tested but may not be right for you. Only required values are shown in the examples. Values in replaceable font should be changed as they are particular to your account. Create the Infrastructure This procedure utilizes the High availability two-tier stack CT followed by the Create S3 storage CT. Gathering the following data before you begin will make the deployment go more quickly. REQUIRED DATA HA STACK: • AutoScalingGroup: • UserData: This value is provided in this tutorial. It includes commands to set up the resource for CodeDeploy and start the CodeDeploy agent. • AMI-ID: This value determines the operating system of EC2 instances your Auto Scaling group (ASG) will spin up. Select an AMI in your account that starts with "customer-" and is of the operating system that you want. Find AMI IDs in the AMS Console VPCs -> VPCs details page. This walkthrough is for ASGs conﬁgured to use an Amazon Linux or RHEL AMI. • Database: • These parameters, DBEngine, EngineVersion, and LicenseModel should be set according to your situation though the values shown in the example have been tested. The tutorial uses these values, respectively: MySQL, 8.0.16, general-public-license. Create the Infrastructure Version September 13, 2024 196 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • These parameters, DBName, MasterUserPassword, and MasterUsername are required when deploying the application bundle. The tutorial uses these values, respectively: wordpressDB, p4ssw0rd, admin. Note that DBName can only contain alphanumeric characters. • When you enter the MasterUsername for the RDS DB, it will appear in cleartext, so log in to the database as soon as possible and change the password to ensure your security. • For RDSSubnetIds, use two Private subnets. Enter them one at a time pressing "Enter" after each. Find Subnet IDs with the For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. operation (CLI: list-subnet-summaries) or in the AMS Console VPCs -> VPC details page. • LoadBalancer: • Set this parameter, Public to true because the tutorial uses Public ELB subnets. • ELBSubnetIds: Use two Public subnets. Enter them one at a time pressing "Enter" after each. Find Subnet IDs with the For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. operation (CLI: list-subnet-summaries) or in the AMS Console VPCs -> VPC details page. • Application: The ApplicationName value sets the CodeDeploy application name and CodeDeploy deployment group name. You use it to deploy your application. It must be unique in the account. To check your account for CodeDeploy names, see the CodeDeploy Console. The example uses WordPress but, if you will use that value, make sure that it is not already in use. 1. Launch the high availability stack. a. On the Create RFC page, select the category Deployment, subcategory Standard Stacks, item High availability two-tier stack and operation Create, from the list. b. IMPORTANT: Choose Advanced and set the values as shown. You only need to enter values for starred (*) options, tested values are shown in the example; you can leave not-required empty options blank. c. For the RFC Description section: Subject: WP-HA-2-Tier-RFC d. For the Resource information section, set parameters for AutoScalingGroup, Database, LoadBalancer, Application, and Tags. Create the Infrastructure Version September 13, 2024 197 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Also, the purpose of the "AppName" tag key is so you can easily search for the ASG instances in the EC2 console; you can call this tag key "Name" or any other key name that you want. Note that you can add up to 50 tags. UserData: #!/bin/bash REGION=$(curl 169.254.169.254/latest/meta-data/placement/availability-zone/ \| sed 's/[a-z]$//') yum -y install ruby httpd chkconfig httpd on service httpd start touch /var/www/html/status cd /tmp curl -O https://aws-codedeploy-$REGION.s3.amazonaws.com/latest/install chmod +x ./install ./install auto chkconfig codedeploy-agent on service codedeploy-agent start AmiId: AMI-ID Description: WP-HA-2-Tier-Stack Database: LicenseModel: general-public-license (USE RADIO BUTTON) EngineVersion: 8.0.16 DBEngine: MySQL RDSSubnetIds: PRIVATE_AZ1 PRIVATE_AZ2 (ENTER ONE AT A TIME PRESSING "ENTER" AFTER EACH) MasterUserPassword: p4ssw0rd MasterUsername: admin DBName: wordpressDB LoadBalancer: Public: true (USE RADIO BUTTON) ELBSubnetIds: PUBLIC_AZ1 PUBLIC_AZ2 Application: ApplicationName: WordPress Tags: Name: WP-Rhel-Stack e. Click Submit when ﬁnished. Create the Infrastructure Version September 13, 2024 198 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. 3. Log in to the database that you created and change the password. Launch an S3 bucket Stack. Gathering the following data before you begin will make the deployment go more quickly. REQUIRED DATA S3 BUCKET: • VPC-ID: This value determines where your S3 Bucket will be. Find VPC IDs with the For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. operation (CLI: list-vpc-summaries) or in the AMS Console VPCs page. • BucketName: This value sets the S3 Bucket name, you use it to
ams-appguide-067	ams-appguide.pdf	67	Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. 3. Log in to the database that you created and change the password. Launch an S3 bucket Stack. Gathering the following data before you begin will make the deployment go more quickly. REQUIRED DATA S3 BUCKET: • VPC-ID: This value determines where your S3 Bucket will be. Find VPC IDs with the For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. operation (CLI: list-vpc-summaries) or in the AMS Console VPCs page. • BucketName: This value sets the S3 Bucket name, you use it to upload your application bundle. It must be unique across the region of the account and cannot include upper-case letters. Including your account ID as part of the BucketName is not a requirement but makes it easier to identify the bucket later. To see what S3 bucket names exist in the account, go to the Amazon S3 Console for your account. a. On the Create RFC page, select the category Deployment, subcategory Advanced Stack Components, item S3 storage, and operation Create from the RFC CT pick list. b. Keep the default Basic option and set the values as shown. Subject: S3-Bucket-WP-HA-RFC Description: S3BucketForWordPressBundles BucketName: ACCOUNT_ID-BUCKET_NAME AccessControl: Private VpcId: VPC_ID Name: S3-Bucket-WP-HA-Stack TimeoutInMinutes: 60 c. Click Submit when ﬁnished. The bucket deployed with this change type allows full read/ write access to the whole account. Create, Upload, and Deploy the Application First, create a WordPress application bundle, and then use the CodeDeploy CTs to create and deploy the application. 1. Download WordPress, extract the ﬁles and create a ./scripts directory. Create, Upload, and Deploy the Application Version September 13, 2024 199 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Linux command: wget https://github.com/WordPress/WordPress/archive/master.zip Windows: Paste https://github.com/WordPress/WordPress/archive/master.zip into a browser window and download the zip ﬁle. Create a temporary directory in which to assemble the package. Linux: mkdir /tmp/WordPress Windows: Create a "WordPress" directory, you will use the directory path later. 2. Extract the WordPress source to the "WordPress" directory and create a ./scripts directory. Linux: unzip master.zip -d /tmp/WordPress_Temp cp -paf /tmp/WordPress_Temp/WordPress-master/* /tmp/WordPress rm -rf /tmp/WordPress_Temp rm -f master cd /tmp/WordPress mkdir scripts Windows: Go to the "WordPress" directory that you created and create a "scripts" directory there. If you are in a Windows environment, be sure to set the break type for the script ﬁles to Unix (LF). In Notepad ++, this is an option at the bottom right of the window. 3. Create the CodeDeploy appspec.yml ﬁle, in the WordPress directory (if copying the example, check the indentation, each space counts). IMPORTANT: Ensure that the "source" path is correct for copying the WordPress ﬁles (in this case, in your WordPress directory) to the expected destination (/var/www/html/WordPress). In the example, the appspec.yml ﬁle is in the directory with the WordPress ﬁles, so only "/" is needed. Also, even if you used a RHEL AMI for your Auto Scaling group, leave the "os: linux" line as-is. Example appspec.yml ﬁle: version: 0.0 Create, Upload, and Deploy the Application Version September 13, 2024 200 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options os: linux files: - source: / destination: /var/www/html/WordPress hooks: BeforeInstall: - location: scripts/install_dependencies.sh timeout: 300 runas: root AfterInstall: - location: scripts/config_wordpress.sh timeout: 300 runas: root ApplicationStart: - location: scripts/start_server.sh timeout: 300 runas: root ApplicationStop: - location: scripts/stop_server.sh timeout: 300 runas: root 4. Create bash ﬁle scripts in the WordPress ./scripts directory. First, create config_wordpress.sh with the following content (if you prefer, you can edit the wp-conﬁg.php ﬁle directly). Note Replace DBName with the value given in the HA Stack RFC (for example, wordpress). Replace DB_MasterUsername with the MasterUsername value given in the HA Stack RFC (for example, admin). Replace DB_MasterUserPassword with the MasterUserPassword value given in the HA Stack RFC (for example, p4ssw0rd). Replace DB_ENDPOINT with the endpoint DNS name in the execution outputs of the HA Stack RFC (for example, srt1cz23n45sfg.clgvd67uvydk.us- east-1.rds.amazonaws.com). You can ﬁnd this with the GetRfc operation (CLI: get- rfc --rfc-id RFC_ID) or in the AMS Console RFC details page for the HA Stack RFC that you previously submitted. Create, Upload, and Deploy the Application Version September 13, 2024 201 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options #!/bin/bash chmod -R 755 /var/www/html/WordPress cp /var/www/html/WordPress/wp-config-sample.php /var/www/html/WordPress/wp- config.php cd /var/www/html/WordPress sed -i "s/database_name_here/DBName/g" wp-config.php sed -i "s/username_here/DB_MasterUsername/g" wp-config.php sed -i "s/password_here/DB_MasterUserPassword/g" wp-config.php sed -i "s/localhost/DB_ENDPOINT/g" wp-config.php 5. In the same directory create install_dependencies.sh with the following content: #!/bin/bash yum install -y php yum install -y php-mysql yum install -y mysql service httpd restart Note HTTPS is installed as part of the user data at launch in order to allow health checks to work from the start. 6. In the same directory create start_server.sh with the following content: • For Amazon Linux instances, use
ams-appguide-068	ams-appguide.pdf	68	Guide AMS Advanced Application Deployment Options #!/bin/bash chmod -R 755 /var/www/html/WordPress cp /var/www/html/WordPress/wp-config-sample.php /var/www/html/WordPress/wp- config.php cd /var/www/html/WordPress sed -i "s/database_name_here/DBName/g" wp-config.php sed -i "s/username_here/DB_MasterUsername/g" wp-config.php sed -i "s/password_here/DB_MasterUserPassword/g" wp-config.php sed -i "s/localhost/DB_ENDPOINT/g" wp-config.php 5. In the same directory create install_dependencies.sh with the following content: #!/bin/bash yum install -y php yum install -y php-mysql yum install -y mysql service httpd restart Note HTTPS is installed as part of the user data at launch in order to allow health checks to work from the start. 6. In the same directory create start_server.sh with the following content: • For Amazon Linux instances, use this: #!/bin/bash service httpd start • For RHEL instances, use this (the extra commands are policies that allow SELINUX to accept WordPress): #!/bin/bash setsebool -P httpd_can_network_connect_db 1 setsebool -P httpd_can_network_connect 1 chcon -t httpd_sys_rw_content_t /var/www/html/WordPress/wp-content -R restorecon -Rv /var/www/html service httpd start Create, Upload, and Deploy the Application Version September 13, 2024 202 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 7. In the same directory create stop_server.sh with the following content: #!/bin/bash service httpd stop 8. Create the zip bundle. Linux: $ cd /tmp/WordPress $ zip -r wordpress.zip . Windows: Go to your "WordPress" directory and select all of the ﬁles and create a zip ﬁle, be sure to name it wordpress.zip. 1. Upload the application bundle to the S3 bucket The package needs to be in place in order to continue deploying the stack. You automatically have access to any S3 bucket instance that you create. You can access it through your Bastions (see Accessing Instances), or through the S3 console, and upload the CodeDeploy package with drag-and-drop, or by browsing to and selecting the ﬁle. You can also use the following command in a shell window; be sure that you have the correct path to the zip ﬁle: aws s3 cp wordpress/wordpress.zip s3://BUCKET_NAME/ 2. Deploy the WordPress CodeDeploy Application Bundle REQUIRED DATA CODEDEPLOY APPLICATION DEPLOYMENT: • CodeDeployApplicationName: The name you gave the CodeDeploy application. • CodeDeployGroupName: Since the CodeDeploy application and group were both created from the name you gave the CodeDeploy application in the HA stack RFC, this is the same name as the CodeDeployApplicationName. • S3Bucket: The name you gave the S3 bucket. • S3BundleType and S3Key: These are part of the WordPress application bundle you deployed. Create, Upload, and Deploy the Application Version September 13, 2024 203 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • VpcId: The relevant VPC. a. On the Create RFC page, select the category Deployment, subcategory Applications, item CodeDeploy application, and operation Deploy from the RFC CT pick list. b. Keep the default Basic option, and set the values as shown. Note Reference the CodeDeploy application, CodeDeploy deployment group, S3 bucket and bundle previously created. Subject: WP-CD-Deploy-RFC Description: DeployWordPress S3Bucket: BUCKET_NAME S3Key: wordpress.zip S3BundleType: zip CodeDeployApplicationName: WordPress CodeDeployDeploymentGroupName: WordPress CodeDeployIgnoreApplicationStopFailures: false RevisionType: S3 VpcId: VPC_ID Name: WP-CD-Deploy-Op TimeoutInMinutes: 60 c. Click Submit when ﬁnished. Validate the Application Deployment Navigate to the endpoint (LoadBalancerCName) of the previously-created load balancer, with the WordPress deployed path: /WordPress. For example: http://stack-ID-FOR-ELB.us-east-1.elb.amazonaws.com/WordPress You should see a page like this: Validate the Application Deployment Version September 13, 2024 204 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Tear Down the High Availability Deployment To tear down the deployment, you submit the Delete Stack CT against the HA Two-Tier stack, and the S3 bucket, and you can request that RDS snapshots be deleted (they are deleted automatically Tear Down the High Availability Deployment Version September 13, 2024 205 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options after ten days, but they do cost a small amount while there). Gather the stack IDs for the HA stack and the S3 bucket and then follow these steps. See Stack \| Delete. Console Tutorial: Deploying a Tier and Tie WordPress Website This section describes how to deploy a high availability (HA) WordPress site into an AMS environment using the AMS console. This set of instructions includes an example of creating the necessary WordPress CodeDeploy-compatible package (e.g. zip) ﬁle. The provisioning of the resources follows an order that allows you to tie them together to form "tiers." Note This deployment walkthrough is designed for use with an AMZN Linux OS. The essential variable parameters are notated as replaceable; however, you may want to modify other parameters to suit your situation. Summary of tasks and required RFCs: 1. Create the infrastructure: a. Create a MySQL RDS database cluster b. Create a load balancer c. Create an Auto scaling group and tie it to the load balancer d. Create an S3 bucket for CodeDeploy applications 2. Create a WordPress application bundle (does not require an RFC) 3. Deploy the WordPress application bundle with CodeDeploy: a. Create a CodeDeploy application b. Create a CodeDeploy deployment
ams-appguide-069	ams-appguide.pdf	69	designed for use with an AMZN Linux OS. The essential variable parameters are notated as replaceable; however, you may want to modify other parameters to suit your situation. Summary of tasks and required RFCs: 1. Create the infrastructure: a. Create a MySQL RDS database cluster b. Create a load balancer c. Create an Auto scaling group and tie it to the load balancer d. Create an S3 bucket for CodeDeploy applications 2. Create a WordPress application bundle (does not require an RFC) 3. Deploy the WordPress application bundle with CodeDeploy: a. Create a CodeDeploy application b. Create a CodeDeploy deployment group c. Upload your WordPress application bundle to the S3 bucket (does not require an RFC) d. Deploy the CodeDeploy application 4. Validate the deployment 5. Tear down the deployment Descriptions for all CT options, including ChangeTypeId can be found in AMS Change Type Reference. Console Tutorial: Deploying a Tier and Tie WordPress Website Version September 13, 2024 206 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Creating an RFC using the Console (Basics) These are some steps that you must follow each time you create an RFC using the Console. 1. Click RFCs in the left navigation pane to open the RFCs list page, then click Create RFC. The Create RFC page opens. 2. Choose either Browse change types (the default) or Choose by category. 3. Browse change types: a. Click on a quick create option to begin an RFC with one of the most used change types. The General conﬁguration area for that change type opens, the subject line is ﬁlled in. To see the change type details, open the area at the top of the page. b. Use the All change types area. Filter, toggle between a cards or table view, or sort the change types. When you ﬁnd the one you want, select it and click Create RFC at the top of the page. The General conﬁguration area for that change type opens, the subject line is ﬁlled in. To see the change type details, open the area at the top of the page. 4. Choose by category: a. Select the appropriate Category, Subcategory, Item, and Operation. The change type details box appears at the bottom of the page. b. Click Create RFC at the bottom of the page. c. The General conﬁguration area for that change type opens, the subject line is ﬁlled in. To see the change type details, open the area at the top of the page. 5. 6. To ensure certain people get notiﬁcations of the RFC progress, ﬁll in the Email addresses. To add details about the change type, ﬁll in the Description. Open the Additional conﬁguration area to add more speciﬁcs about the RFC. For Schedulingselect either Execute this change ASAP or Schedule this change. If you select Execute this change ASAP, your RFC executes as soon as approvals have passed. If you select Schedule this change type, a pick calendar, time, and time zone, appears and your RFC starts, after submission, as scheduled. Creating an RFC using the Console (Basics) Version September 13, 2024 207 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 7. In the Execution conﬁguration area, conﬁgure the change type parameters. To see optional parameters, open the Additional conﬁguration area. 8. When ready, click Run. Creating the Infrastructure Log in to the AWS Console for the target AMS account and then the AMS Console for the account. The following procedures describe creating an RDS database, a load balancer, and an Auto Scaling group in such a manner that you use the resource IDs to build the infrastructure. Create an RDS Stack See RDS stack \| Create. Create an ELB Stack Launch a public ELB. REQUIRED DATA: • VpcId: The VPC you are using, this should be the same as the previously used VPC. • ELBSubnetIds: An array of subnets across which the load balancer will distribute traﬃc. Choose either public or private subnets. Find Subnet IDs with the For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. operation (CLI: list-subnet-summaries) or in the AMS Console VPCs -> VPC details page. • VpcId: The VPC you are using, this should be the same as the previously used VPC. 1. On the Create RFC page, select the category Deployment, subcategory Advanced Stack Components, item Load balancer (ELB) stack, and click Create. Choose Advanced and accept all defaults (including those with no value) except those shown next. Subject: WP-ELB-RFC ELBSubnetIds: PUBLIC_AZ1 PUBLIC_AZ2 ELBScheme true ELBCookieExpirationPeriod 600 VpcId: VPC_ID Name: WP-Public-ELB Creating the Infrastructure Version September 13, 2024 208 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. Click Submit when ﬁnished. Create an Auto Scaling Group Stack Launch an Auto scaling group. REQUIRED DATA: • VpcId: The
ams-appguide-070	ams-appguide.pdf	70	using, this should be the same as the previously used VPC. 1. On the Create RFC page, select the category Deployment, subcategory Advanced Stack Components, item Load balancer (ELB) stack, and click Create. Choose Advanced and accept all defaults (including those with no value) except those shown next. Subject: WP-ELB-RFC ELBSubnetIds: PUBLIC_AZ1 PUBLIC_AZ2 ELBScheme true ELBCookieExpirationPeriod 600 VpcId: VPC_ID Name: WP-Public-ELB Creating the Infrastructure Version September 13, 2024 208 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. Click Submit when ﬁnished. Create an Auto Scaling Group Stack Launch an Auto scaling group. REQUIRED DATA: • VpcId: The VPC you are using, this should be the same as the previously used VPC. • AMI-ID: This value determines what kind of EC2 instances your Auto Scaling group (ASG) will spin up. Be sure to select an AMI in your account that starts with "customer-" and is of the operating system that you want. Find AMI IDs with the For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. operation (CLI: list-amis) or in the AMS Console VPCs -> VPCs details page. This walkthrough is for ASGs conﬁgured to use a Linux AMI. • ASGLoadBalancerNames: The load balancer that you previously created--ﬁnd the name by looking at the EC2 Console -> Load Balancers (in the left nav). Note this is not the "Name" that you speciﬁed when you created the ELB previously. 1. On the Create RFC page, select the category Deployment, subcategory Advanced Stack Components, item Auto scaling group, and click Create. Choose Advanced and accept all defaults (including those with no value) except those shown next. Note Specify the latest AMS AMI. Specify the previously-created ELB. Subject: WP-ASG-RFC ASGSubnetIds: PRIVATE_AZ1 PRIVATE_AZ2 ASGAmiId: AMI_ID VpcId: VPC_ID Name: WP_ASG ASGLoadBalancerNames: ELB_NAME ASGUserData: #!/bin/bash Creating the Infrastructure Version September 13, 2024 209 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options REGION=$(curl 169.254.169.254/latest/meta-data/placement/availability-zone/ \| sed 's/[a-z]$//') yum -y install ruby httpd chkconfig httpd on service httpd start touch /var/www/html/status cd /tmp curl -O https://aws-codedeploy-$REGION.s3.amazonaws.com/latest/install chmod +x ./install ./install auto chkconfig codedeploy-agent on service codedeploy-agent start 2. Click Submit when ﬁnished. Create an S3 Stack Launch an S3 bucket. The S3 bucket is where you upload the application bundle you created. REQUIRED DATA: • VPC-ID: This value determines where your S3 Bucket will be, this should be the same as the previously used VPC. • AccessControl: Pre-set AccessControl list (ACL) options are Private, and PublicRead. For more information, see Amazon Simple Storage Service Canned ACL. • BucketName: This value sets the S3 Bucket name, you use it to upload your application bundle. It must be unique across the region of the account and cannot include upper-case letters. Including your account ID as part of the BucketName is not a requirement but makes it easier to identify the bucket later. To see what S3 bucket names exist in the account, go to the Amazon S3 Console for your account. 1. On the Create RFC page, select the category Deployment, subcategory Advanced Stack Components, item S3 storage, and click Create. You can leave the default parameter option at Basic to accept the defaults as described. To set diﬀerent values, choose Advanced. Creating the Infrastructure Version September 13, 2024 210 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note The bucket deployed with this change type allows full read/write access to the whole account, new change types may be needed to allow more restricted access permissions. Subject: S3-Bucket-RFC BucketName: ACCOUNT_ID-codedeploy-bundles AccessControl: Private VpcId: VPC_ID Name: S3BucketForWP 2. Click Submit when ﬁnished. Create a WordPress CodeDeploy Bundle The section provides an example of creating an application deployment bundle. 1. Download WordPress, extract the ﬁles and create a ./scripts directory. Linux command: wget https://github.com/WordPress/WordPress/archive/master.zip Windows: Paste https://github.com/WordPress/WordPress/archive/master.zip into a browser window and download the zip ﬁle. Create a temporary directory in which to assemble the package. Linux: mkdir /tmp/WordPress Windows: Create a "WordPress" directory, you will use the directory path later. 2. Extract the WordPress source to the "WordPress" directory and create a ./scripts directory. Linux: Create a WordPress CodeDeploy Bundle Version September 13, 2024 211 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options unzip master.zip -d /tmp/WordPress_Temp cp -paf /tmp/WordPress_Temp/WordPress-master/* /tmp/WordPress rm -rf /tmp/WordPress_Temp rm -f master cd /tmp/WordPress mkdir scripts Windows: Go to the "WordPress" directory that you created and create a "scripts" directory there. If you are in a Windows environment, be sure to set the break type for the script ﬁles to Unix (LF). In Notepad ++, this is an option at the bottom right of the window. 3. Create the CodeDeploy appspec.yml ﬁle, in the WordPress directory (if copying the example, check the indentation, each space counts). IMPORTANT: Ensure that the "source" path is correct for copying the WordPress ﬁles (in this
ams-appguide-071	ams-appguide.pdf	71	/tmp/WordPress_Temp cp -paf /tmp/WordPress_Temp/WordPress-master/* /tmp/WordPress rm -rf /tmp/WordPress_Temp rm -f master cd /tmp/WordPress mkdir scripts Windows: Go to the "WordPress" directory that you created and create a "scripts" directory there. If you are in a Windows environment, be sure to set the break type for the script ﬁles to Unix (LF). In Notepad ++, this is an option at the bottom right of the window. 3. Create the CodeDeploy appspec.yml ﬁle, in the WordPress directory (if copying the example, check the indentation, each space counts). IMPORTANT: Ensure that the "source" path is correct for copying the WordPress ﬁles (in this case, in your WordPress directory) to the expected destination (/var/www/html/WordPress). In the example, the appspec.yml ﬁle is in the directory with the WordPress ﬁles, so only "/" is needed. Also, even if you used a RHEL AMI for your Auto Scaling group, leave the "os: linux" line as-is. Example appspec.yml ﬁle: version: 0.0 os: linux files: - source: / destination: /var/www/html/WordPress hooks: BeforeInstall: - location: scripts/install_dependencies.sh timeout: 300 runas: root AfterInstall: - location: scripts/config_wordpress.sh timeout: 300 runas: root ApplicationStart: - location: scripts/start_server.sh timeout: 300 runas: root ApplicationStop: - location: scripts/stop_server.sh timeout: 300 Create a WordPress CodeDeploy Bundle Version September 13, 2024 212 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options runas: root 4. Create bash ﬁle scripts in the WordPress ./scripts directory. First, create config_wordpress.sh with the following content (if you prefer, you can edit the wp-conﬁg.php ﬁle directly). Note Replace DBName with the value given in the HA Stack RFC (for example, wordpress). Replace DB_MasterUsername with the MasterUsername value given in the HA Stack RFC (for example, admin). Replace DB_MasterUserPassword with the MasterUserPassword value given in the HA Stack RFC (for example, p4ssw0rd). Replace DB_ENDPOINT with the endpoint DNS name in the execution outputs of the HA Stack RFC (for example, srt1cz23n45sfg.clgvd67uvydk.us- east-1.rds.amazonaws.com). You can ﬁnd this with the GetRfc operation (CLI: get- rfc --rfc-id RFC_ID) or in the AMS Console RFC details page for the HA Stack RFC that you previously submitted. #!/bin/bash chmod -R 755 /var/www/html/WordPress cp /var/www/html/WordPress/wp-config-sample.php /var/www/html/WordPress/wp- config.php cd /var/www/html/WordPress sed -i "s/database_name_here/DBName/g" wp-config.php sed -i "s/username_here/DB_MasterUsername/g" wp-config.php sed -i "s/password_here/DB_MasterUserPassword/g" wp-config.php sed -i "s/localhost/DB_ENDPOINT/g" wp-config.php 5. In the same directory create install_dependencies.sh with the following content: #!/bin/bash yum install -y php yum install -y php-mysql yum install -y mysql service httpd restart Create a WordPress CodeDeploy Bundle Version September 13, 2024 213 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note HTTPS is installed as part of the user data at launch in order to allow health checks to work from the start. 6. In the same directory create start_server.sh with the following content: • For Amazon Linux instances, use this: #!/bin/bash service httpd start • For RHEL instances, use this (the extra commands are policies that allow SELINUX to accept WordPress): #!/bin/bash setsebool -P httpd_can_network_connect_db 1 setsebool -P httpd_can_network_connect 1 chcon -t httpd_sys_rw_content_t /var/www/html/WordPress/wp-content -R restorecon -Rv /var/www/html service httpd start 7. In the same directory create stop_server.sh with the following content: #!/bin/bash service httpd stop 8. Create the zip bundle. Linux: $ cd /tmp/WordPress $ zip -r wordpress.zip . Windows: Go to your "WordPress" directory and select all of the ﬁles and create a zip ﬁle, be sure to name it wordpress.zip. Create a WordPress CodeDeploy Bundle Version September 13, 2024 214 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Deploy the WordPress Application Bundle with CodeDeploy The CodeDeploy is an AWS deployment service that automates application deployments to Amazon EC2 instances. This part of the process involves creating a CodeDeploy application, creating a CodeDeploy deployment group, and then deploying the application using CodeDeploy. Create a CodeDeploy Application The CodeDeploy application is simply a name or container used by AWS CodeDeploy to ensure that the correct revision, deployment conﬁguration, and deployment group are referenced during a deployment. The deployment conﬁguration, in this case, is the WordPress bundle that you previously created. REQUIRED DATA: • VpcId: The VPC that you are using, this should be the same as the previously used VPC. • CodeDeployApplicationName: Must be unique in the account. Look at the CodeDeploy Console to check for existing application names. 1. Create the CodeDeploy Application for WordPress On the Create RFC page, select the category Deployment, subcategory Applications, item CodeDeploy application and operation Create from the RFC CT pick list. Choose Basic and set the values as shown. Click Submit when ﬁnished. Subject: CD-WP-App-RFC CodeDeployApplicationName: WordPress VpcId: VPC_ID Name: WP-CD-App 2. Click Submit when ﬁnished. Create a CodeDeploy Deployment Group Create the CodeDeploy deployment group. A CodeDeploy deployment group deﬁnes a set of individual instances targeted for a deployment. REQUIRED DATA: Deploy the WordPress Application Bundle with CodeDeploy Version September 13, 2024 215 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • VpcId: The
ams-appguide-072	ams-appguide.pdf	72	WordPress On the Create RFC page, select the category Deployment, subcategory Applications, item CodeDeploy application and operation Create from the RFC CT pick list. Choose Basic and set the values as shown. Click Submit when ﬁnished. Subject: CD-WP-App-RFC CodeDeployApplicationName: WordPress VpcId: VPC_ID Name: WP-CD-App 2. Click Submit when ﬁnished. Create a CodeDeploy Deployment Group Create the CodeDeploy deployment group. A CodeDeploy deployment group deﬁnes a set of individual instances targeted for a deployment. REQUIRED DATA: Deploy the WordPress Application Bundle with CodeDeploy Version September 13, 2024 215 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • VpcId: The VPC that you are using, this should be the same as the previously used VPC. • CodeDeployApplicationName: Use the value you previously created. • CodeDeployAutoScalingGroups: Use the name of the Auto Scaling group that you created previously. • CodeDeployDeploymentGroupName: A name for the deployment group. This name must be unique for each application associated with the deployment group. • CodeDeployServiceRoleArn: Use the formula given in the example. 1. On the Create RFC page, select the Category Deployment, subcategory Applications, item CodeDeploy deployment group, and operation Create from the RFC CT pick list. Choose Advanced and set the values as shown (only a Subject is needed for the RFC). Click Submit when ﬁnished. Note Reference the CodeDeploy service role ARN in this format "arn:aws:iam::085398962942:role/aws-codedeploy-role" and use the previously-created Auto scaling group name for "ASG_NAME". Description: Create CodeDeploy Deployment Group for WP CodeDeployApplicationName: WordPress CodeDeployAutoScalingGroups: ASG_NAME CodeDeployDeploymentConfigName: CodeDeployDefault.HalfAtATime CodeDeployDeploymentGroupName: WP CD Group CodeDeployServiceRoleArn: arn:aws:iam::ACCOUNT_ID:role/aws-codedeploy-role VpcId: VPC_ID Name: WP Deployment Group 2. Click Submit when ﬁnished. Upload the WordPress Application You automatically have access to any S3 bucket instance that you create. You can access it through your Bastions (see Accessing Instances), or through the S3 console, and upload the CodeDeploy Deploy the WordPress Application Bundle with CodeDeploy Version September 13, 2024 216 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options bundle. The bundle needs to be in place in order to continue deploying the stack. The example uses the bucket name previously created. You can use this AWS command to zip up the bundle: aws s3 cp wordpress/wordpress.zip s3://ACCOUNT_ID-codedeploy-bundles/ Deploy the WordPress Application with CodeDeploy Deploy the CodeDeploy application. REQUIRED DATA: • VPC-ID: The VPC you are using, this should be the same as the previously used VPC. • CodeDeployApplicationName: Use the name for the CodeDeploy application that you previously created. • CodeDeployDeploymentGroupName: Use the name of the CodeDeploy deployment group that you created previously. • S3Location (where you uploaded the application bundle): S3Bucket: The BucketName that you previously created, S3BundleType and S3Key: The type of, and name of, the bundle that you put on your S3 store. 1. Deploy the WordPress CodeDeploy Application Bundle On the Create RFC page, select the category Deployment, subcategory Applications, item CodeDeploy application, and operation Deploy from the RFC CT pick list. Choose Basic and set the values as shown. Click Submit when ﬁnished. Note Reference the CodeDeploy application, CodeDeploy deployment group, S3 bucket and bundle previously created. Subject: WP-CD-Deploy-RFC CodeDeployApplicationName: WordPress CodeDeployDeploymentGroupName: WPCDGroup RevisionType: S3 Deploy the WordPress Application Bundle with CodeDeploy Version September 13, 2024 217 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options S3Bucket: ACCOUNT_ID-codedeploy-bundles S3BundleType: zip S3Key: wordpress.zip VpcId: VPC_ID Name: WordPress 2. Click Submit when ﬁnished. Validate the Application Deployment Navigate to the endpoint (ELB CName) of the previously-created load balancer, with the WordPress deployed path: /WordPress. For example: http://stack-ID-FOR-ELB.us-east-1.elb.amazonaws.com/WordPress Tear Down the Application Deployment To tear down the deployment, you submit the Delete Stack CT against the RDS database stack, the application load balancer, the Auto Scaling group, the S3 bucket, and the Code Deploy application and group--six RFCs in all. Additionally, you can submit a service request for the RDS snapshots to be deleted (they are deleted automatically after ten days, but they do cost a small amount while there). Gather the stack IDs for all and then follow these steps. See Stack \| Delete. CLI Tutorial: High Availability Two-Tier Stack (Linux/RHEL) This section describes how to deploy a high availability (HA) two-tier stack into an AMS environment using the AMS CLI. Note This deployment walkthrough has been tested in AMZN Linux and RHEL environments. Summary of tasks and required RFCs: 1. Create infrastructure (HA two-tier stack) 2. Create an S3 bucket for CodeDeploy applications 3. Create the WordPress application bundle and upload it to the S3 bucket Validate the Application Deployment Version September 13, 2024 218 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 4. Deploy the application with CodeDeploy 5. Access the WordPress site and log in to validate the deployment Before You Begin The Deployment \| Advanced Stack Components \| High Availability Two Tier Stack Advanced \| Create CT creates an Auto Scaling group, a load balancer, a database, and
ams-appguide-073	ams-appguide.pdf	73	Summary of tasks and required RFCs: 1. Create infrastructure (HA two-tier stack) 2. Create an S3 bucket for CodeDeploy applications 3. Create the WordPress application bundle and upload it to the S3 bucket Validate the Application Deployment Version September 13, 2024 218 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 4. Deploy the application with CodeDeploy 5. Access the WordPress site and log in to validate the deployment Before You Begin The Deployment \| Advanced Stack Components \| High Availability Two Tier Stack Advanced \| Create CT creates an Auto Scaling group, a load balancer, a database, and a CodeDeploy application name and deployment group (with the same name that you give the application). For information on CodeDeploy see What is CodeDeploy? This walkthrough uses a High Availability Two-Tier Stack (Advanced) RFC that includes UserData and also describes how to create a WordPress bundle that CodeDeploy can deploy. The UserData shown in the example gets instance metadata such as instance ID, region, etc, from within a running instance by querying the EC2 instance metadata service available at http://169.254.169.254/latest/meta-data/. This line in the user data script: REGION=$(curl 169.254.169.254/latest/meta-data/placement/availability-zone/ \| sed 's/ [a-z]$//'), retrieves the availability zone name from the meta-data service into the $REGION variable for our supported regions, and uses it to complete the URL for the S3 bucket where the CodeDeploy agent is downloaded. The 169.254.169.254 IP is routable only within the VPC (all VPCs can query the service). For information about the service, see Instance Metadata and User Data. Note also that scripts entered as UserData are executed as the "root" user and do not need to use the "sudo" command. This walkthrough leaves the following parameters at the default value (shown): • Auto Scaling group: Cooldown=300, DesiredCapacity=2, EBSOptimized=false, HealthCheckGracePeriod=600, IAMInstanceProfile=customer-mc-ec2-instance- profile, InstanceDetailedMonitoring=true, InstanceRootVolumeIops=0, InstanceRootVolumeType=standard, InstanceType=m3.medium, MaxInstances=2, MinInstances=2, 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. Before You Begin Version September 13, 2024 219 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Load Balancer: HealthCheckInterval=30, HealthCheckTimeout=5. • Database: BackupRetentionPeriod=7, Backups=true, InstanceType=db.m3.medium, IOPS=0, MultiAZ=true, PreferredBackupWindow=22:00-23:00, PreferredMaintenanceWindow=wed:03:32-wed:04:02, StorageEncrypted=false, StorageEncryptionKey="", StorageType=gp2. • Application: DeploymentConfigName=CodeDeployDefault.OneAtATime. • S3 bucket: AccessControl=Private. ADDITIONAL SETTINGS: RequestedStartTime and RequestedEndTime if you want to schedule your RFC: You can use Time.is to determine the correct UTC time. The examples provided must be adjusted appropriately. An RFC cannot proceed if the start time has passed. Alternatively, you can leave those values oﬀ to create an ASAP RFC that executes as soon as approvals are passed. Note There are many parameters that you might choose to set diﬀerently than as shown. The values for those parameters shown in the example have been tested but may not be right for you. Create the Infrastructure Gathering the following data before you begin will make the deployment go more quickly. REQUIRED DATA HA STACK: • AutoScalingGroup: • UserData: This value is provided in this tutorial. It includes commands to set up the resource for CodeDeploy and start the CodeDeploy agent. • AMI-ID: This value determines what kind of EC2 instances your Auto Scaling group (ASG) will spin up. Be sure to select an AMI in your account that starts with "customer-" and is of the operating system that you want. Find AMI IDs with the For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. operation (CLI: list-amis) or in the AMS Console VPCs -> VPCs details page. This walkthrough is for ASGs conﬁgured to use a Linux AMI. Create the Infrastructure Version September 13, 2024 220 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Database: • These parameters, DBEngine, EngineVersion, and LicenseModel should be set according to your situation though the values shown in the example have been tested. • These parameters, RDSSubnetIds, DBName, MasterUsername, and MasterUserPassword are required when deploying the application bundle. For RDSSubnetIds, use two Private subnets. • LoadBalancer: • These parameters, DBEngine, EngineVersion, and LicenseModel should be set according to your situation though the values shown in the example have been tested. • ELBSubnetIds: Use two Public subnets. • Application: The ApplicationName value sets the CodeDeploy application name and CodeDeploy deployment group name. You use it to deploy your application. It must be unique in the account. To check your account for CodeDeploy names, see the CodeDeploy Console. The example uses "WordPress" but, if you will use that value, make sure that it is not already in use. This procedure utilizes the High availability two-tier stack (advanced) CT (ct-06mjngx5ﬂwto) and the Create S3 storage CT (ct-1a68ck03fn98r). From your authenticated account, follow these steps at the command line. 1. Launch the infrastructure stack. a. Output the execution parameters JSON schema for the HA two tier stack CT to a ﬁle in your current folder named CreateStackParams.json. aws amscm get-change-type-version --change-type-id "ct-06mjngx5flwto"
ams-appguide-074	ams-appguide.pdf	74	It must be unique in the account. To check your account for CodeDeploy names, see the CodeDeploy Console. The example uses "WordPress" but, if you will use that value, make sure that it is not already in use. This procedure utilizes the High availability two-tier stack (advanced) CT (ct-06mjngx5ﬂwto) and the Create S3 storage CT (ct-1a68ck03fn98r). From your authenticated account, follow these steps at the command line. 1. Launch the infrastructure stack. a. Output the execution parameters JSON schema for the HA two tier stack CT to a ﬁle in your current folder named CreateStackParams.json. aws amscm get-change-type-version --change-type-id "ct-06mjngx5flwto" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateStackParams.json b. Modify the schema. Replace the variables as appropriate. For example, use the OS that you want for the EC2 instances the ASG will create. Record the ApplicationName as you will use it later to deploy the application. Note that you can add up to 50 tags. { "Description": "HA two tier stack for WordPress", "Name": "WordPressStack", "TimeoutInMinutes": 360, "Tags": [ Create the Infrastructure Version September 13, 2024 221 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options { "Key": "ApplicationName", "Value": "WordPress" } ], "AutoScalingGroup": { "AmiId": "AMI-ID", "UserData": "#!/bin/bash \n REGION=$(curl 169.254.169.254/latest/meta-data/placement/ availability-zone/ \| sed 's/[a-z]$//') \n yum -y install ruby httpd \n chkconfig httpd on \n service httpd start \n touch /var/www/html/status \n cd /tmp \n curl -O https://aws-codedeploy-$REGION.s3.amazonaws.com/latest/ install \n chmod +x ./install \n ./install auto \n chkconfig codedeploy-agent on \n service codedeploy-agent start" }, "LoadBalancer": { "Public": true, "HealthCheckTarget": "HTTP:80/status" }, "Database": { "DBEngine": "MySQL", "DBName": "wordpress", "EngineVersion": "8.0.16 ", "LicenseModel": "general-public-license", "MasterUsername": "admin", "MasterUserPassword": "p4ssw0rd" }, "Application": { "ApplicationName": "WordPress" } } c. Output the CreateRfc JSON template to a ﬁle in your current folder named CreateStackRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateStackRfc.json Create the Infrastructure Version September 13, 2024 222 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options d. Modify the RFC template as follows and save it, you can delete and replace the contents. Note that RequestedStartTime and RequestedEndTime are now optional; excluding them creates an ASAP RFC that executes as soon as it is approved (which usually happens automatically). To submit a scheduled RFC, add those values. { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-06mjngx5flwto", "Title": "HA-Stack-For-WP-RFC" } e. Create the RFC, specifying the CreateStackRfc.json ﬁle and the CreateStackParams.json execution parameters ﬁle: aws amscm create-rfc --cli-input-json file://CreateStackRfc.json --execution- parameters file://CreateStackParams.json You receive the RFC ID in the response. Save the ID for subsequent steps. f. Submit the RFC: aws amscm submit-rfc --rfc-id RFC_ID If the RFC succeeds, you receive no output. g. To check RFC status, run aws amscm get-rfc --rfc-id RFC_ID Keep note of the RFC ID. 2. Launch an S3 bucket Gathering the following data before you begin will make the deployment go more quickly. REQUIRED DATA S3 BUCKET: • VPC-ID: This value determines where your S3 Bucket will be. Use the same VPC ID that you used previously. Create the Infrastructure Version September 13, 2024 223 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • BucketName: This value sets the S3 Bucket name, you use it to upload your application bundle. It must be unique across the region of the account and cannot include upper-case letters. Including your account ID as part of the BucketName is not a requirement but makes it easier to identify the bucket later. To see what S3 bucket names exist in the account, go to the Amazon S3 Console for your account. a. Output the execution parameters JSON schema for the S3 storage create CT to a JSON ﬁle named CreateS3StoreParams.json. aws amscm get-change-type-version --change-type-id "ct-1a68ck03fn98r" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateS3StoreParams.json b. Modify the schema as follows, you can delete and replace the contents. Replace VPC_ID appropriately. The values in the example have been tested, but may not be right for you. Tip The BucketName must be unique across the region of the account and cannot include upper-case letters. Including your account ID as part of the BucketName is not a requirement but makes it easier to identify the bucket later. To see what S3 bucket names exist in the account, go to the Amazon S3 Console for your account. { "Description": "S3BucketForWordPressBundle", "VpcId": "VPC_ID", "StackTemplateId": "stm-s2b72beb000000000", "Name": "S3BucketForWP", "TimeoutInMinutes": 60, "Parameters": { "AccessControl": "Private", "BucketName": "ACCOUNT_ID-BUCKET_NAME" } } c. Output the JSON template for CreateRfc to a ﬁle, in your current folder, named CreateS3StoreRfc.json: Create the Infrastructure Version September 13, 2024 224 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm create-rfc --generate-cli-skeleton > CreateS3StoreRfc.json d. Modify and save the CreateS3StoreRfc.json ﬁle, you can delete and replace the contents. Note that RequestedStartTime and RequestedEndTime are now optional; excluding them creates an ASAP RFC that executes as soon as it is approved (which usually happens automatically). To submit a scheduled RFC,
ams-appguide-075	ams-appguide.pdf	75	"VPC_ID", "StackTemplateId": "stm-s2b72beb000000000", "Name": "S3BucketForWP", "TimeoutInMinutes": 60, "Parameters": { "AccessControl": "Private", "BucketName": "ACCOUNT_ID-BUCKET_NAME" } } c. Output the JSON template for CreateRfc to a ﬁle, in your current folder, named CreateS3StoreRfc.json: Create the Infrastructure Version September 13, 2024 224 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm create-rfc --generate-cli-skeleton > CreateS3StoreRfc.json d. Modify and save the CreateS3StoreRfc.json ﬁle, you can delete and replace the contents. Note that RequestedStartTime and RequestedEndTime are now optional; excluding them creates an ASAP RFC that executes as soon as it is approved (which usually happens automatically). To submit a scheduled RFC, add those values. { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1a68ck03fn98r", "Title": "S3-Stack-For-WP-RFC" } e. Create the RFC, specifying the CreateS3StoreRfc.json ﬁle and the CreateS3StoreParams.json execution parameters ﬁle: aws amscm create-rfc --cli-input-json file://CreateS3StoreRfc.json -- execution-parameters file://CreateS3StoreParams.json You receive the RfcId of the new RFC in the response. Save the ID for subsequent steps. f. Submit the RFC: aws amscm submit-rfc --rfc-id RFC_ID If the RFC succeeds, you receive no output. g. To check RFC status, run aws amscm get-rfc --rfc-id RFC_ID Create, Upload, and Deploy the Application First, create a WordPress application bundle, and then use the CodeDeploy CTs to create and deploy the application. 1. Download WordPress, extract the ﬁles and create a ./scripts directory. Linux command: Create, Upload, and Deploy the Application Version September 13, 2024 225 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options wget https://github.com/WordPress/WordPress/archive/master.zip Windows: Paste https://github.com/WordPress/WordPress/archive/master.zip into a browser window and download the zip ﬁle. Create a temporary directory in which to assemble the package. Linux: mkdir /tmp/WordPress Windows: Create a "WordPress" directory, you will use the directory path later. 2. Extract the WordPress source to the "WordPress" directory and create a ./scripts directory. Linux: unzip master.zip -d /tmp/WordPress_Temp cp -paf /tmp/WordPress_Temp/WordPress-master/* /tmp/WordPress rm -rf /tmp/WordPress_Temp rm -f master cd /tmp/WordPress mkdir scripts Windows: Go to the "WordPress" directory that you created and create a "scripts" directory there. If you are in a Windows environment, be sure to set the break type for the script ﬁles to Unix (LF). In Notepad ++, this is an option at the bottom right of the window. 3. Create the CodeDeploy appspec.yml ﬁle, in the WordPress directory (if copying the example, check the indentation, each space counts). IMPORTANT: Ensure that the "source" path is correct for copying the WordPress ﬁles (in this case, in your WordPress directory) to the expected destination (/var/www/html/WordPress). In the example, the appspec.yml ﬁle is in the directory with the WordPress ﬁles, so only "/" is needed. Also, even if you used a RHEL AMI for your Auto Scaling group, leave the "os: linux" line as-is. Example appspec.yml ﬁle: version: 0.0 os: linux files: Create, Upload, and Deploy the Application Version September 13, 2024 226 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options - source: / destination: /var/www/html/WordPress hooks: BeforeInstall: - location: scripts/install_dependencies.sh timeout: 300 runas: root AfterInstall: - location: scripts/config_wordpress.sh timeout: 300 runas: root ApplicationStart: - location: scripts/start_server.sh timeout: 300 runas: root ApplicationStop: - location: scripts/stop_server.sh timeout: 300 runas: root 4. Create bash ﬁle scripts in the WordPress ./scripts directory. First, create config_wordpress.sh with the following content (if you prefer, you can edit the wp-conﬁg.php ﬁle directly). Note Replace DBName with the value given in the HA Stack RFC (for example, wordpress). Replace DB_MasterUsername with the MasterUsername value given in the HA Stack RFC (for example, admin). Replace DB_MasterUserPassword with the MasterUserPassword value given in the HA Stack RFC (for example, p4ssw0rd). Replace DB_ENDPOINT with the endpoint DNS name in the execution outputs of the HA Stack RFC (for example, srt1cz23n45sfg.clgvd67uvydk.us- east-1.rds.amazonaws.com). You can ﬁnd this with the GetRfc operation (CLI: get- rfc --rfc-id RFC_ID) or in the AMS Console RFC details page for the HA Stack RFC that you previously submitted. #!/bin/bash Create, Upload, and Deploy the Application Version September 13, 2024 227 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options chmod -R 755 /var/www/html/WordPress cp /var/www/html/WordPress/wp-config-sample.php /var/www/html/WordPress/wp- config.php cd /var/www/html/WordPress sed -i "s/database_name_here/DBName/g" wp-config.php sed -i "s/username_here/DB_MasterUsername/g" wp-config.php sed -i "s/password_here/DB_MasterUserPassword/g" wp-config.php sed -i "s/localhost/DB_ENDPOINT/g" wp-config.php 5. In the same directory create install_dependencies.sh with the following content: #!/bin/bash yum install -y php yum install -y php-mysql yum install -y mysql service httpd restart Note HTTPS is installed as part of the user data at launch in order to allow health checks to work from the start. 6. In the same directory create start_server.sh with the following content: • For Amazon Linux instances, use this: #!/bin/bash service httpd start • For RHEL instances, use this (the extra commands are policies that allow SELINUX to accept WordPress): #!/bin/bash setsebool -P httpd_can_network_connect_db 1 setsebool -P httpd_can_network_connect 1 chcon -t httpd_sys_rw_content_t /var/www/html/WordPress/wp-content -R restorecon -Rv /var/www/html service httpd start 7. In the same directory create stop_server.sh with the following content: Create, Upload,
ams-appguide-076	ams-appguide.pdf	76	-y mysql service httpd restart Note HTTPS is installed as part of the user data at launch in order to allow health checks to work from the start. 6. In the same directory create start_server.sh with the following content: • For Amazon Linux instances, use this: #!/bin/bash service httpd start • For RHEL instances, use this (the extra commands are policies that allow SELINUX to accept WordPress): #!/bin/bash setsebool -P httpd_can_network_connect_db 1 setsebool -P httpd_can_network_connect 1 chcon -t httpd_sys_rw_content_t /var/www/html/WordPress/wp-content -R restorecon -Rv /var/www/html service httpd start 7. In the same directory create stop_server.sh with the following content: Create, Upload, and Deploy the Application Version September 13, 2024 228 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options #!/bin/bash service httpd stop 8. Create the zip bundle. Linux: $ cd /tmp/WordPress $ zip -r wordpress.zip . Windows: Go to your "WordPress" directory and select all of the ﬁles and create a zip ﬁle, be sure to name it wordpress.zip. 1. Upload the application bundle to the S3 bucket. The bundle needs to be in place in order to continue deploying the stack. You automatically have access to any S3 bucket instance that you create. You can access it through your bastions, or through the S3 console, and upload the WordPress bundle with drag-and-drop or browsing to and selecting the zip ﬁle. You can also use the following command in a shell window; be sure that you have the correct path to the zip ﬁle: aws s3 cp wordpress.zip s3://BUCKET_NAME/ 2. Deploy the WordPress application bundle. Gathering the following data before you begin will make the deployment go more quickly. REQUIRED DATA: • VPC-ID: This value determines where your S3 Bucket will be. Use the same VPC ID that you used previously. • CodeDeployApplicationName and CodeDeployApplicationName: The ApplicationName value you used in the HA 2-Tier Stack RFC set the CodeDeployApplicationName and the CodeDeployDeploymentGroupName. The example uses "WordPress" but you may have used a diﬀerent value. Create, Upload, and Deploy the Application Version September 13, 2024 229 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • S3Location: For S3Bucket, use the BucketName that you previously created. The S3BundleType and S3Key are from the bundle that you put on your S3 store. a. Output the execution parameters JSON schema for the CodeDeploy application deploy CT to a JSON ﬁle named DeployCDAppParams.json. aws amscm get-change-type-version --change-type-id "ct-2edc3sd1sqmrb" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeployCDAppParams.json b. Modify the schema as follows and save it as, you can delete and replace the contents. { "Description": "DeployWPCDApp", "VpcId": "VPC_ID", "Name": "WordPressCDAppDeploy", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "WordPress", "CodeDeployDeploymentGroupName": "WordPress", "CodeDeployIgnoreApplicationStopFailures": false, "CodeDeployRevision": { "RevisionType": "S3", "S3Location": { "S3Bucket": "BUCKET_NAME", "S3BundleType": "zip", "S3Key": "wordpress.zip" } } } } c. Output the JSON template for CreateRfc to a ﬁle, in your current folder, named DeployCDAppRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeployCDAppRfc.json d. Modify and save the DeployCDAppRfc.json ﬁle, you can delete and replace the contents. Note that RequestedStartTime and RequestedEndTime are now optional; excluding them creates an ASAP RFC that executes as soon as it is approved (which usually happens automatically). To submit a scheduled RFC, add those values. Create, Upload, and Deploy the Application Version September 13, 2024 230 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2edc3sd1sqmrb", "Title": "CD-Deploy-For-WP-RFC" } e. Create the RFC, specifying the DeployCDAppRfc ﬁle and the DeployCDAppParams execution parameters ﬁle: aws amscm create-rfc --cli-input-json file://DeployCDAppRfc.json --execution- parameters file://DeployCDAppParams.json You receive the RfcId of the new RFC in the response. Save the ID for subsequent steps. f. Submit the RFC: aws amscm submit-rfc --rfc-id RFC_ID If the RFC succeeds, you receive no output. g. To check RFC status, run aws amscm get-rfc --rfc-id RFC_ID Validate the Application Deployment Navigate to the endpoint (ELB CName) of the previously-created load balancer, with the WordPress deployed path: /WordPress. For example: http://stack-ID-FOR-ELB.us-east-1.elb.amazonaws.com/WordPress Tear Down the Application Deployment Once you are ﬁnished with the tutorial, you will want to tear down the deployment so you are not charged for the resources. The following is a generic stack delete operation. You'll want to submit it twice, once for the HA 2- Tier stack and once for the S3 bucket stack. As a ﬁnal follow-through, submit a service request that Validate the Application Deployment Version September 13, 2024 231 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options all snapshots for the S3 bucket (include the S3 bucket stack ID in the service request) be deleted. They are automatically deleted after 10 days, but deleting them early saves a little bit of cost. This walkthrough provides an example of using the AMS console to delete an S3 stack; this procedure applies to deleting any stack using the AMS console. Note If deleting an S3 bucket, it must be emptied of objects ﬁrst.
ams-appguide-077	ams-appguide.pdf	77	ﬁnal follow-through, submit a service request that Validate the Application Deployment Version September 13, 2024 231 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options all snapshots for the S3 bucket (include the S3 bucket stack ID in the service request) be deleted. They are automatically deleted after 10 days, but deleting them early saves a little bit of cost. This walkthrough provides an example of using the AMS console to delete an S3 stack; this procedure applies to deleting any stack using the AMS console. Note If deleting an S3 bucket, it must be emptied of objects ﬁrst. REQUIRED DATA: • StackId: The stack to use. You can ﬁnd this by looking at the AMS Console Stacks page, available through a link in the left nav. Using the AMS SKMS API/CLI, run the For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. operation (list-stack- summaries in the CLI). • The change type ID for this walkthrough is ct-0q0bic0ywqk6c, the version is "1.0", to ﬁnd out the latest version, run this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=ct-0q0bic0ywqk6c INLINE CREATE: • Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline). E aws amscm create-rfc --change-type-id "ct-0q0bic0ywqk6c" --change-type-version "1.0" --title "Delete My Stack" --execution-parameters "{\"StackId\":\"STACK_ID\"}" • Submit the RFC using the RFC ID returned in the create RFC operation. Until submitted, the RFC remains in the Editing state and is not acted on. aws amscm submit-rfc --rfc-id RFC_ID • Monitor the RFC status and view execution output: Tear Down the Application Deployment Version September 13, 2024 232 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm get-rfc --rfc-id RFC_ID TEMPLATE CREATE: 1. Output the RFC template to a ﬁle in your current folder; example names it DeleteStackRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteStackRfc.json 2. Modify and save the DeleteStackRfc.json ﬁle. Since deleting a stack has only one execution parameter, the execution parameters can be in the DeleteStackRfc.json ﬁle itself (there is no need to create a separate JSON ﬁle with execution parameters). The internal quotation marks in the ExecutionParameters JSON extension must be escaped with a backslash (\). Example without start and end time: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0q0bic0ywqk6c", "Title": "Delete-My-Stack-RFC" "ExecutionParameters": "{ \"StackId\":\"STACK_ID\"}" } 3. Create the RFC: aws amscm create-rfc --cli-input-json file://DeleteStackRfc.json You receive the RfcId of the new RFC in the response. For example: { "RfcId": "daaa1867-ffc5-1473-192a-842f6b326102" } Save the ID for subsequent steps. 4. Submit the RFC: Tear Down the Application Deployment Version September 13, 2024 233 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm submit-rfc --rfc-id RFC_ID If the RFC succeeds, you receive no conﬁrmation at the command line. 5. To monitor the status of the request and to view Execution Output: aws amscm get-rfc --rfc-id RFC_ID --query "Rfc. {Status:Status.Name,Exec:ExecutionOutput}" --output table CLI Tutorial: Deploying a Tier and Tie WordPress Website This section describes how to deploy a high availability (HA) WordPress site into an AMS environment using the AMS CLI. This set of instructions includes an example of creating the necessary WordPress CodeDeploy-compatible package (e.g. zip) ﬁle. Note This deployment walkthrough is designed for use with an AMZN Linux environment. The essential variable parameters are notated as replaceable; however, you may want to modify other parameters to suit your situation. Summary of tasks and required RFCs: 1. Create the infrastructure: a. Create an RDS Stack (CLI) b. Create a load balancer c. Create an Auto scaling group and tie it to the load balancer d. Create an S3 bucket for CodeDeploy applications 2. Create a WordPress application bundle (does not require an RFC) 3. Deploy the WordPress application bundle with CodeDeploy: a. Create a CodeDeploy application b. Create a CodeDeploy deployment group c. Upload your WordPress application bundle to the S3 bucket (does not require an RFC) d. Deploy the CodeDeploy application CLI Tutorial: Deploying a Tier and Tie WordPress Website Version September 13, 2024 234 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 4. Validate the deployment 5. Tear down the deployment Follow all steps at the command line from your authenticated account. Creating an RFC using the CLI For detailed information on creating RFCs, see Creating RFCs; for an explanation of common RFC parameters, see RFC common parameters . Create the Infrastructure The following procedures describe creating an RDS database, a load balancer, and an Auto Scaling group in such a manner that you use the resource IDs to build the infrastructure. Create an RDS Stack (CLI) See RDS stack \| Create. Create an ELB Stack Launch a public load balancer (ELB). See Load Balancer (ELB) Stack \| Create. Create an Auto Scaling Group Stack Launch an Auto scaling group. See Auto Scaling Group \| Create. Create an S3 Store
ams-appguide-078	ams-appguide.pdf	78	information on creating RFCs, see Creating RFCs; for an explanation of common RFC parameters, see RFC common parameters . Create the Infrastructure The following procedures describe creating an RDS database, a load balancer, and an Auto Scaling group in such a manner that you use the resource IDs to build the infrastructure. Create an RDS Stack (CLI) See RDS stack \| Create. Create an ELB Stack Launch a public load balancer (ELB). See Load Balancer (ELB) Stack \| Create. Create an Auto Scaling Group Stack Launch an Auto scaling group. See Auto Scaling Group \| Create. Create an S3 Store Launch an S3 bucket. The S3 bucket is where you upload the application bundle you created. See S3 Storage \| Create. Create a WordPress Application Bundle for CodeDeploy This section provides an example of creating an application deployment bundle. 1. Download WordPress, extract the ﬁles and create a ./scripts directory. Linux command: Creating an RFC using the CLI Version September 13, 2024 235 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options wget https://github.com/WordPress/WordPress/archive/master.zip Windows: Paste https://github.com/WordPress/WordPress/archive/master.zip into a browser window and download the zip ﬁle. Create a temporary directory in which to assemble the package. Linux: mkdir /tmp/WordPress Windows: Create a "WordPress" directory, you will use the directory path later. 2. Extract the WordPress source to the "WordPress" directory and create a ./scripts directory. Linux: unzip master.zip -d /tmp/WordPress_Temp cp -paf /tmp/WordPress_Temp/WordPress-master/* /tmp/WordPress rm -rf /tmp/WordPress_Temp rm -f master cd /tmp/WordPress mkdir scripts Windows: Go to the "WordPress" directory that you created and create a "scripts" directory there. If you are in a Windows environment, be sure to set the break type for the script ﬁles to Unix (LF). In Notepad ++, this is an option at the bottom right of the window. 3. Create the CodeDeploy appspec.yml ﬁle, in the WordPress directory (if copying the example, check the indentation, each space counts). IMPORTANT: Ensure that the "source" path is correct for copying the WordPress ﬁles (in this case, in your WordPress directory) to the expected destination (/var/www/html/WordPress). In the example, the appspec.yml ﬁle is in the directory with the WordPress ﬁles, so only "/" is needed. Also, even if you used a RHEL AMI for your Auto Scaling group, leave the "os: linux" line as-is. Example appspec.yml ﬁle: version: 0.0 os: linux files: Create a WordPress Application Bundle for CodeDeploy Version September 13, 2024 236 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options - source: / destination: /var/www/html/WordPress hooks: BeforeInstall: - location: scripts/install_dependencies.sh timeout: 300 runas: root AfterInstall: - location: scripts/config_wordpress.sh timeout: 300 runas: root ApplicationStart: - location: scripts/start_server.sh timeout: 300 runas: root ApplicationStop: - location: scripts/stop_server.sh timeout: 300 runas: root 4. Create bash ﬁle scripts in the WordPress ./scripts directory. First, create config_wordpress.sh with the following content (if you prefer, you can edit the wp-conﬁg.php ﬁle directly). Note Replace DBName with the value given in the HA Stack RFC (for example, wordpress). Replace DB_MasterUsername with the MasterUsername value given in the HA Stack RFC (for example, admin). Replace DB_MasterUserPassword with the MasterUserPassword value given in the HA Stack RFC (for example, p4ssw0rd). Replace DB_ENDPOINT with the endpoint DNS name in the execution outputs of the HA Stack RFC (for example, srt1cz23n45sfg.clgvd67uvydk.us- east-1.rds.amazonaws.com). You can ﬁnd this with the GetRfc operation (CLI: get- rfc --rfc-id RFC_ID) or in the AMS Console RFC details page for the HA Stack RFC that you previously submitted. #!/bin/bash Create a WordPress Application Bundle for CodeDeploy Version September 13, 2024 237 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options chmod -R 755 /var/www/html/WordPress cp /var/www/html/WordPress/wp-config-sample.php /var/www/html/WordPress/wp- config.php cd /var/www/html/WordPress sed -i "s/database_name_here/DBName/g" wp-config.php sed -i "s/username_here/DB_MasterUsername/g" wp-config.php sed -i "s/password_here/DB_MasterUserPassword/g" wp-config.php sed -i "s/localhost/DB_ENDPOINT/g" wp-config.php 5. In the same directory create install_dependencies.sh with the following content: #!/bin/bash yum install -y php yum install -y php-mysql yum install -y mysql service httpd restart Note HTTPS is installed as part of the user data at launch in order to allow health checks to work from the start. 6. In the same directory create start_server.sh with the following content: • For Amazon Linux instances, use this: #!/bin/bash service httpd start • For RHEL instances, use this (the extra commands are policies that allow SELINUX to accept WordPress): #!/bin/bash setsebool -P httpd_can_network_connect_db 1 setsebool -P httpd_can_network_connect 1 chcon -t httpd_sys_rw_content_t /var/www/html/WordPress/wp-content -R restorecon -Rv /var/www/html service httpd start 7. In the same directory create stop_server.sh with the following content: Create a WordPress Application Bundle for CodeDeploy Version September 13, 2024 238 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options #!/bin/bash service httpd stop 8. Create the zip bundle. Linux: $ cd /tmp/WordPress $ zip -r wordpress.zip . Windows: Go to your "WordPress" directory and select all of the ﬁles and create a zip ﬁle, be sure to name it wordpress.zip.
ams-appguide-079	ams-appguide.pdf	79	that allow SELINUX to accept WordPress): #!/bin/bash setsebool -P httpd_can_network_connect_db 1 setsebool -P httpd_can_network_connect 1 chcon -t httpd_sys_rw_content_t /var/www/html/WordPress/wp-content -R restorecon -Rv /var/www/html service httpd start 7. In the same directory create stop_server.sh with the following content: Create a WordPress Application Bundle for CodeDeploy Version September 13, 2024 238 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options #!/bin/bash service httpd stop 8. Create the zip bundle. Linux: $ cd /tmp/WordPress $ zip -r wordpress.zip . Windows: Go to your "WordPress" directory and select all of the ﬁles and create a zip ﬁle, be sure to name it wordpress.zip. Deploy the WordPress Application Bundle with CodeDeploy The CodeDeploy is an AWS deployment service that automates application deployments to Amazon EC2 instances. This part of the process involves creating a CodeDeploy application, creating a CodeDeploy deployment group, and then deploying the application using CodeDeploy. Create a CodeDeploy Application The CodeDeploy application is simply a name or container used by AWS CodeDeploy to ensure that the correct revision, deployment conﬁguration, and deployment group are referenced during a deployment. The deployment conﬁguration, in this case, is the WordPress bundle that you previously created. REQUIRED DATA: • VpcId: The VPC that you are using, this should be the same as the previously used VPC. • CodeDeployApplicationName: Must be unique in the account. Look at the CodeDeploy Console to check for existing application names. • ChangeTypeId and ChangeTypeVersion: The change type ID for this walkthrough is ct-0ah3gwb9seqk2, to ﬁnd out the latest version, run this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=ct-0ah3gwb9seqk2 Deploy the WordPress Application Bundle with CodeDeploy Version September 13, 2024 239 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 1. Output the execution parameters JSON schema for the CodeDeploy application CT to a ﬁle in your current folder; example names it CreateCDAppParams.json. aws amscm get-change-type-version --change-type-id "ct-0ah3gwb9seqk2" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateCDAppParams.json 2. Modify and save the JSON ﬁle as follows; you can delete and replace the contents. { "Description": "Create WordPress CodeDeploy App", "VpcId": "VPC_ID", "StackTemplateId": "stm-sft6rv00000000000", "Name": "WordPressCDApp", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "WordPressCDApp" } } 3. Output the JSON template for CreateRfc to a ﬁle in your current folder; example names it CreateCDAppRfc.json. aws amscm create-rfc --generate-cli-skeleton > CreateCDAppRfc.json 4. Modify and save the JSON ﬁle as follows; you can delete and replace the contents. Note that RequestedStartTime and RequestedEndTime are now optional; excluding them causes the RFC to be executed as soon as it is approved (which usually happens automatically). Tosubmit a "scheduled" RFC, add those values. { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0ah3gwb9seqk2", "Title": "CD-App-For-WP-Stack-RFC" } 5. Create the RFC, specifying the CreateCDAppRfc ﬁle and the execution parameters ﬁle: aws amscm create-rfc --cli-input-json file://CreateCDAppRfc.json --execution- parameters file://CreateCDAppParams.json You receive the RFC ID of the new RFC in the response. Save the ID for subsequent steps. Deploy the WordPress Application Bundle with CodeDeploy Version September 13, 2024 240 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 6. Submit the RFC: aws amscm submit-rfc --rfc-id RFC_ID If the RFC succeeds, you receive no output. 7. Submit the RFC: aws amscm get-rfc --rfc-id RFC_ID Create a CodeDeploy Deployment Group Create the CodeDeploy deployment group. A CodeDeploy deployment group deﬁnes a set of individual instances targeted for a deployment. REQUIRED DATA: • VpcId: The VPC that you are using, this should be the same as the previously used VPC. • CodeDeployApplicationName: Use the value you previously created. • CodeDeployAutoScalingGroups: Use the name of the Auto Scaling group that you created previously. • CodeDeployDeploymentGroupName: A name for the deployment group. This name must be unique for each application associated with the deployment group. • CodeDeployServiceRoleArn: Use the formula given in the example. • ChangeTypeId and ChangeTypeVersion: The change type ID for this walkthrough is ct-2gd0u847qd9d2, to ﬁnd out the latest version, run this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=ct-2gd0u847qd9d2 1. Output the execution parameters JSON schema to a ﬁle in your current folder; example names it CreateCDDepGroupParams.json. aws amscm get-change-type-version --change-type-id "ct-2gd0u847qd9d2" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateCDDepGroupParams.json Deploy the WordPress Application Bundle with CodeDeploy Version September 13, 2024 241 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. Modify and save the JSON ﬁle as follows; you can delete and replace the contents. { "Description": "CreateWPCDDeploymentGroup", "VpcId": "VPC_ID", "StackTemplateId": "stm-sp9lrk00000000000", "Name": "WordPressCDAppGroup", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "WordPressCDApp", "CodeDeployAutoScalingGroups": ["ASG_NAME"], "CodeDeployDeploymentConfigName": "CodeDeployDefault.HalfAtATime", "CodeDeployDeploymentGroupName": "UNIQUE_CDDepGroupNAME", "CodeDeployServiceRoleArn": "arn:aws:iam::ACCOUNT_ID:role/aws- codedeploy-role" } } 3. Output the JSON template for CreateRfc to a ﬁle in your current folder; example names it CreateCDDepGroupRfc.json. aws amscm create-rfc --generate-cli-skeleton > CreateCDDepGroupRfc.json 4. Modify and save the JSON ﬁle as follows; you can delete and replace the contents. Note that RequestedStartTime and RequestedEndTime are now optional; excluding them causes the RFC to be executed as soon as it is approved (which usually happens automatically). To
ams-appguide-080	ams-appguide.pdf	80	you can delete and replace the contents. { "Description": "CreateWPCDDeploymentGroup", "VpcId": "VPC_ID", "StackTemplateId": "stm-sp9lrk00000000000", "Name": "WordPressCDAppGroup", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "WordPressCDApp", "CodeDeployAutoScalingGroups": ["ASG_NAME"], "CodeDeployDeploymentConfigName": "CodeDeployDefault.HalfAtATime", "CodeDeployDeploymentGroupName": "UNIQUE_CDDepGroupNAME", "CodeDeployServiceRoleArn": "arn:aws:iam::ACCOUNT_ID:role/aws- codedeploy-role" } } 3. Output the JSON template for CreateRfc to a ﬁle in your current folder; example names it CreateCDDepGroupRfc.json. aws amscm create-rfc --generate-cli-skeleton > CreateCDDepGroupRfc.json 4. Modify and save the JSON ﬁle as follows; you can delete and replace the contents. Note that RequestedStartTime and RequestedEndTime are now optional; excluding them causes the RFC to be executed as soon as it is approved (which usually happens automatically). To submit a "scheduled" RFC, add those values. { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2gd0u847qd9d2", "Title": "CD-Dep-Group-For-WP-Stack-RFC" } 5. Create the RFC, specifying the CreateCDDepGroupRfc ﬁle and the execution parameters ﬁle: aws amscm create-rfc --cli-input-json file://CreateCDDepGroupRfc.json --execution- parameters file://CreateCDDepGroupParams.json You receive the RFC ID of the new RFC in the response. Save the ID for subsequent steps. 6. Submit the RFC: Deploy the WordPress Application Bundle with CodeDeploy Version September 13, 2024 242 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm submit-rfc --rfc-id RFC_ID If the RFC succeeds, you receive no output. 7. Check the RFC status: aws amscm get-rfc --rfc-id RFC_ID Upload the WordPress Application You automatically have access to any S3 bucket instance that you create. You can access it through your Bastions (see Accessing Instances), or through the S3 console, and upload the CodeDeploy bundle. The bundle needs to be in place in order to continue deploying the stack. The example uses the bucket name previously created. aws s3 cp wordpress/wordpress.zip s3://ACCOUNT_ID-codedeploy-bundles/ Deploy the WordPress Application with CodeDeploy Deploy the CodeDeploy application. Once you have your CodeDeploy application bundle and deployment group, use this RFC to deploy the application. REQUIRED DATA: • VPC-ID: The VPC you are using, this should be the same as the previously used VPC. • CodeDeployApplicationName: Use the name for the CodeDeploy application that you previously created. • CodeDeployDeploymentGroupName: Use the name of the CodeDeploy deployment group that you created previously. • S3Location (where you uploaded the application bundle): S3Bucket: The BucketName that you previously created, S3BundleType and S3Key: The type of, and name of, the bundle that you put on your S3 store. • ChangeTypeId and ChangeTypeVersion: The change type ID for this walkthrough is ct-2edc3sd1sqmrb, to ﬁnd out the latest version, run this command: Deploy the WordPress Application Bundle with CodeDeploy Version September 13, 2024 243 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=ct-2edc3sd1sqmrb 1. Output the execution parameters JSON schema for the CodeDeploy application deployment CT to a ﬁle in your current folder; example names it DeployCDAppParams.json. aws amscm get-change-type-version --change-type-id "ct-2edc3sd1sqmrb" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeployCDAppParams.json 2. Modify the JSON ﬁle as follows; you can delete and replace the contents. For S3Bucket, use the BucketName that you previously created. { "Description": "Deploy WordPress CodeDeploy Application", "VpcId": "VPC_ID", "Name": "WP CodeDeploy Deployment Group", "TimeoutInMinutes": 60, "Parameters": { "CodeDeployApplicationName": "WordPressCDApp", "CodeDeployDeploymentGroupName": "WordPressCDDepGroup", "CodeDeployIgnoreApplicationStopFailures": false, "CodeDeployRevision": { "RevisionType": "S3", "S3Location": { "S3Bucket": "ACCOUNT_ID.BUCKET_NAME", "S3BundleType": "zip", "S3Key": "wordpress.zip" } } } } 3. Output the JSON template for CreateRfc to a ﬁle in your current folder; example names it DeployCDAppRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeployCDAppRfc.json 4. Modify and save the DeployCDAppRfc.json ﬁle; you can delete and replace the contents. { "ChangeTypeVersion": "1.0", Deploy the WordPress Application Bundle with CodeDeploy Version September 13, 2024 244 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options "ChangeTypeId": "ct-2edc3sd1sqmrb", "Title": "CD-Deploy-For-WP-Stack-RFC", "RequestedStartTime": "2017-04-28T22:45:00Z", "RequestedEndTime": "2017-04-28T22:45:00Z" } 5. Create the RFC, specifying the execution parameters ﬁle and the DeployCDAppRfc ﬁle: aws amscm create-rfc --cli-input-json file://DeployCDAppRfc.json --execution- parameters file://DeployCDAppParams.json You receive the RfcId of the new RFC in the response. Save the ID for subsequent steps. 6. Submit the RFC: aws amscm submit-rfc --rfc-id RFC_ID If the RFC succeeds, you receive no output. Validate the Application Deployment Navigate to the endpoint (ELB CName) of the previously created load balancer, with the WordPress deployed path: /WordPress. For example: http://stack-ID-FOR-ELB.us-east-1.elb.amazonaws.com/WordPress Tear Down the Application Deployment To tear down the deployment, you submit the Delete Stack CT against the RDS database stack, the application load balancer, the Auto Scaling group, the S3 bucket, and the Code Deploy application and group--six RFCs in all. Additionally, you can submit a service request for the RDS snapshots to be deleted (they are deleted automatically after ten days, but they do cost a small amount while there). Gather the stack IDs for all and then follow these steps. This walkthrough provides an example of using the AMS console to delete an S3 stack; this procedure applies to deleting any stack using the AMS console. Validate the Application Deployment Version September 13, 2024 245 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note If
ams-appguide-081	ams-appguide.pdf	81	S3 bucket, and the Code Deploy application and group--six RFCs in all. Additionally, you can submit a service request for the RDS snapshots to be deleted (they are deleted automatically after ten days, but they do cost a small amount while there). Gather the stack IDs for all and then follow these steps. This walkthrough provides an example of using the AMS console to delete an S3 stack; this procedure applies to deleting any stack using the AMS console. Validate the Application Deployment Version September 13, 2024 245 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note If deleting an S3 bucket, it must be emptied of objects ﬁrst. REQUIRED DATA: • StackId: The stack to use. You can ﬁnd this by looking at the AMS Console Stacks page, available through a link in the left nav. Using the AMS SKMS API/CLI, run the For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. operation (list-stack- summaries in the CLI). • The change type ID for this walkthrough is ct-0q0bic0ywqk6c, the version is "1.0", to ﬁnd out the latest version, run this command: aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=ct-0q0bic0ywqk6c INLINE CREATE: • Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline). E aws amscm create-rfc --change-type-id "ct-0q0bic0ywqk6c" --change-type-version "1.0" --title "Delete My Stack" --execution-parameters "{\"StackId\":\"STACK_ID\"}" • Submit the RFC using the RFC ID returned in the create RFC operation. Until submitted, the RFC remains in the Editing state and is not acted on. aws amscm submit-rfc --rfc-id RFC_ID • Monitor the RFC status and view execution output: aws amscm get-rfc --rfc-id RFC_ID TEMPLATE CREATE: Tear Down the Application Deployment Version September 13, 2024 246 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 1. Output the RFC template to a ﬁle in your current folder; example names it DeleteStackRfc.json: aws amscm create-rfc --generate-cli-skeleton > DeleteStackRfc.json 2. Modify and save the DeleteStackRfc.json ﬁle. Since deleting a stack has only one execution parameter, the execution parameters can be in the DeleteStackRfc.json ﬁle itself (there is no need to create a separate JSON ﬁle with execution parameters). The internal quotation marks in the ExecutionParameters JSON extension must be escaped with a backslash (\). Example without start and end time: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0q0bic0ywqk6c", "Title": "Delete-My-Stack-RFC" "ExecutionParameters": "{ \"StackId\":\"STACK_ID\"}" } 3. Create the RFC: aws amscm create-rfc --cli-input-json file://DeleteStackRfc.json You receive the RfcId of the new RFC in the response. For example: { "RfcId": "daaa1867-ffc5-1473-192a-842f6b326102" } Save the ID for subsequent steps. 4. Submit the RFC: aws amscm submit-rfc --rfc-id RFC_ID If the RFC succeeds, you receive no conﬁrmation at the command line. 5. To monitor the status of the request and to view Execution Output: Tear Down the Application Deployment Version September 13, 2024 247 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options aws amscm get-rfc --rfc-id RFC_ID --query "Rfc. {Status:Status.Name,Exec:ExecutionOutput}" --output table Tear Down the Application Deployment Version September 13, 2024 248 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Application maintenance Once infrastructure is deployed, updating it in a consistent way across all your AMS environments, from QA to staging to production, is the challenge. This section provides an overview of the AMS workload ingestion process and some examples of diﬀerent methods you can use to keep your cloud infrastructure layer up to date. Application maintenance strategies How you deploy your applications impacts how you maintain them. This section provides some strategies for application maintenance. Environment updates can involve any of these changes: • Security updates • New versions of your applications • Application conﬁguration changes • Updates to dependencies Note For any application deployment, no matter the method, always ﬁle a service request beforehand to let AMS know that you are going to deploy an application. Immutable vs Mutable Application Installation Examples Compute Instance Mutability App Install Method Mutable With CodeDeploy AMI AMS-provi ded Manually With a Chef or Puppet, Pull-Based With Ansible or Salt, Push-Based Application maintenance strategies Version September 13, 2024 249 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Compute Instance Mutability App Install Method Immutable With a Golden AMI AMI Custom (based on AMS-provi ded) Mutable deployment with a CodeDeploy-enabled AMI AWS CodeDeploy is a service that automates code deployments to any instance, including Amazon EC2 instances and instances running on-premises. You can use CodeDeploy with AMS to create and deploy a CodeDeploy application. Note that AMS provides a default instance proﬁle for CodeDeploy applications. • Amazon Linux (version 1) • Amazon Linux 2 • RedHat 7 • CentOS 7 Before you use CodeDeploy for the ﬁrst time, you must complete a number of setup steps: 1. Install or upgrade the AWS CLI 2. Create a Service Role for AWS CodeDeploy, you use the
ams-appguide-082	ams-appguide.pdf	82	ded) Mutable deployment with a CodeDeploy-enabled AMI AWS CodeDeploy is a service that automates code deployments to any instance, including Amazon EC2 instances and instances running on-premises. You can use CodeDeploy with AMS to create and deploy a CodeDeploy application. Note that AMS provides a default instance proﬁle for CodeDeploy applications. • Amazon Linux (version 1) • Amazon Linux 2 • RedHat 7 • CentOS 7 Before you use CodeDeploy for the ﬁrst time, you must complete a number of setup steps: 1. Install or upgrade the AWS CLI 2. Create a Service Role for AWS CodeDeploy, you use the Service Role ARN in the deployment IDs for all CT options can be found in the Change Type Reference. Note Currently, you must use Amazon S3 storage with this solution. The basic steps are outlined here and the procedure is detailed in the AMS User Guide. 1. Create an Amazon S3 storage bucket. CT: ct-1a68ck03fn98r. The S3 bucket must have versioning enabled (for information on doing this, see Enabling Bucket Versioning). Mutable deployment with a CodeDeploy-enabled AMI Version September 13, 2024 250 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 2. Put your bundled CodeDeploy artifacts on it. You can do this with the Amazon S3 console without requesting access through AMS. Or using a variation of this command: aws s3 cp ZIP_FILEPATH_AND_NAME s3://S3BUCKET_NAME/ 3. Find an AMS customer- AMI; use either: • AMS Console: The VPC details page for the relevant VPC • AMS API For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. or CLI: aws amsskms list-amis 4. Create an Autoscaling group (ASG). CT: ct-2tylseo8rxfsc. Specify the AMS AMI, set the load balancer to have open ports, specify customer-mc-ec2-instance-profile for the ASGIAMInstanceProfile. 5. Create your CodeDeploy application. CT: ct-0ah3gwb9seqk2. Parameters include an application name; for example WordpressProd. 6. Create your CodeDeploy deployment group. CT: ct-2gd0u847qd9d2. Parameters include your CodeDeploy application name, ASG name, the conﬁguration type name, and the service role ARN. 7. Deploy the CodeDeploy application. CT: ct-2edc3sd1sqmrb. Parameters include your CodeDeploy application name, conﬁguration type name, deployment group name, revision type, and the S3 bucket location where the CodeDeploy artifacts are. Mutable deployment, manually conﬁgured and updated application instances This application deployment strategy is a simple and manual update of application instances. These are the basic steps. IDs for all CT options can be found in the Change Type Reference. Note Currently, you must use Amazon S3 storage with this solution. The basic steps are outlined here; the various procedures are detailed in the AMS User Guide. Mutable deployment, manually conﬁgured and updated application instances Version September 13, 2024 251 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options 1. Create an Amazon S3 storage bucket. CT: ct-1a68ck03fn98r. The S3 bucket must have versioning enabled (for information on doing this, see Enabling Bucket Versioning). 2. Put your bundled application artifacts on it (everything your application needs to start on boot and work). You can do this with the Amazon S3 console without requesting access through AMS. Or using a variation of this command: aws s3 cp ZIP_FILEPATH_AND_NAME s3://S3BUCKET_NAME/ 3. Find an AMS AMI, all will have CodeDeploy on them. To ﬁnd a "customer-" AMI use either: • AMS Console: The VPC details page for the relevant VPC • AMS API For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. or CLI: aws amsskms list-amis 4. Create an EC2 instance with that AMI. CT: ct-14027q0sjyt1h. Specify the AMS AMI, set a tag Key=backup, Value=true and specify the customer-mc-ec2-instance-profile for the InstanceProfile parameter. Note the instance ID that is returned. 5. Request admin access to the instance. CT: ct-1dmlg9g1l91h6. You'll need the FQDN for your account. If you’re unsure what your FQDN is, you can ﬁnd it by: • Using the AWS Management Console for Directory Services (under Security and Identity) Directory Name tab. • Running one of these commands (return directory classes; DC+DC+DC=FQDN): Windows: whoami /fqdn or Linux: hostname --fqdn. 6. Log into the instance, see Accessing Instances via Bastions in the AMS User Guide. 7. Download your bundled application ﬁles from your S3 bucket to the instance. 8. Request an immediate backup with a service request to AMS, you will need to know the instance ID. 9. When you need to update your application, load new ﬁles to your S3 bucket and then follow steps 3 through 8. Mutable deployment, manually conﬁgured and updated application instances Version September 13, 2024 252 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Mutable deployment with a pull-based deployment tool- conﬁgured AMI This strategy relies on the InstanceUserData parameter in the Managed Services Create EC2 CT. For more information on using this parameter, see Conﬁguring Instances with User Data. This example assumes
ams-appguide-083	ams-appguide.pdf	83	immediate backup with a service request to AMS, you will need to know the instance ID. 9. When you need to update your application, load new ﬁles to your S3 bucket and then follow steps 3 through 8. Mutable deployment, manually conﬁgured and updated application instances Version September 13, 2024 252 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Mutable deployment with a pull-based deployment tool- conﬁgured AMI This strategy relies on the InstanceUserData parameter in the Managed Services Create EC2 CT. For more information on using this parameter, see Conﬁguring Instances with User Data. This example assumes a pull-based application deployment tool like Chef or Puppet. The CodeDeploy agent is supported on all AMS AMIs. Here is the list of supported AMIs: • Amazon Linux (version 1) • Amazon Linux 2 • RedHat 7 • CentOS 7 IDs for all CT options can be found in the Change Types Reference. Note Currently, you must use Amazon S3 storage with this solution. The basic steps are outlined here and the procedure is detailed in the AMS User Guide. 1. Create an Amazon S3 storage bucket. CT: ct-1a68ck03fn98r. The S3 bucket must have versioning enabled (for information on doing this, see Enabling Bucket Versioning). 2. Put your bundled CodeDeploy artifacts on it. You can do this with the Amazon S3 console without requesting access through AMS. Or using a variation of this command: aws s3 cp ZIP_FILEPATH_AND_NAME s3://S3BUCKET_NAME/ 3. Find an AMS customer- AMI; use either: • AMS Console: The VPC details page for the relevant VPC • AMS API For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. or CLI: aws amsskms list-amis 4. Create an EC2 instance. CT: ct-14027q0sjyt1h; set a tag Key=backup, Value=true, and use the InstanceUserData parameter to specify a bootstrap and other scripts (download Chef/ Mutable deployment with a pull-based deployment tool-conﬁgured AMI Version September 13, 2024 253 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Puppet agent, etc.), and include the necessary authorization keys. You can ﬁnd an example of doing this in the AMS User Guide, Change Mangement section examples of creating an HA Two Tier Deployment. Alternatively, request access to, and log into, the instance and conﬁgure it with the necessary deployment artifacts. Remember that pull-based deployment commands go from the agents on your instances to your corporate master server and may need authorization to go through bastions. You may need a service request to AMS to request security group/AD group access without bastions. 5. Repeat step 4 to create another EC2 instance and conﬁgure it with the deployment tool master server. 6. When you need to update your application, use the deployment tool to rollout the updates to your instances. Mutable deployment with a push-based deployment tool- conﬁgured AMI This strategy relies on the InstanceUserData parameter in the Managed Services Create EC2 CT. For more information on using this parameter, see Conﬁguring Instances with User Data. This example assumes a pull-based application deployment tool like Chef or Puppet. IDs for all CT options can be found in the Change Type Reference. Note Currently, you must use Amazon S3 storage with this solution. The basic steps are outlined here and the procedure is detailed in the AMS User Guide. 1. Create an Amazon S3 storage bucket. CT: ct-1a68ck03fn98r. The S3 bucket must have versioning enabled (for information on doing this, see Enabling Bucket Versioning). 2. Put your bundled CodeDeploy artifacts on it. You can do this with the Amazon S3 console without requesting access through AMS. Or using a variation of this command: aws s3 cp ZIP_FILEPATH_AND_NAME s3://S3BUCKET_NAME/ 3. Find an AMS AMI, all will have CodeDeploy on them. To ﬁnd a "customer-" AMI use either: Mutable deployment with a push-based deployment tool-conﬁgured AMI Version September 13, 2024 254 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AMS Console: The VPC details page for the relevant VPC • AMS API For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. or CLI: aws amsskms list-amis 4. Create an EC2 instance. CT: ct-14027q0sjyt1h; set a tag Key=backup, Value=true, and use the InstanceUserData parameter to run a bootstrap and other scripts including authorization keys, SALT stack (bootstrap a minion—for more information see Bootstrapping Salt on Linux EC2 with Cloud-Init) or Ansible (install a key pair—for more information see Getting Started with Ansible and Dynamic Amazon EC2 Inventory Management). Alternately, request access to, and log in to, the instance and conﬁgure it with the necessary deployment artifacts. Remember that push-based commands come from your corporate subnet to your instances and you may need to conﬁgure authorization for them to go thru bastions. You may need a service request to AMS to request security group/AD group access without bastions.
ams-appguide-084	ams-appguide.pdf	84	bootstrap and other scripts including authorization keys, SALT stack (bootstrap a minion—for more information see Bootstrapping Salt on Linux EC2 with Cloud-Init) or Ansible (install a key pair—for more information see Getting Started with Ansible and Dynamic Amazon EC2 Inventory Management). Alternately, request access to, and log in to, the instance and conﬁgure it with the necessary deployment artifacts. Remember that push-based commands come from your corporate subnet to your instances and you may need to conﬁgure authorization for them to go thru bastions. You may need a service request to AMS to request security group/AD group access without bastions. 5. Repeat step 4 to create another EC2 instance and conﬁgure it with the deployment tool master server. 6. When you need to update your application, use the deployment tool to rollout the updates to your instances. Immutable deployment with a golden AMI This strategy employs a "golden" AMI that you have conﬁgured to behave as you want all of your application instances to. For example, the instances created with this golden AMI would self- join the correct domain and DNS, self-conﬁgure, reboot and launch all necessary systems. When you want to update your application instances, you re-create the golden AMI and rollout all-new application instances with it. The CodeDeploy agent is supported on all AMS AMIs. Here is the list of supported AMIs: • Amazon Linux (version 1) • Amazon Linux 2 • RedHat 7 • CentOS 7 IDs for all CT options can be found in the Change Type Reference. Immutable deployment with a golden AMI Version September 13, 2024 255 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Note Currently, you must use Amazon S3 storage with this solution. 1. Create an Amazon S3 storage bucket. CT: ct-1a68ck03fn98r. The S3 bucket must have versioning enabled (for information on doing this, see Enabling Bucket Versioning). 2. Put your bundled application artifacts on it (everything your application needs to start on boot and work). You can do this with the Amazon S3 console without requesting access through AMS. Or using a variation of this command: aws s3 cp ZIP_FILEPATH_AND_NAME s3://S3BUCKET_NAME/ 3. Find an AMS customer- AMI; use either: • AMS Console: The VPC details page for the relevant VPC • AMS API For the AMS SKMS API reference, see the Reports tab in the AWS Artifact Console. or CLI: aws amsskms list-amis 4. Create an EC2 instance with that AMI. CT: ct-14027q0sjyt1h. Specify the AMS AMI, set a tag Key=backup, Value=true and specify customer-mc-ec2-instance-profile for the InstanceProfile. Note the instance ID that is returned. 5. Request admin access to the instance. CT: ct-1dmlg9g1l91h6. You'll need the FQDN for your account. If you’re unsure what your FQDN is, you can ﬁnd it by: • Using the AWS Management Console for Directory Services (under Security and Identity) Directory Name tab. • Running one of these commands (return directory classes; DC+DC+DC=FQDN): Windows: whoami /fqdn or Linux: hostname --fqdn. 6. Log into the instance, see Accessing Instances in the AMS User Guide. 7. Download to the instance your bundled application ﬁles from your S3 bucket. Conﬁgure the instance so that it self-deploys the fully-functioning application on boot. 8. Create the golden AMI on the instance. CT: ct-3rqqu43krekby. For details, see AMI \| Create. 9. Conﬁgure an Auto Scaling group to create new instances using that AMI. CT: ct-2tylseo8rxfsc. When you need to update your application, follow this procedure and request AMS to update the ASG to use the new golden AMI; use a Management \| Other \| Other \| Update CT for this. Immutable deployment with a golden AMI Version September 13, 2024 256 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Update Strategies There are a few diﬀerent strategies you can employ to update your applications or instances in your AMS-managed environment. • Scheduled Downtime: This simple strategy involves scheduling time for your application to be oﬄine and manually updated. To do this, submit a Management \| Other \| Other \| Update CT (ct-0xdawir96cy7k) request to stop the required instances. Make the necessary updates, and then submit another Management \| Other \| Other \| Update CT (ct-0xdawir96cy7k) request to start the instances. • Blue/Green: This strategy requires that you have a redundant environment (two completely functional environments) and take one environment oﬄine using domain name system (DNS) or web ﬁrewall (WAF) updates to redirect traﬃc. Update one environment and then redirect again to update the other environment. To learn more, see AWS CodeDeploy Introduces Blue/Green Deployments. • Rolling Update with new AMI: This is where you have a new AMI that you customize (see Create AMI) and then request that AMS deploy it to your Auto Scaling group. Use a Management \| Other \| Other \| Update CT (ct-0xdawir96cy7k) to do this. AWS Managed Services Resource Scheduler Use
ams-appguide-085	ams-appguide.pdf	85	you have a redundant environment (two completely functional environments) and take one environment oﬄine using domain name system (DNS) or web ﬁrewall (WAF) updates to redirect traﬃc. Update one environment and then redirect again to update the other environment. To learn more, see AWS CodeDeploy Introduces Blue/Green Deployments. • Rolling Update with new AMI: This is where you have a new AMI that you customize (see Create AMI) and then request that AMS deploy it to your Auto Scaling group. Use a Management \| Other \| Other \| Update CT (ct-0xdawir96cy7k) to do this. AWS Managed Services Resource Scheduler Use AWS Managed Services (AMS) Resource Scheduler to schedule the automatic start and stop of AutoScaling groups, Amazon EC2 instances, and RDS instances in your account. This helps reduce infrastructure costs where the resources are not meant to be running 24/7. The solution is built on top of Instance Scheduler on AWS, but contains additional features and customizations speciﬁc to AMS needs. Note By default, AMS Resource Scheduler doesn't interact with resources that aren't part of an AWS CloudFormation stack. The resource must be part of a stack that starts with "stack-" , "sc-" or "SC-". To schedule the resources that are not part of a CloudFormation stack, you can update the Resource Scheduler stack parameter ScheduleNonStackResources to Yes. Update Strategies Version September 13, 2024 257 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options AMS Resource Scheduler uses periods and schedules: • Periods deﬁne the times when Resource Scheduler runs, such as start time, end time, and days of the month. • Schedules contain your deﬁned periods, along with additional conﬁgurations, such as SSM maintenance window, timezone, hibernate setting, and so forth; and specify when resources should run, given the conﬁgured period rules. You can conﬁgure these periods and schedules using AMS Resource Scheduler's automated change types (CTs). For full details on the settings available for AMS Resource Scheduler, see the corresponding AWS Instance Scheduler documentation at Solution components. For an architectural view of the solution, see the corresponding AWS Instance Scheduler documentation at Architecture overview.html. Deploying AMS Resource Scheduler To deploy AMS Resource Scheduler, use the automated change type (CT) : Deployment \| AMS Resource Scheduler \| Solution \| Deploy (ct-0ywnhc8e5k9z5) to raise an RFC that then deploys the solution in your account. Once the RFC is executed, a CloudFormation stack containing AMS Resource Scheduler resources with default conﬁguration, is automatically provisioned into your account. For more on Resource Scheduler change types, see AMS Resource Scheduler. Note To ﬁnd out if AMS Resource Scheduler is already deployed in your account, check the AWS Lambda console for that account and look for the AMSResourceScheduler function. After the AMS Resource Scheduler is provisioned in your account, we recommend you review the default conﬁguration and, if required, customize conﬁgurations such as tag key, timezone, scheduled services, and so forth, based on your preferences. For details on the recommended customizations, see Customizing AMS Resource Scheduler, next. To make the custom conﬁgurations, or just conﬁrm the Resource Scheduler conﬁguration, Deploying Resource Scheduler Version September 13, 2024 258 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Customizing AMS Resource Scheduler We recommend you customize the following properties of AMS Resource Scheduler using the update AMS Resource Scheduler change types, see AMS Resource Scheduler. • Tag name: The name of the tag that Resource Scheduler will use to associate instance schedules with resources. The default value is Schedule. • Scheduled Services: A comma-separated list of services that Resource Scheduler can manage. The default value is "ec2,rds,autoscaling". Valid values are "ec2", "rds" and "autoscaling" • Default timezone: Specify the default time zone for the Resource Scheduler to use. The default value is UTC. • Use CMK: A comma-separated list of Amazon KMS Customer Managed Key (CMK) ARNs that Resource Scheduler can be granted permissions to. • Use LicenseManager: A comma-separated list of AWS Licence Manager ARNs to that Resource Scheduler can be granted permissions to. Note AMS may, time to time, release features and ﬁxes to keep AMS Resource Scheduler up to date in your account. When this happens, any customization that you make to the AMS Resource Scheduler are preserved. Using AMS Resource Scheduler To conﬁgure AMS Resource Scheduler after the solution is deployed, use the automated Resource Scheduler CTs to create, delete, update, and describe (get details on) AMS Resource Scheduler periods (the times when Resource Scheduler runs) and schedules (the conﬁgured periods and other options). For an example of using the AMS Resource Scheduler change types, see AMS Resource Scheduler. To select resources to be managed by AMS Resource Scheduler, following deployment and schedule creation, you use the AMS Tag Create CTs to tag Auto Scaling groups, Amazon RDS stacks, and Amazon EC2 resources with that tag key you provided during
ams-appguide-086	ams-appguide.pdf	86	Scheduler To conﬁgure AMS Resource Scheduler after the solution is deployed, use the automated Resource Scheduler CTs to create, delete, update, and describe (get details on) AMS Resource Scheduler periods (the times when Resource Scheduler runs) and schedules (the conﬁgured periods and other options). For an example of using the AMS Resource Scheduler change types, see AMS Resource Scheduler. To select resources to be managed by AMS Resource Scheduler, following deployment and schedule creation, you use the AMS Tag Create CTs to tag Auto Scaling groups, Amazon RDS stacks, and Amazon EC2 resources with that tag key you provided during deployment, and the deﬁned schedule as the tag value. After the resources are tagged, the resources are scheduled for start or stop per your deﬁned Resource Scheduler schedule. Customizing Resource Scheduler Version September 13, 2024 259 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options There is no additional cost to using AMS Resource Scheduler. However the solution makes use of several AWS services and you're charged for these resources as they are used. For more details, see Architecture overview. To opt out temporarily or completely of AMS Resource Scheduler, submit a Management \| Other \| Other \| Update RFC requesting to disable or remove the solution from our release automation system. AMS Resource Scheduler cost estimator In order to track cost savings, AMS Resource Scheduler features a component that hourly calculates the estimated cost savings for Amazon EC2 and RDS resources that are managed by scheduler. This cost savings data is then published as a CloudWatch metric (AMS/ResourceScheduler) to help you track it. The cost savings estimator only estimates savings on instance running hours. It does not account any other cost, such as data transfer costs associated with a resource. The cost savings estimator is enabled with Resource Scheduler. It runs hourly and retrieves cost and usage data from AWS Cost Explorer. From that data it calculates the average cost per hour for each instance type and then projects the cost for a full day if it was running without being scheduled. The cost savings is the diﬀerence between the projected cost and the actual reported cost from Cost Explorer for a given day. For example, if instance A is conﬁgured with Resource Scheduler to run from 9 a.m. to 5 p.m., that is eight hours on a given day. Cost Explorer reports the cost as $1 and usage as 8. The average cost per hour is therefore $0.125. If the instance was not scheduled with Resource Scheduler, then the instance would run 24 hours on that day. In that case, the cost would have been 24x0.125 = $3. Resource Scheduler helped you achieve a cost savings of $2. In order for the cost savings estimator to retrieve cost and usage only for resources managed by Resource Scheduler from Cost Explorer, the tag key that Resource Scheduler uses to target resources needs to be activated as the Cost allocation tag in the Billing Dashboard. If the account belongs to an organization, the tag key needs to be activated in the Management account of the organization. For information on doing this, see Activating User-Deﬁned Cost Allocation Tags and User-Deﬁned Cost Allocation Tags After the tag key is activated as Cost Allocation Tag, AWS billing starts tracking cost and usage for resources managed by Resource Scheduler, and after that data is available, the cost savings estimator starts to calculate the cost savings and publish the data under the AMS/ ResourceScheduler metric namespace in CloudWatch. AMS Resource Scheduler cost estimator Version September 13, 2024 260 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Cost estimator tips Cost Savings Estimator does not accept discounts such as reserved instances, savings plans, and so forth, into consideration in its calculation. The Estimator takes usage costs from Cost Explorer and calculates the average cost per hour for the resources. For more details, see Understanding your AWS Cost Datasets: A Cheat Sheet In order for the cost savings estimator to retrieve cost and usage only for resources managed by Resource Scheduler from Cost Explorer, the tag key that Resource Scheduler uses to target resources needs to be activated as the Cost Allocation tag in the Billing Dashboard. If the account belongs to an organization, the tag key needs to be activated in the management account of the organization. For information on doing this, see User-Deﬁned Cost Allocation Tags. If the cost allocation tag is not activated, the estimator is not able to calculate the savings and publish the metric, even if it is enabled. AMS Resource Scheduler best practices Scheduling Amazon EC2 Instances • Instance shut down behavior must be set to stop and not to terminate. This is pre-set to stop for instances that are created with the AMS Amazon EC2 Create automated
ams-appguide-087	ams-appguide.pdf	87	the Billing Dashboard. If the account belongs to an organization, the tag key needs to be activated in the management account of the organization. For information on doing this, see User-Deﬁned Cost Allocation Tags. If the cost allocation tag is not activated, the estimator is not able to calculate the savings and publish the metric, even if it is enabled. AMS Resource Scheduler best practices Scheduling Amazon EC2 Instances • Instance shut down behavior must be set to stop and not to terminate. This is pre-set to stop for instances that are created with the AMS Amazon EC2 Create automated change type (ct-14027q0sjyt1h) and can be set for Amazon EC2 instances created with AWS CloudFormation ingestion, by setting the InstanceInitiatedShutdownBehavior property to stop. If instances have shut down behavior set to terminate, then the instances will end when the Resource Scheduler stops them and the scheduler won't be able to start them back up. • Amazon EC2 instances that are part of an Auto Scaling group aren't processed individually by AMS Resource Scheduler, even if they are tagged. • If the target instance root volume is encrypted with a KMS customer master key (CMK), an additional kms:CreateGrant permission needs to be added to your Resource Scheduler IAM role, for the scheduler to be able to start such instances. This permission is not added to the role by default for improved security. If you require this permission, submit an RFC with the Management \| AMS Resource Scheduler \| Solution \| Update change type, and specify a comma separated list of ARNs of the KMS CMKs. Scheduling Auto Scaling groups AMS Resource Scheduler best practices Version September 13, 2024 261 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • AMS Resource Scheduler starts or stops the auto scaling of Auto Scaling groups, not individual instances in the group. That is, the scheduler restores the size of the Auto Scaling group (start) or sets the size to 0 (stop). • Tag AutoScaling group with the speciﬁed tag and not the instances within the group. • During stop, AMS Resource Scheduler stores the Auto Scaling group's Minimum, Desired, and Maximum capacity values and sets the Minimum and Desired Capacity to 0. During start, the scheduler restores the Auto Scaling group size as it was during the stop. Therefore, Auto Scaling group instances must use an appropriate capacity conﬁguration so that the instances' termination and relaunch don't aﬀect any application running in the Auto Scaling group. • If the Auto Scaling group is modiﬁed (the minimum or maximum capacity) during a running period, the scheduler stores the new Auto Scaling group size and uses it when restoring the group at the end of a stop schedule. Scheduling Amazon RDS instances • The scheduler can take a snapshot before stopping the RDS instances (does not apply to Aurora DB cluster). This feature is turned on by default with the Create RDS Instance Snapshot AWS CloudFormation template parameter set to true. The snapshot is kept until the next time the Amazon RDS instance is stopped and a new snapshot is created. Scheduler can start/stop Amazon RDS instance that are part of a cluster or Amazon RDS Aurora database or in a multi availability zone (Multi-AZ) conﬁguration. However, check Amazon RDS limitation when the scheduler won't be able to stop the Amazon RDS instance, especially Multi- AZ instances. To schedule Aurora Cluster for start or stop use the Schedule Aurora Clusters template parameter (default is true). The Aurora cluster (not the individual instances within the cluster) must be tagged with the tag key deﬁned during initial conﬁguration and the schedule name as the tag value to schedule that cluster. Every Amazon RDS instance has a weekly maintenance window during which any system changes are applied. During the maintenance window, Amazon RDS will automatically start instances that have been stopped for more than seven days to apply maintenance. Note that Amazon RDS will not stop the instance once the maintenance event is complete. The scheduler allows specifying whether to add the preferred maintenance window of an Amazon RDS instance as a running period to its schedule. The solution will start the instance at the beginning of the maintenance window and stop the instance at the end of the maintenance AMS Resource Scheduler best practices Version September 13, 2024 262 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options window if no other running period speciﬁes that the instance should run, and if the maintenance event is completed. If the maintenance event is not completed by the end of the maintenance window, the instance will run until the scheduling interval after the maintenance event is completed. Note The Scheduler doesn't validate that a resource is started or stopped. It makes the API call and moves on. If
ams-appguide-088	ams-appguide.pdf	88	maintenance window and stop the instance at the end of the maintenance AMS Resource Scheduler best practices Version September 13, 2024 262 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options window if no other running period speciﬁes that the instance should run, and if the maintenance event is completed. If the maintenance event is not completed by the end of the maintenance window, the instance will run until the scheduling interval after the maintenance event is completed. Note The Scheduler doesn't validate that a resource is started or stopped. It makes the API call and moves on. If the API call fails, it logs the error for investigation. AMS Resource Scheduler best practices Version September 13, 2024 263 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Application security considerations Application security includes considering what permissions the application will need to run, what ﬁrewall rules, what IAM roles should be enabled for access to the application. To better understand general AWS security, see Best Practices for Security, Identity, & Compliance. Access for conﬁguration management AWS Managed Services (AMS) seeks to provide you with a headache-free infrastructure so you don’t have to worry about security issues, patching issues, backup issues, etc. To do that, AMS recommends minimal IAM roles allowing only a speciﬁc group or a master server, if using an application deployment tool, access to the instances running your application. Application access ﬁrewall rules Just like the operating system (OS), all application access should be governed using Active Directory (AD) groups. Using Amazon Relational Database Service (Amazon RDS) as an example, you must break the mirror (replication) to add a new user. The best approach is to create a group in AD and add it at database creation time. Having the groups in your AMS AD means that you can create CTs for application access. For information on the oﬃcial grouping strategy for AD, see Using Group Nesting Strategy – AD Best Practices for Group Strategy. To learn more about domain trees and parent/child domains, see How Domains and Forests Work. The following rules illustrate a solution appropriate for a multi-domain forest trust with users located in child domains. Windows Instances These are the rules to conﬁgure for your Windows parent and child domain controllers. Parent Domain Controller, Windows FROM: Parent domain controllers TO: Windows stack and shared services subnets Source Port Destination Port Protocol 88 49152 - 65535 TCP Access for conﬁguration management Version September 13, 2024 264 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Source Port Destination Port Protocol 389 49152 - 65535 UDP FROM: Stack subnets, including shared services TO: Windows forest root domain controllers Source Port Destination Port Protocol 49152 - 65535 49152 - 65535 88 389 TCP UDP Child Domain Controller, Windows FROM: Child domain controllers TO: Windows AWS domain controllers Source Port Destination Port Protocol 49152 - 65535 49152 - 65535 49152 - 65535 53 88 389 TCP TCP UDP FROM: Child domain controllers TO: Windows stack and shared services subnets Source Port Destination Port Protocol 88 135 389 389 445 49152 - 65535 49152 - 65535 49152 - 65535 49152 - 65535 49152 - 65535 TCP TCP TCP UDP TCP Child Domain Controller, Windows Version September 13, 2024 265 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Source Port Destination Port Protocol 49152 - 65535 49152 - 65535 TCP FROM: Stack subnets, including shared services TO: Windows child domain controllers Source Port Destination Port Protocol 49152 - 65535 49152 - 65535 49152 - 65535 49152 - 65535 49152 - 65535 88 135 389 389 445 49152 - 65535 49152 - 65535 Linux Instances TCP TCP TCP UDP TCP TCP These are the rules to conﬁgure for your Linux parent and child domain controllers. All testing was performed using Amazon Linux. While the dynamic port range for Windows is 49152 to 65535, many Linux kernels use the port range 32768 to 61000. Run the below command to view the IP port range. cat /proc/sys/net/ipv4/ip_local_port_range Parent Domain Controller, Linux FROM: Parent domain controllers TO: Linux stack and shared services subnets Source Port Destination Port Protocol 389 88 32768 - 61000 32768 - 61000 UDP TCP Linux Instances Version September 13, 2024 266 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options FROM: Stack subnets, including shared services TO: Linux forest root domain controllers Source Port Destination Port Protocol 32768 - 61000 32768 - 61000 88 389 TCP UDP Child Domain Controller, Linux FROM: Child domain controllers TO: Linux AWS domain controllers Source Port Destination Port Protocol 49152 - 65535 49152 - 65535 53 88 389 49152 - 65535 49152 - 65535 389 TCP TCP UDP UDP FROM: Child domain controllers TO: Linux stack and shared services subnets Source Port Destination Port Protocol 88 389 32768 -
ams-appguide-089	ams-appguide.pdf	89	Version September 13, 2024 266 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options FROM: Stack subnets, including shared services TO: Linux forest root domain controllers Source Port Destination Port Protocol 32768 - 61000 32768 - 61000 88 389 TCP UDP Child Domain Controller, Linux FROM: Child domain controllers TO: Linux AWS domain controllers Source Port Destination Port Protocol 49152 - 65535 49152 - 65535 53 88 389 49152 - 65535 49152 - 65535 389 TCP TCP UDP UDP FROM: Child domain controllers TO: Linux stack and shared services subnets Source Port Destination Port Protocol 88 389 32768 - 61000 32768 - 61000 TCP UDP FROM: Stack subnets, including shared services TO: Linux child domain controller Source Port Destination Port Protocol 32768 - 61000 32768 - 61000 88 389 TCP UDP Linux Instances Version September 13, 2024 267 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options AMS egress traﬃc management By default, the route with a destination CIDR of 0.0.0.0/0 for AMS private and customer- applications subnets has a network address translation (NAT) gateway as the target. AMS services, TrendMicro and patching, are components that must have egress access to the Internet so that AMS is able to provide its service, and TrendMicro and operating systems can obtain updates. AMS supports diverting the egress traﬃc to the internet through a customer-managed egress device as long as: • It acts as an implicit (for example, transparent) proxy. and • It allows AMS HTTP and HTTPS dependencies (listed in this section) in order to allow ongoing patching and maintenance of AMS managed infrastructure. Some examples are: • The transit gateway (TGW) has a default route pointing to the customer-managed, on-premises ﬁrewall over the AWS Direct Connect connection in the Multi-Account Landing Zone Networking account. • The TGW has a default route pointing to an AWS endpoint in the Multi-Account Landing Zone egress VPC leveraging AWS PrivateLink, pointing to a customer-managed proxy in another AWS account. • The TGW has a default route pointing to a customer-managed ﬁrewall in another AWS account, with site-to-site VPN connection as an attachment to the Multi-Account Landing Zone TGW. AMS has identiﬁed the corresponding AMS HTTP and HTTPS dependencies, and develops and reﬁnes these dependencies on an ongoing basis. See egressMgmt.zip. Along with the JSON ﬁle, the ZIP contains a README. Note • This information isn't comprehensive--some required external sites aren't listed here. • Do not use this list under a deny list or blocking strategy. AMS egress traﬃc management Version September 13, 2024 268 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • This list is meant as a starting point for an egress ﬁltering rule set, with the expectation that reporting tools will be used to determine precisely where the actual traﬃc diverges from the list. To ask for information about ﬁltering egress traﬃc, email your CSDM: ams-csdm@amazon.com. Security groups In AWS VPCs, AWS Security Groups act as virtual ﬁrewalls, controlling the traﬃc for one or more stacks (an instance or a set of instances). When a stack is launched, it's associated with one or more security groups, which determine what traﬃc is allowed to reach it: • For stacks in your public subnets, the default security groups accept traﬃc from HTTP (80) and HTTPS (443) from all locations (the internet). The stacks also accept internal SSH and RDP traﬃc from your corporate network, and AWS bastions. Those stacks can then egress through any port to the Internet. They can also egress to your private subnets and other stacks in your public subnet. • Stacks in your private subnets can egress to any other stack in your private subnet, and instances within a stack can fully communicate over any protocol with each other. Important The default security group for stacks on private subnets allows all stacks in your private subnet to communicate with other stacks in that private subnet. If you want to restrict communications between stacks within a private subnet, you must create new security groups that describe the restriction. For example, if you want to restrict communications to a database server so that the stacks in that private subnet can only communicate from a speciﬁc application server over a speciﬁc port, request a special security group. How to do so is described in this section. Security groups Version September 13, 2024 269 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Default Security Groups MALZ The following table describes the default inbound security group (SG) settings for your stacks. The SG is named "SentinelDefaultSecurityGroupPrivateOnly-vpc-ID" where ID is a VPC ID in your AMS multi-account landing zone account. All traﬃc is allowed outbound to "mc-initial- garden-SentinelDefaultSecurityGroupPrivateOnly" via this security group (all local traﬃc within stack subnets is allowed). All traﬃc is allowed outbound to 0.0.0.0/0 by a second
ams-appguide-090	ams-appguide.pdf	90	a speciﬁc port, request a special security group. How to do so is described in this section. Security groups Version September 13, 2024 269 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Default Security Groups MALZ The following table describes the default inbound security group (SG) settings for your stacks. The SG is named "SentinelDefaultSecurityGroupPrivateOnly-vpc-ID" where ID is a VPC ID in your AMS multi-account landing zone account. All traﬃc is allowed outbound to "mc-initial- garden-SentinelDefaultSecurityGroupPrivateOnly" via this security group (all local traﬃc within stack subnets is allowed). All traﬃc is allowed outbound to 0.0.0.0/0 by a second security group "SentinelDefaultSecurityGroupPrivateOnly". Tip If you're choosing a security group for an AMS change type, such as EC2 create, or OpenSearch create domain, you would use one of the default security groups described here, or a security group that you created. You can ﬁnd the list of security groups, per VPC, in either the AWS EC2 console or VPC console. There are additional default security groups that are used for internal AMS purposes. AMS default security groups (inbound traﬃc) Type Protocol Port range Source All traﬃc All traﬃc HTTP, HTTPS, SSH, RDP All All All All SentinelDefaultSecurityGroupPrivateOnly (restrict s outbound traﬃc to members of the same security group) SentinelDefaultSecurityGroupPrivateOnlyEgress All (does not restrict outbound traﬃc) TCP 80 / 443 (Source 0.0.0.0/0) SentinelDefaultSecurityGroupPublic (does not restrict outbound traﬃc) SSH and RDP access is allowed from bastions Default Security Groups Version September 13, 2024 270 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Type Protocol Port range Source MALZ bastions: SSH SSH RDP RDP TCP TCP TCP TCP SALZ bastions: SSH SSH RDP RDP TCP TCP TCP TCP 22 22 3389 3389 22 22 3389 3389 SALZ SharedServices VPC CIDR and DMZ VPC CIDR, plus Customer-provided on-prem CIDRs mc-initial-garden-LinuxBastionSG mc-initial-garden-LinuxBastionDMZSG mc-initial-garden-WindowsBastionSG mc-initial-garden-WindowsBastionDMZSG The following table describes the default inbound security group (SG) settings for your stacks. The SG is named "mc-initial-garden-SentinelDefaultSecurityGroupPrivateOnly-ID" where ID is a unique identiﬁer. All traﬃc is allowed outbound to "mc-initial-garden- SentinelDefaultSecurityGroupPrivateOnly" via this security group (all local traﬃc within stack subnets is allowed). All traﬃc is allowed outbound to 0.0.0.0/0 by a second security group "mc-initial-garden- SentinelDefaultSecurityGroupPrivateOnlyEgressAll-ID". Tip If you're choosing a security group for an AMS change type, such as EC2 create, or OpenSearch create domain, you would use one of the default security groups described here, or a security group that you created. You can ﬁnd the list of security groups, per VPC, in either the AWS EC2 console or VPC console. Default Security Groups Version September 13, 2024 271 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options There are additional default security groups that are used for internal AMS purposes. AMS default security groups (inbound traﬃc) Type Protocol Port range Source All traﬃc All traﬃc HTTP, HTTPS, SSH, RDP All All All All SentinelDefaultSecurityGroupPrivateOnly (restrict s outbound traﬃc to members of the same security group) SentinelDefaultSecurityGroupPrivateOnlyEgress All (does not restrict outbound traﬃc) TCP 80 / 443 (Source 0.0.0.0/0) SentinelDefaultSecurityGroupPublic (does not restrict outbound traﬃc) SSH and RDP access is allowed from bastions MALZ bastions: SSH SSH RDP RDP TCP TCP TCP TCP SALZ bastions: SSH SSH RDP RDP TCP TCP TCP TCP 22 22 3389 3389 22 22 3389 3389 SharedServices VPC CIDR and DMZ VPC CIDR, plus Customer-provided on-prem CIDRs mc-initial-garden-LinuxBastionSG mc-initial-garden-LinuxBastionDMZSG mc-initial-garden-WindowsBastionSG mc-initial-garden-WindowsBastionDMZSG Default Security Groups Version September 13, 2024 272 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Create, Change, or Delete Security Groups You can request custom security groups. In cases where the default security groups do not meet the needs of your applications or your organization, you can modify or create new security groups. Such a request would be considered approval-required and would be reviewed by the AMS operations team. To create a security group outside of stacks and VPCs, submit an RFC using the Management \| Other \| Other \| Create CT (ct-1e1xtak34nx76). To add or remove a user from an Active Directory (AD) security group, submit a request for change (RFC) using the Management \| Other \| Other \| Update CT (ct-0xdawir96cy7k). Note When using "review required" CTs, AMS recommends that you use the ASAP Scheduling option (choose ASAP in the console, leave start and end time blank in the API/CLI) as these CTs require an AMS operator to examine the RFC, and possibly communicate with you before it can be approved and run. If you schedule these RFCs, be sure to allow at least 24 hours. If approval does not happen before the scheduled start time, the RFC is rejected automatically. Find Security Groups To ﬁnd the security groups attached to a stack or instance, use the EC2 console. After ﬁnding the stack or instance, you can see all security groups attached to it. For ways to ﬁnd security groups at
ams-appguide-091	ams-appguide.pdf	91	leave start and end time blank in the API/CLI) as these CTs require an AMS operator to examine the RFC, and possibly communicate with you before it can be approved and run. If you schedule these RFCs, be sure to allow at least 24 hours. If approval does not happen before the scheduled start time, the RFC is rejected automatically. Find Security Groups To ﬁnd the security groups attached to a stack or instance, use the EC2 console. After ﬁnding the stack or instance, you can see all security groups attached to it. For ways to ﬁnd security groups at the command line and ﬁlter the output, see describe- security-groups. Create, Change, or Delete Security Groups Version September 13, 2024 273 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Appendix: Application onboarding questionnaire Use this questionnaire to describe your deployment elements and structure so AMS can determine what infrastructure components are needed. The onboarding requirements for Line-of-Business (LoB) applications are signiﬁcantly diﬀerent than product applications, so this questionnaire is designed to address both. Topics • Deployment summary • Infrastructure deployment components • Application hosting platform • Application deployment model • Application dependencies • SSL certiﬁcates for product applications Deployment summary A description of the deployment. For example: • This account is for a Line-of-Business (LoB) application deployment (as opposed to a product application deployment). • The deployment involves an auto-scaled ARP (authenticated reverse proxy) within the account’s public/DMZ subnet. • Web and application servers will be deployed within the account's private subnet. • An Amazon RDS (Amazon Relational Database Service) instance will also be deployed within the account’s private subnet. • The servers (ARP, web, application, database, load balancer, and so on) are separated into distinct security groups. • The account requires an HA (high availability) design spread across Availability Zones (AZs), that is, Multi-AZ. Infrastructure deployment components What are all the diﬀerent components that will need conﬁguring to support your application? Deployment summary Version September 13, 2024 274 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options • Region: What AWS Region or Regions are needed? • High Availability (HA): What Availability Zones will be used? • Virtual Private Cloud (VPC): What is the CIDR block for the VPC? • What server instances are needed? • Authenticated Reverse Proxy (ARP): OS, AMI, instance type, subnet ID, security group, ingress port? • Application Deployment Tool server: OS, AMI, instance type, subnet ID, security group, ingress port (Chef, Puppet) or egress port (Ansible, Saltstack) port? • Amazon RDS with MySQL: DB version, Usage Type, instance class, subnet ID, security group, DB instance ID, storage size, Multi-AZ, Auth type, encryption? • Storage: Is your app stateless? Do you require S3 buckets? Do you require persistent storage? Do you require data at rest encryption on your EBS volumes? Do you require DB encryption? • External (to the Managed Services VPC) server endpoints: SMTP? LDAP? • Network requirements: Network ﬁltering (based on security groups?)? Web traﬃc inspection (inbound?outbound?)? • Tagging: What tags should be used to group resources into logical collections? For example, all resources for an application stack. Select tags for your use case; for example, backup=true to enable backups. Additionally, you must use the tag name=value in order for any EC2 instances you create to display a name in the console. • Security groups: • What security groups are needed? • Security group ingress rules? • Security group egress rules? Application hosting platform For your application hosting platform, consider the following possible requirements: • Databases encrypted? • Encryption keys managed by whom? • All data in-transit and at-rest encrypted? • All user access to the system via HTTPS? • All system-to-system interactions approved by your security operations team? Application hosting platform Version September 13, 2024 275 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Application deployment model Considerations of how you plan your application deployments. See What is my operating model? • Automated or manual? No deployment automation means no Auto Scale. If you request access and log in and manually update your application, and your update fails. AMS would expect you to rollback your update or alert us through a service request so we can assist you. • If automated, what is the framework? Scripts? Agent-based (puppet/chef)? Agentless (SALT/ Ansible)? CodeDeploy? Agent-based and agentless deployment tooling require a separate instance be created and deployed as the master server for the tooling. AMS expects you to be aware of all of the elements necessary for successful application deployment tooling; however, we are happy to help with related infrastructure questions. • Do your Line-of-Business applications (those applications that you use to create and manage your applications) require patching? Application dependencies Do you need instances for Line-of-Business (LoB) applications? For product applications? What do your Product applications need to
ams-appguide-092	ams-appguide.pdf	92	you. • If automated, what is the framework? Scripts? Agent-based (puppet/chef)? Agentless (SALT/ Ansible)? CodeDeploy? Agent-based and agentless deployment tooling require a separate instance be created and deployed as the master server for the tooling. AMS expects you to be aware of all of the elements necessary for successful application deployment tooling; however, we are happy to help with related infrastructure questions. • Do your Line-of-Business applications (those applications that you use to create and manage your applications) require patching? Application dependencies Do you need instances for Line-of-Business (LoB) applications? For product applications? What do your Product applications need to function properly? • Network level dependencies: For example, AWS Direct Connect • Package dependencies: For example, pip • Applications that this application depends on: For example, MySql • Firewall dependencies? What do your LoB applications need to function properly? • Network level dependencies: For example, AWS Direct Connect • Package dependencies: For example, Firefox Saucy • Applications that this application depends on: For example, MySql • Firewall dependencies? Application deployment model Version September 13, 2024 276 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options SSL certiﬁcates for product applications What SSL certiﬁcates will your servers need so your applications (LoB and product) can reach everything they need to run and be accessible? • Auto Scaling Group? • Database (Amazon RDS)? • Load Balancer? • Deployment tool server? • Web application ﬁrewall (AWS WAF)? • Other instances? As an example, for each of the instances listed above you might need the following certiﬁcates: WAF (cert 1) - > ELB-Ext (cert 2) - > ARP (cert 3) - > ELB-Int (cert 4) -> Website (cert 5) - > ELB-Int (cert 6) -> Web service (cert 7). SSL certiﬁcates for product applications Version September 13, 2024 277 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Document history The following table describes the documentation for this release of AMS. • API version: 2019-05-21 • Latest documentation update: February 16, 2023 Change Description Updated content: Migrating Workloads: Windows pre- Updated section to include detailed steps for using the pre-WIGs validater script to ingestion validation validate that your Windows instance is ready for ingestion into your AMS account;. Updated content, DMS conﬁguration an important note about the required role, dms-vpc-role. Updated content, CFN Ingest supported resources Added OpenSearch. Updated content, Migrating workloads Updated instructions for pre-ingestion validation. Updated content, CFN Ingest. Removed restricted "supported resources" from CFN ingest content. Updated supported Windows versions Added support for Windows Server 2022. Link Migrating workloads : Windows pre-ingestion validation 1: AWS DMS replicati on subnet group: Create Supported Resources Migrating workloads : Windows pre-ingestion validation CloudForm ation Ingest Stack: Supported resources AMS Amazon Machine Version September 13, 2024 278 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Change Description Link Images (AMIs), Migrating Workloads: Prerequisites for Linux and Windows, and Migrating workloads : Windows pre-ingestion validation Updated content, Resource Scheduler. Updated instructions to use the dedicated deployment CT, ct-0ywnhc8e5k9z5, applicable AMS Resource to both SALZ and MALZ. Updated content, Workload Ingest. Updated supported SUSE Linux versions. Updated content, Database Migration Service. Added to prerequisites and made several changes for usefulness and usability. Updated content, Workload Ingest. The Linux Pre-WIGS Validation Zip has been updated. Scheduler quick start Migrating Workloads: Prerequisites for Linux and Windows AWS Database Migration Service (AWS DMS) Migrating Workloads: Prerequisites for Linux and Windows Version September 13, 2024 279 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Change Description Link Updated content. Updated the pre-WIGS validation zip for Linux. Also, added Windows Server 2008 R2 as a Migrating Workloads: supported operating system. Prerequisites for Linux and Windows New content Quick Starts and Tutorials have been moved here from the retired AMS Advanced Change Quick starts, Tutorials. Updated content Management Guide. Deployment \| Advanced stack components \| Database Migration Service (DMS) \| Start replication task (ct-1yq7hhqse71yg) Updated to indicate the DocumentName and Region are required parameters; previously, they were erroneously listed as optional. Updated content CloudFormation Ingest Updated to indicate two new supported resources, AWS::Route53Resolver::Resol verRuleAssociation and AWS::Route53Resolv er::ResolverRule. Updated content Migrating workloads: Windows pre-ingestion validation Database Migration Service (DMS) \| Start Replication Task Supported Resources Sysprep informati on updated with more speciﬁcs. Migrating workloads : Windows pre-ingestion validation Version September 13, 2024 280 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Change Description Link Management \| Custom stack \| Stack from CloudFormation Template \| Approve Stack from CloudForm Changeset and Update (ct-1404e21baa2ox) ation Updated content The CT walkthrough description for the ChangeSetName parameter has been updated with additional information. Ubuntu 18.04 and Oracle Linux 8.3 available Template \| Approve Changeset and Update Migrating Workloads: Prerequisites for Linux and Windows New content: IAM deployments through CFN Ingest and Stack Update CTs. February 10, 2022 Database Migration Service
ams-appguide-093	ams-appguide.pdf	93	updated with more speciﬁcs. Migrating workloads : Windows pre-ingestion validation Version September 13, 2024 280 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options Change Description Link Management \| Custom stack \| Stack from CloudFormation Template \| Approve Stack from CloudForm Changeset and Update (ct-1404e21baa2ox) ation Updated content The CT walkthrough description for the ChangeSetName parameter has been updated with additional information. Ubuntu 18.04 and Oracle Linux 8.3 available Template \| Approve Changeset and Update Migrating Workloads: Prerequisites for Linux and Windows New content: IAM deployments through CFN Ingest and Stack Update CTs. February 10, 2022 Database Migration Service (DMS) replication tasks Change types updated so regular expressio ns permit task ARNs that contain hyphens. January 13, 2022 Start AWS DMS replication task and Database Migration Service (DMS) \| Stop Replication Task. Linux WIGS pre-ingestion validation The zip ﬁle was updated. Migrating workloads: Linux pre-ingestion validation. January 13, 2022 Fixed links The Database (DB) Import to AMS SQL RDS -> Setting up section had some bad links. January 13, 2022 Version September 13, 2024 281 AMS Advanced Application Developer's Guide AMS Advanced Application Deployment Options AWS Glossary For the latest AWS terminology, see the AWS glossary in the AWS Glossary Reference. Version September 13, 2024 282
ams-ct-001	ams-ct.pdf	1	AMS Advanced Change Type Details AMS Advanced Change Type Reference Version April 22, 2025 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AMS Advanced Change Type Reference AMS Advanced Change Type Details AMS Advanced Change Type Reference: AMS Advanced Change Type Details Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AMS Advanced Change Type Reference AMS Advanced Change Type Details Table of Contents What Are AMS Change Types? ........................................................................................................ 1 Change Types by Classiﬁcation ....................................................................................................... 3 Deployment .................................................................................................................................................... 3 Advanced Stack Components ............................................................................................................... 3 AMS Patterns ....................................................................................................................................... 457 AMS Resource Scheduler ................................................................................................................... 462 Applications ......................................................................................................................................... 468 AWS Backup ......................................................................................................................................... 489 Directory Service ................................................................................................................................. 497 Ingestion ............................................................................................................................................... 507 Managed Firewall ............................................................................................................................... 525 Managed Landing Zone ..................................................................................................................... 535 Monitoring and Notiﬁcation ............................................................................................................. 606 Patching ................................................................................................................................................ 639 Standalone Resources ........................................................................................................................ 674 Standard Stacks .................................................................................................................................. 679 Management ............................................................................................................................................. 699 Access .................................................................................................................................................... 700 Advanced Stack Components .......................................................................................................... 720 AMS Resource Scheduler ................................................................................................................ 1340 Applications ....................................................................................................................................... 1393 AWS Backup ...................................................................................................................................... 1398 AWS Service ....................................................................................................................................... 1428 Custom Stack .................................................................................................................................... 1438 Directory Service .............................................................................................................................. 1459 Host Security ..................................................................................................................................... 1542 Managed Account ............................................................................................................................. 1576 Managed Firewall ............................................................................................................................. 1605 Managed Landing Zone .................................................................................................................. 1629 Monitoring and Notiﬁcation .......................................................................................................... 1689 Other ................................................................................................................................................... 1727 Patching .............................................................................................................................................. 1737 Standalone Resources ..................................................................................................................... 1753 Standard Stacks ................................................................................................................................ 1768 Version April 22, 2025 iii AMS Advanced Change Type Reference AMS Advanced Change Type Details Trusted Remediator ......................................................................................................................... 1801 Change Type Schemas ............................................................................................................... 1817 ct-00tlkda4242x7 .................................................................................................................................. 1817 ct-00zr0b0ozlcn3 ................................................................................................................................... 1821 ct-0176f0n99vcps .................................................................................................................................. 1824 ct-01zl37gmuk4q2 ................................................................................................................................ 1827 ct-02ocqy2i0jx3t .................................................................................................................................... 1829 ct-02u0hoaa9grat .................................................................................................................................. 1831 ct-03ms1d7xrck8w ................................................................................................................................ 1831 ct-03t7kvuwx6rgr .................................................................................................................................. 1833 ct-03ytgoevfebjr .................................................................................................................................... 1835 ct-042luqo63j4mx ................................................................................................................................. 1837 ct-046aizcwg5idf ................................................................................................................................... 1839 ct-04gzyy008v1bg ................................................................................................................................. 1842 ct-059ewa92tc2i1 .................................................................................................................................. 1843 ct-05muqzievnxk5 ................................................................................................................................. 1845 ct-05yb337abq3x5 ................................................................................................................................ 1850 ct-063qsm82cfxu6 ................................................................................................................................ 1851 ct-06bwg93ukgg8t ................................................................................................................................ 1855 ct-06mjngx5ﬂwto .................................................................................................................................. 1856 ct-07jzw8bzd2on7 ................................................................................................................................. 1870 ct-08avsj2e9mc7g ................................................................................................................................. 1872 ct-08sgdn5zowyyl ................................................................................................................................. 1874 ct-09qbhy7kvtxqw ................................................................................................................................. 1876 ct-09t6q7j9v5hrn ................................................................................................................................... 1876 ct-0ah3gwb9seqk2 ................................................................................................................................ 1888 ct-0aqx5t0pgfzbg .................................................................................................................................. 1891 ct-0ary07xiajwx4 .................................................................................................................................... 1893 ct-0attesnjqy2cx ..................................................................................................................................... 1908 ct-0biqnokj25gkd ................................................................................................................................... 1913 ct-0bpxsrtu16igp ................................................................................................................................... 1915 ct-0c38gftq56zj6 ................................................................................................................................... 1916 ct-0cupn1txog5tk .................................................................................................................................. 1918 ct-0cyqd7laxyhlm .................................................................................................................................. 1922 ct-0el2j07llrxs7 ...................................................................................................................................... 1932 ct-0erkoad6uyvvg .................................................................................................................................. 1936 Version April 22, 2025 iv AMS Advanced Change Type Reference AMS Advanced Change Type Details ct-0ﬀvihqwjvqj1 ..................................................................................................................................... 1937 ct-0fpjlxa808sh2 .................................................................................................................................... 1940 ct-0fqo03yizfnw6 ................................................................................................................................... 1942 ct-0g690ekkyfm79 ................................................................................................................................ 1945 ct-0h3p576mj4rqm ............................................................................................................................... 1949 ct-0hahohe17csnc ................................................................................................................................. 1951 ct-0hi7z7tyikjf6 ...................................................................................................................................... 1954 ct-0hu3q3957aghj ................................................................................................................................. 1956 ct-0idxb0xsg1ui6 .................................................................................................................................... 1958 ct-0ikpop8zqhkxg .................................................................................................................................. 1960 ct-0ixp4ch2tiu04 .................................................................................................................................... 1962 ct-0jb01cofkhwk1 .................................................................................................................................. 1963 ct-0k4b96aatyqgl .................................................................................................................................. 1964 ct-0kbey7hb00atp ................................................................................................................................. 1966 ct-0loed9dzig1ze ................................................................................................................................... 1970 ct-0lqruajvhwsbk .................................................................................................................................... 1974 ct-0ltm873rsebx9 .................................................................................................................................. 1977 ct-0mss4i7neuj7f ................................................................................................................................... 1984 ct-0o4zi9bzg74lp ................................................................................................................................... 1989 ct-0pgvtw5rpcsb6 .................................................................................................................................. 1992 ct-0q0bic0ywqk6c ................................................................................................................................. 1997 ct-0q43l40hxrzum ................................................................................................................................. 1998 ct-0qbikxr9okwvy .................................................................................................................................. 2001 ct-0rmgrnr9w8mzh ............................................................................................................................... 2004 ct-0tmpmp1wpgkr9 .............................................................................................................................. 2006 ct-0tpbr6lfa3zng .................................................................................................................................... 2009 ct-0ttx8eh3ice91 .................................................................................................................................... 2011 ct-0vdiy51oyrhhm ................................................................................................................................. 2012 ct-0vevjppj9eta4 .................................................................................................................................... 2014 ct-0vzsr2nyraedl .................................................................................................................................... 2015 ct-0wglhholzo0uw ................................................................................................................................. 2017 ct-0wspy4o646g9p ................................................................................................................................ 2022 ct-0x6dylrnfjgz5 ..................................................................................................................................... 2025 ct-0xdawir96cy7k ................................................................................................................................... 2028 ct-0xi6q7uwuwrqe ................................................................................................................................. 2029 ct-0xqwmtn1hfh8u ................................................................................................................................ 2034 Version April 22, 2025 v AMS Advanced Change Type Reference AMS Advanced Change Type Details ct-0ywnhc8e5k9z5 ................................................................................................................................ 2036 ct-0zko7t3rk2efb ................................................................................................................................... 2051 ct-0zzf0fjz76jmb .................................................................................................................................... 2054 ct-1078jhyxq32dp ................................................................................................................................. 2057 ct-10nh4ztyxu8kz .................................................................................................................................. 2059 ct-10yi1sd9nst1c .................................................................................................................................... 2061 ct-111fhplhx9axe ................................................................................................................................... 2063 ct-111r1yayblnw4 .................................................................................................................................. 2066 ct-117rmp64d5mvb .............................................................................................................................. 2080 ct-128svy9nn2yj8 .................................................................................................................................. 2088 ct-12amsdz909cfh ................................................................................................................................. 2091 ct-12lyw7otiyr6f .................................................................................................................................... 2099 ct-12w49boaiwtzp ................................................................................................................................. 2102 ct-13lk0noacn6ua .................................................................................................................................. 2107 ct-13swbwdxg106z ................................................................................................................................ 2111 ct-13xvbj5pqg253 ................................................................................................................................. 2114 ct-14027q0sjyt1h .................................................................................................................................. 2116 ct-1404e21baa2ox ................................................................................................................................. 2121 ct-14v49adibs4db .................................................................................................................................. 2123 ct-14yjom3kvpinu .................................................................................................................................. 2125 ct-15mazjj88xc69 .................................................................................................................................. 2130 ct-16pknsfa8lul7 .................................................................................................................................... 2133 ct-16xg8qguovg2w ................................................................................................................................ 2137 ct-1706xvvk6j9hf ................................................................................................................................... 2148 ct-17cj84y7632o6 .................................................................................................................................. 2150 ct-17vnu10suy631 ................................................................................................................................. 2152 ct-17w6f6kzf6w51 ................................................................................................................................ 2157 ct-1895yr1p87noq ................................................................................................................................. 2160 ct-18fzkt86jmw1s .................................................................................................................................. 2162 ct-18r16ldqil6w9 ................................................................................................................................... 2167 ct-1962s5oczal9z ................................................................................................................................... 2169 ct-1976sir132k22 .................................................................................................................................. 2170 ct-199h35t7uz6jl ................................................................................................................................... 2174 ct-19f40lfm5umy8 ................................................................................................................................ 2176 ct-19fdy7np55xiu .................................................................................................................................. 2179 ct-1a1zzgi2nb83d .................................................................................................................................. 2182 Version April 22, 2025 vi AMS Advanced Change Type Reference AMS Advanced Change Type Details ct-1a68ck03fn98r .................................................................................................................................. 2189 ct-1aqsjf86w6vxg .................................................................................................................................. 2193 ct-1ax768xtu8c9q .................................................................................................................................. 2208 ct-1ay83wy4vxa3k ................................................................................................................................. 2211 ct-1b8fudnqq7m8r ................................................................................................................................ 2215 ct-1c0jrxd3su5oe ................................................................................................................................... 2216 ct-1c7ch8z5phrjp ................................................................................................................................... 2219 ct-1d2fml15b9eth ................................................................................................................................. 2221 ct-1d55pi44ﬀ21u ................................................................................................................................... 2226 ct-1d84keiri1jhg ..................................................................................................................................... 2228 ct-1dmlg9g1l91h6 ................................................................................................................................. 2233 ct-1e0xmuy1diafq .................................................................................................................................. 2235 ct-1e1xtak34nx76 .................................................................................................................................. 2240 ct-1eft8s6vdhz0w .................................................................................................................................. 2242 ct-1eiczxw8ihc18 ................................................................................................................................... 2243 ct-1elb1vtam0ka5 ................................................................................................................................. 2245 ct-1erytvmumckoa ................................................................................................................................ 2247 ct-1ezarc5xph3tq ................................................................................................................................... 2249 ct-1f9hi4bephqa9 .................................................................................................................................. 2252 ct-1fzddqrr20c2i .................................................................................................................................... 2254 ct-1g6x4ev0hnvfn ................................................................................................................................. 2256 ct-1gi93jhvj28eg .................................................................................................................................... 2257 ct-1h1tuxn2oxrtf .................................................................................................................................... 2262 ct-1h5xgl9cr4bzy ................................................................................................................................... 2264 ct-1hzofpphabs3i ................................................................................................................................... 2265 ct-1i20abktsm05v .................................................................................................................................. 2267 ct-1icghmq38rnsn .................................................................................................................................. 2269 ct-1icrtx8ydvdwe ................................................................................................................................... 2271 ct-1j3503fres5a5 .................................................................................................................................... 2273 ct-1k3oui719dcju ................................................................................................................................... 2283 ct-1ksyoxreh35tu ................................................................................................................................... 2293 ct-1malj7snzxrkr .................................................................................................................................... 2294 ct-1mrqxscu15apz ................................................................................................................................. 2301 ct-1n323w7eu27u9 ............................................................................................................................... 2305 ct-1n9gfnog5x7ﬂ ................................................................................................................................... 2306 ct-1o1x2itfd6rk8 .................................................................................................................................... 2313 Version April 22, 2025 vii AMS Advanced Change Type Reference AMS Advanced Change Type Details ct-1opjmhuddw194 ............................................................................................................................... 2322 ct-1oxx2g2d7hc90 ................................................................................................................................. 2323 ct-1pvlhug439gl2 .................................................................................................................................. 2328
ams-ct-002	ams-ct.pdf	2	2233 ct-1e0xmuy1diafq .................................................................................................................................. 2235 ct-1e1xtak34nx76 .................................................................................................................................. 2240 ct-1eft8s6vdhz0w .................................................................................................................................. 2242 ct-1eiczxw8ihc18 ................................................................................................................................... 2243 ct-1elb1vtam0ka5 ................................................................................................................................. 2245 ct-1erytvmumckoa ................................................................................................................................ 2247 ct-1ezarc5xph3tq ................................................................................................................................... 2249 ct-1f9hi4bephqa9 .................................................................................................................................. 2252 ct-1fzddqrr20c2i .................................................................................................................................... 2254 ct-1g6x4ev0hnvfn ................................................................................................................................. 2256 ct-1gi93jhvj28eg .................................................................................................................................... 2257 ct-1h1tuxn2oxrtf .................................................................................................................................... 2262 ct-1h5xgl9cr4bzy ................................................................................................................................... 2264 ct-1hzofpphabs3i ................................................................................................................................... 2265 ct-1i20abktsm05v .................................................................................................................................. 2267 ct-1icghmq38rnsn .................................................................................................................................. 2269 ct-1icrtx8ydvdwe ................................................................................................................................... 2271 ct-1j3503fres5a5 .................................................................................................................................... 2273 ct-1k3oui719dcju ................................................................................................................................... 2283 ct-1ksyoxreh35tu ................................................................................................................................... 2293 ct-1malj7snzxrkr .................................................................................................................................... 2294 ct-1mrqxscu15apz ................................................................................................................................. 2301 ct-1n323w7eu27u9 ............................................................................................................................... 2305 ct-1n9gfnog5x7ﬂ ................................................................................................................................... 2306 ct-1o1x2itfd6rk8 .................................................................................................................................... 2313 Version April 22, 2025 vii AMS Advanced Change Type Reference AMS Advanced Change Type Details ct-1opjmhuddw194 ............................................................................................................................... 2322 ct-1oxx2g2d7hc90 ................................................................................................................................. 2323 ct-1pvlhug439gl2 .................................................................................................................................. 2328 ct-1pybwg08h8qsz ................................................................................................................................ 2329 ct-1q8q56cmwqj9m .............................................................................................................................. 2330 ct-1r19m51jeijlk ..................................................................................................................................... 2332 ct-1r1vbr8ahr156 .................................................................................................................................. 2344 ct-1taxucdyi84iy ..................................................................................................................................... 2346 ct-1urj94c3hdfu5 ................................................................................................................................... 2347 ct-1v9g9n30woc8h ................................................................................................................................ 2348 ct-1vbv99ko7bsrq .................................................................................................................................. 2352 ct-1vd3y4ygbqmfk ................................................................................................................................ 2356 ct-1vjbacfr4ufdv ..................................................................................................................................... 2357 ct-1vq0f289r36ay .................................................................................................................................. 2360 ct-1vrnixswq1uwf .................................................................................................................................. 2361 ct-1w8z66n899dct ................................................................................................................................ 2363 ct-1wle0ai4en6km ................................................................................................................................. 2367 ct-1x66wvkjw2zp5 ................................................................................................................................. 2371 ct-1yq7hhqse71yg ................................................................................................................................. 2379 ct-1yqy4frl5s8y8 .................................................................................................................................... 2382 ct-1zdasmc2ewzrs ................................................................................................................................. 2383 ct-2019s9y3nfml4 ................................................................................................................................. 2399 ct-2052miu12d8fn ................................................................................................................................ 2401 ct-20san5sgtwd9e ................................................................................................................................. 2403 ct-211l2gxvsrrhy .................................................................................................................................... 2408 ct-220bdb8blaixf ................................................................................................................................... 2409 ct-22cbvc1yujhec ................................................................................................................................... 2411 ct-24pi85mjtza8k ................................................................................................................................... 2413 ct-24rl68y07m769 ................................................................................................................................. 2415 ct-257p9zjk14ija .................................................................................................................................... 2417 ct-25v6r7t8gvkq5 .................................................................................................................................. 2420 ct-26vhhlj9jmlpf .................................................................................................................................... 2422 ct-2781aqd6f6svs .................................................................................................................................. 2424 ct-27apldkhqr0ol ................................................................................................................................... 2426 ct-27jjy5wnrfef2 .................................................................................................................................... 2432 ct-27tuth19k52b4 ................................................................................................................................. 2433 Version April 22, 2025 viii AMS Advanced Change Type Reference AMS Advanced Change Type Details ct-281dpwh9tqnan ................................................................................................................................ 2440 ct-281et7bs9ep4s .................................................................................................................................. 2443 ct-2aaaqid7asjy6 .................................................................................................................................... 2458 ct-2b9q8339bj2sa .................................................................................................................................. 2459 ct-2bxelbn765ive ................................................................................................................................... 2461 ct-2c7ve50jost1v .................................................................................................................................... 2477 ct-2d55p1d7z6w3d ............................................................................................................................... 2491 ct-2dphvdy1krpj6 .................................................................................................................................. 2493 ct-2edc3sd1sqmrb ................................................................................................................................. 2498 ct-2eof6j3mlcwhf .................................................................................................................................. 2503 ct-2epp05svrlwod .................................................................................................................................. 2505 ct-2fqmbyud166z9 ................................................................................................................................ 2508 ct-2fuzb2l7hckrj ..................................................................................................................................... 2510 ct-2fzh1wckpl7f5 ................................................................................................................................... 2512 ct-2gd0u847qd9d2 ............................................................................................................................... 2513 ct-2ha68tpd7nr3y .................................................................................................................................. 2516 ct-2hh93eyzmwbkd ............................................................................................................................... 2531 ct-2hhqzgxvkcig8 ................................................................................................................................... 2533 ct-2hhud2lx01tq7 .................................................................................................................................. 2535 ct-2hxcllf1b4ey0 .................................................................................................................................... 2538 ct-2hyozbpa0sx0m ................................................................................................................................ 2544 ct-2iz9nvw8zlhst .................................................................................................................................... 2563 ct-2j7q1hgf26x5c .................................................................................................................................. 2564 ct-2jndrh7uit8uf ..................................................................................................................................... 2571 ct-2jvzjwunghrhy ................................................................................................................................... 2574 ct-2lt0jeydeumpe ................................................................................................................................... 2583 ct-2mf36chtp1ejh .................................................................................................................................. 2585 ct-2murl5xzbxoxf ................................................................................................................................... 2586 ct-2ni31oyto1i5k ................................................................................................................................... 2588 ct-2nyeguspp2g1l .................................................................................................................................. 2590 ct-2oxl37nphsrjz .................................................................................................................................... 2595 ct-2p93tyd5angmi ................................................................................................................................. 2599 ct-2paw0y79kvr3l .................................................................................................................................. 2601 ct-2pbqoﬀhclpek ................................................................................................................................... 2602 ct-2pfarpvczsstr ...................................................................................................................................... 2604 ct-2pkdckieh62ps ................................................................................................................................... 2606 Version April 22, 2025 ix AMS Advanced Change Type Reference AMS Advanced Change Type Details ct-2ptn20pq7ur3x ................................................................................................................................. 2609 ct-2pxyajek47am2 ................................................................................................................................. 2611 ct-2q5azjd8p1ag5 .................................................................................................................................. 2613 ct-2qhl8j1pjnbgn ................................................................................................................................... 2616 ct-2qjqju7h67s7w .................................................................................................................................. 2619 ct-2qldv4h9osmau ................................................................................................................................. 2621 ct-2r2bﬀv9u6q4m ................................................................................................................................. 2629 ct-2r9xvd3sdsic0 .................................................................................................................................... 2630 ct-2rfzmkm6ugigh ................................................................................................................................. 2631 ct-2rnjx5yd6jgpt .................................................................................................................................... 2633 ct-2svg4k2fqi4ak ................................................................................................................................... 2635 ct-2syhk4sr7cvyw .................................................................................................................................. 2637 ct-2taqdgegqthjr .................................................................................................................................... 2639 ct-2tqi3kjcusen4 .................................................................................................................................... 2643 ct-2tylseo8rxfsc ...................................................................................................................................... 2644 ct-2u5rcyv5h34zn .................................................................................................................................. 2654 ct-2uimt36z7j6vn .................................................................................................................................. 2656 ct-2utx36abv83pv .................................................................................................................................. 2660 ct-2uw99b8hpncnu ............................................................................................................................... 2664 ct-2uzbqr7x7mekd ................................................................................................................................ 2668 ct-2v82sp4np40ki .................................................................................................................................. 2670 ct-2w3rbmnny1qpo ............................................................................................................................... 2678 ct-2wlfo2jxj2rkj ...................................................................................................................................... 2681 ct-2wllq61djysxz .................................................................................................................................... 2682 ct-2wrvu4kca9xky .................................................................................................................................. 2690 ct-2x14cv67uym46 ................................................................................................................................ 2692 ct-2xd2anlb5hbzo .................................................................................................................................. 2693 ct-2y6q4vco4miyp ................................................................................................................................. 2695 ct-2yja7ihh30ply .................................................................................................................................... 2701 ct-2z60dyvto9g6c .................................................................................................................................. 2703 ct-2zebb2czoxpjd ................................................................................................................................... 2712 ct-2zqwr34epwzx1 ................................................................................................................................ 2714 ct-2zxya20wmf5bf ................................................................................................................................ 2716 ct-3047c34zuvswh ................................................................................................................................. 2718 ct-309eozh6lpkr8 .................................................................................................................................. 2719 ct-30bﬁwxjku1nu ................................................................................................................................... 2721 Version April 22, 2025 x AMS Advanced Change Type Reference AMS Advanced Change Type Details ct-30ecvﬁ3tq4k3 .................................................................................................................................... 2724 ct-30j78u6li9aqr .................................................................................................................................... 2726 ct-31eb7rrxb7qju ................................................................................................................................... 2728 ct-31eyj2hlvqjwu ................................................................................................................................... 2732 ct-33ste5yc7hprs ................................................................................................................................... 2734 ct-34alumbtv2b9p ................................................................................................................................. 2736 ct-34jldf2qihaic ...................................................................................................................................... 2737 ct-34sxfo53yuzah .................................................................................................................................. 2740 ct-35p977vul06df .................................................................................................................................. 2741 ct-361tlo1k7339x .................................................................................................................................. 2744 ct-361vpyun9a9dd ................................................................................................................................ 2747 ct-369odosk0pd9w ................................................................................................................................ 2755 ct-36cn2avfrrj9v ..................................................................................................................................... 2757 ct-36emj2uapfbu8 ................................................................................................................................. 2760 ct-36jq7gvwyty8h ................................................................................................................................. 2762 ct-36x3u7v2oklwd ................................................................................................................................. 2764 ct-36zubwzxp44a4 ................................................................................................................................ 2766 ct-379uwo67vbvng ............................................................................................................................... 2767 ct-37bq2l9c8fzxv ................................................................................................................................... 2770 ct-37kcp2v1mriu6 .................................................................................................................................. 2772 ct-37qquo9wbpa8x ............................................................................................................................... 2774 ct-37vqa0oggka3q ................................................................................................................................ 2777 ct-38s4s4tm4ic4u .................................................................................................................................. 2779 ct-38xcr0q86k9lh ................................................................................................................................... 2781 ct-3929xwf222jri ................................................................................................................................... 2797 ct-393q3yaq9ewlm ............................................................................................................................... 2800 ct-39c5qiasbe4he .................................................................................................................................. 2802 ct-3cp96z7r065e4 ................................................................................................................................. 2803 ct-3cx7we852p3af ................................................................................................................................. 2805 ct-3d0lrfb8eckuu ................................................................................................................................... 2807 ct-3da2lxapopb86 ................................................................................................................................. 2809 ct-3dfnglm4ombbs ................................................................................................................................ 2811 ct-3dfubbpesm2v9 ................................................................................................................................ 2818 ct-3dgbnh6gpst4d ................................................................................................................................. 2820 ct-3dpd8mdd9jn1r ................................................................................................................................ 2821 ct-3dscwaeyi6cup .................................................................................................................................. 2829 Version April 22, 2025 xi AMS Advanced Change Type Reference AMS Advanced Change Type Details ct-3e3h8u0sp5z80 ................................................................................................................................. 2831 ct-3e3prksxmdhw8 ................................................................................................................................ 2833 ct-3ebotglihggse .................................................................................................................................... 2835 ct-3eutt7grkict4 ..................................................................................................................................... 2840 ct-3ﬁ2cx8b83iua .................................................................................................................................... 2842 ct-3g6fq83nxg1a7 ................................................................................................................................. 2850 ct-3g9dbtun44mal ................................................................................................................................ 2853 ct-3gf8dolbo8x9p .................................................................................................................................. 2865 ct-3gg0id58rn82h .................................................................................................................................. 2870 ct-3gjfayulf5hhs ..................................................................................................................................... 2872 ct-3glr80c15rp7z ................................................................................................................................... 2874 ct-3hox8uwjgze1f .................................................................................................................................. 2876 ct-3j2zstluz6dxq ..................................................................................................................................... 2878 ct-3jo8yccbin4it ...................................................................................................................................... 2881 ct-3jrqmeq7j0wke .................................................................................................................................. 2883 ct-3jx80fquylzhf ..................................................................................................................................... 2889 ct-3kh1wiizlne1i ..................................................................................................................................... 2891 ct-3kinq0u4l33zf ................................................................................................................................... 2893 ct-3kl2d1u40lrj8 .................................................................................................................................... 2895 ct-3l14e139i5p50 .................................................................................................................................. 2898 ct-3lkbpansfv69k ................................................................................................................................... 2903 ct-3ll9hnadql9s1 .................................................................................................................................... 2905 ct-3memthlcmvc1b ............................................................................................................................... 2908 ct-3mlsibqhugrf1 ................................................................................................................................... 2915 ct-3mvvt2zkyveqj .................................................................................................................................. 2917 ct-3nba0wtdugnan ................................................................................................................................ 2919 ct-3nmhh0qr338q6 ............................................................................................................................... 2921 ct-3oafsdbzjtuqp .................................................................................................................................... 2923 ct-3ovo7px2vsa6n ................................................................................................................................. 2927 ct-3oy53m1qzl2s5 ................................................................................................................................. 2930 ct-3pc215bnwb6p7 ............................................................................................................................... 2933 ct-3pwbixz27n3tn .................................................................................................................................. 2942 ct-3qe6io8t6jtny .................................................................................................................................... 2943 ct-3r2ckznmt0a59 ................................................................................................................................. 2947 ct-3rcl9u1k017wu .................................................................................................................................. 2949 ct-3rd4781c2nnhp ................................................................................................................................. 2950 Version April 22, 2025 xii AMS Advanced Change Type Reference AMS Advanced Change Type Details ct-3rk1nl1ufn5g3 ................................................................................................................................... 2952 ct-3rqqu43krekby .................................................................................................................................. 2954 ct-3s3ik03uzw19t .................................................................................................................................. 2955 ct-3sk74t8igor0s .................................................................................................................................... 2957 ct-3skaisgnq0pf8 ................................................................................................................................... 2959 ct-3t4lifos8tu58 ..................................................................................................................................... 2961 ct-3u61cd4edns0x ................................................................................................................................. 2972 ct-3u9yd8jznb2zd .................................................................................................................................. 2988 ct-3va4bkrxb9z42 .................................................................................................................................. 2989 ct-3vfxkiudtovm9 .................................................................................................................................. 2991 ct-3w4lxdl3pqxob .................................................................................................................................. 2993 Document history ...................................................................................................................... 3010 Earlier updates ....................................................................................................................................... 3017 AWS Glossary ............................................................................................................................. 3061 Version April 22, 2025 xiii AMS Advanced Change Type Reference AMS Advanced Change Type Details What Are AMS Change Types? Welcome to the AWS Managed Services (AMS) Change Type Reference. Change Types are the method you use when submitting a request for change (RFC) to indicate what change you
ams-ct-003	ams-ct.pdf	3	Reference AMS Advanced Change Type Details ct-3rk1nl1ufn5g3 ................................................................................................................................... 2952 ct-3rqqu43krekby .................................................................................................................................. 2954 ct-3s3ik03uzw19t .................................................................................................................................. 2955 ct-3sk74t8igor0s .................................................................................................................................... 2957 ct-3skaisgnq0pf8 ................................................................................................................................... 2959 ct-3t4lifos8tu58 ..................................................................................................................................... 2961 ct-3u61cd4edns0x ................................................................................................................................. 2972 ct-3u9yd8jznb2zd .................................................................................................................................. 2988 ct-3va4bkrxb9z42 .................................................................................................................................. 2989 ct-3vfxkiudtovm9 .................................................................................................................................. 2991 ct-3w4lxdl3pqxob .................................................................................................................................. 2993 Document history ...................................................................................................................... 3010 Earlier updates ....................................................................................................................................... 3017 AWS Glossary ............................................................................................................................. 3061 Version April 22, 2025 xiii AMS Advanced Change Type Reference AMS Advanced Change Type Details What Are AMS Change Types? Welcome to the AWS Managed Services (AMS) Change Type Reference. Change Types are the method you use when submitting a request for change (RFC) to indicate what change you want and how it should be implemented. Change types have a four-part classiﬁcation scheme: category, subcategory, item, and operation, "CSIO" for short. The category and subcategory are higher-level concepts, and the item and operation specify an entity and the operation that is applied to the entity. For example, the change type that creates an EC2 instance has the classiﬁcation Deployment \| Advanced stack components \| EC2 stack \| Create, and the change type that requests administrative access to that instance has the classiﬁcation Management \| Access \| Stack admin access \| Grant. For more information about change types and requests for change (RFCs), see Change management in the AMS User Guide. This document provides a reference for all of the AMS change types. Any request for change (RFC) that you submit to AMS requires that you specify a change type. If none of the existing change types are appropriate for your request, you can use the Management \| Other \| Other \| Create or Management \| Other \| Other \| Update classiﬁcations. To learn more about using change types, see the following topics in the AMS User Guide: • Understanding Change Types • Understanding RFCs For example walkthroughs of each change type, see the Additional information section for the change type, Change Types by Classiﬁcation. For a comma-separated value ﬁle of change types, open this ZIP ﬁle: Change type CSV output ﬁle (output-12.2023.zip). Note At this time, AMS operates in these AWS Regions: US East (Virginia), US West (N. California), US West (Oregon), US East (Ohio), Canada (Central), South America (São Paulo), EU (Ireland), EU (Frankfurt), EU (London), EU (Paris), Asia Paciﬁc (Mumbai), Asia Paciﬁc (Seoul), Asia Paciﬁc (Singapore), Asia Paciﬁc (Sydney), Asia Paciﬁc (Tokyo) Version April 22, 2025 1 AMS Advanced Change Type Reference AMS Advanced Change Type Details New Regions are added frequently, however all API calls and CLI operations are run out of us-east-1. To learn more, see AWS Regions and availability zones. Version April 22, 2025 2 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Types by Classiﬁcation Current change type categories are Deployment and Mangement. The Deployment category contains change types that provision AMS resources including by copying or cloning. The Management category contains change types that operate on existing resources. Change Type Categories • Deployment Category • Management Category Deployment Category Change Type Subcategories in the Deployment Category • Advanced Stack Components Subcategory • AMS Patterns Subcategory • AMS Resource Scheduler Subcategory • Applications Subcategory • AWS Backup Subcategory • Directory Service Subcategory • Ingestion Subcategory • Managed Firewall Subcategory • Managed Landing Zone Subcategory • Monitoring and Notiﬁcation Subcategory • Patching Subcategory • Standalone Resources Subcategory • Standard Stacks Subcategory Advanced Stack Components Subcategory Change Type Items and Operations in the Advanced Stack Components Subcategory • ACM \| Create Private Certiﬁcate • ACM \| Create Public Certiﬁcate Deployment Version April 22, 2025 3 AMS Advanced Change Type Reference AMS Advanced Change Type Details • ACM Certiﬁcate With Additional SANs \| Create • AMI \| Copy • AMI \| Create • AMI \| Create from Auto Scaling Group • Application Load Balancer \| Create • Auto Scaling Group \| Create • Cache (ElastiCache Memcached) Stack \| Create • Cache (ElastiCache Redis) Stack \| Create • Database Migration Service (DMS) \| Create Replication Instance • Database Migration Service (DMS) \| Create Replication Subnet Group • Database Migration Service (DMS) \| Create Replication Task • Database Migration Service (DMS) \| Create Source Endpoint • Database Migration Service (DMS) \| Create Source Endpoint (MongoDB) • Database Migration Service (DMS) \| Create Source Endpoint (S3) • Database Migration Service (DMS) \| Create Target Endpoint • Database Migration Service (DMS) \| Create Target Endpoint (Kafka) • Database Migration Service (DMS) \| Create Target Endpoint (S3) • DNS (Private) \| Create • DNS (Public) \| Create • DynamoDB \| Create from Backup • EBS Snapshot \| Copy • EBS Snapshot \| Create • EBS Volume \| Create • EBS Volume \| Create from Backup • EC2 Stack \| Create • EC2 Stack \| Create (With Additional Volumes) • Elastic File System (EFS) \| Create • Elastic File System (EFS) \| Create from Backup • Identity and Access
ams-ct-004	ams-ct.pdf	4	• Database Migration Service (DMS) \| Create Target Endpoint • Database Migration Service (DMS) \| Create Target Endpoint (Kafka) • Database Migration Service (DMS) \| Create Target Endpoint (S3) • DNS (Private) \| Create • DNS (Public) \| Create • DynamoDB \| Create from Backup • EBS Snapshot \| Copy • EBS Snapshot \| Create • EBS Volume \| Create • EBS Volume \| Create from Backup • EC2 Stack \| Create • EC2 Stack \| Create (With Additional Volumes) • Elastic File System (EFS) \| Create • Elastic File System (EFS) \| Create from Backup • Identity and Access Management (IAM) \| Create Access Key • Identity and Access Management (IAM) \| Create Account Alias Advanced Stack Components Version April 22, 2025 4 AMS Advanced Change Type Reference AMS Advanced Change Type Details • Identity and Access Management (IAM) \| Create EC2 Instance Proﬁle • Identity and Access Management (IAM) \| Create Entity or Policy (Read-Write Permissions) • Identity and Access Management (IAM) \| Create Entity or Policy (Review Required) • Identity and Access Management (IAM) \| Create Lambda Execution Role • Identity and Access Management (IAM) \| Create OpenID Connect Provider • Identity and Access Management (IAM) \| Create SAML Identity Provider • Identity and Access Management (IAM) \| Create Service-Linked Role • Identity and Access Management (IAM) \| Create Service-Speciﬁc Credentials • KMS Alias \| Create • KMS Key \| Create • KMS Key \| Create (Review Required) • Listener \| Create (For ALB or NLB) • Load Balancer (ELB) Stack \| Create • Load Balancer (ELB) Stack \| Create (With Additional Listeners) • Network Load Balancer \| Create • OpenSearch \| Create Domain • RDS Database Stack \| Create • RDS Database Stack \| Create (For Aurora) • RDS Database Stack \| Create DB Subnet Group • RDS Database Stack \| Create from Backup • RDS Database Stack \| Create from Backup (For Aurora) • RDS Database Stack \| Create from Snapshot • RDS Database Stack \| Create Option Group (Review Required) • RDS Database Stack \| Create Parameter Group (Review Required) • RDS Snapshot \| Copy • RDS Snapshot \| Copy (For Aurora) • RDS Snapshot \| Create • RDS Snapshot \| Create (For Cluster) • Redshift \| Create (Cluster from Snapshot) • Redshift \| Create (Cluster Subnet Group) Advanced Stack Components Version April 22, 2025 5 AMS Advanced Change Type Reference • Redshift \| Create (Cluster) • S3 Access Point \| Create Access Point (Review Required) AMS Advanced Change Type Details • S3 Storage \| Create • S3 Storage \| Create Policy (Review Required) • Security Group \| Create • Security Group \| Create (Review Required) • Storage Gateway \| Create from Backup • Tag \| Create • Tag \| Create (Review Required) • Target Group \| Create (For ALB) • Target Group \| Create (For NLB) • VPC \| Add Static Route (Review Required) • VPC Endpoint (Interface) \| Create • VPN Gateway \| Create ACM \| Create Private Certiﬁcate Create a private AWS Certiﬁcate Manager (ACM) certiﬁcate with email or DNS validation. To create a public ACM certiﬁcate, use ct-3ll9hnadql9s1. Full classiﬁcation: Deployment \| Advanced stack components \| ACM \| Create private certiﬁcate Change Type Details Change type ID ct-0hu3q3957aghj 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 6 AMS Advanced Change Type Reference Additional Information Create ACM private certiﬁcate Creating a private ACM 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 ﬁlled in for you if
ams-ct-005	ams-ct.pdf	5	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 7 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 private ACM 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 8 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-0hu3q3957aghj" --change-type-version "2.0" --title "ACM_PRIVATE_CREATE" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-RequestACMCertificate\",\"Region\":\"eu-west-1\", \"Parameters\":{\"DomainName\":[\"www.test.com\"],\"CertificateType\":[\"Private\"], \"Route53DNSValidation\":[\"False\"],\"CertificateAuthorityArn\":[\"arn:aws:acm-pca:eu- west-1:000000000000:certificate-authority/6a06b611-xxxx-xxxx-xxxx-80cbff8e0000\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateAcmPrivateParams.json. aws amscm get-change-type-version --change-type-id "ct-0hu3q3957aghj" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAcmPrivateParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-RequestACMCertificateV2", "Region": "eu-west-1", "Parameters": { "DomainName": [ "www.test.com" ], "CertificateType": [ "Private" ], "Route53DNSValidation": [ "False" ], "CertificateAuthorityArn": [ "arn:aws:acm-pca:eu-west-1:000000000000:certificate-authority/6a06b611- xxxx-xxxx-xxxx-80cbff8e0000" ] Advanced Stack Components Version April 22, 2025 9 AMS Advanced Change Type Reference AMS Advanced Change Type Details } } 3. Output the RFC template to a ﬁle in your current folder; this example names it CreateAcmPrivateRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateAcmPrivateRfc.json 4. Modify and save the CreateAcmPrivateRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-0hu3q3957aghj", "ChangeTypeVersion": "2.0", "Title": "ACM-Create-Private-RFC" } 5. Create the RFC, specifying the CreateAcmPrivateRfc ﬁle and the CreateAcmPrivateParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateAcmPrivateRfc.json --execution- parameters file://CreateAcmPrivateParams.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 ACM certiﬁcates, see What Is AWS Certiﬁcate Manager? and ACM Certiﬁcate Characteristic. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0hu3q3957aghj. Example: Required Parameters { "DocumentName": "AWSManagedServices-RequestACMCertificateV2", "Region": "us-east-1", Advanced Stack Components Version April 22, 2025 10 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Parameters": { "DomainName": "www.example-1.com", "CertificateAuthorityArn": "arn:aws:acm-pca:us-east-1:000000000000:certificate- authority/c45863f3-705e-45f6-a3d0-421cf3788800" } } Example: All Parameters { "DocumentName": "AWSManagedServices-RequestACMCertificateV2", "Region": "us-east-1", "Parameters": { "DomainName": "www.example-1.com", "CertificateType": "Private", "CertificateAuthorityArn": "arn:aws:acm-pca:us-east-1:000000000000:certificate- authority/c45863f3-705e-45f6-a3d0-421cf3788800", "SubjectAlternativeNames": [ "www.example-1.com", "www.example-2.com" ], "Route53DNSValidation": "False" } } ACM \| Create Public Certiﬁcate Create a public AWS Certiﬁcate Manager (ACM) certiﬁcate with email or DNS validation. To create a private ACM certiﬁcate, use ct-0hu3q3957aghj. Full classiﬁcation: Deployment \| Advanced stack components \| ACM \| Create public
ams-ct-006	ams-ct.pdf	6	ct-0hu3q3957aghj. Example: Required Parameters { "DocumentName": "AWSManagedServices-RequestACMCertificateV2", "Region": "us-east-1", Advanced Stack Components Version April 22, 2025 10 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Parameters": { "DomainName": "www.example-1.com", "CertificateAuthorityArn": "arn:aws:acm-pca:us-east-1:000000000000:certificate- authority/c45863f3-705e-45f6-a3d0-421cf3788800" } } Example: All Parameters { "DocumentName": "AWSManagedServices-RequestACMCertificateV2", "Region": "us-east-1", "Parameters": { "DomainName": "www.example-1.com", "CertificateType": "Private", "CertificateAuthorityArn": "arn:aws:acm-pca:us-east-1:000000000000:certificate- authority/c45863f3-705e-45f6-a3d0-421cf3788800", "SubjectAlternativeNames": [ "www.example-1.com", "www.example-2.com" ], "Route53DNSValidation": "False" } } ACM \| Create Public Certiﬁcate Create a public AWS Certiﬁcate Manager (ACM) certiﬁcate with email or DNS validation. To create a private ACM certiﬁcate, use ct-0hu3q3957aghj. Full classiﬁcation: Deployment \| Advanced stack components \| ACM \| Create public certiﬁcate Change Type Details Change type ID ct-3ll9hnadql9s1 Current version 2.0 Expected execution duration 60 minutes AWS approval Required Advanced Stack Components Version April 22, 2025 11 AMS Advanced Change Type Reference AMS Advanced Change Type Details Customer approval Not required Execution mode Automated Additional Information Create ACM public certiﬁcate Creating a public ACM with the Console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Advanced Stack Components Version April 22, 2025 12 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 public ACM 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 13 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-3ll9hnadql9s1" --change-type-version "1.0" --title "ACM-PUBLIC-CREATE" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-RequestACMCertificate\",\"Region\":\"us-east-1\",\"Parameters \":{\"DomainName\":[\"www.testing.com\"],\"ValidationMethod\":[\"EMAIL\"], \"CertificateType\":[\"Public\"],\"ValidationDomain\":[\"\"],\"Route53DNSValidation\": [\"False\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateAcmPublicParams.json. aws amscm get-change-type-version --change-type-id "ct-3ll9hnadql9s1" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAcmPublicParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-RequestACMCertificate", "Region": "us-east-1", "Parameters": { "DomainName": [ "www.testing.com" ], "ValidationMethod":
ams-ct-007	ams-ct.pdf	7	(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-3ll9hnadql9s1" --change-type-version "1.0" --title "ACM-PUBLIC-CREATE" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-RequestACMCertificate\",\"Region\":\"us-east-1\",\"Parameters \":{\"DomainName\":[\"www.testing.com\"],\"ValidationMethod\":[\"EMAIL\"], \"CertificateType\":[\"Public\"],\"ValidationDomain\":[\"\"],\"Route53DNSValidation\": [\"False\"]}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateAcmPublicParams.json. aws amscm get-change-type-version --change-type-id "ct-3ll9hnadql9s1" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAcmPublicParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-RequestACMCertificate", "Region": "us-east-1", "Parameters": { "DomainName": [ "www.testing.com" ], "ValidationMethod": [ "EMAIL" ], "CertificateType": [ "Public" Advanced Stack Components Version April 22, 2025 14 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "ValidationDomain": [ "DOMAIN" ], "Route53DNSValidation": [ "False" ] } } 3. Output the RFC template to a ﬁle in your current folder; this example names it CreateAcmPublicRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateAcmPublicRfc.json 4. Modify and save the CreateAcmPublicRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-3ll9hnadql9s1", "ChangeTypeVersion": "1.0", "Title": "ACM-Create-Public-RFC" } 5. Create the RFC, specifying the CreateAcmPublicRfc ﬁle and the CreateAcmPublicParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateAcmPublicRfc.json --execution- parameters file://CreateAcmPublicParams.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 set to EMAIL, ACM sends validation email to the following ﬁve common system addresses where your_domain is the domain name you entered when you initially requested a certiﬁcate and .com is the top-level domain. • administrator@your_domain.com Advanced Stack Components Version April 22, 2025 15 AMS Advanced Change Type Reference AMS Advanced Change Type Details • hostmaster@your_domain.com • postmaster@your_domain.com • webmaster@your_domain.com • admin@your_domain.com If set to DNS, ACM provides you one or more CNAME records to add into your DNS database, ACM uses CNAME records to validate that you own or control a domain. If the Route53DNSValidation parameter is set to true and the ACM certiﬁcate and Route53 are in same AWS account, then the CNAME records is added automatically for the validation. If the Route53DNSValidation parameter is set to false (in the case of a third party DNS Provider), the CNAME records are stored in AWS Secrets Manager. Add the CNAME records to the DNS database manually. To learn more about ACM certiﬁcates, see What Is AWS Certiﬁcate Manager? and ACM Certiﬁcate Characteristic. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3ll9hnadql9s1. Example: Required Parameters { "DocumentName": "AWSManagedServices-RequestACMCertificateV2", "Region": "us-east-1", "Parameters": { "DomainName": "www.example.com", "ValidationMethod": "DNS" } } Example: All Parameters { "DocumentName": "AWSManagedServices-RequestACMCertificateV2", "Region": "us-east-1", Advanced Stack Components Version April 22, 2025 16 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Parameters": { "DomainName": "www.example.com", "CertificateType": "Public", "ValidationMethod": "DNS", "ValidationDomain": "www.example.com", "SubjectAlternativeNames": [ "www.example1.com", "www.example2.com" ], "Route53DNSValidation": "False" } } ACM Certiﬁcate With Additional SANs \| Create ACM Certiﬁcate with additional SANs Full classiﬁcation: Deployment \| Advanced stack components \| ACM Certiﬁcate with additional SANs \| Create Change Type Details Change type ID ct-3l14e139i5p50 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create ACM certiﬁcate with additional SANs Creating an ACM with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 17 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 ﬁlled in for you if you choose your CT in the Browse change
ams-ct-008	ams-ct.pdf	8	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. Advanced Stack Components Version April 22, 2025 18 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When ﬁnished, 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 conﬁgurations 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 ACM 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 19 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: All parameters: aws amscm create-rfc --title test-acm-certificate --change-type-id ct-3l14e139i5p50 --change-type-version 1.0 --execution-parameters '{ "Description": "Create an ACM certificate", "VpcId": "VPC_ID", "Name": "Create an ACM certificate", "StackTemplateId": "stm-ftu71ma6q29bvulv0", "Parameters": { "DomainName": ".example.com", "ValidationDomain": "example.com", "SubjectAlternativeName1": ".example-domain.com", "SubjectAlternativeNameValidationDomain1": "example-domain.com", "SubjectAlternativeName2": ".example.net", "SubjectAlternativeNameValidationDomain2": "example.net", "SubjectAlternativeName3": ".example-domain.net", "SubjectAlternativeNameValidationDomain3": "example-domain.net", "SubjectAlternativeName4": ".example.org", "SubjectAlternativeNameValidationDomain4": "example.org", "SubjectAlternativeName5": ".example-domain.org", "SubjectAlternativeNameValidationDomain5": "example- domain.org" }, "TimeoutInMinutes": 60 }' Only required parameters: aws amscm create-rfc --title test-acm-certificate --change-type-id ct-3l14e139i5p50 --change-type-version 1.0 --execution-parameters '{ "Description": "Create an ACM certificate", "VpcId": "VPC_ID", "Name": "Create an ACM certificate", "StackTemplateId": "stm-ftu71ma6q29bvulv0", "Parameters": { "DomainName": "*.example.com" }, "TimeoutInMinutes": 60 }' TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateAcmParams.json. aws amscm get-change-type-version --change-type-id "ct-3l14e139i5p50" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAcmParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "VpcId": "VPC_ID", "StackTemplateId": "stm-ftu71ma6q29bvulv0", Advanced Stack Components Version April 22, 2025 20 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DomainName": "DOMAIN_NAME" } 3. Output the RFC template to a ﬁle in your current folder; this example names it CreateAcmRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateAcmRfc.json 4. Modify and save the CreateAcmRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-3l14e139i5p50", "ChangeTypeVersion": "1.0", "Title": "ACM-Create-RFC" } 5. Create the RFC, specifying the CreateAcmRfc ﬁle and the CreateAcmParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateAcmRfc.json --execution- parameters file://CreateAcmParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note The timeout setting isn't only about execution, but also your validation of the ACM certiﬁcate through email validation. Without your validation, the RFC fails. To learn more about ACM certiﬁcates, see What Is AWS Certiﬁcate Manager? and ACM Certiﬁcate Characteristics. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3l14e139i5p50. Advanced Stack Components Version April 22, 2025 21 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters Example
ams-ct-009	ams-ct.pdf	9	and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note The timeout setting isn't only about execution, but also your validation of the ACM certiﬁcate through email validation. Without your validation, the RFC fails. To learn more about ACM certiﬁcates, see What Is AWS Certiﬁcate Manager? and ACM Certiﬁcate Characteristics. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3l14e139i5p50. Advanced Stack Components Version April 22, 2025 21 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters Example not available. Example: All Parameters { "Description": "This is a test description", "Name": "Test Stack", "Parameters": { "DomainName": "example.com", "ValidationDomain": "example.com", "SubjectAlternativeName1": "domain-1.example.com", "SubjectAlternativeNameValidationDomain1": "domain-1.example.com", "SubjectAlternativeName2": "domain-2.example.com", "SubjectAlternativeNameValidationDomain2": "domain-2.example.com", "SubjectAlternativeName3": "domain-3.example.com", "SubjectAlternativeNameValidationDomain3": "domain-3.example.com", "SubjectAlternativeName4": "domain-4.example.com", "SubjectAlternativeNameValidationDomain4": "domain-4.example.com", "SubjectAlternativeName5": "domain-5.example.com", "SubjectAlternativeNameValidationDomain5": "domain-5.example.com" }, "StackTemplateId": "stm-ftu71ma6q29bvulv0", "TimeoutInMinutes": 60, "VpcId": "vpc-01234567890abcdef" } AMI \| Copy Copy an Amazon Machine Image (AMI) in your AMS account. Full classiﬁcation: Deployment \| Advanced stack components \| AMI \| Copy Change Type Details Change type ID ct-046aizcwg5idf Current version 1.0 Expected execution duration 60 minutes Advanced Stack Components Version April 22, 2025 22 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS approval Required Customer approval Not required Execution mode Automated Additional Information Copy an AMI Copying 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. • 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 23 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Copying an 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 24 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
ams-ct-010	ams-ct.pdf	10	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 24 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-046aizcwg5idf" --change-type-version "1.0" -- title "Copy AMI" --execution-parameters "{\"DocumentName\":\"AWSManagedServices-CopyAMI \",\"Region\":\"us-east-1\",\"Parameters\":{\"Name\":[\"AmiName\"],\"SourceImageId \":[\"ami-1234567890abcdef0\"],\"SourceRegion\":[\"ap-southeast-2\"],\"Encrypted\": [\"True\"],\"KmsKeyId\":[\"01234567-abcd-abcd-abcd-0123456789ab\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; this example names it CopyAmiParams.json: aws amscm get-change-type-version --change-type-id "ct-046aizcwg5idf" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CopyAmiParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CopyAMI", "Region": "us-east-1", "Parameters": { "Name": [ "AmiName" ], "SourceImageId": [ "ami-1234567890abcdef0" ], "SourceRegion": [ "ap-southeast-2" ], "Encrypted": [ Advanced Stack Components Version April 22, 2025 25 AMS Advanced Change Type Reference AMS Advanced Change Type Details "True" ], "KmsKeyId": [ "01234567-abcd-abcd-abcd-0123456789ab" ] } } 3. Output the RFC template JSON ﬁle; this example names it CopyAmiRfc.json: aws amscm create-rfc --generate-cli-skeleton > CopyAmiRfc.json 4. Modify and save the CopyAmiRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-046aizcwg5idf", "Title": "Copy AMI" } 5. Create the RFC, specifying the CopyAmiRfc ﬁle and the CopyAmiParams ﬁle: aws amscm create-rfc --cli-input-json file://CopyAmiRfc.json --execution- parameters file://CopyAmiParams.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 copying AMIs, see Copying an AMI. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-046aizcwg5idf. Example: Required Parameters { "DocumentName": "AWSManagedServices-CopyAMI", Advanced Stack Components Version April 22, 2025 26 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters": { "Name": [ "AmiName" ], "SourceImageId": [ "ami-1234567890abcdef0" ], "SourceRegion": [ "ap-southeast-2" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-CopyAMI", "Region": "us-east-1", "Parameters": { "Name": [ "AmiName" ], "SourceImageId": [ "ami-1234567890abcdef0" ], "SourceRegion": [ "ap-southeast-2" ], "Encrypted": [ "True" ], "KmsKeyId": [ "arn:aws:kms:us-west-2:111122223333:key/01234567-abcd-abcd-abcd-0123456789ab" ] } } AMI \| Create Create an Amazon Machine Image (AMI) based on an existing standalone EC2 instance in your AMS account. The instance must be in the stopped state before running this change type. Advanced Stack Components Version April 22, 2025 27 AMS Advanced Change Type Reference AMS Advanced Change Type Details Full classiﬁcation: Deployment \| Advanced stack components \| AMI \| Create Change Type Details Change type ID ct-3rqqu43krekby Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create an AMI Creating an AMI with the console The following shows this change type in the AMS console. Advanced Stack Components Version April 22, 2025 28 AMS Advanced Change Type Reference AMS Advanced Change Type Details Important Before you begin, prepare the EC2 instance that you will use to create the AMI. Without proper preparation, the create AMI RFC is likely to be rejected or fail. For information about preparing your instance to successfully create an AMI, see the instructions included in this tutorial. 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 ﬁlled in for you if you choose your CT in the Browse change
ams-ct-011	ams-ct.pdf	11	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 29 AMS Advanced Change Type Reference AMS Advanced Change Type Details Creating 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-3rqqu43krekby" --change-type-version "2.0" --title "AMI-Create-IC" -- execution-parameters "{\"AMIName\":\"MyAmi\",\"VpcId\":\"VPC_ID\",\"EC2InstanceId\": \"INSTANCE_ID\"}" TEMPLATE CREATE: Advanced Stack Components Version April 22, 2025 30 AMS Advanced Change Type Reference AMS Advanced Change Type Details 1. Output the execution parameters JSON schema for this change type to a ﬁle; this example names it CreateAmiParams.json: aws amscm get-change-type-version --change-type-id "ct-3rqqu43krekby" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAmiParams.json 2. Modify and save the execution parameters CreateAmiParams.json ﬁle. For example, you can replace the contents with something like this: { "AMIName": "My-AMI", "InstanceId": "EC2_INSTANCE_ID" } 3. Output the RFC template JSON ﬁle to a ﬁle in your current folder; this example names it CreateAmiRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateAmiRfc.json 4. Modify and save the CreateAmiRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-3rqqu43krekby", "ChangeTypeVersion": "2.0", "Title": "AMI-Create-RFC" } 5. Create the RFC, specifying the CreateAmiRfc ﬁle and the CreateAmiParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateAmiRfc.json --execution- parameters file://CreateAmiParams.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 31 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note After you have created a custom AMI, you can submit a service request to AMS to have your existing EC2 Auto Scaling group use the new AMI. For information about creating a service request, see Service Request Examples. Important Before you begin, prepare the EC2 instance that you will use to create the AMI. Without proper preparation, the create AMI RFC is likely to be rejected or fail. To avoid authentication issues from instances created from the new AMI, run these system commands on the instance after applying custom changes, and prior to calling the Create AMI CT. Important If the speciﬁed instance isn't stopped and separated from its current domain, the AMI creation RFC fails. Prepare the instance as described. For more information, see Create a Standard Amazon Machine Image Using Sysprep. You can subscribe to an AMS SNS AMI notiﬁcation topic to receive an alert whenever new AMS AMIs
ams-ct-012	ams-ct.pdf	12	create the AMI. Without proper preparation, the create AMI RFC is likely to be rejected or fail. To avoid authentication issues from instances created from the new AMI, run these system commands on the instance after applying custom changes, and prior to calling the Create AMI CT. Important If the speciﬁed instance isn't stopped and separated from its current domain, the AMI creation RFC fails. Prepare the instance as described. For more information, see Create a Standard Amazon Machine Image Using Sysprep. You can subscribe to an AMS SNS AMI notiﬁcation topic to receive an alert whenever new AMS AMIs of interest to you are deployed. For more information, see AMS AMI Notiﬁcation Service. 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 Advanced Stack Components Version April 22, 2025 32 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note: 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 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 need user data to be executed on the next boot from your AMI, ensure the following: • Registry Key HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\ManagedServices \RunUserDataViaAMSBootModule is present; if that key is not present, user data will not be run next time. • To enable user data to be run on next boot: 1. Start a Windows PowerShell under administrator privilege (run as administrator) 2. Run the following command: Install-AMSDependencies For information about failed AMI Create RFCs, see RFC failure troubleshooting. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3rqqu43krekby. Example: Required Parameters { "InstanceId": "i-01234567890abcdef", Advanced Stack Components Version April 22, 2025 33 AMS Advanced Change Type Reference AMS Advanced Change Type Details "AmiName": "MyAMI" } Example: All Parameters { "InstanceId": "i-12345678", "AmiName": "MyAMI", "AmiTags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ] } AMI \| Create from Auto Scaling Group Create an Amazon Machine Image (AMI) from an EC2 Instance in an Auto Scaling group. Full classiﬁcation: Deployment \| Advanced stack components \| AMI \| Create from Auto Scaling group Change Type Details Change type ID ct-3e3prksxmdhw8 Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 34 AMS Advanced Change Type Reference Additional Information Create AMIs from Auto Scaling groups (ASGs) Creating an AMI from an ASG with the console The following shows this change type in the AMS console. AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 35 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update
ams-ct-013	ams-ct.pdf	13	types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 35 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 AMI from an ASG 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 36 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 --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-3e3prksxmdhw8" --change-type-version "2.0" --title "AMI-Create-IC" -- execution-parameters "{\"AMIName\":\"MyAmi\",\"VpcId\":\"VPC_ID\",\"EC2InstanceId\": \"INSTANCE_ID\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; this example names it CreateAmiFromAsgParams.json: aws amscm create-rfc --change-type-id "ct-3e3prksxmdhw8" --change-type-version "1.0" --title "Create AMI from an Auto Scaling group" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateAmiInAutoScalingGroup\",\"Region \": \"us-east-1\",\"Parameters\": {\"AutoScalingGroupName\": [\"stack-ab0123cdef- ASG-1ABC2345\"],\"Sysprep\": [\"False\"],\"StopInstance\": [\"False\"]}}" 2. Modify and save the execution parameters CreateAmiFromAsgParams.json ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateAmiInAutoScalingGroup", "Region": "us-east-1", "Parameters": { "AutoScalingGroupName": [ "stack-ab0123cdef-ASG-1ABC2345" ], "Sysprep": [ "False" ], "StopInstance": [ "False" ] } } Advanced Stack Components Version April 22, 2025 37 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. Output the RFC template JSON ﬁle to a ﬁle in your current folder; this example names it CreateAmiFromAsgRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateAmiFromAsgRfc.json 4. Modify and save the CreateAmiFromAsgRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3e3prksxmdhw8", "Title": "Create AMI from an Auto Scaling group" } 5. Create the RFC, specifying the CreateAmiFromAsgRfc ﬁle and the CreateAmiFromAsgParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateAmiFromAsgRfc.json --execution- parameters file://CreateAmiFromAsgParams.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 After you have created a custom AMI, you can submit a service request to AMS to have your existing EC2 Auto Scaling group use the new AMI. For information about creating a service request, see Service Request Examples. For information about failed AMI Create RFCs, see RFC failure troubleshooting. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3e3prksxmdhw8. Advanced Stack Components Version April 22, 2025 38 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "DocumentName" : "AWSManagedServices-CreateAmiInAutoScalingGroup", "Region" : "us-east-1", "Parameters" : { "AutoScalingGroupName" : [ "TestASG" ], "Sysprep" : [ "False" ], "StopInstance" : [ "False" ] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateAmiInAutoScalingGroup", "Region" : "us-east-1", "Parameters" : { "AutoScalingGroupName" : [ "TestASG" ], "Sysprep" : [ "False" ], "StopInstance" : [ "False" ] } } Application Load Balancer \| Create Create an AWS Application Load Balancer (ALB), with additional listeners. Full classiﬁcation: Deployment \| Advanced stack components \| Application Load Balancer \| Create Advanced Stack Components Version April 22, 2025 39 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-111r1yayblnw4 Current version 3.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution
ams-ct-014	ams-ct.pdf	14	} Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateAmiInAutoScalingGroup", "Region" : "us-east-1", "Parameters" : { "AutoScalingGroupName" : [ "TestASG" ], "Sysprep" : [ "False" ], "StopInstance" : [ "False" ] } } Application Load Balancer \| Create Create an AWS Application Load Balancer (ALB), with additional listeners. Full classiﬁcation: Deployment \| Advanced stack components \| Application Load Balancer \| Create Advanced Stack Components Version April 22, 2025 39 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-111r1yayblnw4 Current version 3.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create application load balancer (ALB) Creating 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. 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 40 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 41 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 notiﬁcations 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-111r1yayblnw4" --change-type-version "3.0" --title 'Create ALB' --description "My Test ALB" --execution-parameters ""{\"Description\":\"Test ALB\",\"VpcId\": \"VPC_ID\",\"Name\":\"TestStack\",\"StackTemplateId\":\"stm-sd7uv500000000000\", \"TimeoutInMinutes\":360,\"LoadBalancer\":{\"SecurityGroups\":[\"SG_ID\"],\"SubnetIds \":[\"SUBNET_ID\",\"SUBNET_ID\"]},\"Listener1\":{\"Port\":\"443\",\"Protocol\": \"HTTPS\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON ﬁle. 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 > CreateAlbParams.json 2. Modify and save the CreateAlbParams ﬁle. For example: { "Description": "ALB-Create", "VpcId": "VPC_ID", "Name": "My-ALB", "StackTemplateId": "stm-sd7uv500000000000", "TimeoutInMinutes" : 360, Advanced Stack Components Version April 22, 2025 42 AMS Advanced Change Type Reference AMS Advanced Change Type Details "LoadBalancer" : { "SecurityGroups" : ["SG_ID"], "SubnetIds" : ["SUBNET_ID", "SUBNET_ID"] }, "Listener1" :
ams-ct-015	ams-ct.pdf	15	Test ALB" --execution-parameters ""{\"Description\":\"Test ALB\",\"VpcId\": \"VPC_ID\",\"Name\":\"TestStack\",\"StackTemplateId\":\"stm-sd7uv500000000000\", \"TimeoutInMinutes\":360,\"LoadBalancer\":{\"SecurityGroups\":[\"SG_ID\"],\"SubnetIds \":[\"SUBNET_ID\",\"SUBNET_ID\"]},\"Listener1\":{\"Port\":\"443\",\"Protocol\": \"HTTPS\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON ﬁle. 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 > CreateAlbParams.json 2. Modify and save the CreateAlbParams ﬁle. For example: { "Description": "ALB-Create", "VpcId": "VPC_ID", "Name": "My-ALB", "StackTemplateId": "stm-sd7uv500000000000", "TimeoutInMinutes" : 360, Advanced Stack Components Version April 22, 2025 42 AMS Advanced Change Type Reference AMS Advanced Change Type Details "LoadBalancer" : { "SecurityGroups" : ["SG_ID"], "SubnetIds" : ["SUBNET_ID", "SUBNET_ID"] }, "Listener1" : { "Port" : "443", "Protocol" : "HTTPS" } } 3. Output the RFC template to a ﬁle in your current folder. For example, you can replace the contents with something like this: aws amscm create-rfc --generate-cli-skeleton > CreateAlbRfc.json 4. Modify and save the CreateAlbRfc.json ﬁle. For example: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-111r1yayblnw4", "Title": "ALB-Create-RFC" } 5. Create the RFC, specifying the CreateAlbRfc ﬁle and the CreateAlbParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateAlbRfc.json --execution- parameters file://CreateAlbParams.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 As of version 3.0, you can also conﬁgure four CloudWatch alarms with customized alarm thresholds. Advanced Stack Components Version April 22, 2025 43 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note To open ports and associate all the load balancer resources, submit a Management \| Advanced stack components \| Security groups \| Update RFC. To learn more about AWS Application Load Balancers, see What Is an Application Load Balancer? To create an Application Load Balancer listener, see Target Group \| Create (For ALB). To create an Application Load Balancer target group, see Create ALB target group. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-111r1yayblnw4. Example: Required Parameters { "Description" : "Test description", "VpcId" : "vpc-1234567890abcdef0", "Name" : "TestStack", "StackTemplateId" : "stm-sd7uv500000000000", "TimeoutInMinutes" : 360, "LoadBalancer" : { "SecurityGroups" : ["sg-1234567890abcdef0"], "SubnetIds" : ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"] }, "Listener1" : { "Port" : "443", "Protocol" : "HTTPS" } } Example: All Parameters { "Description" : "Test description", "VpcId" : "vpc-1234567890abcdef0", "Name" : "TestStack", "Tags" : [ { Advanced Stack Components Version April 22, 2025 44 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Key" : "foo", "Value" : "bar" } ], "StackTemplateId" : "stm-sd7uv500000000000", "TimeoutInMinutes" : 360, "LoadBalancer" : { "Name" : "MyLoadBalancer", "SecurityGroups" : ["sg-1234567890abcdef0"], "SubnetIds" : ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"], "Public" : "true", "DeletionProtection" : "false", "IdleTimeout" : "60" }, "Listener1" : { "Port" : "443", "Protocol" : "HTTPS", "SSLCertificateArn" : "arn:aws:acm:ap-southeast-2:012345678912:certificate/ e23c3545-e92d-4542-83b8-63483505b5a5", "SSLPolicy" : "ELBSecurityPolicy-TLS-1-2-Ext-2018-06" }, "Listener2" : { "Port" : "8080", "Protocol" : "HTTP" }, "TargetGroup" : { "Name" : "MyTargetGroup", "HealthCheckInterval" : "10", "HealthCheckPath" : "/thing/index.html", "HealthCheckPort" : "8080", "HealthCheckProtocol" : "HTTP", "HealthCheckTimeout" : "10", "HealthyThreshold" : "2", "UnhealthyThreshold" : "10", "ValidHTTPCode" : "200", "TargetPort" : "80", "TargetProtocol" : "HTTP", "DeregistrationDelayTimeout" : "300", "SlowStartDuration" : "30", "CookieExpirationPeriod" : "20", "TargetType" : "instance" }, "HealthyHostsAlarm": { "EvaluationPeriods": "10", Advanced Stack Components Version April 22, 2025 45 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Period": "120", "Threshold": "1.0" }, "HTTPCodeELB5XXCountAlarm": { "EvaluationPeriods": "5", "Period": "360", "Threshold": "2.0" }, "TargetConnectionErrorsAlarm": { "EvaluationPeriods": "5", "Period": "360", "Threshold": "2.0" }, "RejectedConnectionCountAlarm": { "EvaluationPeriods": "10", "Period": "120", "Threshold": "1.0" } } Auto Scaling Group \| Create Use to create an Auto Scaling group, the launch conﬁguration to use to create new instances when needed, and CloudWatch metrics and alarms for the group. Full classiﬁcation: Deployment \| Advanced stack components \| Auto Scaling group \| Create Change Type Details Change type ID ct-2tylseo8rxfsc Current version 4.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 46 AMS Advanced Change Type Reference Additional Information Create Auto Scaling groups Creating an Auto Scaling group with the console AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC
ams-ct-016	ams-ct.pdf	16	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 47 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 48 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE: 1. 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: Required parameters only: aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-2tylseo8rxfsc" --change-type-version "3.0" --title "ASG-Create-QC" --execution- parameters "{\"Description\":\"Create a new ASG\",\"VpcId\":\"VPC_ID\",\"Name\": \"MyASG\",\"TimeoutInMinutes\":360,\"Parameters\":{\"InstanceAmiId\":\"AMI_ID\", \"InstanceSubnetId\":\"SUBNET_ID\"}}" Most parameters, except Tags and UserData: aws --profile saml amscm create-rfc --change-type-id "ct-2tylseo8rxfsc" -- change-type-version "3.0" --title "Stack-Create-ASG-IC" --execution-parameters "{\"Description\":\"MyTestASG\",\"VpcId\":\"VPC_ID\",\"StackTemplateId \":\"stm-suw38u20000000000\",\"Name\":\"MyTestASG\",\"TimeoutInMinutes \":60,\"Parameters\":{\"ASGAmiId\":\"ami-0021317f\",\"ASGCooldown\":300, \"ASGDesiredCapacity\":1,\"ASGEBSOptimized\":false,\"ASGHealthCheckGracePeriod \":1800,\"ASGIAMInstanceProfile\":\"customer-mc-ec2-instance-profile\", \"ASGInstanceDetailedMonitoring\":true,\"ASGInstanceRootVolumeIops\":0, \"ASGInstanceRootVolumeName\":\"TEST\",\"ASGInstanceRootVolumeType\": \"standard\",\"ASGInstanceType\":\"m4.large\",\"ASGMaxInstances\":1, \"ASGMinInstances\":1,\"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\":[\"SUBNET1_ID\",\"SUBNET2_ID\"], \"ASGUserData\":\"\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle in your current folder; this example names it CreateAsgParams.json: Advanced Stack Components Version April 22, 2025 49 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm get-change-type-version --change-type-id "ct-2tylseo8rxfsc" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateAsgParams.json 2. Modify and save the schema as follows. For example, you can replace the contents with something like this: 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 run before returning a ﬁnal status of success or failure. { "Description": "Create_WordPress_ASG", "VpcId": "VPC_ID", "StackTemplateId": "stm-suw38u00000000000", "Name": "WP_ASG", "Tags": [{"Key": "Name","Value": "WP_ASG"}], "TimeoutInMinutes": 60, "ASGAmiId": "AMI_ID", "ASGLoadBalancerNames": ["ELB_NAME"], "ASGSubnetIds": ["PRIVATE_AZ1", "PRIVATE_AZ2"], "ASGUserData": "#!/bin/bash \n REGION=$(curl 169.254.169.254/latest/meta-data/placement/ availability-zone/ \| sed 's/[a-z]$//') \n yum -y install ruby httpd \n chkconfig httpd on \n service httpd start \n touch /var/www/html/status \n cd /tmp \n curl -O https://aws-codedeploy-$REGION.s3.amazonaws.com/latest/ install \n chmod +x ./install \n ./install auto \n chkconfig codedeploy-agent on \n service codedeploy-agent start" } Advanced Stack Components Version April 22, 2025 50 AMS Advanced Change Type Reference
ams-ct-017	ams-ct.pdf	17	the UserData script commands to run before returning a ﬁnal status of success or failure. { "Description": "Create_WordPress_ASG", "VpcId": "VPC_ID", "StackTemplateId": "stm-suw38u00000000000", "Name": "WP_ASG", "Tags": [{"Key": "Name","Value": "WP_ASG"}], "TimeoutInMinutes": 60, "ASGAmiId": "AMI_ID", "ASGLoadBalancerNames": ["ELB_NAME"], "ASGSubnetIds": ["PRIVATE_AZ1", "PRIVATE_AZ2"], "ASGUserData": "#!/bin/bash \n REGION=$(curl 169.254.169.254/latest/meta-data/placement/ availability-zone/ \| sed 's/[a-z]$//') \n yum -y install ruby httpd \n chkconfig httpd on \n service httpd start \n touch /var/www/html/status \n cd /tmp \n curl -O https://aws-codedeploy-$REGION.s3.amazonaws.com/latest/ install \n chmod +x ./install \n ./install auto \n chkconfig codedeploy-agent on \n service codedeploy-agent start" } Advanced Stack Components Version April 22, 2025 50 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. Output the JSON template for CreateRfc to a ﬁle in your current folder; example names it CreateAsgRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateAsgRfc.json 4. Modify and save the JSON ﬁle as follows. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "3.0", "ChangeTypeId": "ct-2tylseo8rxfsc", "Title": "ASG-For-WP-Stack-RFC" } 5. Create the RFC, specifying the CreateAsgRfc ﬁle and the execution parameters ﬁle: aws amscm create-rfc --cli-input-json file://CreateAsgRfc.json --execution- parameters file://CreateAsgParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. To learn more, see Amazon Auto Scaling. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2tylseo8rxfsc. Example: Required Parameters { Advanced Stack Components Version April 22, 2025 51 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "StackTemplateId": "stm-suw38u40000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "ASGAmiId": "ami-1234567890abcdef0", "ASGSubnetIds": ["subnet-1234567890abcdef0", "subnet-1234567890abcdef1"] } } Example: All Parameters { "Description": "This is a test description", "VpcId": "vpc-1234abcd", "StackTemplateId": "stm-suw38u40000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "ASGAmiId": "ami-12345678", "ASGCooldown": 300, "ASGDesiredCapacity": 1, Advanced Stack Components Version April 22, 2025 52 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ASGEBSOptimized": false, "ASGIAMInstanceProfile": "customer-mc-ec2-instance-profile", "ASGInstanceDetailedMonitoring": false, "ASGInstanceRootVolumeIops": 0, "ASGInstanceRootVolumeName": "/dev/xvda", "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-1234abcd", "subnet-1a2b3c4d"], "ASGUserData": "pwd\nls -ltrh\necho \"Hello, World\"" } } Cache (ElastiCache Memcached) Stack \| Create Use to create an Amazon ElastiCache cluster (one or more cache nodes) that uses the Memcached engine, and specify CloudWatch metrics and alarms for the cluster. Full classiﬁcation: Deployment \| Advanced stack components \| Cache (ElastiCache Memcached) stack \| Create Advanced Stack Components Version April 22, 2025 53 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-0xi6q7uwuwrqe Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create ElastiCache Memcached stack Creating a Memcached ElastiCache 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 54 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution
ams-ct-018	ams-ct.pdf	18	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 Memcached ElastiCache 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 55 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 notiﬁcations 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-0xi6q7uwuwrqe" --change-type-version "1.0" -- execution-parameters "{\"Description\":\"Test description\",\"VpcId\":\"VPC_ID\",\"Name \":\"TEST_MEMCACHE\",\"StackTemplateId\":\"stm-sfpo2o00000000000\",\"TimeoutInMinutes \":60,\"Parameters\":{\"ElastiCacheAvailabilityZones": [ \"eu-west-1b\", \"eu- west-1c\" ],\"ElastiCacheClusterName\":\"TEST_NAME\",\"ElastiCacheEngine\":\"redis\", \"ElastiCacheSubnetIds\":[\"SUBNET_ID\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON ﬁle; this example names it CreateMemcacheParams.json: aws amscm get-change-type-version --change-type-id "ct-0xi6q7uwuwrqe" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateMemcacheParams.json 2. Modify and save the CreateMemcacheParams ﬁle as follows. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 56 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description": "This is a test description", "VpcId": "VPC_ID", "StackTemplateId": "stm-sfpo2o00000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "ElastiCacheAvailabilityZones": [ "eu-west-1b", "eu-west-1c" ], "ElastiCacheClusterName": "test-cluster", "ElastiCacheEngine": "memcached", "ElastiCacheSubnetIds": [ "SUBNET_ID" , "SUBNET_ID" ] } } 3. Output the RFC template to a ﬁle in your current folder; this example names it CreateMemcacheRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateMemcacheRfc.json 4. Modify and save the CreateMemcacheRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0xi6q7uwuwrqe", "Title": "Memcache-Create-RFC" } 5. Create the RFC, specifying the CreateMemcacheRfc ﬁle and the CreateMemcacheParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateMemcacheRfc.json --execution- parameters file://CreateMemcacheParams.json Advanced Stack Components Version April 22, 2025 57 AMS Advanced Change Type Reference AMS Advanced Change Type Details You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information, see Amazon ElastiCache for Memcached. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0xi6q7uwuwrqe. Example: Required Parameters { "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "StackTemplateId": "stm-sfpo2o00000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "ElastiCacheAvailabilityZones": [ "eu-west-1b", "eu-west-1c" ], "ElastiCacheClusterName": "some-cluster", "ElastiCacheEngine": "memcached", "ElastiCacheSubnetIds": [ "subnet-1234567890abcdef0", "subnet-1234567890abcdef1" ] } } Example: All Parameters { "Description": "This is a test description", Advanced Stack Components Version April 22, 2025 58 AMS Advanced Change Type Reference AMS Advanced Change Type Details "VpcId": "vpc-1234abcd", "StackTemplateId": "stm-sfpo2o00000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey",
ams-ct-019	ams-ct.pdf	19	Type ct-0xi6q7uwuwrqe. Example: Required Parameters { "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "StackTemplateId": "stm-sfpo2o00000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "ElastiCacheAvailabilityZones": [ "eu-west-1b", "eu-west-1c" ], "ElastiCacheClusterName": "some-cluster", "ElastiCacheEngine": "memcached", "ElastiCacheSubnetIds": [ "subnet-1234567890abcdef0", "subnet-1234567890abcdef1" ] } } Example: All Parameters { "Description": "This is a test description", Advanced Stack Components Version April 22, 2025 58 AMS Advanced Change Type Reference AMS Advanced Change Type Details "VpcId": "vpc-1234abcd", "StackTemplateId": "stm-sfpo2o00000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "ElastiCacheAutoMinorVersionUpgrade": true, "ElastiCacheAvailabilityZones": ["eu-west-1a","eu-west-1b"], "ElastiCacheClusterName": "mmulti-az", "ElastiCacheCPUThresholdAlarmOverride": 95, "ElastiCacheEngine": "memcached", "ElastiCacheEngineVersion": "1.4.25", "ElastiCacheInstanceType": "cache.t1.micro", "ElastiCacheMultiAZ": true, "ElastiCacheNumberOfNodes": 2, "ElastiCachePort": 1121, "ElastiCachePreferredMaintenanceWindow": "sun:05:00-sun:09:00", "ElastiCacheSubnetGroup": "cachegroup", "ElastiCacheSubnetIds": ["subnet-1234abcd","subnet-1a2b3c4d"], "SecurityGroups": ["sg-1234abcd"] } } Cache (ElastiCache Redis) Stack \| Create Use to create an Amazon ElastiCache cluster (one or more cache nodes) that uses the Redis engine. Full classiﬁcation: Deployment \| Advanced stack components \| Cache (ElastiCache Redis) stack \| Create Change Type Details Change type ID ct-17vnu10suy631 Advanced Stack Components Version April 22, 2025 59 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create ElastiCache Redis stack Creating a Redis ElastiCache 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 60 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 Redis ElastiCache 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 61 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 notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this:
ams-ct-020	ams-ct.pdf	20	CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notiﬁcations 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-17vnu10suy631" --change-type-version "1.0" -- execution-parameters "{\"Description\":\"Test description\",\"VpcId\":\"VPC_ID\",\"Name \":\"Test_REDIS\",\"StackTemplateId\":\"stm-sfpo2o00000000000\",\"TimeoutInMinutes \":60,\"Parameters\":{\"ElastiCacheClusterName\":\"Test_Name\",\"ElastiCacheEngine\": \"redis\",\"ElastiCacheSubnetIds\":[\"subnet_id\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON ﬁle; this example names it CreateRedisParams.json: aws amscm get-change-type-version --change-type-id "ct-17vnu10suy631" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateRedisParams.json 2. Modify and save the CreateRedisParams ﬁle as follows. For example, you can replace the contents with something like this: { "Description": "This is a test description", "VpcId": "VPC_ID", Advanced Stack Components Version April 22, 2025 62 AMS Advanced Change Type Reference AMS Advanced Change Type Details "StackTemplateId": "stm-sfpo2o00000000000", "Name": "Test Stack", "Tags": [ { "Key": "tag-key", "Value": "tag-value" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "ElastiCacheClusterName": "test-cluster", "ElastiCacheEngine": "redis", "ElastiCacheSubnetIds": [ "SUBNET_ID" ] } } 3. Output the RFC template to a ﬁle in your current folder; this example names it CreateRedisRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateRedisRfc.json 4. Modify and save the CreateRedisRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-17vnu10suy631", "Title": "Redis-Create-RFC" } 5. Create the RFC, specifying the CreateRedisRfc ﬁle and the CreateRedisParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateRedisRfc.json --execution- parameters file://CreateRedisParams.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 63 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips For more information, see Amazon ElastiCache for Redis. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-17vnu10suy631. Example: Required Parameters { "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "StackTemplateId": "stm-sfpo2o00000000000", "Name": "Test Stack", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "ElastiCacheClusterName": "yet-another-cluster", "ElastiCacheEngine": "redis", "ElastiCacheSubnetIds": [ "subnet-1234567890abcdef0" ] } } Example: All Parameters { "Description": "This is a test description", "VpcId": "vpc-12345678", "StackTemplateId": "stm-sfpo2o00000000000", "Name": "Test Stack", "Tags": [ { Advanced Stack Components Version April 22, 2025 64 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "ElastiCacheAutoMinorVersionUpgrade": true, "ElastiCacheBackupSnapshotRetentionLimit": 5, "ElastiCacheClusterName": "project-redis", "ElastiCacheCPUThresholdAlarmOverride": 95, "ElastiCacheEnableBackup": true, "ElastiCacheEngine": "redis", "ElastiCacheEngineVersion": "2.8.28", "ElastiCacheInstanceType": "cache.t1.micro", "ElastiCachePort": 6380, "ElastiCachePreferredBackupWindow": "01:00-03:00", "ElastiCachePreferredMaintenanceWindow": "sun:05:00-sun:09:00", "ElastiCacheSnapshotArns": "arn:aws:s3:::my-bucket/snapshot1.rdb", "ElastiCacheSnapshotName": "foo-snapshot", "ElastiCacheSubnetGroup": "cachegroup", "ElastiCacheSubnetIds": ["subnet-ae7321f7","subnet-05f5cf72"], "SecurityGroups": ["sg-4b1b522f"] } } Database Migration Service (DMS) \| Create Replication Instance Create a Database Migration Service (DMS) replication instance on an Amazon EC2 instance in an AMS VPC. Use the replication instance to perform your database migration. The replication instance provides high availability and failover support using a Multi-AZ deployment when you select the Multi-AZ option. Full classiﬁcation: Deployment \| Advanced stack components \| Database Migration Service (DMS) \| Create replication instance Change Type Details Change type ID ct-27apldkhqr0ol Advanced Stack Components Version April 22, 2025 65 AMS Advanced Change Type Reference AMS Advanced Change Type Details Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create AWS DMS replication instance Creating a AWS DMS replication instance with the console Screenshot of this change type in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. Advanced Stack Components Version April 22, 2025 66 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
ams-ct-021	ams-ct.pdf	21	Choose by category view. Advanced Stack Components Version April 22, 2025 66 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 AWS DMS replication 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 67 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 notiﬁcations 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 --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-27apldkhqr0ol" --change-type-version "1.0" --title "TestDMSRepInstance" -- execution-parameters "{\"Description\":\"DMSTestRepInstance\",\"VpcId\":\"VPC-ID\", \"Name\":\"REP-INSTANCE-NAME\",\"Parameters\":{\"InstanceClass\":\"dms.t2.micro\", \"ReplicationSubnetGroupIdentifier\":\"TEST-REP-SG\",\"SecurityGroupIds\":\"SG-ID, SG- ID\"},\"TimeoutInMinutes\":60,\"StackTemplateId\":\"stm-3n1j5hdrmiiiuqk6v\"}" While your replication instance is being created, you can specify the source and target data stores. The source and target data stores can be on an Amazon Elastic Compute Cloud (Amazon EC2) instance, an AWS S3 Bucket, an Amazon Relational Database Service (Amazon RDS) DB instance, or an on-premises database. TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it CreateDmsRiParams.json: aws amscm get-change-type-version --change-type-id "ct-27apldkhqr0ol" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsRiParams.json Advanced Stack Components Version April 22, 2025 68 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Modify and save the execution parameters CreateDmsRiParams.json ﬁle. For example, you can replace the contents with something like this: { "Description": "DMSTestRepInstance", "VpcId": "VPC_ID", "Name": "Test RI", "StackTemplateId": "stm-3n1j5hdrmiiiuqk6v", "TimeoutInMinutes": 60, "Parameters": { "Description": "DESCRIPTION", "InstanceClass": "dms.t2.micro", "ReplicationSubnetGroupIdentifier": "TEST-REP-SG", "SecurityGroupIds": ["SG-ID, SG-ID"} } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsRiRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsRiRfc.json 4. Modify and save the CreateDmsRiRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-27apldkhqr0ol", "Title": "DMS-RI-Create-RFC" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsRiRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsRiRfc.json --execution- parameters file://CreateDmsRiParams.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 69 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips • You
ams-ct-022	ams-ct.pdf	22	the CreateDmsRiRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-27apldkhqr0ol", "Title": "DMS-RI-Create-RFC" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsRiRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsRiRfc.json --execution- parameters file://CreateDmsRiParams.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 69 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips • You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. • You must create a replication instance on an EC2 instance in your AMS VPC that has suﬃcient storage and processing power to perform the tasks you assign and migrate data from your source database to the target database. The required size of this instance varies depending on the amount of data you need to migrate and the tasks that you need the instance to perform. The replication instance provides high availability and failover support using a Multi- AZ deployment when you select the MultiAZ option. For more information about replication instances, see Working with an AWS DMS Replication Instance. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-27apldkhqr0ol. Example: Required Parameters Example not available. Example: All Parameters { "Description": "This is a test description", "Name": "Test Stack", "Parameters": { "AllocatedStorage": 50, "AutoMinorVersionUpgrade": "true", "AvailabilityZone": "us-east-1", "EngineVersion": "1.5.0", "Identifier": "my-instance", "InstanceClass": "dms.t2.micro", "KmsKeyId": "12345678-1234-1234-1234-1234567890ab", "MultiAZ": "false", "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", "ReplicationSubnetGroupIdentifier": "my-subnet-group", "SecurityGroupIds": ["sg-1234556eaba0a4799", "sg-1234556eaba0a5799"] }, "StackTemplateId": "stm-3n1j5hdrmiiiuqk6v", "TimeoutInMinutes": 60, Advanced Stack Components Version April 22, 2025 70 AMS Advanced Change Type Reference AMS Advanced Change Type Details "VpcId": "vpc-01234567890abcdef" } Database Migration Service (DMS) \| Create Replication Subnet Group Use to create a Database Migration Service (DMS) replication subnet group. Resource creation will fail if the dms-vpc-role IAM role doesn't already exist. Full classiﬁcation: Deployment \| Advanced stack components \| Database Migration Service (DMS) \| Create replication subnet group Change Type Details Change type ID ct-2q5azjd8p1ag5 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 71 AMS Advanced Change Type Reference Additional Information Create AWS DMS replication subnet group Creating a AWS DMS replication subnet group with the console AMS Advanced Change Type Details Note This CT fails if the dms-vpc-role IAM role doesn't exist in the account. 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 72 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 AWS DMS replication subnet group with the CLI Note This CT fails if the dms-vpc-role IAM role doesn't exist in the account. How it works: 1. Use either the Inline Create (you issue a create-rfc
ams-ct-023	ams-ct.pdf	23	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 conﬁgurations 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 AWS DMS replication subnet group with the CLI Note This CT fails if the dms-vpc-role IAM role doesn't exist in the account. 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 73 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 notiﬁcations 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 --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-2q5azjd8p1ag5" --change-type-version "1.0" --title "TestDMSRepSG" --execution- parameters "{\"Description\":\"DMSTestRepSG\",\"VpcId\":\"VPC-ID\",\"Name\":\"Test Stack\",\"Parameters\":{\"Description\":\"DESCRIPTION\",\"SubnetIds\":[\"SUBNET-ID\", \"SUBNET-ID\"]},\"TimeoutInMinutes\":60,\"StackTemplateId\":\"stm-j637f96ls1h4oy5fj \"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it CreateDmsRsgParams.json: aws amscm get-change-type-version --change-type-id "ct-2q5azjd8p1ag5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsRsgParams.json 2. Modify and save the execution parameters CreateDmsRsgParams.json ﬁle. For example, you can replace the contents with something like this: { "Description": "DMSTestRepSG", Advanced Stack Components Version April 22, 2025 74 AMS Advanced Change Type Reference AMS Advanced Change Type Details "VpcId": "VPC_ID", "TimeoutInMinutes": 60, "StackTemplateId": "stm-j637f96ls1h4oy5fj", "Name": "Test RSG", "Parameters": { "Description": "DESCRIPTION", "SubnetIds": ["SUBNET_ID", "SUBNET_ID"] } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsRsgRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsRsgRfc.json 4. Modify and save the CreateDmsRsgRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2q5azjd8p1ag5", "Title": "DMS-RSG-Create-RFC" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsRsgRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsRsgRfc.json --execution- parameters file://CreateDmsRsgParams.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 dms-vpc-role IAM role doesn't exist in the account. • You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. For more information about DMS replication instances and subnet groups, see Setting Up a Network for a Replication Instance. Advanced Stack Components Version April 22, 2025 75 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-2q5azjd8p1ag5. Example: Required Parameters { "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "Name": "Test Stack", "Parameters": { "Description": "test description", "SubnetIds": ["subnet-1234567890abcdef0"] }, "TimeoutInMinutes": 60, "StackTemplateId": "stm-j637f96ls1h4oy5fj" } Example: All Parameters { "Description": "This is a test description", "VpcId": "vpc-12345678", "Name": "Test Stack", "Tags": [ { "Key": "key1", "Value": "value1" }, { "Key": "key2", "Value": "value2" } ], "Parameters": { "Identifier": "myidentifier", "Description": "test description", "SubnetIds": ["subnet-12345678"] }, "TimeoutInMinutes": 60, "StackTemplateId": "stm-j637f96ls1h4oy5fj" } Advanced Stack Components Version April 22, 2025 76 AMS Advanced Change Type Reference AMS Advanced Change Type Details Database Migration Service (DMS) \| Create Replication Task Use to create a Database Migration Service (DMS) replication task. Full classiﬁcation: Deployment \| Advanced stack components \| Database Migration Service (DMS) \| Create replication task Change Type Details Change type ID ct-1d2fml15b9eth Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create AWS DMS replication task Creating a AWS DMS Replication Task with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 77 AMS Advanced Change Type Reference AMS Advanced Change Type Details
ams-ct-024	ams-ct.pdf	24	Service (DMS) \| Create Replication Task Use to create a Database Migration Service (DMS) replication task. Full classiﬁcation: Deployment \| Advanced stack components \| Database Migration Service (DMS) \| Create replication task Change Type Details Change type ID ct-1d2fml15b9eth Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create AWS DMS replication task Creating a AWS DMS Replication Task with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 77 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. Advanced Stack Components Version April 22, 2025 78 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 notiﬁcations 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 --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-1d2fml15b9eth" --change-type-version "1.0" --title "TestDMSRepTask" -- execution-parameters "{\"Description\":\"TestRepTask\",\"VpcId\":\"VPC-ID\",\"Name \":\"DMSRepTask\",\"Parameters\":{\"CdcStartTime\":\1533776569\"MigrationType\": \"full-load\",\"ReplicationInstanceArn\":\"REP_INSTANCE_ARN\",\"SourceEndpointArn \":\"SOURCE_ENDPOINT_ARN\",\"TableMappings\":\"{\\\"rules\\\": [{\\\"rule-type \\\": \\\"selection\\\",\\\"rule-id\\\": \\\"1\\\",\\\"rule-name\\\": \\\"1\\ \",\\\"object-locator\\\": {\\\"schema-name\\\": \\\"Test\\\",\\\"table-name\\ \": \\\"%\\\"}, \\\"rule-action\\\": \\\"include\\\"}] }\",\"TargetEndpointArn \":\"TARGET_ENDPOINT_ARN\"},\"StackTemplateId\":\"stm-eos7uq0usnmeggdet\", \"TimeoutInMinutes\":60}" TEMPLATE CREATE: Advanced Stack Components Version April 22, 2025 79 AMS Advanced Change Type Reference AMS Advanced Change Type Details 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it CreateDmsRtParams.json: aws amscm get-change-type-version --change-type-id "ct-1d2fml15b9eth" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsRtParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "DMSTestRepTask", "VpcId": "VPC_ID", "StackTemplateId": "stm-eos7uq0usnmeggdet", "Name": "Test DMS RT", "TimeoutInMinutes": 60, "Parameters": { "CdcStartTime": "1533776569", "MigrationType": "full-load", "ReplicationInstanceArn": "REP_INSTANCE_ARN", "SourceEndpointArn": "SOURCE_ENDPOINT_ARN", "TargetEndpointArn": "TARGET_ENDPOINT_ARN" "TableMappings": {"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"schema-name": "Test","table-name": "%"}, "rule-action": "include"}] }", } } 3. Output the JSON template to a ﬁle in your current folder; this example names
ams-ct-025	ams-ct.pdf	25	execution parameters for this change type to a JSON ﬁle; this example names it CreateDmsRtParams.json: aws amscm get-change-type-version --change-type-id "ct-1d2fml15b9eth" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsRtParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "DMSTestRepTask", "VpcId": "VPC_ID", "StackTemplateId": "stm-eos7uq0usnmeggdet", "Name": "Test DMS RT", "TimeoutInMinutes": 60, "Parameters": { "CdcStartTime": "1533776569", "MigrationType": "full-load", "ReplicationInstanceArn": "REP_INSTANCE_ARN", "SourceEndpointArn": "SOURCE_ENDPOINT_ARN", "TargetEndpointArn": "TARGET_ENDPOINT_ARN" "TableMappings": {"rules": [{"rule-type": "selection","rule-id": "1","rule-name": "1","object-locator": {"schema-name": "Test","table-name": "%"}, "rule-action": "include"}] }", } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsRtRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsRtRfc.json 4. Modify and save the CreateDmsRtRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1d2fml15b9eth", "Title": "DMS-RI-Create-RFC" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsRtRfc ﬁle: Advanced Stack Components Version April 22, 2025 80 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --cli-input-json file://CreateDmsRtRfc.json --execution- parameters file://CreateDmsRtParams.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 create a AWS DMS task that captures three diﬀerent types of changes or data. For more information, see Working with AWS DMS Tasks, Creating a Task, and Creating Tasks for Ongoing Replication Using AWS DMS. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1d2fml15b9eth. Example: Required Parameters { "Description": "Test Description", "VpcId": "vpc-1234567890abcdef0", "Name": "dmstask01", "StackTemplateId": "stm-eos7uq0usnmeggdet", "TimeoutInMinutes": 60, "Parameters": { "MigrationType": "full-load", "ReplicationInstanceArn": "arn:aws:dms:us- east-1:123456789123:rep:6LDPDHOHCSDDSWHJP0UQJPAZLW", "SourceEndpointArn": "arn:aws:dms:us- east-1:123456789123:endpoint:GLYHN8SUXLO5DS4PU4ODJ7KP0O", "TableMappings": "{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"Test\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }", "TargetEndpointArn": "arn:aws:dms:us- east-1:123456789123:endpoint:6PLJC4V60JGPKXN6OUOFWNJIUE" } } Advanced Stack Components Version April 22, 2025 81 AMS Advanced Change Type Details AMS Advanced Change Type Reference Example: All Parameters { "Description": "Test Description", "VpcId": "vpc-317a9856", "Name": "dmstask01", "StackTemplateId": "stm-eos7uq0usnmeggdet", "TimeoutInMinutes": 60, "Parameters": { "CdcStartTime": "1533776569", "MigrationType": "full-load", "ReplicationInstanceArn": "arn:aws:dms:us- east-1:123456789123:rep:6LDPDHOHCSDDSWHJP0UQJPAZLWTHISISVERYLONGANDIAMOKWITHIT", "ReplicationTaskIdentifier": "mydmstask01", "ReplicationTaskSettings": " { \"TargetMetadata\": { \"TargetSchema\": \"\", \"SupportLobs\": true, \"FullLobMode\": false, \"LobChunkSize\": 64, \"LimitedSizeLobMode\": true, \"LobMaxSize\": 32, \"BatchApplyEnabled \": true }, \"FullLoadSettings\": { \"TargetTablePrepMode\": \"DO_NOTHING \", \"CreatePkAfterFullLoad\": false, \"StopTaskCachedChangesApplied\": false, \"StopTaskCachedChangesNotApplied\": false, \"MaxFullLoadSubTasks \": 8, \"TransactionConsistencyTimeout\": 600, \"CommitRate\": 10000 }, \"Logging\": { \"EnableLogging\": false }, \"ControlTablesSettings\": { \"ControlSchema\":\"\", \"HistoryTimeslotInMinutes\":5, \"HistoryTableEnabled \": false, \"SuspendedTablesTableEnabled\": false, \"StatusTableEnabled \": false }, \"StreamBufferSettings\": { \"StreamBufferCount\": 3, \"StreamBufferSizeInMB\": 8 }, \"ChangeProcessingTuning\": { \"BatchApplyPreserveTransaction\": true, \"BatchApplyTimeoutMin\": 1, \"BatchApplyTimeoutMax\": 30, \"BatchApplyMemoryLimit\": 500, \"BatchSplitSize\": 0, \"MinTransactionSize\": 1000, \"CommitTimeout \": 1, \"MemoryLimitTotal\": 1024, \"MemoryKeepTime\": 60, \"StatementCacheSize\": 50 }, \"ChangeProcessingDdlHandlingPolicy\": { \"HandleSourceTableDropped\": true, \"HandleSourceTableTruncated\": true, \"HandleSourceTableAltered\": true }, \"ValidationSettings\": { \"EnableValidation\": false, \"ThreadCount\": 5 }, \"ErrorBehavior\": { \"DataErrorPolicy\": \"LOG_ERROR\", \"DataTruncationErrorPolicy\":\"LOG_ERROR\", \"DataErrorEscalationPolicy\":\"SUSPEND_TABLE\", \"DataErrorEscalationCount \": 50, \"TableErrorPolicy\":\"SUSPEND_TABLE\", \"TableErrorEscalationPolicy \":\"STOP_TASK\", \"TableErrorEscalationCount\": 50, \"RecoverableErrorCount \": 0, \"RecoverableErrorInterval\": 5, \"RecoverableErrorThrottling\": true, \"RecoverableErrorThrottlingMax\": 1800, \"ApplyErrorDeletePolicy \":\"IGNORE_RECORD\", \"ApplyErrorInsertPolicy\":\"LOG_ERROR\", \"ApplyErrorUpdatePolicy\":\"LOG_ERROR\", \"ApplyErrorEscalationPolicy\": \"LOG_ERROR\", \"ApplyErrorEscalationCount\": 0, \"FullLoadIgnoreConflicts\": true } }", Advanced Stack Components Version April 22, 2025 82 AMS Advanced Change Type Reference AMS Advanced Change Type Details "SourceEndpointArn": "arn:aws:dms:us- east-1:123456789123:endpoint:GLYHN8SUXLO5DS4PU4ODJ7KP0OLONGSTRINGBUTITSOK", "TableMappings": "{ \"rules\": [ { \"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": { \"schema-name\": \"Test\", \"table-name\": \"%\" }, \"rule-action\": \"include\" } ] }", "TargetEndpointArn": "arn:aws:dms:us- east-1:123456789123:endpoint:6PLJC4V60JGPKXN6OUOFWNJIUEYOUSTILLDONTBELIEVEICANHANDLEVERYLONGSTRINGS" } } Database Migration Service (DMS) \| Create Source Endpoint Use to create a Database Migration Service (DMS) source endpoint. Full classiﬁcation: Deployment \| Advanced stack components \| Database Migration Service (DMS) \| Create source endpoint Change Type Details Change type ID ct-0attesnjqy2cx Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information DMS source endpoint: creating Creating a DMS Source Endpoint with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 83 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
ams-ct-026	ams-ct.pdf	26	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. Advanced Stack Components Version April 22, 2025 84 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When ﬁnished, 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 conﬁgurations 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 DMS Source Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 85 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws --profile saml --region us-east-1 amscm create-rfc --title "MariaDB-DMS- Source-Endpoint" --aws-account-id ACCOUNT-ID --change-type-id ct-0attesnjqy2cx -- change-type-version 1.0 --execution-parameters "{\"Description\":\"DESCRIPTION.\", \"VpcId\":\"VPC-ID\",\"Name\":\"MariaDB-DMS-SE\",\"Parameters\":{\"EngineName\": \"mariadb\",\"ServerName\":\"mariadb.db.example.com\",\"Port\":3306,\"Username\": \"DB-USER\",\"Password\":\"DB-PW\"},\"TimeoutInMinutes\":60,\"StackTemplateId\":\"stm- pud4ghhkp7395n9bc\"}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDmsSeParams.json. aws amscm get-change-type-version --change-type-id "ct-0attesnjqy2cx" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsSeParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "MariaDB-DMS-SE", "VpcId": "VPC_ID", "Name": "Test SE", "StackTemplateId": "stm-pud4ghhkp7395n9bc", "TimeoutInMinutes": 60, "Parameters": { "Description": "DESCRIPTION", "EngineName": "mariadb", "ServerName": "mariadb.db.example.com", "Port": "3306", "Username": "DB-USER", "Password": "DB-PW",} } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsSeRfc.json: Advanced Stack Components Version April 22, 2025 86 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > CreateDmsSeRfc.json 4. Modify and save the CreateDmsSeRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0attesnjqy2cx", "Title": "MariaDB-DMS-Source-Endpoint" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsSeRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsSeRfc.json --execution- parameters file://CreateDmsSeParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Before you create the DMS endpoint, make sure that your password doesn't contain unsupported characters. For more information, see Creating source and target endpoints in the AWS Database Migration Service User Guide. To learn more, see Sources for Data Migration. For an S3 source endpoint, see DMS source endpoint for S3: creating. For a Mongo DB source endpoint, see DMS source endpoint for MongoDB: Creating. Execution
ams-ct-027	ams-ct.pdf	27	ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Before you create the DMS endpoint, make sure that your password doesn't contain unsupported characters. For more information, see Creating source and target endpoints in the AWS Database Migration Service User Guide. To learn more, see Sources for Data Migration. For an S3 source endpoint, see DMS source endpoint for S3: creating. For a Mongo DB source endpoint, see DMS source endpoint for MongoDB: Creating. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0attesnjqy2cx. Example: Required Parameters Example not available. Advanced Stack Components Version April 22, 2025 87 AMS Advanced Change Type Reference Example: All Parameters AMS Advanced Change Type Details { "Description": "This is a test description", "Name": "Test Stack", "Parameters": { "CertificateArn": "arn:aws:dms:us- east-1:123456789121:cert:5957UBG4LS4ZJP2PK7YRYET6YE", "DatabaseName": "my-database", "EndpointIdentifier": "my-endpoint", "EngineName": "aurora", "KmsKeyId": "12345678-1234-1234-1234-1234567890ab", "Password": "$tr0n9PA55w0Rd", "Port": 50000, "ServerName": "", "SslMode": "none", "Username": "" }, "StackTemplateId": "stm-pud4ghhkp7395n9bc", "TimeoutInMinutes": 60, "VpcId": "vpc-01234567890abcdef" } Database Migration Service (DMS) \| Create Source Endpoint (MongoDB) Use to create a Database Migration Service (DMS) source endpoint for MongoDB. Full classiﬁcation: Deployment \| Advanced stack components \| Database Migration Service (DMS) \| Create source endpoint (MongoDB) Change Type Details Change type ID ct-2hxcllf1b4ey0 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Advanced Stack Components Version April 22, 2025 88 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution mode Automated Additional Information DMS source endpoint for MongoDB: Creating Creating a DMS Mongo DB Source Endpoint 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 89 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 DMS Mongo DB Source Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations when the RFC status Advanced Stack Components Version April 22, 2025 90 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
ams-ct-028	ams-ct.pdf	28	--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 notiﬁcations when the RFC status Advanced Stack Components Version April 22, 2025 90 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 --profile saml --region us-east-1 create-rfc --change-type-id "ct-2hxcllf1b4ey0" --change-type-version "1.0" --title 'DMS_Source_MongoDB' --description "DESCRIPTION" --execution-parameters "{\"Description\": \"DMS_MongoDB_Source_Endpoint\",\"VpcId\":\"VPC_ID\",\"Name\":\"DMS-Mongo-SE\", \"StackTemplateId\":\"stm-pud4ghhkp7395n9bc\",\"TimeoutInMinutes\":60,\"Parameters\": {\"DatabaseName\":\"mytestdb\",\"EngineName\":\"mongodb\",\"Port\":27017,\"ServerName \":\"test.example.com\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDmsSeMongoParams.json. aws amscm get-change-type-version --change-type-id "ct-2hxcllf1b4ey0" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsSeMongoParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "MongoDB-DMS-SE", "VpcId": "VPC_ID", "StackTemplateId": "stm-pud4ghhkp7395n9bc", "Name": "Test Mongo SE", "TimeoutInMinutes": 60, "Parameters": { "Description": "DESCRIPTION", "DatabaseName": "mytestdb", Advanced Stack Components Version April 22, 2025 91 AMS Advanced Change Type Reference AMS Advanced Change Type Details "EngineName": "mongodb", "ServerName": "test.example.com", "Port": "27017" } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsSeMongoRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsSeMongoRfc.json 4. Modify and save the CreateDmsSeMongoRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2hxcllf1b4ey0", "Title": "DMS_Source_MongoDB" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsSeMongoRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsSeMongoRfc.json --execution- parameters file://CreateDmsSeMongoParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. AMS DMS can use Mongo or any Relational Database Service (RDS) as a source endpoint. For an S3 source endpoint, see DMS source endpoint for S3: creating. Advanced Stack Components Version April 22, 2025 92 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-2hxcllf1b4ey0. Example: Required Parameters Example not available. Example: All Parameters { "Description": "This is a test description", "Name": "Test Stack", "Parameters": { "CertificateArn": "arn:aws:dms:us- east-1:123456789121:cert:5957UBG4LS4ZJP2PK7YRYET6YE", "DatabaseName": "my-database", "EndpointIdentifier": "my-endpoint", "EngineName": "mongodb", "MongoDbAuthMechanism": "default", "MongoDbAuthSource": "admin", "MongoDbAuthType": "no", "MongoDbDocsToInvestigate": "1000", "MongoDbExtractDocId": "false", "MongoDbMetadataMode": "none", "Password": "$tr0n9PA55w0Rd", "Port": 27017, "ServerName": "my-server", "SslMode": "none", "Username": "my-user" }, "StackTemplateId": "stm-pud4ghhkp7395n9bc", "TimeoutInMinutes": 60, "VpcId": "vpc-01234567890abcdef" } Database Migration Service (DMS) \| Create Source Endpoint (S3) Use to create a Database Migration Service (DMS) source endpoint for S3. Full classiﬁcation: Deployment \| Advanced stack components \| Database Migration Service (DMS) \| Create source endpoint (S3) Advanced Stack Components Version April 22, 2025 93 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-2oxl37nphsrjz Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information DMS source endpoint for S3: creating Creating a DMS S3 Source Endpoint 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 94 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
ams-ct-029	ams-ct.pdf	29	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 DMS S3 Source Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 95 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 notiﬁcations 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 --profile saml --region us-east-1 amscm create-rfc --title "S3DMSSourceEndpoint" -- aws-account-id ACCOUNT-ID --change-type-id ct-2oxl37nphsrjz --change-type-version 1.0 --execution-parameters "{\"Description\":\"TestS3DMS-SE\",\"VpcId\":\"VPC-ID\",\"Name \":\"S3-DMS-SE\",\"Parameters\":{\"EngineName\":\"s3\",\"S3BucketName\":\"amzn-s3- demo-bucket\",\"S3ExternalTableDefinition\":\"{\\\"TableCount\\\":\\\"1\\\",\\\"Tables \\\":[{\\\"TableName\\\":\\\"employee\\\",\\\"TablePath\\\":\\\"hr/employee/\\\",\\ \"TableOwner\\\":\\\"hr\\\",\\\"TableColumns\\\":[{\\\"ColumnName\\\":\\\"Id\\\",\\ \"ColumnType\\\":\\\"INT8\\\",\\\"ColumnNullable\\\":\\\"false\\\",\\\"ColumnIsPk\\\": \\\"true\\\"},{\\\"ColumnName\\\":\\\"LastName\\\",\\\"ColumnType\\\":\\\"STRING\\\", \\\"ColumnLength\\\":\\\"20\\\"},{\\\"ColumnName\\\":\\\"FirstName\\\",\\\"ColumnType \\\":\\\"STRING\\\",\\\"ColumnLength\\\":\\\"30\\\"},{\\\"ColumnName\\\":\\\"HireDate\ \\",\\\"ColumnType\\\":\\\"DATETIME\\\"},{\\\"ColumnName\\\":\\\"OfficeLocation\\\",\\ \"ColumnType\\\":\\\"STRING\\\",\\\"ColumnLength\\\":\\\"20\\\"}],\\\"TableColumnsTotal \\\":\\\"5\\\"}]}\",\"S3ServiceAccessRoleArn\":\"arn:aws:iam::123456789101:role/ams- ops-ct-authors-dms-s3-test-role\"},\"TimeoutInMinutes\":60,\"StackTemplateId\":\"stm- pud4ghhkp7395n9bc\"}" TEMPLATE CREATE: Advanced Stack Components Version April 22, 2025 96 AMS Advanced Change Type Reference AMS Advanced Change Type Details 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDmsSeS3Params.json. aws amscm get-change-type-version --change-type-id "ct-2oxl37nphsrjz" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsSeS3Params.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "TestS3DMS-SE", "VpcId": "VPC_ID", "Name": "S3-DMS-SE", "StackTemplateId": "stm-pud4ghhkp7395n9bc", "TimeoutInMinutes": 60, "Parameters": { "EngineName": "s3", "S3BucketName": "amzn-s3-demo-bucket", "S3ExternalTableDefinition": "BUCKET-NAME", {"TableCount": "1", "Tables":[{"TableName":"employee","TablePath":"hr/ employee/","TableOwner":"hr","TableColumns": [{"ColumnName":"Id","ColumnType":"INT8","ColumnNullable":"false","ColumnIsPk":"true"}, {"ColumnName":"LastName","ColumnType":"STRING","ColumnLength":"20"}, {"ColumnName":"FirstName","ColumnType":"STRING","ColumnLength":"30"}, {"ColumnName":"HireDate","ColumnType":"DATETIME"}, {"ColumnName":"OfficeLocation","ColumnType":"STRING","ColumnLength":"20"}],"TableColumnsTotal":"5"}]}" "S3ServiceAccessRoleArn": "arn:aws:iam::123456789101:role/ams-ops-ct- authors-dms-s3-test-role", } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsSeS3Rfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsSeS3Rfc.json 4. Modify and save the CreateDmsSeS3Rfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", Advanced Stack Components Version April 22, 2025 97 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-2oxl37nphsrjz", "Title": "DMS_Source_S3" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsSeS3Rfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsSeS3Rfc.json --execution- parameters file://CreateDmsSeS3Params.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. AMS DMS can use S3 or any Relational Database Service (RDS) source endpoint. For a Mongo DB source endpoint, see DMS source endpoint for MongoDB: Creating. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type
ams-ct-030	ams-ct.pdf	30	parameters file://CreateDmsSeS3Params.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. AMS DMS can use S3 or any Relational Database Service (RDS) source endpoint. For a Mongo DB source endpoint, see DMS source endpoint for MongoDB: Creating. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2oxl37nphsrjz. Example: Required Parameters Example not available. Example: All Parameters { "Description": "This is a test description", "Name": "Test Stack", "Parameters": { "EndpointIdentifier": "my-endpoint", "EngineName": "s3", Advanced Stack Components Version April 22, 2025 98 AMS Advanced Change Type Reference AMS Advanced Change Type Details "S3BucketFolder": "my-folder", "S3BucketName": "my-bucket", "S3CompressionType": "NONE", "S3CsvDelimiter": ",", "S3CsvRowDelimiter": "\n", "S3ExternalTableDefinition": "false", "S3ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/my-s3service-role" }, "StackTemplateId": "stm-pud4ghhkp7395n9bc", "TimeoutInMinutes": 60, "VpcId": "vpc-01234567890abcdef" } Database Migration Service (DMS) \| Create Target Endpoint Use to create a Database Migration Service (DMS) target endpoint for RDS supported MySQL, MariaDB, PostgreSQL, Oracle and Microsoft SQL server engine. Full classiﬁcation: Deployment \| Advanced stack components \| Database Migration Service (DMS) \| Create target endpoint Change Type Details Change type ID ct-3gf8dolbo8x9p Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information DMS target endpoint: creating AMS DMS can use S3 or any Relational Database Service (RDS) with MySQL, MariaDB, Oracle, Postgresql, or Microsoft SQL as a target endpoint. Advanced Stack Components Version April 22, 2025 99 AMS Advanced Change Type Reference AMS Advanced Change Type Details Creating a DMS Target Endpoint 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 100 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 DMS Target Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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
ams-ct-031	ams-ct.pdf	31	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 notiﬁcations 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 101 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 --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-3gf8dolbo8x9p" --change-type-version "1.0" --title "TestDMSTargetEndpoint" -- execution-parameters "{\"Description\":\"TestTE\",\"VpcId\":\"VPC-ID\",\"Name\": \"TE-NAME\",\"StackTemplateId\":\"stm-knghtmmgefafdq89u\",\"TimeoutInMinutes\":60, \"Parameters\":{\"EngineName\":\"mysql\",\"Password\":\"testpw123\",\"Port\":\"3306\", \"ServerName\":\"mytestdb.d5fga0rf2wpi.ap-southeast-2.rds.amazonaws.com\",\"Username\": \"USERNAME\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDmsTeParams.json. aws amscm get-change-type-version --change-type-id "ct-3gf8dolbo8x9p" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsTeParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "TestTE", "VpcId": "VPC_ID", "StackTemplateId": "stm-knghtmmgefafdq89u", "Name": "TE-NAME", "TimeoutInMinutes": 60, "Parameters": { "EngineName": "mysql", "ServerName": "sql.db.example.com", "Port": "3306", "Username": "DB-USER", "Password": "DB-PW",} } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsTeRfc.json: Advanced Stack Components Version April 22, 2025 102 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > CreateDmsTeRfc.json 4. Modify and save the CreateDmsTeRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3gf8dolbo8x9p", "Title": "DB-DMS-Target-Endpoint" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsTeRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsTeRfc.json --execution- parameters file://CreateDmsTeParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • This change type is now at version 2.0. • AMS DMS can use S3 or any Relational Database Service (RDS) with MySQL, MariaDB, Oracle, Postgresql, or Microsoft SQL as a target endpoint. For an S3 target endpoint, see DMS target endpoint for S3: creating. • For more information, see Targets for Data Migration. • You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3gf8dolbo8x9p. Example: Required Parameters { "Description": "Test description.", "VpcId": "vpc-1234567890abcdef0", Advanced Stack Components Version April 22, 2025 103 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Name": "dmstarget01", "Tags": [ { "Key": "key1", "Value": "value1" }, { "Key": "key2", "Value": "value2" } ], "StackTemplateId": "stm-knghtmmgefafdq89u", "TimeoutInMinutes": 60, "Parameters": { "EngineName": "mysql", "Password": "testpasswrod123", "Port": "3306", "ServerName": "mytestdb.d5fga0rf2wpi.ap-southeast-2.rds.amazonaws.com", "Username": "myuser01" } } Example: All Parameters { "Description": "Test description.", "VpcId": "vpc-104ed2fb", "Name": "dmstarget01", "Tags": [ { "Key": "key1", "Value": "value1" }, { "Key": "key2", "Value": "value2" } ], "StackTemplateId": "stm-knghtmmgefafdq89u", "TimeoutInMinutes": 60, "Parameters": { "CertificateArn": "arn:aws:dms:us- east-1:123456789121:cert:5957UBG4LS4ZJP2PK7YRYET6YE", Advanced Stack Components Version April 22, 2025 104 AMS Advanced Change Type Reference AMS Advanced Change Type Details "DatabaseName": "mytestdb", "EndpointIdentifier": "myctdmstarget", "EngineName": "mysql", "ExtraConnectionAttributes": "targetDbType=MULTIPLE_DATABASES", "KmsKeyId": "15a25b6b-b29d-4bc5-af34-88eeb3740a94", "Password": "testpasswrod123", "Port": "3306", "ServerName": "mytestdb.d5fga0rf2wpi.ap-southeast-2.rds.amazonaws.com", "SslMode": "verify-full", "Username": "myuser01" } } Database Migration Service (DMS) \| Create Target Endpoint (Kafka) Create a Database Migration Service (DMS) target endpoint for kafka. Full classiﬁcation: Deployment \| Advanced stack components \| Database Migration Service (DMS) \| Create target endpoint (kafka) Change Type Details Change type ID ct-1mrqxscu15apz Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create AWS Database Migration Service target endpoint for Amazon MSK AMS DMS can use Amazon Managed Streaming for Apache Kafka as a target endpoint. Advanced Stack Components Version April 22, 2025 105 AMS Advanced Change Type Reference AMS Advanced Change Type Details Creating a DMS Amazon MSK target endpoint 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
ams-ct-032	ams-ct.pdf	32	105 AMS Advanced Change Type Reference AMS Advanced Change Type Details Creating a DMS Amazon MSK target endpoint 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 106 AMS Advanced Change Type Reference AMS Advanced Change Type Details 5. Open the Run parameters area to see the conﬁgurations 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 DMS Amazon MSK target endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 107 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws --profile saml --region us-east-1 amscm create-rfc --change-type-id "ct-1mrqxscu15apz" --change-type-version "1.0" --title "TestDMSTargetEndpointKafka" --execution-parameters "{\"Description\":\"TestKafkaTE\",\"VpcId\":\"VPC-ID\",\"Name \":\"KafkaTE-NAME\",\"StackTemplateId\":\"stm-knghtmmgefafdq89u"\",\"TimeoutInMinutes \":60,\"Parameters\":{\"EngineName\":\"kafka\",\"Broker": "BROKER-ID\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDmsTeKafkaParams.json. aws amscm get-change-type-version --change-type-id "ct-1mrqxscu15apz" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsTeKafkaParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "Description": "Test description", "VpcId": "VPC-ID", "Name": "dmstargetsKafka", "StackTemplateId": "stm-knghtmmgefafdq89u", "TimeoutInMinutes": 60, "Parameters": { "EngineName": "kafka", "Broker": "BROKER-ID" } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsTeKafkaRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsTeKafkaRfc.json 4. Modify and save the CreateDmsTeKafkaRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1mrqxscu15apz", Advanced Stack Components Version April 22, 2025 108 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "Kafka-DMS-Target-Endpoint" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsTeKafkaRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsTeKafkaRfc.json --execution- parameters file://CreateDmsTeKafkaParams.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-033	ams-ct.pdf	33	CreateDmsTeKafkaRfc.json 4. Modify and save the CreateDmsTeKafkaRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1mrqxscu15apz", Advanced Stack Components Version April 22, 2025 108 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "Kafka-DMS-Target-Endpoint" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsTeKafkaRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsTeKafkaRfc.json --execution- parameters file://CreateDmsTeKafkaParams.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 Database Migration Service (AWS DMS) Amazon MSK endpoints, see Using Apache Kafka as a target for AWS Database Migration Service • To learn more about Amazon Managed Streaming for Apache Kafka see What is Apache Kafka? • For more information on AWS DMS targets, see Targets for Data Migration. • You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1mrqxscu15apz. Example: Required Parameters { "Description": "Test description.", "VpcId": "vpc-1234567890abcdef0", "Name": "dmstargets301", "StackTemplateId": "stm-knghtmmgefafdq89u", "TimeoutInMinutes": 60, "Parameters": { "EngineName": "kafka", "Broker": "ec2-12-345-678-901.compute-1.amazonaws.com:2345" } } Advanced Stack Components Version April 22, 2025 109 AMS Advanced Change Type Reference Example: All Parameters AMS Advanced Change Type Details { "Description": "Test description.", "VpcId": "vpc-317a9856", "Name": "dmstargets301", "StackTemplateId": "stm-knghtmmgefafdq89u", "TimeoutInMinutes": 60, "Parameters": { "EndpointIdentifier": "mykafkadmstarget", "EngineName": "kafka", "Broker": "ec2-12-345-678-901.compute-1.amazonaws.com:2345", "Topic": "kafka-default-topic" } } Database Migration Service (DMS) \| Create Target Endpoint (S3) Use to create a Database Migration Service (DMS) target endpoint for S3. Full classiﬁcation: Deployment \| Advanced stack components \| Database Migration Service (DMS) \| Create target endpoint (S3) Change Type Details Change type ID ct-05muqzievnxk5 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 110 AMS Advanced Change Type Reference Additional Information DMS target endpoint for S3: creating Creating a DMS S3 Target Endpoint with the Console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Advanced Stack Components Version April 22, 2025 111 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 DMS S3 Target Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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
ams-ct-034	ams-ct.pdf	34	top of the page. Creating a DMS S3 Target Endpoint with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 112 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 --region us-east-1 amscm create-rfc --change-type-id "ct-05muqzievnxk5" --change-type-version "1.0" --title "TestDMSTargetEndpointS3" --execution-parameters "{\"Description\":\"TestS3TE\",\"VpcId\":\"VPC-ID\",\"Name \":\"S3TE-NAME\",\"StackTemplateId\":\"stm-knghtmmgefafdq89u\",\"TimeoutInMinutes \":60,\"Parameters\":{\"EngineName\":\"s3\",\"S3BucketName\":\"amzn-s3-demo-bucket\", \"S3ServiceAccessRoleArn\":\"arn:aws:iam::123456789123:role/my-s3-role\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it CreateDmsTeS3Params.json: aws amscm get-change-type-version --change-type-id "ct-05muqzievnxk5" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDmsTeS3Params.json 2. Modify and save the execution parameters CreateDmsTeS3Params.json ﬁle. For example, you can replace the contents with something like this: { "Description": "TestS3DMS-TE", "VpcId": "VPC_ID", "StackTemplateId": "stm-knghtmmgefafdq89u", "Name": "DMS-S3-TE", "TimeoutInMinutes": 60, "Parameters": { "EngineName": "s3", "S3BucketName": "amzn-s3-demo-bucket", "S3ServiceAccessRoleArn": "arn:aws:iam::123456789101:role/ams-ops-ct- authors-dms-s3-test-role" } } Advanced Stack Components Version April 22, 2025 113 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDmsTeS3Rfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDmsTeS3Rfc.json 4. Modify and save the CreateDmsTeS3Rfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-05muqzievnxk5", "Title": "DMS_Target_S3" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDmsTeS3Rfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDmsTeS3Rfc.json --execution- parameters file://CreateDmsTeS3Params.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Note You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. AMS provides a separate change type for creating a target endpoint for S3. For more information, see Using Amazon S3 as a Target for AWS Database Migration Service and Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-05muqzievnxk5. Advanced Stack Components Version April 22, 2025 114 AMS Advanced Change Type Reference AMS Advanced Change Type Details Example: Required Parameters { "Description": "Test description.", "VpcId": "vpc-1234567890abcdef0", "Name": "dmstargets301", "StackTemplateId": "stm-knghtmmgefafdq89u", "TimeoutInMinutes": 60, "Parameters": { "EngineName": "s3", "S3BucketName": "mybucket.in.s3", "S3ServiceAccessRoleArn": "arn:aws:iam::123456789123:role/my-s3-role" } } Example: All Parameters { "Description": "Test description.", "VpcId": "vpc-317a9856", "Name": "dmstargets301", "StackTemplateId": "stm-knghtmmgefafdq89u", "TimeoutInMinutes": 60, "Parameters": { "EndpointIdentifier": "mys3dmstarget", "EngineName": "s3", "ExtraConnectionAttributes": "maxFileSize=512", "S3BucketFolder": "mytestfolder", "S3BucketName": "mybucket.in.s3", "S3CompressionType": "NONE", "S3CsvDelimiter": "\|", "S3CsvRowDelimiter": "M", "S3ServiceAccessRoleArn": "arn:aws:iam::123456789123:role/my-s3-role" } } DNS (Private) \| Create Create a new Route 53 DNS resource record sets and a new private hosted zone for a VPC, and conﬁgure traﬃc routing. Full classiﬁcation: Deployment \| Advanced stack components \| DNS (private) \| Create Advanced Stack Components Version April 22, 2025 115 AMS Advanced Change Type Reference AMS Advanced Change Type Details Change Type Details Change type ID ct-0c38gftq56zj6 Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create private DNS Route 53 Creating a private Route 53 hosted zone 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 116 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
ams-ct-035	ams-ct.pdf	35	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 116 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 private 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 117 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 notiﬁcations 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-0c38gftq56zj6" \ --change-type-version "2.0" --title "Testing - Creating New Private Hosted Zone" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- CreateAddRoute53Resources\",\"Region\":\"us-east-1\",\"Parameters\":{\"DomainName\": \"mydomain.com\",\"VPCId\":\"vpc-12345678\",\"DomainType\":\"private\",\"RecordSet\": [\"[{\\\"Name\\\":\\\"test1.mydomain.com\\\",\\\"Type\\\":\\\"A\\\",\\\"TTL\\\":600,\\ \"ResourceRecords\\\":[\\\"10.1.1.1\\\",\\\"10.1.2.2\\\"]}]}\"]}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDnsPrivateParams.json. aws amscm get-change-type-version --change-type-id "ct-0c38gftq56zj6" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDnsPrivateParams.json Advanced Stack Components Version April 22, 2025 118 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateAddRoute53Resources", "Region": "us-east-1", "Parameters": { "DomainName": "mydomain.com", "VpcId": "vpc-12345678", "DomainType": "private", "RecordSet": [ "{\"RecordSet\":[{\"Name\":\"test1.mydomain.com\",\"Type\":\"A\",\"TTL \":600,\"ResourceRecords\":[\"10.1.1.1\",\"10.1.2.2\"]}]}" ] } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDnsPrivateRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDnsPrivateRfc.json 4. Modify and save the CreateDnsPrivateRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-0c38gftq56zj6", "ChangeTypeVersion": "2.0", "Title": "Creating New Private Hosted Zone" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDnsPrivateRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDnsPrivateRfc.json --execution- parameters file://CreateDnsPrivateParams.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
ams-ct-036	ams-ct.pdf	36	it CreateDnsPrivateRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDnsPrivateRfc.json 4. Modify and save the CreateDnsPrivateRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-0c38gftq56zj6", "ChangeTypeVersion": "2.0", "Title": "Creating New Private Hosted Zone" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDnsPrivateRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDnsPrivateRfc.json --execution- parameters file://CreateDnsPrivateParams.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 119 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips • This CT fails if the speciﬁed RecordSet contains more than 500 resource records (RRs), or if the CloudFormation template surpasses the maximum body of 51,200 bytes. • To create a public Route 53 DNS stack, see Create public DNS Route 53. To update an existing private Route 53 DNS stack, see Update private DNS Route 53. • For RecordSetType = A, be sure to specify either AliasTargetDnsNameor RecordSetValue. • You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. • For more information, see Working with Private Hosted Zones. To update your private DNS stack after it's created, see Update private DNS Route 53. To create a public Route 53 DNS stack, see Create public DNS Route 53. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0c38gftq56zj6. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateAddRoute53Resources", "Region" : "ap-southeast-2", "Parameters": { "DomainName": "mydomain.com", "VPCId": "vpc-5a25bd3f", "DomainType": "private", "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, Advanced Stack Components Version April 22, 2025 120 AMS Advanced Change Type Reference AMS Advanced Change Type Details \"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) \| Create Create a new Route 53 DNS resource record set and a new public hosted zone for a VPC, and conﬁgure traﬃc routing. Full classiﬁcation: Deployment \| Advanced stack components \| DNS (public) \| Create Change Type Details Change type ID ct-0vzsr2nyraedl 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 121 AMS Advanced Change Type Reference Additional Information Create public DNS Route 53 Creating a public Route 53 hosted zone with the console Screenshot of this change type in the AMS console: AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Advanced Stack Components Version April 22, 2025 122 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 public 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
ams-ct-037	ams-ct.pdf	37	When ﬁnished, 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 conﬁgurations 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 public 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 123 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-0vzsr2nyraedl" \ --change-type-version "2.0" --title "Creating New Public Hosted Zone" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- CreateAddRoute53Resources\",\"Region\":\"us-east-1\",\"Parameters\":{\"DomainName \":\"mydomain.com\",\"DomainType\":\"public\",\"RecordSet\":[\"[{\\\"Name\\\":\\ \"test1.mydomain.com\\\",\\\"Type\\\":\\\"A\\\",\\\"TTL\\\":600,\\\"ResourceRecords\\ \":[\\\"10.1.1.1\\\",\\\"10.1.2.2\\\"]}]}\"]}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateDnsPublicParams.json. aws amscm get-change-type-version --change-type-id "ct-0vzsr2nyraedl" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateDnsPublicParams.json 2. Modify and save the execution parameters JSON ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateAddRoute53Resources", "Region": "ap-southeast-2", "Parameters": { "DomainName": "domain.com", "DomainType": "public", "RecordSet": [ "{\"RecordSet\":[{\"Name\":\"test1.domain.com\",\"Type\":\"A\",\"TTL\":600, \"ResourceRecords\":[\"10.1.1.1\",\"10.1.2.2\"]},{\"Name\":\"test3.domain.com\", \"Type\":\"CNAME\",\"TTL\":600,\"ResourceRecords\":[\"www.google.com\"]}, Advanced Stack Components Version April 22, 2025 124 AMS Advanced Change Type Reference AMS Advanced Change Type Details {\"Name\":\"test4.domain.com\",\"Type\":\"A\",\"AliasTarget\":{\"DNSName\": \"d1i3674zujyzy1.cloudfront.net\",\"EvaluateTargetHealth\":true,\"HostedZoneId \":\"Z2FDTNDATAQYW2\"}},{\"Name\":\"weighted.domain.com\",\"Weight\":200, \"SetIdentifier\":\"Example-Set-Identifier-1\",\"Type\":\"A\",\"AliasTarget\": {\"DNSName\":\"d1i3674zujyzy1.cloudfront.net\",\"EvaluateTargetHealth\":true, \"HostedZoneId\":\"Z2FDTNDATAQYW2\"}},{\"Name\":\"geolocationexample.domain.com\", \"SetIdentifier\":\"Example-GeoLocation-Identifier-1\",\"GeoLocation\": {\"CountryCode\":\"US\",\"SubdivisionCode\":\"WA\"},\"Type\":\"A\",\"AliasTarget \":{\"DNSName\":\"d1i3674zujyzy1.cloudfront.net\",\"EvaluateTargetHealth\":true, \"HostedZoneId\":\"Z2FDTNDATAQYW2\"}},{\"Name\":\"examplelatency.domain.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.domain.com\",\"SetIdentifier\":\"Example- MultiValue-Identifier-1\",\"MultiValueAnswer\":true,\"Type\":\"A\",\"TTL\":600, \"ResourceRecords\":[\"10.1.1.1\"]}]}" ] } } 3. Output the JSON template to a ﬁle in your current folder; this example names it CreateDnsPublicRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateDnsPublicRfc.json 4. Modify and save the CreateDnsPublicRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-0vzsr2nyraedl", "Title": "DNS-Public-Create-RFC" } 5. Create the RFC, specifying the execution parameters ﬁle and the CreateDnsPublicRfc ﬁle: aws amscm create-rfc --cli-input-json file://CreateDnsPublicRfc.json --execution- parameters file://CreateDnsPublicParams.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 125 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note To create a private Route 53 DNS stack, see Create private DNS Route 53. Note For RecordSetType = A, be sure to specify either AliasTargetDnsNameor RecordSetValue. Note You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. To learn more, see Working with Public Hosted Zones. To update your public DNS stack after it's created, see Update public DNS Route 53. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0vzsr2nyraedl. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateAddRoute53Resources", "Region" : "us-east-1", "Parameters": { "DomainName": "mydomain.com", "DomainType": "public", Advanced Stack Components Version April 22, 2025 126 AMS Advanced Change Type Reference "RecordSet": [ AMS Advanced Change Type Details "{\"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\"]}]}" ] } } DynamoDB \| Create from Backup Create an Amazon DynamoDB stack from backup. Full classiﬁcation: Deployment \| Advanced stack components \| DynamoDB \| Create from backup Change Type Details Change type ID ct-1h1tuxn2oxrtf 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 127 AMS Advanced Change Type Reference Additional Information DynamoDB (creating from backup) Creating a DynamoDb with an AWS Backup 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-ct-038	ams-ct.pdf	38	from backup. Full classiﬁcation: Deployment \| Advanced stack components \| DynamoDB \| Create from backup Change Type Details Change type ID ct-1h1tuxn2oxrtf 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 127 AMS Advanced Change Type Reference Additional Information DynamoDB (creating from backup) Creating a DynamoDb with an AWS Backup 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 128 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 DynamoDb with an AWS Backup with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 129 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-1h1tuxn2oxrtf" \ --change-type-version "1.0" --title "AWS Backup Start Restore Job for DynamoDB" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices-StartRestoreJobDynamoDB \",\"Region\":\"us-east-1\",\"Parameters\":{\"BackupVaultName\":[\"Default\"], \"RecoveryPointArn\":[\"arn:aws:dynamodb:us-east-1:000000000000:table/table-name/ backup/00000000000000-00000000\"],\"TargetTableName\":[\"TARGET_TABLE_NAME\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON ﬁle; this example names it RestoreJobRestoreDynamoDbParams.json: aws amscm get-change-type-version --change-type-id "ct-1h1tuxn2oxrtf" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > RestoreJobRestoreDynamoDbParams.json 2. Modify and save the RestoreJobRestoreDynamoDbParams ﬁle. { "DocumentName": "AWSManagedServices-StartRestoreJobDynamoDB", "Region": "us-east-1", "Parameters": { "BackupVaultName": ["Default"], "RecoveryPointArn": ["arn:aws:dynamodb:us-east-1:000000000000:table/table-name/ backup/00000000000000-00000000"], "TargetTableName": ["TARGET_TABLE_NAME"] } } 3. Output the RFC template to a ﬁle in your current folder; this example names it RestoreJobRestoreDynamoDbRfc.json: aws amscm create-rfc --generate-cli-skeleton > RestoreJobRestoreDynamoDbRfc.json Advanced Stack Components Version April 22, 2025 130 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the RestoreJobRestoreDynamoDbRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1h1tuxn2oxrtf", "ChangeTypeVersion": "1.0", "Title": "AWS Backup Start Restore Job for DynamoDB" } 5. Create the
ams-ct-039	ams-ct.pdf	39	RestoreJobRestoreDynamoDbParams.json 2. Modify and save the RestoreJobRestoreDynamoDbParams ﬁle. { "DocumentName": "AWSManagedServices-StartRestoreJobDynamoDB", "Region": "us-east-1", "Parameters": { "BackupVaultName": ["Default"], "RecoveryPointArn": ["arn:aws:dynamodb:us-east-1:000000000000:table/table-name/ backup/00000000000000-00000000"], "TargetTableName": ["TARGET_TABLE_NAME"] } } 3. Output the RFC template to a ﬁle in your current folder; this example names it RestoreJobRestoreDynamoDbRfc.json: aws amscm create-rfc --generate-cli-skeleton > RestoreJobRestoreDynamoDbRfc.json Advanced Stack Components Version April 22, 2025 130 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the RestoreJobRestoreDynamoDbRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-1h1tuxn2oxrtf", "ChangeTypeVersion": "1.0", "Title": "AWS Backup Start Restore Job for DynamoDB" } 5. Create the RFC, specifying the RestoreJobRestoreDynamoDbRfc ﬁle and the RestoreJobRestoreDynamoDbParams ﬁle: aws amscm create-rfc --cli-input-json file://RestoreJobRestoreDynamoDbRfc.json -- execution-parameters file://RestoreJobRestoreDynamoDbParams.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 DynamoDB. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1h1tuxn2oxrtf. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-StartRestoreJobDynamoDB", "Region": "us-east-1", "Parameters": { "BackupVaultName": ["Vault01"], "RecoveryPointArn": ["arn:aws:dynamodb:us-east-1::table/xyz-test/ backup/01585118622000-75ee13f1"], Advanced Stack Components Version April 22, 2025 131 AMS Advanced Change Type Reference AMS Advanced Change Type Details "TargetTableName": ["New-TargetTable"] } } EBS Snapshot \| Copy Copy an Elastic Block Store (EBS) snapshot in your AMS account. Full classiﬁcation: Deployment \| Advanced stack components \| EBS snapshot \| Copy Change Type Details Change type ID ct-3lkbpansfv69k Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Copy EBS snapshot Copying EBS Snapshots with the Console Advanced Stack Components Version April 22, 2025 132 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Copying 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. Advanced Stack Components Version April 22, 2025 133 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 notiﬁcations 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-040	ams-ct.pdf	40	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 notiﬁcations 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-3lkbpansfv69k" --change-type-version "2.0" --title "Copy EBS snapshot" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CopyEBSSnapshot\",\"Region\":\"us-east-1\",\"Parameters\": {\"SourceSnapshotId\":[\"SNAPSHOT_ID\"],\"SourceRegion\":[\"ap-southeast-2\"], \"KmsKeyId\":[\"KEY_ID\"],\"Description\":[\"test-snapshot\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; this example names it CopyEbsSnpshtParams.json: aws amscm get-change-type-version --change-type-id "ct-3lkbpansfv69k" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CopyEbsSnpshtParams.json Advanced Stack Components Version April 22, 2025 134 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Modify and save the CopyEbsSnpshtParams ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CopyEBSSnapshot", "Region": "us-east-1", "Parameters": { "SourceSnapshotId": [ "SNAPSHOT_ID" ], "SourceRegion": [ "ap-southeast-2" ], "KmsKeyId": [ "KEY_ID" ], "Description": [ "test-snapshot" ] } } 3. Output the RFC template JSON ﬁle to a ﬁle; this example names it CopyEbsSnpshtRfc.json: aws amscm create-rfc --generate-cli-skeleton > CopyEbsSnpshtRfc.json 4. Modify and save the CopyEbsSnpshtRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-3lkbpansfv69k", "Title": "Copy EBS snapshot" } 5. Create the RFC, specifying the CopyEbsSnpshtRfc ﬁle and the CopyEbsSnpshtParams ﬁle: aws amscm create-rfc --cli-input-json file://CopyEbsSnpshtRfc.json --execution- parameters file://CopyEbsSnpshtParams.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 135 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note A typical use for the EBS snapshot share and copy CTs would be: 1. In account A, use the Share EBS snapshot CT to share the snapshot with account B. 2. In account B, use the EBS snapshot copy CT to copy the snapshot to the AWS Region for account B. Important This change type version, 2.0, removes several parameters, TargetParameterName, Targets, MaxConcurrency, and MaxErrors; and introduces one new parameter, 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-3lkbpansfv69k. Example: Required Parameters { "DocumentName": "AWSManagedServices-CopyEBSSnapshot", "Region": "us-east-1", "Parameters": { "SourceRegion": [ "us-east-1" ], "SourceSnapshotId": [ "snap-1234567890abcdef0" ] } } Advanced Stack Components Version April 22, 2025 136 AMS Advanced Change Type Details AMS Advanced Change Type Reference Example: All Parameters { "DocumentName": "AWSManagedServices-CopyEBSSnapshot", "Region": "us-east-1", "Parameters": { "SourceRegion": [ "us-east-1" ], "SourceSnapshotId": [ "snap-1234567890abcdef0" ], "KmsKeyId": [ "01234567-abcd-abcd-abcd-0123456789ab" ], "Description": [ "my-snapshot" ] } } EBS Snapshot \| Create Create an Elastic Block Store (EBS) snapshot from an EBS volume. The volume must be attached to an EC2 instance. Full classiﬁcation: Deployment \| Advanced stack components \| EBS snapshot \| Create Change Type Details Change type ID ct-3mlsibqhugrf1 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 137 AMS Advanced Change Type Reference Additional Information Create EBS snapshot Creating 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.
ams-ct-041	ams-ct.pdf	41	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. Advanced Stack Components Version April 22, 2025 138 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When ﬁnished, 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 conﬁgurations 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 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 139 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-3mlsibqhugrf1" --change-type-version "1.0" --title "Create EBS snapshot" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateEBSSnapshot\",\"Region\":\"us-east-1\",\"Parameters\": {\"VolumeId\":[\"VOL_ID\"],\"Description\":[\"My snapshot\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; this example names it CreateEbsSnpshtParams.json: aws amscm get-change-type-version --change-type-id "ct-3mlsibqhugrf1" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateEbsSnpshtParams.json 2. Modify and save the CreateEbsSnpshtParams ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateEBSSnapshot", "Region": "us-east-1", "Parameters": { "VolumeId": [ "VOL_ID" ], "Description": [ "My snapshot" ] } } 3. Output the RFC template JSON ﬁle to a ﬁle; this example names it CreateEbsSnpshtRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateEbsSnpshtRfc.json 4. Modify and save the CreateEbsSnpshtRfc.json ﬁle. For example, you can replace the contents with something like this: Advanced Stack Components Version April 22, 2025 140 AMS Advanced Change Type Reference AMS Advanced Change Type Details { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3mlsibqhugrf1", "Title": "Create EBS snapshot" } 5. Create the RFC, specifying the CreateEbsSnpshtRfc ﬁle and the CreateEbsSnpshtParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateEbsSnpshtRfc.json --execution- parameters file://CreateEbsSnpshtParams.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-3mlsibqhugrf1. Example: Required Parameters { "DocumentName": "AWSManagedServices-CreateEBSSnapshot", "Region": "us-east-1", "Parameters": { "VolumeId": [ "vol-1234567890abcdef0" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-CreateEBSSnapshot", Advanced Stack Components Version April 22, 2025 141 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters": { "VolumeId": [ "vol-1234567890abcdef0" ], "Description": [ "my-snapshot" ] } } EBS Volume \| Create Creates up to ﬁve EBS volumes, and attaches them to an existing EC2 instance that
ams-ct-042	ams-ct.pdf	42	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-3mlsibqhugrf1. Example: Required Parameters { "DocumentName": "AWSManagedServices-CreateEBSSnapshot", "Region": "us-east-1", "Parameters": { "VolumeId": [ "vol-1234567890abcdef0" ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-CreateEBSSnapshot", Advanced Stack Components Version April 22, 2025 141 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters": { "VolumeId": [ "vol-1234567890abcdef0" ], "Description": [ "my-snapshot" ] } } EBS Volume \| Create Creates up to ﬁve EBS volumes, and attaches them to an existing EC2 instance that you specify. Does not create a root volume. Full classiﬁcation: Deployment \| Advanced stack components \| EBS Volume \| Create Change Type Details Change type ID ct-16xg8qguovg2w 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 142 AMS Advanced Change Type Reference Additional Information Create EBS volume Creating 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 143 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 144 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-16xg8qguovg2w" --change-type-version "1.0" --title "EBS-Create-RFC" --execution-parameters "{\"Description\": \"Create 2 volumes and attach to i-12345678901234567\",\"VpcId\": \"vpc-0a60eb65b4EXAMPLE\",\"Name\": \"EBSVolumeStack\",\"StackTemplateId\": \"stm-hrnfpt7l0qqumcelt\",\"TimeoutInMinutes \":\"45\",\"Parameters\": {\"AvailabilityZone\": \"us-east-1d\",\"InstanceId\": \"i-12345678901234567\",\"Volume1Name\": \"/dev/xvdf\",\"Volume1Size\": \"20\", \"Volume1Type\": \"gp3\",\"Volume1Iops\": \"3000\",\"Volume1Throughput\": \"125\", \"Volume2Name\": \"/dev/xvdg\",\"Volume2Size\": \"20\",\"Volume2Iops\": \"200\", \"Volume2Type\": \"io2\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; this example names it CreateEbsParams.json: aws amscm get-change-type-version --change-type-id "ct-16xg8qguovg2w" --query "ChangeTypeVersion.ExecutionInputSchema" --output text >
ams-ct-043	ams-ct.pdf	43	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-16xg8qguovg2w" --change-type-version "1.0" --title "EBS-Create-RFC" --execution-parameters "{\"Description\": \"Create 2 volumes and attach to i-12345678901234567\",\"VpcId\": \"vpc-0a60eb65b4EXAMPLE\",\"Name\": \"EBSVolumeStack\",\"StackTemplateId\": \"stm-hrnfpt7l0qqumcelt\",\"TimeoutInMinutes \":\"45\",\"Parameters\": {\"AvailabilityZone\": \"us-east-1d\",\"InstanceId\": \"i-12345678901234567\",\"Volume1Name\": \"/dev/xvdf\",\"Volume1Size\": \"20\", \"Volume1Type\": \"gp3\",\"Volume1Iops\": \"3000\",\"Volume1Throughput\": \"125\", \"Volume2Name\": \"/dev/xvdg\",\"Volume2Size\": \"20\",\"Volume2Iops\": \"200\", \"Volume2Type\": \"io2\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; this example names it CreateEbsParams.json: aws amscm get-change-type-version --change-type-id "ct-16xg8qguovg2w" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateEbsParams.json 2. Modify and save the CreateEbsParams ﬁle. For example, you can replace the contents with something like this: { "Description": "Create 2 volumes and attach to i-12345678901234567.", "VpcId": "vpc-0a60eb65b4EXAMPLE", "Name": "EBSVolumeStack", "StackTemplateId": "stm-hrnfpt7l0qqumcelt", "TimeoutInMinutes": "45", "Parameters": { "AvailabilityZone": "us-east-1a", "InstanceId": "i-12345678901234567", "Volume1Name": "/dev/xvdf", "Volume1Size": "20", "Volume1Type": "gp3" "Volume1Iops": "3000", "Volume1Throughput": "125", "Volume2Name": "/dev/xvdg", Advanced Stack Components Version April 22, 2025 145 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Volume2Size": "20", "Volume2Iops": "200", "Volume2Type": "io2" } } 3. Output the RFC template JSON ﬁle to a ﬁle; this example names it CreateEbsRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateEbsRfc.json 4. Modify and save the CreateEbsRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-16xg8qguovg2w", "Title": "EBS-Create-RFC" } 5. Create the RFC, specifying the CreateEbsRfc ﬁle and the CreateEbsParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateEbsRfc.json --execution- parameters file://CreateEbsParams.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-16xg8qguovg2w. Example: Required Parameters { "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", Advanced Stack Components Version April 22, 2025 146 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Name": "Test Stack", "Parameters": { "AvailabilityZone": "us-west-2a", "InstanceId": "i-04ca00332c8e8c226", "Volume1Name": "/dev/xvdbb", "Volume1Size": "100", "Volume1Type": "gp2" }, "TimeoutInMinutes": 60, "StackTemplateId": "stm-hrnfpt7l0qqumcelt" } Example: All Parameters { "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "Name": "Test Stack", "Tags": [ { "Key": "key1", "Value": "value1" }, { "Key": "key2", "Value": "value2" } ], "Parameters": { "AvailabilityZone": "us-west-2a", "InstanceId": "i-04ca00332c8e8c226", "Volume1Iops": "3000", "Volume1Throughput": "125", "Volume1KmsKeyId": "225bc21e-fc82-4388-8c91-855f3cadb63c", "Volume1Name": "/dev/xvdbb", "Volume1Size": "100", "Volume1Snapshot": "snap-12345678", "Volume1Type": "gp3", "Volume2Iops": "3000", "Volume2Throughput": "125", "Volume2KmsKeyId": "225bc21e-fc82-4388-8c91-855f3cadb63c", "Volume2Name": "/dev/xvdbc", "Volume2Size": "100", Advanced Stack Components Version April 22, 2025 147 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Volume2Snapshot": "snap-12345678", "Volume2Type": "gp3", "Volume3Iops": "3000", "Volume3Throughput": "125", "Volume3KmsKeyId": "225bc21e-fc82-4388-8c91-855f3cadb63c", "Volume3Name": "/dev/xvdbd", "Volume3Size": "100", "Volume3Snapshot": "snap-12345678", "Volume3Type": "gp3", "Volume4Iops": "3000", "Volume4Throughput": "125", "Volume4KmsKeyId": "225bc21e-fc82-4388-8c91-855f3cadb63c", "Volume4Name": "/dev/xvdbe", "Volume4Size": "100", "Volume4Snapshot": "snap-12345678", "Volume4Type": "gp3", "Volume5Iops": "3000", "Volume5Throughput": "125", "Volume5KmsKeyId": "225bc21e-fc82-4388-8c91-855f3cadb63c", "Volume5Name": "/dev/xvdbf", "Volume5Size": "100", "Volume5Snapshot": "snap-12345678", "Volume5Type": "gp3" }, "TimeoutInMinutes": 60, "StackTemplateId": "stm-hrnfpt7l0qqumcelt" } EBS Volume \| Create from Backup Create an AWS Elastic Block Store (EBS) stack from backup. Full classiﬁcation: Deployment \| Advanced stack components \| EBS Volume \| Create from backup Change Type Details Change type ID ct-063qsm82cfxu6 Current version 1.0 Expected execution duration 60 minutes AWS approval Required Advanced Stack Components Version April 22, 2025 148 AMS Advanced Change Type Reference AMS Advanced Change Type Details Customer approval Not required Execution mode Automated Additional Information Create EBS volume from backup Creating EBS with an AWS Backup with the Console Screenshot of this change type, in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. Advanced Stack Components Version April 22, 2025 149 AMS Advanced Change Type Reference AMS Advanced Change Type Details 3. On the Run RFC page, open the CT name area to see the
ams-ct-044	ams-ct.pdf	44	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 149 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 EBS with an AWS Backup with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 150 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-063qsm82cfxu6" \ --change-type-version "1.0" --title "EBS Create From Backup" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices-StartRestoreJobEBS \",\"Region\":\"us-east-1\",\"Parameters\":{\"AvailabilityZone\":[\"us-east-1a\"], \"BackupVaultName\":[\"Default\"],\"RecoveryPointArn\":[\"arn:aws:ec2:us- east-1::snapshot/snap-0000000000000000\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON ﬁle; this example names it EbsCreateFromBackupParams.json: aws amscm get-change-type-version --change-type-id "ct-063qsm82cfxu6" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > EbsCreateFromBackupParams.json 2. Modify and save the EbsCreateFromBackupParams ﬁle. { "DocumentName": "AWSManagedServices-StartRestoreJobEBS", "Region": "us-east-1", "Parameters": { "AvailabilityZone": ["us-east-1a"], "BackupVaultName": ["Default"], "RecoveryPointArn": ["arn:aws:ec2:us-east-1::snapshot/snap-0000000000000000"] } } 3. Output the RFC template to a ﬁle in your current folder; this example names it EbsCreateFromBackupRfc.json: Advanced Stack Components Version April 22, 2025 151 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > EbsCreateFromBackupRfc.json 4. Modify and save the EbsCreateFromBackupRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-063qsm82cfxu6", "ChangeTypeVersion": "1.0", "Title": "EBS Create From Backup" } 5. Create the RFC, specifying the EbsCreateFromBackupRfc ﬁle and the EbsCreateFromBackupParams ﬁle: aws amscm create-rfc --cli-input-json file://EbsCreateFromBackupRfc.json -- execution-parameters file://EbsCreateFromBackupParams.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-063qsm82cfxu6. Example: Required Parameters { "DocumentName": "AWSManagedServices-StartRestoreJobEBS", "Region": "us-east-1", "Parameters": { "AvailabilityZone": ["us-east-1a"], "BackupVaultName": ["Vault01"], "RecoveryPointArn": ["arn:aws:ec2:us-east-1::snapshot/snap-00000000000000000"] } } Advanced Stack Components Version April 22, 2025 152 AMS Advanced Change Type Reference Example: All Parameters { AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-StartRestoreJobEBS", "Region": "us-east-1", "Parameters": { "AvailabilityZone": ["us-east-1a"], "BackupVaultName": ["Vault01"], "IOPS": ["250"], "RecoveryPointArn": ["arn:aws:ec2:us-east-1::snapshot/snap-00000000000000000"], "VolumeSize": ["100"], "VolumeType": ["gp3"], "Throughput": ["125"] } } EC2 Stack \| Create Use to create an Amazon Elastic Compute Cloud (EC2) instance. Full classiﬁcation: Deployment \| Advanced stack components \| EC2 stack \| Create Change Type Details Change type ID ct-14027q0sjyt1h Current version 5.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components
ams-ct-045	ams-ct.pdf	45	} } Advanced Stack Components Version April 22, 2025 152 AMS Advanced Change Type Reference Example: All Parameters { AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-StartRestoreJobEBS", "Region": "us-east-1", "Parameters": { "AvailabilityZone": ["us-east-1a"], "BackupVaultName": ["Vault01"], "IOPS": ["250"], "RecoveryPointArn": ["arn:aws:ec2:us-east-1::snapshot/snap-00000000000000000"], "VolumeSize": ["100"], "VolumeType": ["gp3"], "Throughput": ["125"] } } EC2 Stack \| Create Use to create an Amazon Elastic Compute Cloud (EC2) instance. Full classiﬁcation: Deployment \| Advanced stack components \| EC2 stack \| Create Change Type Details Change type ID ct-14027q0sjyt1h Current version 5.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 153 AMS Advanced Change Type Reference Additional Information Create stack Creating an EC2 instance with the console The following shows this change type in the AMS console. AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 154 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 155 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-14027q0sjyt1h" --change-type-version "4.0" --title "EC2-Create-RFC" --execution-parameters "{\"Description\": \"Create a new EC2 Instance stack\",\"VpcId\": \"vpc-0a60eb65b4EXAMPLE\",\"Name\": \"My-EC2\", \"TimeoutInMinutes\": 60,\"Parameters\": {\"InstanceAmiId\": \"ami-1234567890EXAMPLE\", \"InstanceDetailedMonitoring\": false,\"InstanceEBSOptimized\": false,\"InstanceProfile \": \"customer-mc-ec2-instance-profile\",\"InstanceRootVolumeIops\": 3000, \"InstanceRootVolumeType\": \"gp3\",\"InstanceType\": \"t2.large\",\"InstanceUserData \": \"\",\"InstanceSubnetId\": \"subnet-0bb1c79de3EXAMPLE\",\"EnforceIMDSV2\": \"false\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it CreateEC2Params.json: aws amscm get-change-type-version --change-type-id "ct-14027q0sjyt1h" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateEC2Params.json 2. Modify and save the CreateEC2Params ﬁle. For example, you can replace the contents with something like this: { "Description": "Create a new EC2 Instance stack", "VpcId": "vpc-0a60eb65b4EXAMPLE", "Name": "My-EC2", "TimeoutInMinutes": 60, "Parameters": { "InstanceAmiId": "ami-1234567890EXAMPLE", "InstanceDetailedMonitoring":
ams-ct-046	ams-ct.pdf	46	"ct-14027q0sjyt1h" --change-type-version "4.0" --title "EC2-Create-RFC" --execution-parameters "{\"Description\": \"Create a new EC2 Instance stack\",\"VpcId\": \"vpc-0a60eb65b4EXAMPLE\",\"Name\": \"My-EC2\", \"TimeoutInMinutes\": 60,\"Parameters\": {\"InstanceAmiId\": \"ami-1234567890EXAMPLE\", \"InstanceDetailedMonitoring\": false,\"InstanceEBSOptimized\": false,\"InstanceProfile \": \"customer-mc-ec2-instance-profile\",\"InstanceRootVolumeIops\": 3000, \"InstanceRootVolumeType\": \"gp3\",\"InstanceType\": \"t2.large\",\"InstanceUserData \": \"\",\"InstanceSubnetId\": \"subnet-0bb1c79de3EXAMPLE\",\"EnforceIMDSV2\": \"false\"}}" TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle; this example names it CreateEC2Params.json: aws amscm get-change-type-version --change-type-id "ct-14027q0sjyt1h" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateEC2Params.json 2. Modify and save the CreateEC2Params ﬁle. For example, you can replace the contents with something like this: { "Description": "Create a new EC2 Instance stack", "VpcId": "vpc-0a60eb65b4EXAMPLE", "Name": "My-EC2", "TimeoutInMinutes": 60, "Parameters": { "InstanceAmiId": "ami-1234567890EXAMPLE", "InstanceDetailedMonitoring": false, "InstanceEBSOptimized": false, "InstanceProfile": "customer-mc-ec2-instance-profile", "InstanceRootVolumeIops": 3000, "InstanceRootVolumeType": "gp3", "InstanceType": "t2.large", "InstanceUserData": "", "InstanceSubnetId": "subnet-0bb1c79de3EXAMPLE", Advanced Stack Components Version April 22, 2025 156 AMS Advanced Change Type Reference AMS Advanced Change Type Details "EnforceIMDSV2": "false" } } 3. Output the RFC template to a ﬁle in your current folder; this example names it CreateEC2Rfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateEC2Rfc.json 4. Modify and save the CreateEC2Rfc.json ﬁle. For example, you can replace the contents with something like this:. { "ChangeTypeVersion": "4.0", "ChangeTypeId": "ct-14027q0sjyt1h", "Title": "EC2-Create-RFC" } 5. Create the RFC, specifying the CreateEC2Rfc ﬁle and the CreateEC2Params ﬁle: aws amscm create-rfc --cli-input-json file://CreateEC2Rfc.json --execution- parameters file://CreateEC2Params.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 Security Groups Starting with version 3.0 of this change type, AMS does not attach the default AMS security groups if you specify your own security groups. If you do not specify your own security groups in the request, AMS attaches the AMS default security groups. In previous versions, AMS attached the default security groups whether or not you provided your own security groups. Currently, if you specify custom security groups, you must also specify the IDs of the default AMS security groups for your account, mc-initial-garden-SG-name and mc- initial-garden-SG-name. Advanced Stack Components Version April 22, 2025 157 AMS Advanced Change Type Reference AMS Advanced Change Type Details Instance Types AMS does not recommend the t2.micro/t3.micro and t2.nano/t3.nano types. These are smaller instance types, and can degrade the performance of your application and AMS tools. EC2 instances need enough capacity to support AMS tools such as EPS, SSM, and Cloudwatch in addition to the application workload. For more information, see Choosing the Right EC2 Instance Type for Your Application. To create an EC2 stack with additional volumes, see EC2 Stack \| Create (with Additional Volumes). You can add up to 50 tags, but to do so you must enable the Additional conﬁguration view. 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-14027q0sjyt1h. Example: Required Parameters { "Description": "This is a test description", "VpcId": "vpc-1234567890abcdef0", "Name": "Test Stack", "TimeoutInMinutes": 360, "Parameters": { "InstanceAmiId": "ami-1234567890abcdef0", "InstanceSubnetId": "subnet-1234567890abcdef0", "EnforceIMDSV2": "true" } } Example: All Parameters { "Description": "This is a test description", "VpcId": "vpc-12345678", "Name": "Test Stack", "Tags": [ { Advanced Stack Components Version April 22, 2025 158 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "TimeoutInMinutes": 60, "Parameters": { "InstanceAmiId": "ami-a0b1c2d3", "InstanceDetailedMonitoring": false, "InstanceEBSOptimized": false, "InstanceProfile": "customer-mc-ec2-instance-profile", "InstanceRootVolumeIops": 3000, "InstanceRootVolumeName": "/dev/xvda", "InstanceRootVolumeSize": 60, "InstanceRootVolumeType": "gp3", "InstancePrivateStaticIp": "172.16.0.0", "InstanceSubnetId": "subnet-a0b1c2d3", "InstanceType": "t2.large", "InstanceUserData": "pwd\nls -ltrh\necho \"Hello, World\"", "EnforceIMDSV2": "true" } } EC2 Stack \| Create (With Additional Volumes) Create an Amazon Elastic Compute Cloud (EC2) instance with up to ﬁve additional volumes. Full classiﬁcation: Deployment \| Advanced stack components \| EC2 stack \| Create (with additional volumes) Change Type Details Change type ID ct-1aqsjf86w6vxg Current version 5.0 Expected execution duration 360 minutes AWS approval Required Advanced Stack Components Version April 22, 2025 159 AMS Advanced Change Type Reference AMS Advanced Change Type Details Customer approval Not required Execution mode Automated Additional Information Create stack (with additional volumes) Creating an EC2 instance and additional 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. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT
ams-ct-047	ams-ct.pdf	47	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 160 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 161 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 (example shows required parameters only). For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-1aqsjf86w6vxg" --change-type-version "4.0" --title "EC2-Create-A-V-QC" --execution-parameters "{\"Description\":\"My EC2 stack with addl vol\",\"VpcId\":\"VPC_ID\",\"Name\":\"My Stack\",\"StackTemplateId\": \"stm-nn8v8ffhcal611bmo\",\"TimeoutInMinutes\":60,\"Parameters\":{\"InstanceAmiId\": \"AMI_ID\",\"InstanceSubnetId\":\"SUBNET_ID\"}} TEMPLATE CREATE: 1. Output the execution parameters for this change type to a JSON ﬁle named CreateEC2AVParams.json. aws amscm get-change-type-version --change-type-id "ct-1aqsjf86w6vxg" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateEC2AVParams.json 2. Modify and save the CreateEC2AVParams ﬁle (example shows most parameters). For example, you can replace the contents with something like this: { "Description": "EC2-Create-1-Addl-Volumes", "VpcId": "VPC_ID", "StackTemplateId": "stm-nn8v8ffhcal611bmo", "Name": "My-EC2-1-Addl-Volume", "TimeoutInMinutes": 60, "Parameters": { "InstanceAmiId": "AMI_ID", "InstanceSecurityGroupIds": "SECURITY_GROUP_ID", "InstanceCoreCount": 1, "InstanceThreadsPerCore": 2, "InstanceDetailedMonitoring": "true", "InstanceEBSOptimized": "false", "InstanceProfile": "customer-mc-ec2-instance-profile", Advanced Stack Components Version April 22, 2025 162 AMS Advanced Change Type Reference AMS Advanced Change Type Details "InstanceRootVolumeIops": 100, "InstanceRootVolumeName": "/dev/xvda", "InstanceRootVolumeSize": 50, "InstanceRootVolumeType": "io1", "RootVolumeKmsKeyId": "default", "InstancePrivateStaticIp": "10.27.0.100", "InstanceSecondaryPrivateIpAddressCount": 0, "InstanceTerminationProtection": "false", "InstanceType": "t3.large", "CreditSpecification": "unlimited", "InstanceUserData": "echo $", "Volume1Encrypted": "true", "Volume1Iops": "IOPS" "Volume1KmsKeyId": "KMS_MASTER_KEY_ID", "Volume1Name": "xvdh" "Volume1Size": "2 GiB", "Volume1Snapshot": "SNAPSHOT_ID", "Volume1Type": "iol", "InstanceSubnetId": "SUBNET_ID" } } 3. Output the RFC template to a ﬁle in your current folder; this example names it CreateEC2AVRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateEC2AVRfc.json 4. Modify and save the CreateEC2AVRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "4.0", "ChangeTypeId": "ct-1aqsjf86w6vxg", "Title": "EC2-Create-1-Addl-Volume-RFC" } 5. Create the RFC, specifying the CreateEC2AVRfc ﬁle and the CreateEC2AVParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateEC2AVRfc.json --execution- parameters file://CreateEC2AVParams.json Advanced Stack Components Version April 22, 2025 163 AMS Advanced Change Type Reference AMS Advanced Change Type Details You receive the
ams-ct-048	ams-ct.pdf	48	"2 GiB", "Volume1Snapshot": "SNAPSHOT_ID", "Volume1Type": "iol", "InstanceSubnetId": "SUBNET_ID" } } 3. Output the RFC template to a ﬁle in your current folder; this example names it CreateEC2AVRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateEC2AVRfc.json 4. Modify and save the CreateEC2AVRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "4.0", "ChangeTypeId": "ct-1aqsjf86w6vxg", "Title": "EC2-Create-1-Addl-Volume-RFC" } 5. Create the RFC, specifying the CreateEC2AVRfc ﬁle and the CreateEC2AVParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateEC2AVRfc.json --execution- parameters file://CreateEC2AVParams.json Advanced Stack Components Version April 22, 2025 163 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 Important There is a new version of this change type, v 4.0, that uses a diﬀerent StackTemplateId (stm-nn8v8ﬀhcal611bmo). This is important if you're submitting the RFC with this change type at the command line. The new version introduces two new parameters (RootVolumeKmsKeyId and CreditSpeciﬁcation) and changes the default for one existing parameter (InstanceType). Instance Types • If you choose to specify the number of cores or threads, you must specify values for both. Use the parameters InstanceCoreCount and InstanceThreadsPerCore. To ﬁnd valid combinations of cores/threads, see CPU cores and threads per CPU core per instance type . • AMS does not recommend the t2.micro/t3.micro or t2.nano/t3.nano instance types. These are too small to support AMS tools such as EPS, SSM, and Cloudwatch in addition to your business workload. For more information, see Choosing the Right EC2 Instance Type for Your Application. • In version 4.0, the default type was raised from t2.large to t3.large. T3 instances launch with 'unlimited credits' by default. You won't experience CPU throttling even if the instance consumes all CPU credits. You can, instead, choose T2 instances and use the CreditSpeciﬁcation unlimited option. • For more information about Amazon EC2, including size recommendations, see Amazon Elastic Compute Cloud Documentation. To update your EC2 stack with additional volumes after they're created, see EC2 Instance stack: Updating (With Additional Volumes) Advanced Stack Components Version April 22, 2025 164 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-1aqsjf86w6vxg. Example: Required Parameters { "Description" : "Test description", "VpcId" : "vpc-12345678901234567", "Name" : "TestStack", "StackTemplateId" : "stm-nn8v8ffhcal611bmp", "TimeoutInMinutes" : 60, "Parameters" : { "InstanceAmiId" : "ami-1234567890abcdef0", "InstanceSubnetId" : "subnet-1234567890abcdef0", "EnforceIMDSV2": "true" } } Example: All Parameters { "Description": "This is a test description", "VpcId": "vpc-12345678", "Name": "Test Stack", "Tags": [ { "Key": "key1", "Value": "value1" }, { "Key": "key2", "Value": "value2" } ], "Parameters": { "InstanceAmiId": "ami-12345678", "InstanceCoreCount": 0, "InstanceThreadsPerCore": 0, "InstanceRootVolumeName": "/dev/xvda", "InstanceRootVolumeSize": 100, "InstanceSubnetId": "subnet-12345678", Advanced Stack Components Version April 22, 2025 165 AMS Advanced Change Type Reference AMS Advanced Change Type Details "InstanceDetailedMonitoring": "false", "InstanceEBSOptimized": "false", "InstanceProfile": "customer-mc-ec2-instance-profile", "InstanceRootVolumeIops": 1000, "InstanceRootVolumeType": "io1", "InstancePrivateStaticIp": "172.16.0.10", "InstanceSecondaryPrivateIpAddressCount" : 1, "InstanceTerminationProtection" : "true", "InstanceType": "t2.small", "InstanceUserData": "#!/bin/bash\\npwd\\nls -ltrh\\necho \"Hello, World\"", "Volume1Iops": 100, "Volume1KmsKeyId": "12345678-1234-1234-1234-1234567890ab", "Volume1Name": "/dev/sdf", "Volume1Size": 100, "Volume1Type": "io1", "Volume2Iops": 100, "Volume2KmsKeyId": "12345678-1234-1234-1234-1234567890ab", "Volume2Name": "/dev/sdg", "Volume2Size": 100, "Volume2Type": "io1", "Volume3Iops": 100, "Volume3KmsKeyId": "12345678-1234-1234-1234-1234567890ab", "Volume3Name": "/dev/sdh", "Volume3Size": 100, "Volume3Type": "io1", "Volume4Iops": 100, "Volume4KmsKeyId": "12345678-1234-1234-1234-1234567890ab", "Volume4Name": "/dev/sdi", "Volume4Size": 100, "Volume4Type": "io1", "Volume5Iops": 100, "Volume5KmsKeyId": "12345678-1234-1234-1234-1234567890ab", "Volume5Name": "/dev/sdj", "Volume5Size": 100, "Volume5Type": "io1", "EnforceIMDSV2": "true" }, "TimeoutInMinutes": 60, "StackTemplateId": "stm-nn8v8ffhcal611bmp" } Advanced Stack Components Version April 22, 2025 166 AMS Advanced Change Type Reference AMS Advanced Change Type Details Elastic File System (EFS) \| Create Use to create a Elastic File System (EFS) stack Full classiﬁcation: Deployment \| Advanced stack components \| Elastic File System (EFS) \| Create Change Type Details Change type ID ct-2uw99b8hpncnu Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create EFS Creating an Elastic File System with the console The following shows this change type in the AMS console. How it works: Advanced Stack Components Version April 22, 2025 167 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
ams-ct-049	ams-ct.pdf	49	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an Elastic File System 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 168 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 notiﬁcations 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 --profile saml --region us-east-1 amscm create-rfc --change-type-id ct-2uw99b8hpncnu --change-type-version 1.0 --title "TEST-EFS-RFC" --description "TEST-EFS-RFC" --execution-parameters "{\"Description\":\"TEST-EFS\",\"Name\":\"Test- EFS-Stack\",\"VpcId\":\"VPC_ID\",\"TimeoutInMinutes\":60,\"Parameters\":{\"Encrypted \":true,\"PerformanceMode\":\"generalPurpose\",\"MountTargets\":[{\"AvailabilityZone\": \"us-east-1a\"}]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON ﬁle; this example names it CreateEfsParams.json: aws amscm get-change-type-version --change-type-id "ct-2uw99b8hpncnu" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateEfsParams.json Advanced Stack Components Version April 22, 2025 169 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Modify and save the CreateEfsParams ﬁle. For example, you can replace the contents with something like this: { "Description": "EFS-Create", "VpcId": "VPC_ID", "StackTemplateId": "stm-sdhopv00000000000", "Name": "My-EFS", "Parameters": { "ELBSubnetIds": ["PUBLIC_SUBNET"], } } 3. Output the RFC template to a ﬁle in your current folder; this example names it CreateEfsRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateEfsRfc.json 4. Modify and save the CreateEfsRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2uw99b8hpncnu", "Title": "EFS-Create-RFC" } 5. Create the RFC, specifying the CreateEfsRfc ﬁle and the CreateEfsParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateEfsRfc.json --execution- parameters file://CreateEfsParams.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 170 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note Currently AMS has a known issue that is preventing the auto-mounting of the EFS by using the UserData ﬁeld when creating new instances. For more information, see Amazon Elastic File System Documentation. This change type creates an EFS and mounts targets in your speciﬁed Availability Zones. You only
ams-ct-050	ams-ct.pdf	50	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 170 AMS Advanced Change Type Reference AMS Advanced Change Type Details Tips Note Currently AMS has a known issue that is preventing the auto-mounting of the EFS by using the UserData ﬁeld when creating new instances. For more information, see Amazon Elastic File System Documentation. This change type creates an EFS and mounts targets in your speciﬁed Availability Zones. You only need to specify an Availability Zone to create a mount target, but you can optionally specify a speciﬁc subnet to create the mount target in, and a private IP address to give the mount target within that subnet. If you only specify an Availability Zone, AMS picks a subnet/IP address to give the mount target. For an example of creating an EFS, , see Create EFS. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2uw99b8hpncnu. Example: Required Parameters { "Description": "This is a test description", "Name": "Test Stack", "VpcId": "vpc-1234567890abcdef0", "TimeoutInMinutes": 60, "Parameters": { "Encrypted": true, "PerformanceMode": "generalPurpose", "MountTargets": [ { "AvailabilityZone": "us-east-1a" } ] } } Example: All Parameters { Advanced Stack Components Version April 22, 2025 171 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Description": "This is a test description", "Name": "Test Stack", "VpcId": "vpc-12345678", "TimeoutInMinutes": 60, "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ], "Parameters": { "Encrypted": true, "KmsKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "PerformanceMode": "generalPurpose", "MountTargets": [ { "AvailabilityZone": "us-east-1a", "SubnetId": "subnet-12345678", "IpAddress": "10.0.0.1" } ] } } Elastic File System (EFS) \| Create from Backup Create an AWS Elastic File System (EFS) stack from backup. Full classiﬁcation: Deployment \| Advanced stack components \| Elastic File System (EFS) \| Create from backup Change Type Details Change type ID ct-0g690ekkyfm79 Current version 1.0 Expected execution duration 60 minutes Advanced Stack Components Version April 22, 2025 172 AMS Advanced Change Type Reference AMS Advanced Change Type Details AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create EFS from backup Creating EFS with an AWS Backup with the Console Screenshot of this change type, in the AMS console: How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. Advanced Stack Components Version April 22, 2025 173 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 EFS with an AWS Backup with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. 2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned
ams-ct-051	ams-ct.pdf	51	RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating EFS with an AWS Backup with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations when the RFC status Advanced Stack Components Version April 22, 2025 174 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-0g690ekkyfm79" \ --change-type-version "1.0" --title "EFS Create From Backup" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices-StartRestoreJobEFS \",\"Region\":\"us-east-1\",\"Parameters\":{\"BackupVaultName\":[\"Default\"], \"RecoveryPointArn\":[\"RECOVERY_POINT_ARN\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a JSON ﬁle; this example names it EfsCreateFromBackupParams.json: aws amscm get-change-type-version --change-type-id "ct-0g690ekkyfm79" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > EfsCreateFromBackupParams.json 2. Modify and save the EfsCreateFromBackupParams ﬁle. { "DocumentName": "AWSManagedServices-StartRestoreJobEFS", "Region": "us-east-1", "Parameters": { "BackupVaultName": ["Default"], "EnableEncryption": ["true"], "KmsKeyId": ["arn:aws:kms:us- east-1:000000000000:key/00000000-0000-0000-0000-000000000000"], "PerformanceMode": ["maxIO"], "RecoveryPointArn": ["arn:aws:backup:us-east-1:000000000000:recovery- point:00000000-0000-0000-0000-000000000000"], Advanced Stack Components Version April 22, 2025 175 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RestoreToNewFileSystem": ["true"] } } 3. Output the RFC template to a ﬁle in your current folder; this example names it EfsCreateFromBackupRfc.json: aws amscm create-rfc --generate-cli-skeleton > EfsCreateFromBackupRfc.json 4. Modify and save the EfsCreateFromBackupRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-0g690ekkyfm79", "ChangeTypeVersion": "1.0", "Title": "EFS Create From Backup" } 5. Create the RFC, specifying the EfsCreateFromBackupRfc ﬁle and the EfsCreateFromBackupParams ﬁle: aws amscm create-rfc --cli-input-json file://EfsCreateFromBackupRfc.json -- execution-parameters file://EfsCreateFromBackupParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips To learn more about AWS Backup, see AWS Backup: How It Works. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-0g690ekkyfm79. Example: Required Parameters { "DocumentName": "AWSManagedServices-StartRestoreJobEFS", "Region": "us-east-1", Advanced Stack Components Version April 22, 2025 176 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Parameters": { "BackupVaultName": ["Vault01"], "RecoveryPointArn": ["arn:aws:ec2:us-east-1::snapshot/snap-00000000000000000"] } } Example: All Parameters { "DocumentName": "AWSManagedServices-StartRestoreJobEFS", "Region": "us-east-1", "Parameters": { "BackupVaultName": ["Vault01"], "EnableEncryption": ["true"], "ItemsToRestore": ["/dir1", "/dir2"], "KmsKeyId": ["arn:aws:kms:us- east-1:000000000000:key/00000000-0000-0000-0000-000000000000"], "PerformanceMode": ["maxIO"], "RecoveryPointArn": ["arn:aws:ec2:us-east-1::snapshot/snap-00000000000000000"], "RestoreToNewFileSystem": ["true"] } } Identity and Access Management (IAM) \| Create Access Key Create a new AWS secret access key and corresponding AWS access key ID for the speciﬁed user. Full classiﬁcation: Deployment \| Advanced stack components \| Identity and Access Management (IAM) \| Create access key Change Type Details Change type ID ct-2hhqzgxvkcig8 Current version 2.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Advanced Stack Components Version April 22, 2025 177 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution mode Automated Additional Information Create access key Creating access key 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
ams-ct-052	ams-ct.pdf	52	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 178 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations 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 access key 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 179 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note When pasting in a policy document, note that the RFC only accepts policy pastes up to 5,000 characters. If your ﬁle has more than 5,000 characters, create a service request to upload the policy and then refer to that service request in the RFC that you open for IAM. 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-2hhqzgxvkcig8" --change-type-version "2.0" --title "Create access key" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateIAMAccessKey\",\"Region\": \"us-east-1\",\"Parameters\": {\"UserARN\": \"arn:aws:iam::012345678910:user/myusername\"}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; example names it CreateIamAccessKeyParameters.json: aws amscm get-change-type-version --change-type-id "ct-2hhqzgxvkcig8" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateIamAccessKeyParameters.json 2. Modify and save the CreateIamAccessKeyParameters.json ﬁle; example creates an IAM Role with policy documents pasted inline. { "DocumentName": "AWSManagedServices-CreateIAMAccessKey", "Region": "ap-southeast-2", "Parameters": { "UserARN": "arn:aws:iam::012345678910:user/myusername" } } } 3. Output the RFC template JSON ﬁle to a ﬁle named CreateIamAccessKeyRfc.json: Advanced Stack Components Version April 22, 2025 180 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > CreateIamAccessKeyRfc.json 4. Modify and save the CreateIamAccessKeyRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-2hhqzgxvkcig8", "Title": "Create IAM access key" } 5. Create the RFC, specifying the CreateIamAccessKeyRfc.json ﬁle and the CreateIamAccessKeyParameters.json ﬁle: aws amscm create-rfc --cli-input-json file://CreateIamAccessKeyRFC.json -- execution-parameters file://CreateIamAccessKeyParameters.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 AWS Identity and Access Management, see AWS Identity and Access Management (IAM) and for policy information, see Managed policies and inline policies. For information about AMS permissions, see Deploying IAM resources. Execution Input Parameters For detailed information about the execution input parameters, see Schema
ams-ct-053	ams-ct.pdf	53	the CreateIamAccessKeyRfc.json ﬁle and the CreateIamAccessKeyParameters.json ﬁle: aws amscm create-rfc --cli-input-json file://CreateIamAccessKeyRFC.json -- execution-parameters file://CreateIamAccessKeyParameters.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 AWS Identity and Access Management, see AWS Identity and Access Management (IAM) and for policy information, see Managed policies and inline policies. For information about AMS permissions, see Deploying IAM resources. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2hhqzgxvkcig8. Example: Required Parameters { "DocumentName": "AWSManagedServices-CreateIAMAccessKeyV2", "Region": "us-east-1", "Parameters": { "UserARN": "arn:aws:iam::012345678910:user/myusername" } Advanced Stack Components Version April 22, 2025 181 AMS Advanced Change Type Reference AMS Advanced Change Type Details } Example: All Parameters { "DocumentName": "AWSManagedServices-CreateIAMAccessKeyV2", "Region": "us-east-1", "Parameters": { "UserARN": "arn:aws:iam::012345678910:user/myusername" } } Identity and Access Management (IAM) \| Create Account Alias Create an AWS account alias. Note that an AWS account can have only one alias. This operation fails if the AWS account already has an alias. To update an existing account alias, use the Update Account Alias (ct-3skaisgnq0pf8) change type. Full classiﬁcation: Deployment \| Advanced stack components \| Identity and Access Management (IAM) \| Create account alias Change Type Details Change type ID ct-36x3u7v2oklwd 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 182 AMS Advanced Change Type Reference Additional Information Create IAM account alias Creating IAM account alias with the console The following shows this change type in the AMS console. AMS Advanced Change Type Details How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button. • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page. 3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 183 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating IAM 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 184 AMS Advanced Change Type Reference AMS
ams-ct-054	ams-ct.pdf	54	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 notiﬁcations 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 184 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-36x3u7v2oklwd" --change-type- version "1.0" --title "Create Account Alias" --execution-parameters '{"DocumentName":"AWSManagedServices-CreateAccountAlias","Region":"us- east-1","Parameters":{"AWSAccountAlias":["my-alias"]}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; example names it CreateIamAccountAliasParams.json: aws amscm get-change-type-version --change-type-id "ct-36x3u7v2oklwd" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateIamAccountAliasParams.json 2. Modify and save the CreateIamAccountAliasParams ﬁle; example creates an IAM Role with policy documents pasted inline. { "DocumentName": "AWSManagedServices-CreateAccountAlias", "Region": "us-east-1", "Parameters": { "AWSAccountAlias": [ "my-alias" ] } } 3. Output the RFC template JSON ﬁle to a ﬁle named CreateIamAccountAliasRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateIamAccountAliasRfc.json 4. Modify and save the CreateIamAccountAliasRfc.json ﬁle. For example, you can replace the contents with something like this: { Advanced Stack Components Version April 22, 2025 185 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ChangeTypeId": "ct-36x3u7v2oklwd", "ChangeTypeVersion": "1.0", "Title": "Create Account Alias" } 5. Create the RFC, specifying the CreateIamAccountAliasRfc ﬁle and the CreateIamAccountAliasParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateIamAccountAliasRfc.json -- execution-parameters file://CreateIamAccountAliasParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS Identity and Access Management, see AWS Identity and Access Management (IAM). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-36x3u7v2oklwd. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName": "AWSManagedServices-CreateAccountAlias", "Region": "us-east-1", "Parameters": { "AWSAccountAlias": ["myalias"] } } Advanced Stack Components Version April 22, 2025 186 AMS Advanced Change Type Reference AMS Advanced Change Type Details Identity and Access Management (IAM) \| Create EC2 Instance Proﬁle Create an IAM instance proﬁle to use with EC2 instances. Each ARN speciﬁed in the parameters creates a part of the IAM policy. Use the Preview option to see what the completed, generated, policy looks like before it is created and implemented. Full classiﬁcation: Deployment \| Advanced stack components \| Identity and Access Management (IAM) \| Create EC2 instance proﬁle Change Type Details Change type ID ct-117rmp64d5mvb Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create IAM EC2 proﬁle Creating IAM EC2 proﬁles with the console Advanced Stack Components Version April 22, 2025 187 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, click Run. If there are no errors, the RFC successfully created
ams-ct-055	ams-ct.pdf	55	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating IAM EC2 proﬁles 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles as input. Both methods are described here. Advanced Stack Components Version April 22, 2025 188 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 notiﬁcations 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 (required parameters only): 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-117rmp64d5mvb" --change-type-version "2.0" --title "new EC2 instance profile" --execution-parameters "{\"DocumentName \": \"AWSManagedServices-HandleCreateIAMRole-Admin\",\"Region\": \"us-east-1\", \"Parameters\": { \"RoleName\": \"customer_application_instance_profile\", \"ServicePrincipal\": \"ec2.amazonaws.com\", \"Preview\": \"No\" }}" TEMPLATE CREATE (all parameters): 1. Output the execution parameters JSON schema for this change type to a ﬁle; example names it CreateIamEc2ProﬁleParams.json: aws amscm get-change-type-version --change-type-id "ct-117rmp64d5mvb" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateIamEc2ProfileParams.json Advanced Stack Components Version April 22, 2025 189 AMS Advanced Change Type Reference AMS Advanced Change Type Details 2. Modify and save the CreateIamEc2ProﬁleParams ﬁle; example creates an IAM Role with policy documents pasted inline. { "DocumentName": "AWSManagedServices-HandleCreateIAMRole-Admin", "Region": "us-east-1", "Parameters": { "RoleName": "customer_application_instance_profile", "ServicePrincipal": "ec2.amazonaws.com", "Preview": "No" } } 3. Output the RFC template JSON ﬁle to a ﬁle named CreateIamEc2ProﬁleRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateIamEc2ProfileRfc.json 4. Modify and save the CreateIamEc2ProﬁleRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-117rmp64d5mvb", "Title": "Create New EC2 Instance Profile" } 5. Create the RFC, specifying the CreateIamEc2ProﬁleRfc ﬁle and the CreateIamEc2ProﬁleParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateIamEc2ProfileRfc.json -- execution-parameters file://CreateIamEc2ProfileParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS Identity and Access Management, see AWS Identity and Access Management (IAM). Advanced Stack Components Version April 22, 2025 190 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-117rmp64d5mvb. Example: Required Parameters { "DocumentName" : "AWSManagedServices-HandleCreateIAMRole-Admin", "Region" : "us-east-1", "Parameters" : { "RoleName": "customer_application_instance_profile", "ServicePrincipal": "ec2.amazonaws.com", "Preview": "No" } } Example: All Parameters { "DocumentName" : "AWSManagedServices-HandleCreateIAMRole-Admin", "Region" : "us-east-1", "Parameters": { "CloudWatchAlarmReadAccess": ["arn:aws:cloudwatch:us- east-1:123456789012:alarm:myalarm"], "CloudWatchAlarmWriteAccess": ["arn:aws:cloudwatch:us- east-1:123456789012:alarm:myalarm"], "CloudWatchLogsReadAccess": ["arn:aws:logs:us-east-1:123456789012:log- group:myparam:log-stream:mylogstream"], "CloudWatchLogsWriteAccess": ["arn:aws:logs:us-east-1:123456789012:log- group:mylogs"], "CloudWatchMetricsReadAccess": [""], "CloudWatchMetricsWriteAccess": ["Company/AppMetric"], "DynamoDBDataReadWriteAccess": ["arn:aws:dynamodb:us-east-1:123456789012:table/ mytable"], "DynamoDBResourceReadAccess": ["arn:aws:dynamodb:us-east-1:123456789012:table/ anotherTable"], "KMSCryptographicOperationAccess": ["arn:aws:kms:us- east-1:123456789012:key/97f43232-6bdc-4830-b54c-2d2926ba69aa"], "KMSReadAccess": ["arn:aws:kms:us-east-1:123456789012:key/97f43232-6bdc-4830- b54c-2d2926ba69aa"], "Preview": "No", "RoleName": "customer_application_instance_profile", Advanced Stack Components Version April 22, 2025 191 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RolePath": "/test/", "S3ReadAccess": ["arn:aws:s3:::my-s3-us-east-1/"], "S3WriteAccess": ["arn:aws:s3:::my-s3-ap-southeast-2/developers/design_info.doc"], "SNSReadAccess": ["arn:aws:sns:us-east-1:123456789012:mytopic"], "SNSWriteAccess": ["arn:aws:sns:us-east-1:123456789012:MyTopic"], "SQSReadAccess": ["arn:aws:sqs:us-east-1:123456789012:Myqueue"], "SQSWriteAccess": ["arn:aws:sqs:us-east-1:123456789012:MyQueeu"], "SSMReadAccess": ["arn:aws:ssm:us-east-1:123456789012:parameter/myparam"], "SSMWriteAccess": ["arn:aws:ssm:us-east-1:123456789012:parameter/myparam"], "STSAssumeRole": ["arn:aws:iam::123456789012:role/roleName"], "SecretsManagerReadAccess": ["arn:aws:secretsmanager:us- east-1:123456789012:secret:mysecret"], "ServicePrincipal": "ec2.amazonaws.com", "AdditionalPolicy" : "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\": \"Allow\",\"Action\":[\"iam:ListRoles\",\"iam:ListAccountAliases\"],\"Resource\":\"* \"}]}" } } Identity and Access Management (IAM) \| Create Entity or Policy (Read-Write Permissions) Create Identity and Access Management (IAM) role or policy with read-write permissions. You must have enabled this feature with change type ct-1706xvvk6j9hf before submitting this request. Automated IAM provisioning
ams-ct-056	ams-ct.pdf	56	["arn:aws:kms:us- east-1:123456789012:key/97f43232-6bdc-4830-b54c-2d2926ba69aa"], "KMSReadAccess": ["arn:aws:kms:us-east-1:123456789012:key/97f43232-6bdc-4830- b54c-2d2926ba69aa"], "Preview": "No", "RoleName": "customer_application_instance_profile", Advanced Stack Components Version April 22, 2025 191 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RolePath": "/test/", "S3ReadAccess": ["arn:aws:s3:::my-s3-us-east-1/"], "S3WriteAccess": ["arn:aws:s3:::my-s3-ap-southeast-2/developers/design_info.doc"], "SNSReadAccess": ["arn:aws:sns:us-east-1:123456789012:mytopic"], "SNSWriteAccess": ["arn:aws:sns:us-east-1:123456789012:MyTopic"], "SQSReadAccess": ["arn:aws:sqs:us-east-1:123456789012:Myqueue"], "SQSWriteAccess": ["arn:aws:sqs:us-east-1:123456789012:MyQueeu"], "SSMReadAccess": ["arn:aws:ssm:us-east-1:123456789012:parameter/myparam"], "SSMWriteAccess": ["arn:aws:ssm:us-east-1:123456789012:parameter/myparam"], "STSAssumeRole": ["arn:aws:iam::123456789012:role/roleName"], "SecretsManagerReadAccess": ["arn:aws:secretsmanager:us- east-1:123456789012:secret:mysecret"], "ServicePrincipal": "ec2.amazonaws.com", "AdditionalPolicy" : "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\": \"Allow\",\"Action\":[\"iam:ListRoles\",\"iam:ListAccountAliases\"],\"Resource\":\"* \"}]}" } } Identity and Access Management (IAM) \| Create Entity or Policy (Read-Write Permissions) Create Identity and Access Management (IAM) role or policy with read-write permissions. You must have enabled this feature with change type ct-1706xvvk6j9hf before submitting this request. Automated IAM provisioning with read-write permissions runs over 200 validations to help ensure successful outcomes. Full classiﬁcation: Deployment \| Advanced stack components \| Identity and Access Management (IAM) \| Create entity or policy (read-write permissions) Change Type Details Change type ID ct-1n9gfnog5x7ﬂ Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required if submitter Advanced Stack Components Version April 22, 2025 192 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution mode Automated Additional Information Create IAM entity or policy Creating IAM entity or policy with the console How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • 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 193 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating IAM entity or policy with the CLI How it works: 1. Use either the Inline Create (you issue a create-rfc command with all RFC and execution parameters included), or Template Create (you create two JSON ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations when the RFC status Advanced Stack Components Version April 22, 2025 194 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-1n9gfnog5x7fl" --change-type- version "1.0" --title "Create role or policy" --execution-parameters '{"DocumentName":"AWSManagedServices-HandleAutomatedIAMProvisioningCreate- Admin","Region":"us-east-1","Parameters":{"ValidateOnly":"No"},"RoleDetails": {"Roles":[{"RoleName":"RoleTest01","Description":"This is a test role","AssumeRolePolicyDocument":"{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal": {"AWS":"arn:aws:iam::123456789012:root"},"Action":"sts:AssumeRole"}]}","ManagedPolicyArns": ["arn:aws:iam::123456789012:policy/policy01","arn:aws:iam::123456789012:policy/ policy02"],"Path":"/","MaxSessionDuration":"7200","PermissionsBoundary":"arn:aws:iam::123456789012:policy/ permission_boundary01","InstanceProfile":"No"}]},"ManagedPolicyDetails": {"Policies":[{"ManagedPolicyName":"TestPolicy01","Description":"This is customer policy","Path":"/test/","PolicyDocument":"{"Version":"2012-10-17","Statement": [{"Sid":"AllQueueActions","Effect":"Allow","Action":"sqs:ListQueues","Resource":"*","Condition": {"ForAllValues:StringEquals":{"aws:tagKeys":["temporary"]}}}]}"}]}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; example
ams-ct-057	ams-ct.pdf	57	parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: aws amscm create-rfc --change-type-id "ct-1n9gfnog5x7fl" --change-type- version "1.0" --title "Create role or policy" --execution-parameters '{"DocumentName":"AWSManagedServices-HandleAutomatedIAMProvisioningCreate- Admin","Region":"us-east-1","Parameters":{"ValidateOnly":"No"},"RoleDetails": {"Roles":[{"RoleName":"RoleTest01","Description":"This is a test role","AssumeRolePolicyDocument":"{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal": {"AWS":"arn:aws:iam::123456789012:root"},"Action":"sts:AssumeRole"}]}","ManagedPolicyArns": ["arn:aws:iam::123456789012:policy/policy01","arn:aws:iam::123456789012:policy/ policy02"],"Path":"/","MaxSessionDuration":"7200","PermissionsBoundary":"arn:aws:iam::123456789012:policy/ permission_boundary01","InstanceProfile":"No"}]},"ManagedPolicyDetails": {"Policies":[{"ManagedPolicyName":"TestPolicy01","Description":"This is customer policy","Path":"/test/","PolicyDocument":"{"Version":"2012-10-17","Statement": [{"Sid":"AllQueueActions","Effect":"Allow","Action":"sqs:ListQueues","Resource":"","Condition": {"ForAllValues:StringEquals":{"aws:tagKeys":["temporary"]}}}]}"}]}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; example names it CreateIamResourceParams.json: aws amscm get-change-type-version --change-type-id "ct-1n9gfnog5x7fl" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateIamResourceParams.json 2. Modify and save the CreateIamResourceParams ﬁle; example creates an IAM Role with policy documents pasted inline. { "DocumentName": "AWSManagedServices-HandleAutomatedIAMProvisioningCreate-Admin", Advanced Stack Components Version April 22, 2025 195 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters": { "ValidateOnly": "No" }, "RoleDetails": { "Roles": [ { "RoleName": "RoleTest01", "Description": "This is a test role", "AssumeRolePolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\": [{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"}, \"Action\":\"sts:AssumeRole\"}]}", "ManagedPolicyArns": [ "arn:aws:iam::123456789012:policy/policy01", "arn:aws:iam::123456789012:policy/policy02" ], "Path": "/", "MaxSessionDuration": "7200", "PermissionsBoundary": "arn:aws:iam::123456789012:policy/ permission_boundary01", "InstanceProfile": "No" } ] }, "ManagedPolicyDetails": { "Policies": [ { "ManagedPolicyName": "TestPolicy01", "Description": "This is customer policy", "Path": "/test/", "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\": \"AllQueueActions\",\"Effect\":\"Allow\",\"Action\":\"sqs:ListQueues\",\"Resource \":\"\",\"Condition\":{\"ForAllValues:StringEquals\":{\"aws:tagKeys\":[\"temporary \"]}}}]}" } ] } } 3. Output the RFC template JSON ﬁle to a ﬁle named CreateIamResourceRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateIamResourceRfc.json Advanced Stack Components Version April 22, 2025 196 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the CreateIamResourceRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-1n9gfnog5x7fl", "Title": "Create entity or policy (read-write permissions)" } 5. Create the RFC, specifying the CreateIamResourceRfc ﬁle and the CreateIamResourceParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateIamResourceRfc.json -- execution-parameters file://CreateIamResourceParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • After an IAM role is provisioned in your account, depending on the role and the policy document you attach to the role, you may need to onboard the role in your federation solution. • For information about AWS Identity and Access Management, see AWS Identity and Access Management (IAM) and for policy information, see Managed policies and inline policies. For information about AMS permissions, see Deploying IAM resources. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1n9gfnog5x7ﬂ. Example: Required Parameters { "DocumentName": "AWSManagedServices-HandleAutomatedIAMProvisioningCreate-Admin", "Region": "us-east-1", "Parameters": { "ValidateOnly": "No" }, Advanced Stack Components Version April 22, 2025 197 AMS Advanced Change Type Reference AMS Advanced Change Type Details "RoleDetails": { "Roles": [ { "RoleName": "RoleTest01", "AssumeRolePolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\": [{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"}, \"Action\":\"sts:AssumeRole\"}]}" } ] }, "ManagedPolicyDetails": { "Policies": [ { "ManagedPolicyName": "TestPolicy01", "Description": "This is customer policy", "Path": "/test/", "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\": \"AllQueueActions\",\"Effect\":\"Allow\",\"Action\":\"sqs:ListQueues\",\"Resource\":\"* \",\"Condition\":{\"ForAllValues:StringEquals\":{\"aws:tagKeys\":[\"temporary\"]}}}]}" } ] } } Example: All Parameters { "DocumentName": "AWSManagedServices-HandleAutomatedIAMProvisioningCreate-Admin", "Region": "us-east-1", "Parameters": { "ValidateOnly": "No" }, "RoleDetails": { "Roles": [ { "RoleName": "RoleTest01", "Description": "This is a test role", "AssumeRolePolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\": [{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"}, \"Action\":\"sts:AssumeRole\"}]}", "ManagedPolicyArns": [ "arn:aws:iam::123456789012:policy/policy01", "arn:aws:iam::123456789012:policy/policy02" Advanced Stack Components Version April 22, 2025 198 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "Path": "/", "MaxSessionDuration": "7200", "PermissionsBoundary": "arn:aws:iam::123456789012:policy/ permission_boundary01", "InstanceProfile": "No" } ] }, "ManagedPolicyDetails": { "Policies": [ { "ManagedPolicyName": "TestPolicy01", "Description": "This is customer policy", "Path": "/test/", "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\": \"AllQueueActions\",\"Effect\":\"Allow\",\"Action\":\"sqs:ListQueues\",\"Resource\":\"* \",\"Condition\":{\"ForAllValues:StringEquals\":{\"aws:tagKeys\":[\"temporary\"]}}}]}" } ] } } Identity and Access Management (IAM) \| Create Entity or Policy (Review Required) Create Identity and Access Management (IAM) user, role, or policy. Full classiﬁcation: Deployment \| Advanced stack components \| Identity and Access Management (IAM) \| Create entity or policy (review required) Change Type Details Change type ID ct-3dpd8mdd9jn1r 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 199 AMS Advanced Change Type Reference AMS Advanced Change Type Details Execution mode Manual Additional Information Create IAM entity or policy (review required) Creating IAM resources (review required) with the console How it works: 1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC. 2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view. • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then
ams-ct-058	ams-ct.pdf	58	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 200 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating IAM resources (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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 201 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. Note When pasting in a policy document, note that the RFC only accepts policy pastes up to 20,480 characters. If your ﬁle has more than 20,480 characters, create a service request to upload the policy and then refer to that service request in the RFC that you open for IAM. 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-3dpd8mdd9jn1r" --change-type-version "1.0" --title "TestIamCreate" --execution-parameters "{\"UseCase\":\"IAM_RESOURCE_DETAILS\", \"IAM Role\":[{\"RoleName\":\"ROLE_NAME\",\"TrustPolicy\":\"TRUST_POLICY\", \"RolePermissions\":\"ROLE_PERMISSIONS\"}],\"Operation\":\"Create\"}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; example names it CreateIamResourceParams.json: aws amscm get-change-type-version --change-type-id "ct-3dpd8mdd9jn1r" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateIamResourceParams.json 2. Modify and save the CreateIamResourceParams ﬁle; example creates an IAM Role with policy documents pasted inline. { "UseCase": "IAM_RESOURCE_DETAILS", "IAM Role": [ { "RoleName": "codebuild_ec2_test_role", Advanced Stack Components Version April 22, 2025 202 AMS Advanced Change Type Reference AMS Advanced Change Type Details "TrustPolicy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Effect\": \"Allow\",\"Principal\":{\"Service\":\"codebuild.amazonaws.com\"},\"Action\": \"sts:AssumeRole\"}]}", "RolePermissions": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\": \"Allow\",\"Action\":[\"ec2:DescribeInstanceStatus\"],\"Resource\":\"*\"}]}" } ], "Operation": "Create" } 3. Output the RFC template JSON ﬁle to a ﬁle named CreateIamResourceRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateIamResourceRfc.json 4. Modify and save the CreateIamResourceRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3dpd8mdd9jn1r", "Title": "Create IAM Role" } 5. Create the RFC, specifying the CreateIamResourceRfc ﬁle and the CreateIamResourceParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateIamResourceRfc.json -- execution-parameters file://CreateIamResourceParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • After
ams-ct-059	ams-ct.pdf	59	JSON ﬁle to a ﬁle named CreateIamResourceRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateIamResourceRfc.json 4. Modify and save the CreateIamResourceRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3dpd8mdd9jn1r", "Title": "Create IAM Role" } 5. Create the RFC, specifying the CreateIamResourceRfc ﬁle and the CreateIamResourceParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateIamResourceRfc.json -- execution-parameters file://CreateIamResourceParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips • After an IAM role is provisioned in your account, you must onboard the role in your federation solution. • When pasting in a policy document, note that the RFC only accepts policy pastes up to 20,480 characters. If your policy has more than 20,480 characters, create a service request to upload the policy, and then refer to that service request in the RFC that you open for IAM. Advanced Stack Components Version April 22, 2025 203 AMS Advanced Change Type Reference AMS Advanced Change Type Details • This is a "review required" change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a "review required" change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. • For information about AWS Identity and Access Management, see AWS Identity and Access Management (IAM) and for policy information, see Managed policies and inline policies. For information about AMS permissions, see Deploying IAM resources. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3dpd8mdd9jn1r. Example: Required Parameters { "UseCase": "Use case...", "Operation": "Create" } Example: All Parameters { "UseCase": "Use case...", "IAM User": [ { "UserName": "user-a", "AccessType": "Console access", "UserPermissions": "Power User permissions", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ] } Advanced Stack Components Version April 22, 2025 204 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "IAM Role": [ { "RoleName": "role-b", "AddPermissionsAsInlinePolicy": "No", "InstanceProfile": "No", "TrustPolicy": "Trust policy example", "RolePermissionPolicyName": "TestPolicy1", "RolePermissions": "Role permissions example", "ManagedPolicyArns": [ "arn:aws:iam::123456789012:policy/policy01", "arn:aws:iam::123456789012:policy/policy02" ], "Path": "/", "Tags": [ { "Key": "foo", "Value": "bar" }, { "Key": "testkey", "Value": "testvalue" } ] } ], "IAM Policy": [ { "PolicyName": "policy1", "PolicyDocument": "Policy document example 1", "Path": "/", "RelatedResources": [ "resourceA", "resourceB" ] }, { "PolicyName": "policy2", "PolicyDocument": "Policy document example 2", "Path": "/", "RelatedResources": [ "resourceC", "resourceD" ] Advanced Stack Components Version April 22, 2025 205 AMS Advanced Change Type Reference AMS Advanced Change Type Details } ], "Operation": "Create", "Priority": "Medium" } Identity and Access Management (IAM) \| Create Lambda Execution Role Create an Lambda execution role to use with Lambda Function. Each ARN speciﬁed in the parameters creates a part of the IAM policy. Use the Preview option to see what the completed, generated, policy looks like before it is created and implemented. Full classiﬁcation: Deployment \| Advanced stack components \| Identity and Access Management (IAM) \| Create Lambda execution role Change Type Details Change type ID ct-1k3oui719dcju Current version 2.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 206 AMS Advanced Change Type Reference Additional Information Create IAM Lambda execution role Creating IAM Lambda execution roles 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
ams-ct-060	ams-ct.pdf	60	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 207 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating IAM Lambda execution roles 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 208 AMS Advanced Change Type Reference AMS Advanced Change Type Details INLINE CREATE (required parameters only): 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-1k3oui719dcju" --change-type-version "2.0" --title "Create IAM Lambda Execution Role" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-HandleCreateIAMRole-Admin\",\"Region\":\"us-east-1\", \"Parameters\":{\"ServicePrincipal\":[\"lambda.amazonaws.com\"],\"RoleName\":[\"test- application-ec2-instance-profile\"],\"LambdaFunctionArns": [\"arn:aws:lambda:us- east-1:123456789012:function:testing\"}}" TEMPLATE CREATE (all parameters): 1. Output the execution parameters JSON schema for this change type to a ﬁle; example names it CreateIamLambdaExeRoleParams.json: aws amscm get-change-type-version --change-type-id "ct-1k3oui719dcju" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateIamLambdaExeRoleParams.json 2. Modify and save the CreateIamLambdaExeRoleParams ﬁle; example creates an IAM Role with policy documents pasted inline. { "DocumentName": "AWSManagedServices-HandleCreateIAMRole-Admin", "Region": "us-east-1", "Parameters": { "ServicePrincipal" : "lambda.amazonaws.com", "RoleName" : "customer_lambda_execution_role", "VPCAccess" : "No", "Preview" : "No", "LambdaFunctionArns": ["arn:aws:lambda:us-east-1:123456789012:function:dabba"] } } 3. Output the RFC template JSON ﬁle to a ﬁle named CreateIamLambdaExeRoleRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateIamLambdaExeRoleRfc.json Advanced Stack Components Version April 22, 2025 209 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the CreateIamLambdaExeRoleRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "2.0", "ChangeTypeId": "ct-1k3oui719dcju", "Title": "Create IAM Lambda Execution Role" } 5. Create the RFC, specifying the CreateIamLambdaExeRoleRfc ﬁle and the CreateIamLambdaExeRoleParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateIamLambdaExeRoleRfc.json -- execution-parameters file://CreateIamLambdaExeRoleParams.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 with improvements in the create RFC Console experience and the change makes it easier to copy and paste JSON. For more information about AWS Identity and Access Management, see AWS Identity and Access Management (IAM). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1k3oui719dcju. Example: Required Parameters { "DocumentName" : "AWSManagedServices-HandleCreateIAMRole-Admin", "Region" : "us-east-1", "Parameters" : { Advanced Stack Components Version April 22, 2025 210 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ServicePrincipal" : "lambda.amazonaws.com", "RoleName" : "customer_lambda_execution_role", "VPCAccess" : "No", "Preview" : "No", "LambdaFunctionArns": ["arn:aws:lambda:us-east-1:083904590739:function:dabba"] } } Example: All Parameters { "DocumentName"
ams-ct-061	ams-ct.pdf	61	create RFC Console experience and the change makes it easier to copy and paste JSON. For more information about AWS Identity and Access Management, see AWS Identity and Access Management (IAM). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-1k3oui719dcju. Example: Required Parameters { "DocumentName" : "AWSManagedServices-HandleCreateIAMRole-Admin", "Region" : "us-east-1", "Parameters" : { Advanced Stack Components Version April 22, 2025 210 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ServicePrincipal" : "lambda.amazonaws.com", "RoleName" : "customer_lambda_execution_role", "VPCAccess" : "No", "Preview" : "No", "LambdaFunctionArns": ["arn:aws:lambda:us-east-1:083904590739:function:dabba"] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-HandleCreateIAMRole-Admin", "Region" : "us-east-1", "Parameters": { "ServicePrincipal": "lambda.amazonaws.com", "RoleName" : "customer_lambda_execution_role", "RolePath": "/test/", "Preview": "No", "LambdaFunctionArns": ["arn:aws:lambda:us-east-1:083904590739:function:dabba"], "VPCAccess": "Yes", "CloudWatchAlarmReadAccess": ["arn:aws:cloudwatch:us- east-1:123456789012:alarm:myalarm"], "CloudWatchAlarmWriteAccess": ["arn:aws:cloudwatch:us- east-1:123456789012:alarm:myalarm"], "CloudWatchLogsReadAccess": ["arn:aws:logs:us-east-1:123456789012:log- group:myparam:log-stream:mylogstream"], "CloudWatchLogsWriteAccess": ["arn:aws:logs:us-east-1:123456789012:log- group:mylogs"], "CloudWatchMetricsReadAccess": [""], "CloudWatchMetricsWriteAccess": ["Company/AppMetric"], "DynamoDBDataReadWriteAccess": ["arn:aws:dynamodb:us-east-1:123456789012:table/ mytable"], "DynamoDBResourceReadAccess": ["arn:aws:dynamodb:us-east-1:123456789012:table/ anotherTable"], "KMSCryptographicOperationAccess": ["arn:aws:kms:us- east-1:123456789012:key/97f43232-6bdc-4830-b54c-2d2926ba69aa"], "KMSReadAccess": ["arn:aws:kms:us-east-1:123456789012:key/97f43232-6bdc-4830- b54c-2d2926ba69aa"], "S3ReadAccess": ["arn:aws:s3:::my-s3-us-east-1/"], "S3WriteAccess": ["arn:aws:s3:::my-s3-ap-southeast-2/developers/design_info.doc"], "SNSReadAccess": ["arn:aws:sns:us-east-1:123456789012:mytopic"], "SNSWriteAccess": ["arn:aws:sns:us-east-1:123456789012:MyTopic"], "SQSReadAccess": ["arn:aws:sqs:us-east-1:123456789012:Myqueue"], Advanced Stack Components Version April 22, 2025 211 AMS Advanced Change Type Reference AMS Advanced Change Type Details "SQSWriteAccess": ["arn:aws:sqs:us-east-1:123456789012:MyQueeu"], "SSMReadAccess": ["arn:aws:ssm:us-east-1:123456789012:parameter/myparam"], "SSMWriteAccess": ["arn:aws:ssm:us-east-1:123456789012:parameter/myparam"], "LambdaReadAccess" : ["arn:aws:lambda:us-east-1:083904590739:function:dabba"], "LambdaInvokeAccess" : ["arn:aws:lambda:us-east-1:083904590739:function:dabba"], "EventsReadAccess" : ["arn:aws:events:us-east-1:083904590739:rule/rule01"], "EventsWriteAccess" : ["arn:aws:events:us-east-1:083904590739:event-bus/bus01"], "STSAssumeRole": ["arn:aws:iam::123456789012:role/roleName"], "SecretsManagerReadAccess": ["arn:aws:secretsmanager:us- east-1:123456789012:secret:mysecret"], "AdditionalPolicy" : "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\": \"Allow\",\"Action\":[\"iam:ListRoles\",\"iam:ListAccountAliases\"],\"Resource\":\"* \"}]}" } } Identity and Access Management (IAM) \| Create OpenID Connect Provider Create an IAM OpenID Connect provider for the Amazon Elastic Kubernetes Service (Amazon EKS) cluster. Full classiﬁcation: Deployment \| Advanced stack components \| Identity and Access Management (IAM) \| Create OpenID Connect provider Change Type Details Change type ID ct-30ecvfi3tq4k3 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 212 AMS Advanced Change Type Reference Additional Information Create IAM OpenID Connect provider Creating an IAM OpenID Connect provider 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. Advanced Stack Components Version April 22, 2025 213 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When ﬁnished, 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 conﬁgurations 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 IAM OpenID Connect provider 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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).
ams-ct-062	ams-ct.pdf	62	ﬁles 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 notiﬁcations 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 214 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note When pasting in a policy document, note that the RFC only accepts policy pastes up to 5,000 characters. If your ﬁle has more than 5,000 characters, create a service request to upload the policy and then refer to that service request in the RFC that you open for IAM. 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-30ecvfi3tq4k3" --change-type-version "1.0" --title "Create OpenID Connect provider" --execution-parameters "{\"DocumentName \": \"AWSManagedServices-HandleAssociateIAMOpenIDProvider-Admin\",\"Region\": \"us- east-1\",\"Parameters\": {\"ClusterName\": [\"test-cluster\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; example names it CreateIamOpenIdParams.json: aws amscm get-change-type-version --change-type-id "ct-30ecvfi3tq4k3" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateIamOpenIdParams.json 2. Modify and save the CreateIamOpenIdParams ﬁle; example creates an IAM Role with policy documents pasted inline. { "DocumentName": "AWSManagedServices-HandleAssociateIAMOpenIDProvider-Admin", "Region": "us-east-1", "Parameters": { "ClusterName": [ "test-cluster" ] } } 3. Output the RFC template JSON ﬁle to a ﬁle named CreateIamOpenIdRfc.json: Advanced Stack Components Version April 22, 2025 215 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > CreateIamOpenIdRfc.json 4. Modify and save the CreateIamOpenIdRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-30ecvfi3tq4k3", "Title": "Create OpenID Connect provider" } 5. Create the RFC, specifying the CreateIamOpenIdRfc ﬁle and the CreateIamOpenIdParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateIamOpenIdRfc.json --execution- parameters file://CreateIamOpenIdParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS Identity and Access Management, see AWS Identity and Access Management (IAM). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-30ecvﬁ3tq4k3. Example: Required Parameters Example not available. Example: All Parameters { "DocumentName" : "AWSManagedServices-HandleAssociateIAMOpenIDProvider-Admin", "Region" : "us-east-1", "Parameters" : { Advanced Stack Components Version April 22, 2025 216 AMS Advanced Change Type Reference AMS Advanced Change Type Details "ClusterName" : [ "test-cluster" ] } } Identity and Access Management (IAM) \| Create SAML Identity Provider Create an IAM identity provider using the SAML metadata document ﬁle that you stored in your chosen S3 bucket. Full classiﬁcation: Deployment \| Advanced stack components \| Identity and Access Management (IAM) \| Create SAML identity provider Change Type Details Change type ID ct-3hox8uwjgze1f 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 217 AMS Advanced Change Type Reference Additional Information Create IAM SAML identity provider Creating IAM SAML IDPs 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
ams-ct-063	ams-ct.pdf	63	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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 218 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating IAM SAML IDPs 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 219 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-3hox8uwjgze1f" --change-type-version "1.0" --title "Create SAML Identity Provider" --execution-parameters "{\"DocumentName \":\"AWSManagedServices-HandleCreateSamlProvider-Admin\",\"Region\":\"us-east-1\", \"Parameters\":{\"SAMLMetadataDocumentURL\":[\"s3://bucket.name/idp-metadata.xml\"], \"Name\":[\"customer-saml\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; example names it CreateIamSamlIdpParams.json: aws amscm get-change-type-version --change-type-id "ct-3hox8uwjgze1f" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateIamSamlIdpParams.json 2. Modify and save the CreateIamSamlIdpParams ﬁle; example creates an IAM Role with policy documents pasted inline. { "DocumentName" : "AWSManagedServices-HandleCreateSamlProvider-Admin", "Region" : "us-east-1", "Parameters" : { "SAMLMetadataDocumentURL" : [ "s3://bucket.name/idp-metadata.xml" ], "Name" : [ "customer-saml" ] } } 3. Output the RFC template JSON ﬁle to a ﬁle named CreateIamSamlIdpRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateIamSamlIdpRfc.json Advanced Stack Components Version April 22, 2025 220 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. Modify and save the CreateIamSamlIdpRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3hox8uwjgze1f", "Title": "Create IAM SAML identity provider" } 5. Create the RFC, specifying the CreateIamSamlIdpRfc ﬁle and the CreateIamSamlIdpParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateIamSamlIdpRfc.json --execution- parameters file://CreateIamSamlIdpParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS Identity and Access Management, see AWS Identity and Access Management (IAM). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-3hox8uwjgze1f. Example: Required Parameters { "DocumentName" : "AWSManagedServices-HandleCreateSamlProvider-Admin", "Region" : "us-east-1", "Parameters" : { "SAMLMetadataDocumentURL" : [ "s3://mybucket/path/to/metadata.xml" ] } } Advanced Stack Components Version April 22, 2025 221 AMS Advanced Change Type Reference Example: All Parameters { AMS Advanced Change Type Details "DocumentName" : "AWSManagedServices-HandleCreateSamlProvider-Admin", "Region" : "us-east-1", "Parameters" : { "SAMLMetadataDocumentURL" : [ "s3://mybucket/path/to/metadata.xml" ], "Name" : [ "customer-saml" ] } } Identity and Access Management (IAM) \| Create Service-Linked Role Create an IAM service-linked role linked to an AWS service that you specify. Full classiﬁcation: Deployment \| Advanced stack components \| Identity and
ams-ct-064	ams-ct.pdf	64	Schema for Change Type ct-3hox8uwjgze1f. Example: Required Parameters { "DocumentName" : "AWSManagedServices-HandleCreateSamlProvider-Admin", "Region" : "us-east-1", "Parameters" : { "SAMLMetadataDocumentURL" : [ "s3://mybucket/path/to/metadata.xml" ] } } Advanced Stack Components Version April 22, 2025 221 AMS Advanced Change Type Reference Example: All Parameters { AMS Advanced Change Type Details "DocumentName" : "AWSManagedServices-HandleCreateSamlProvider-Admin", "Region" : "us-east-1", "Parameters" : { "SAMLMetadataDocumentURL" : [ "s3://mybucket/path/to/metadata.xml" ], "Name" : [ "customer-saml" ] } } Identity and Access Management (IAM) \| Create Service-Linked Role Create an IAM service-linked role linked to an AWS service that you specify. Full classiﬁcation: Deployment \| Advanced stack components \| Identity and Access Management (IAM) \| Create Service-Linked role Change Type Details Change type ID ct-2eof6j3mlcwhf 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 222 AMS Advanced Change Type Reference Additional Information Create IAM service-linked role Creating IAM service-linked roles 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 223 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating IAM service-linked roles 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 224 AMS Advanced Change Type Reference AMS Advanced Change Type Details Note When pasting in a policy document, note that the RFC only accepts policy pastes up to 5,000 characters. If your ﬁle has more than 5,000 characters, create a service request to upload the policy and then refer to that service request in the RFC that you open for IAM. 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-2eof6j3mlcwhf" --change-type-version "1.0" --title "Create service-linked role" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateServiceLinkedRole-Admin\",\"Region\": \"us-east-1\", \"Parameters\": {\"AWSServiceName\": [\"acm.amazonaws.com\"],\"Description\": [\"AWSServiceRoleForCertificateManager\"]}}" aws amscm create-rfc --change-type-id "ct-2eof6j3mlcwhf" --change-type-version "1.0" --title "Create
ams-ct-065	ams-ct.pdf	65	up to 5,000 characters. If your ﬁle has more than 5,000 characters, create a service request to upload the policy and then refer to that service request in the RFC that you open for IAM. 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-2eof6j3mlcwhf" --change-type-version "1.0" --title "Create service-linked role" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateServiceLinkedRole-Admin\",\"Region\": \"us-east-1\", \"Parameters\": {\"AWSServiceName\": [\"acm.amazonaws.com\"],\"Description\": [\"AWSServiceRoleForCertificateManager\"]}}" aws amscm create-rfc --change-type-id "ct-2eof6j3mlcwhf" --change-type-version "1.0" --title "Create service-linked role" --execution-parameters "{\"DocumentName\": \"AWSManagedServices-CreateServiceLinkedRole-Admin\",\"Region\": \"us-east-1\", \"Parameters\": {\"AWSServiceName\": [\"acm.amazonaws.com\"],\"Description\": [\"AWSServiceRoleForCertificateManager\",\"CustomSuffix\": [\"CustomSuffix-Dev\"]}}" TEMPLATE CREATE: 1. Save a CreateSlrRfc.json ﬁle. { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2eof6j3mlcwhf", "Title": "Create service-linked role" } 2. Save a CreateSlrParams.json ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateServiceLinkedRole-Admin", Advanced Stack Components Version April 22, 2025 225 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Region": "us-east-1", "Parameters": { "AWSServiceName": [ "acm.amazonaws.com" ], "Description" : ["AWSServiceRoleForCertificateManager" ], "CustomSuffix" : ["CustomSuffix-Dev" ] } } 3. Create the RFC, specifying the CreateSlrRfc ﬁle and the CreateSlrParams ﬁles: aws amscm create-rfc --cli-input-json file://CreateSlrRfc.json --execution- parameters file://CreateSlrParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS Identity and Access Management, see AWS Identity and Access Management (IAM). For more information about service-linked roles, see Using service-linked roles. Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2eof6j3mlcwhf. Example: Required Parameters { "DocumentName" : "AWSManagedServices-CreateServiceLinkedRole-Admin", "Region" : "us-east-1", "Parameters" : { "AWSServiceName" : [ "autoscaling.amazonaws.com" ] } } Advanced Stack Components Version April 22, 2025 226 AMS Advanced Change Type Reference Example: All Parameters { AMS Advanced Change Type Details "DocumentName": "AWSManagedServices-CreateServiceLinkedRole-Admin", "Region": "us-east-1", "Parameters": { "AWSServiceName": [ "autoscaling.amazonaws.com" ], "CustomSuffix": [ "test123" ], "Description": [ "" ] } } Identity and Access Management (IAM) \| Create Service-Speciﬁc Credentials Generate a set of credentials consisting of a user name and password, to use to access the speciﬁed service. Full classiﬁcation: Deployment \| Advanced stack components \| Identity and Access Management (IAM) \| Create service-speciﬁc credentials Change Type Details Change type ID ct-2ni31oyto1i5k Current version 1.0 Expected execution duration 360 minutes AWS approval Required Customer approval Not required Execution mode Automated Advanced Stack Components Version April 22, 2025 227 AMS Advanced Change Type Reference Additional Information Create service speciﬁc credentials Creating IAM service speciﬁc credentials 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 228 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating IAM service speciﬁc credentials with the CLI How it works: 1. Use either the Inline Create (you
ams-ct-066	ams-ct.pdf	66	enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating IAM service speciﬁc credentials 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 229 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-2ni31oyto1i5k" \ --change-type-version "1.0" --title "Create service specific credentials for IAM User" \ --execution-parameters "{\"DocumentName\":\"AWSManagedServices- CreateServiceSpecificCredentials\",\"Region\":\"us-east-1\",\"Parameters\":{\"Username \":[\"testuser\"],\"Service\":[\"CodeCommit\"]}}" TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; example names it CreateServSpecCredsParams.json: aws amscm get-change-type-version --change-type-id "ct-2ni31oyto1i5k" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateServSpecCredsParams.json 2. Modify and save the CreateServSpecCredsParams ﬁle; example creates an IAM Role with policy documents pasted inline. { "DocumentName" : "AWSManagedServices-CreateServiceSpecificCredentials", "Region" : "us-east-1", "Parameters" : { "Username" : [ "testuser" ], "Service" : [ "CodeCommit" ] } } 3. Output the RFC template JSON ﬁle to a ﬁle named CreateServSpecCredsRfc.json: Advanced Stack Components Version April 22, 2025 230 AMS Advanced Change Type Reference AMS Advanced Change Type Details aws amscm create-rfc --generate-cli-skeleton > CreateServSpecCredsRfc.json 4. Modify and save the CreateServSpecCredsRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeId": "ct-2ni31oyto1i5k", "ChangeTypeVersion": "1.0", "Title": "Testing ct-2ni31oyto1i5k CreateServiceSpecificCredentials in region us- east-1 for an IAM User" } 5. Create the RFC, specifying the CreateServSpecCredsRfc ﬁle and the CreateServSpecCredsParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateServSpecCredsRfc.json -- execution-parameters file://CreateServSpecCredsParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips For more information about AWS Identity and Access Management, see AWS Identity and Access Management (IAM). Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2ni31oyto1i5k. Example: Required Parameters { "DocumentName" : "AWSManagedServices-CreateServiceSpecificCredentials", "Region" : "us-east-1", "Parameters" : { "Username" : [ "testuser" ], Advanced Stack Components Version April 22, 2025 231 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Service" : [ "CodeCommit" ] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateServiceSpecificCredentials", "Region" : "us-east-1", "Parameters" : { "Username" : [ "testuser" ], "Service" : [ "CodeCommit" ] } } KMS Alias \| Create Create an alias for an AWS Key Management Service (KMS) customer master key (CMK). Full classiﬁcation: Deployment \| Advanced stack components \| KMS alias \| Create Change Type Details Change type ID ct-2svg4k2fqi4ak 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 232 AMS Advanced Change Type Reference Additional Information Create an AWS KMS alias Creating an AWS KMS alias 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
ams-ct-067	ams-ct.pdf	67	an AWS KMS alias Creating an AWS KMS alias 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. Advanced Stack Components Version April 22, 2025 233 AMS Advanced Change Type Reference AMS Advanced Change Type Details In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an AWS KMS 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations 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 234 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 --title create-kms-alias --change-type-id ct-2svg4k2fqi4ak -- change-type-version 1.0 --execution-parameters '{"DocumentName": "AWSManagedServices- CreateKMSAlias", "Region": "us-east-1", "Parameters": {"TargetKeyId": ["12345678-90ab- cdef-1234-567890abcdef"], "AliasName": ["my-test-key"]}}' TEMPLATE CREATE: 1. Output the execution parameters JSON schema for this change type to a ﬁle; this example names it CreateKmsAliasParams.json: aws amscm get-change-type-version --change-type-id "ct-2svg4k2fqi4ak" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateKmsAliasParams.json 2. Modify and save the CreateKmsAliasParams ﬁle. For example, you can replace the contents with something like this: { "DocumentName": "AWSManagedServices-CreateKMSAlias", "Region": "us-east-1", "Parameters": { "TargetKeyId": ["12345678-90ab-cdef-1234-567890abcdef"] "AliasName": ["my-test-key"] } } 3. Output the RFC template JSON ﬁle to a ﬁle; this example names it CreateKmsAliasRfc.json: aws amscm create-rfc --generate-cli-skeleton > CreateKmsAliasRfc.json 4. Modify and save the CreateKmsAliasRfc.json ﬁle. For example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2svg4k2fqi4ak", Advanced Stack Components Version April 22, 2025 235 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "create-kms-alias" } 5. Create the RFC, specifying the CreateKmsAlias Rfc ﬁle and the CreateKmsAliasParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateKmsAliasRfc.json --execution- parameters file://CreateKmsAliasParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Execution Input Parameters For detailed information
ams-ct-068	ams-ct.pdf	68	example, you can replace the contents with something like this: { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2svg4k2fqi4ak", Advanced Stack Components Version April 22, 2025 235 AMS Advanced Change Type Reference AMS Advanced Change Type Details "Title": "create-kms-alias" } 5. Create the RFC, specifying the CreateKmsAlias Rfc ﬁle and the CreateKmsAliasParams ﬁle: aws amscm create-rfc --cli-input-json file://CreateKmsAliasRfc.json --execution- parameters file://CreateKmsAliasParams.json You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. Tips Execution Input Parameters For detailed information about the execution input parameters, see Schema for Change Type ct-2svg4k2fqi4ak. Example: Required Parameters { "DocumentName" : "AWSManagedServices-CreateKMSAlias", "Region" : "us-east-1", "Parameters" : { "TargetKeyId" : [ "58c399bf-1662-4d55-8bbe-fb6d26bd72b9" ], "AliasName" : [ "test-alias" ] } } Example: All Parameters { "DocumentName" : "AWSManagedServices-CreateKMSAlias", "Region" : "us-east-1", "Parameters" : { "TargetKeyId" : [ "arn:aws:kms:us-east-1:123456789012:key/58c399bf-1662-4d55-8bbe-fb6d26bd72b9" Advanced Stack Components Version April 22, 2025 236 AMS Advanced Change Type Reference AMS Advanced Change Type Details ], "AliasName" : [ "test-alias" ] } } KMS Key \| Create Request a KMS key with a predeﬁned key policy. Full classiﬁcation: Deployment \| Advanced stack components \| KMS key \| Create Change Type Details Change type ID ct-1d84keiri1jhg Current version 1.0 Expected execution duration 60 minutes AWS approval Required Customer approval Not required Execution mode Automated Additional Information Create KMS key Creating an AWS KMS Key with the Console Screenshot of this change type in the AMS console: Advanced Stack Components Version April 22, 2025 237 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 ﬁlled in for you if you choose your CT in the Browse change types view). Open the Additional conﬁguration area to add information about the RFC. In the Execution conﬁguration area, use available drop-down lists or enter values for the required parameters. To conﬁgure optional execution parameters, open the Additional conﬁguration area. Advanced Stack Components Version April 22, 2025 238 AMS Advanced Change Type Reference AMS Advanced Change Type Details 4. When ﬁnished, 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 conﬁgurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. Creating an AWS KMS Key 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 ﬁles, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two ﬁles 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 notiﬁcations when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients \" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference. INLINE CREATE: Advanced Stack Components Version April 22, 2025 239 AMS Advanced Change Type Reference AMS Advanced Change Type Details Issue the create RFC command with

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.