High Availability One-Tier Stack | Create

Use to create an Application Load Balancer and an Auto Scaling Group.

Full classification: Deployment | Standard stacks | High availability one-tier stack | Create

Change Type Details

Additional Information

High availability one-tier stacks: Creating

How it works:

1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC.

2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view.

   • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create.

     To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button.

   • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page.

3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC.

   In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area.

4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output.

5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page.

Creating a high availability one-tier stack with the console

How it works:

1. Navigate to the Create RFC page: In the left navigation pane of the AMS console click RFCs to open the RFCs list page, and then click Create RFC.

2. Choose a popular change type (CT) in the default Browse change types view, or select a CT in the Choose by category view.

   • Browse by change type: You can click on a popular CT in the Quick create area to immediately open the Run RFC page. Note that you cannot choose an older CT version with quick create.

     To sort CTs, use the All change types area in either the Card or Table view. In either view, select a CT and then click Create RFC to open the Run RFC page. If applicable, a Create with older version option appears next to the Create RFC button.

   • Choose by category: Select a category, subcategory, item, and operation and the CT details box opens with an option to Create with older version if applicable. Click Create RFC to open the Run RFC page.

3. On the Run RFC page, open the CT name area to see the CT details box. A Subject is required (this is filled in for you if you choose your CT in the Browse change types view). Open the Additional configuration area to add information about the RFC.

   In the Execution configuration area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the Additional configuration area.

4. When finished, click Run. If there are no errors, the RFC successfully created page displays with the submitted RFC details, and the initial Run output.

5. Open the Run parameters area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page.

How it works:

1. Use the Template Create method (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here.

2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID.

   Monitor the RFC: aws amscm get-rfc --rfc-id ID command.

To check the change type version, use this command:

aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID

Note

You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference.

TEMPLATE CREATE:

1. Output the execution parameters JSON schema for this change type to a file in your current folder; this example names it CreateOnetierStackParams.json.

   aws amscm get-change-type-version --change-type-id "ct-09t6q7j9v5hrn" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateOnetierStackParams.json

2. Modify the schema, replacing the variables as appropriate.

   {
       "Description":          "HA-One-Tier-Stack",
       "Name":                 "One-Tier-Stack",
       "TimeoutInMinutes":     "360",
       "VpcId":                "VPC_ID",
       "ApplicationLoadBalancer": {
           "SubnetIds": [
                     "SUBNET_ID",
                     "SUBNET_ID"
           ]
       },
       "AutoScalingGroup": {
           "AmiId": "AMI-ID"
           "SubnetIds": [
                    "SUBNET_ID",
                    "SUBNET_ID"
           ]
       }
   }

3. Output the CreateRfc JSON template to a file in your current folder; example names it CreateOnetierStackRfc.json:

   aws amscm create-rfc --generate-cli-skeleton > CreateOnetierStackRfc.json

4. Modify the RFC template as appropriate and save it. Reset the start and end times for a scheduled RFC, or leave off for an ASAP RFC.

   {
   "ChangeTypeVersion":    2.0",
   "ChangeTypeId":         "ct-09t6q7j9v5hrn",
   "Title":                "HA-One-Tier-RFC",
   "RequestedStartTime":   "2019-04-28T22:45:00Z",
   "RequestedEndTime":     "2019-04-28T22:45:00Z"
   }

5. Create the RFC, specifying the CreateOnetierStackRfc.json file and the CreateOnetierStackParams.json execution parameters file:

   aws amscm create-rfc --cli-input-json file://CreateOnetierStackRfc.json --execution-parameters file://CreateOnetierStackParams.json

   You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start.

Creating a high availability one-tier stack with the CLI

How it works:

1. Use the Template Create method (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the create-rfc command with the two files as input. Both methods are described here.

2. Submit the RFC: aws amscm submit-rfc --rfc-id ID command with the returned RFC ID.

   Monitor the RFC: aws amscm get-rfc --rfc-id ID command.

To check the change type version, use this command:

aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID

Note

You can use any CreateRfc parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, --notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}" to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the AMS Change Management API Reference.

TEMPLATE CREATE:

1. Output the execution parameters JSON schema for this change type to a file in your current folder; this example names it CreateOnetierStackParams.json.

   aws amscm get-change-type-version --change-type-id "ct-09t6q7j9v5hrn" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CreateOnetierStackParams.json

2. Modify the schema, replacing the variables as appropriate.

   {
       "Description":          "HA-One-Tier-Stack",
       "Name":                 "One-Tier-Stack",
       "TimeoutInMinutes":     "360",
       "VpcId":                "VPC_ID",
       "ApplicationLoadBalancer": {
           "SubnetIds": [
                     "SUBNET_ID",
                     "SUBNET_ID"
           ]
       },
       "AutoScalingGroup": {
           "AmiId": "AMI-ID"
           "SubnetIds": [
                    "SUBNET_ID",
                    "SUBNET_ID"
           ]
       }
   }

3. Output the CreateRfc JSON template to a file in your current folder; example names it CreateOnetierStackRfc.json:

   aws amscm create-rfc --generate-cli-skeleton > CreateOnetierStackRfc.json

4. Modify the RFC template as appropriate and save it. Reset the start and end times for a scheduled RFC, or leave off for an ASAP RFC.

   {
   "ChangeTypeVersion":    2.0",
   "ChangeTypeId":         "ct-09t6q7j9v5hrn",
   "Title":                "HA-One-Tier-RFC",
   "RequestedStartTime":   "2019-04-28T22:45:00Z",
   "RequestedEndTime":     "2019-04-28T22:45:00Z"
   }

5. Create the RFC, specifying the CreateOnetierStackRfc.json file and the CreateOnetierStackParams.json execution parameters file:

   aws amscm create-rfc --cli-input-json file://CreateOnetierStackRfc.json --execution-parameters file://CreateOnetierStackParams.json

   You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start.

Note

This is a large provisioning of resources, especially if you add UserData. The load balancer Amazon resource name (ARN) can be found through the Load Balancer page of the EC2 console by searching with the load balancer stack ID returned in the RFC execution output.

Tips

Note

This is a large provisioning of resources, especially if you add UserData. The load balancer Amazon resource name (ARN) can be found through the Load Balancer page of the EC2 console by searching with the load balancer stack ID returned in the RFC execution output.

Execution Input Parameters

For detailed information about the execution input parameters, see Schema for Change Type ct-09t6q7j9v5hrn.

Example: Required Parameters

{
  "VpcId": "vpc-1234567890abcdef0",
  "TimeoutInMinutes": 360,
  "ApplicationLoadBalancer": {
    "SubnetIds": ["subnet-01234567890abcdef", "subnet-01234567891abcdef"]
  },
  "AutoScalingGroup": {
    "AmiId": "ami-01234567890abcdef",
    "SubnetIds": ["subnet-01234567890abcdef", "subnet-01234567891abcdef"]
  },
  "Description": "This stack contains an ALB and an ASG.",
  "Name": "High availability one-tier stack"
}

Example: All Parameters

{
  "VpcId": "vpc-12345678",
  "TimeoutInMinutes": 360,
  "DatabaseStackId": "stack-0123456789abcdefg",
  "Description": "This stack contains an ALB and an ASG.",
  "Name": "High availability one-tier stack",
  "Tags": [
    {
      "Key": "Foo",
      "Value": "Bar"
    }
  ],
  "TimeoutInMinutes": 60,
  "VpcId": "vpc-01234567",
  "ApplicationLoadBalancer": {
    "HealthCheckHealthyThreshold": 2,
    "HealthCheckIntervalInSeconds": 10,
    "HealthCheckTargetPath": "/",
    "HealthCheckTargetPort": 80,
    "HealthCheckTargetProtocol": "HTTPS",
    "HealthCheckTimeoutSeconds": 5,
    "HealthCheckUnhealthyThreshold": 2,
    "InstancePort": 80,
    "InstanceProtocol": "HTTP",
    "LoadBalancerCookieExpirationPeriodInSeconds": 3600,
    "LoadBalancerPort": 80,
    "LoadBalancerAccessCIDRRange": "1.2.3.4/0",
    "LoadBalancerProtocol": "HTTP",
    "LoadBalancerSslPolicy": "ELBSecurityPolicy-2016-08",
    "Public": false,
    "SSLCertificateId": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012.",
    "SubnetIds": ["subnet-a0b1c2d3", "subnet-e4f5g6h7"],
    "ValidHTTPCode": "200"
  },
  "AutoScalingGroup": {
    "AmiId": "ami-01234567",
    "CooldownInSeconds": 300,
    "DesiredCapacity": 1,
    "EBSOptimized": false,
    "HealthCheckGracePeriodInSeconds": 1800,
    "HealthCheckType": "EC2",
    "IAMInstanceProfile": "customer-mc-ec2-instance-profile",
    "InstanceDetailedMonitoring" : true,
    "InstanceRootVolumeIops" : 0,
    "InstanceRootVolumeName": "/dev/xvda",
    "InstanceRootVolumeSizeInGiB" : 20,
    "InstanceRootVolumeType" : "standard",
    "InstanceType": "m4.large",
    "MaxInstances": 1,
    "MinInstances": 1,
    "ScaleMetricName": "CPUUtilization",
    "ScaleDownPolicyCooldownInSeconds": 300,
    "ScaleDownPolicyEvaluationPeriods": 4,
    "ScaleDownPolicyPeriod": 60,
    "ScaleDownPolicyScalingAdjustment": -1,
    "ScaleDownPolicyStatistic": "Average",
    "ScaleDownPolicyThreshold": 35,
    "ScaleUpPolicyCooldownInSeconds": 300,
    "ScaleUpPolicyEvaluationPeriods": 2,
    "ScaleUpPolicyPeriod": 60,
    "ScaleUpPolicyScalingAdjustment": 1,
    "ScaleUpPolicyStatistic": "Average",
    "ScaleUpPolicyThreshold": 75,
    "SubnetIds": ["subnet-a0b1c2d3", "subnet-e4f5g6h7"],
    "UserData": ["#!/bin/bash","echo hello"]
  }
}