AWS elasticbeanstalk documentation change
Summary
Updated terminology from 'Auto Scaling group' to 'Amazon EC2 Auto Scaling group' throughout the document for consistency with AWS service naming conventions. Changed references to Elastic Load Balancing (ELB) to use abbreviated 'ELB' in health check parameters. Fixed URL formatting in EC2 instance type documentation links.
Security assessment
The changes are primarily branding/naming convention updates (adding 'Amazon EC2' to Auto Scaling references) and documentation link formatting fixes. No security vulnerabilities, mitigations, or new security features are introduced. The SecurityGroups option description remains unchanged in security context beyond naming updates.
Diff
diff --git a/elasticbeanstalk/latest/dg/command-options-general.md b/elasticbeanstalk/latest/dg/command-options-general.md index d525324ff..5c65734c4 100644 --- a//elasticbeanstalk/latest/dg/command-options-general.md +++ b//elasticbeanstalk/latest/dg/command-options-general.md @@ -90 +90 @@ aws:autoscaling:asgaws:autoscaling:launchconfigurationaws:autoscaling:scheduleda -Configure your environment's Auto Scaling group. For more information, see [Auto Scaling your Elastic Beanstalk environment instances](./using-features.managing.as.html). +Configure your environment's Amazon EC2 Auto Scaling group. For more information, see [Amazon EC2 Auto Scaling your Elastic Beanstalk environment instances](./using-features.managing.as.html). @@ -98,2 +98,2 @@ EnableCapacityRebalancing | Specifies whether to enable the Capacity Rebalancin -MinSize | The minimum number of instances that you want in your Auto Scaling group. | `1` | `1` to `10000` -MaxSize | The maximum number of instances that you want in your Auto Scaling group. | `4` | `1` to `10000` +MinSize | The minimum number of instances that you want in your Amazon EC2 Auto Scaling group. | `1` | `1` to `10000` +MaxSize | The maximum number of instances that you want in your Amazon EC2 Auto Scaling group. | `4` | `1` to `10000` @@ -105 +105 @@ Configure the Amazon Elastic Compute Cloud (Amazon EC2) instances for your envir -The instances that are used for your environment are created using either an Amazon EC2 launch template or an Auto Scaling group launch configuration resource. The following options work with both of these resource types. +The instances that are used for your environment are created using either an Amazon EC2 launch template or an Amazon EC2 Auto Scaling group launch configuration resource. The following options work with both of these resource types. @@ -152 +152 @@ The `InstanceType` option is obsolete. It's replaced by the newer and more power - * For more information on the available instance types across Regions, see [Available instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) in the _Amazon EC2 User Guide_. + * For more information on the available instance types across Regions, see [Available instance types](https://docs.aws.amazon.com//AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) in the _Amazon EC2 User Guide_. @@ -158 +158 @@ The `InstanceType` option is obsolete. It's replaced by the newer and more power -If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](./ebextensions.html). The console and EB CLI override this option with a [recommended value](./command-options.html#configuration-options-recommendedvalues). | Varies by account and Region. | One EC2 instance type. Varies by account, Region, and Availability Zone. You can obtain a list of Amazon EC2 instance types filtered by these values. For more information, see [Available instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) in the _Amazon EC2 User Guide_. +If you use the Elastic Beanstalk console or EB CLI to create an environment, you can't set this option in a [configuration file](./ebextensions.html). The console and EB CLI override this option with a [recommended value](./command-options.html#configuration-options-recommendedvalues). | Varies by account and Region. | One EC2 instance type. Varies by account, Region, and Availability Zone. You can obtain a list of Amazon EC2 instance types filtered by these values. For more information, see [Available instance types](https://docs.aws.amazon.com//AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) in the _Amazon EC2 User Guide_. @@ -181 +181 @@ MonitoringInterval | The interval (in minutes) that you want Amazon CloudWatch -SecurityGroups | Lists the Amazon EC2 security group IDs to assign to the EC2 instances in the Auto Scaling group to define firewall rules for the instances. Use this option along with `DisableDefaultEC2SecurityGroup` to attach your own custom security groups that define firewall rules for the EC2 instances. For more information, see [Load balanced (multi-instance) environments](./using-features.managing.ec2.instances.sg.html#using-features.managing.ec2.instances.sg.load-balancer-security). +SecurityGroups | Lists the Amazon EC2 security group IDs to assign to the EC2 instances in the Amazon EC2 Auto Scaling group to define firewall rules for the instances. Use this option along with `DisableDefaultEC2SecurityGroup` to attach your own custom security groups that define firewall rules for the EC2 instances. For more information, see [Load balanced (multi-instance) environments](./using-features.managing.ec2.instances.sg.html#using-features.managing.ec2.instances.sg.load-balancer-security). @@ -204 +204 @@ SSHSourceRestriction | Used to lock down SSH access to an environment. For exam -BlockDeviceMappings | Attach additional Amazon EBS volumes or instance store volumes on all of the instances in the Auto Scaling group. +BlockDeviceMappings | Attach additional Amazon EBS volumes or instance store volumes on all of the instances in the Amazon EC2 Auto Scaling group. @@ -238 +238 @@ This option is only applicable to `gp3` storage types. | None | `125` to `1000 -Configure [scheduled actions](./environments-cfg-autoscaling-scheduledactions.html) for your environment's Auto Scaling group. For each action, specify a `resource_name` in addition to the option name, namespace, and value for each setting. See [The aws:autoscaling:scheduledaction namespace](./environments-cfg-autoscaling-scheduledactions.html#environments-cfg-autoscaling-scheduledactions-namespace) for examples. +Configure [scheduled actions](./environments-cfg-autoscaling-scheduledactions.html) for your environment's Amazon EC2 Auto Scaling group. For each action, specify a `resource_name` in addition to the option name, namespace, and value for each setting. See [The aws:autoscaling:scheduledaction namespace](./environments-cfg-autoscaling-scheduledactions.html#environments-cfg-autoscaling-scheduledactions-namespace) for examples. @@ -246 +246 @@ MinSize | The minimum instance count to apply when the action runs. | None | -DesiredCapacity | Set the initial desired capacity for the Auto Scaling group. After the scheduled action is applied, triggers adjust the desired capacity based on their settings. | None | `0` to `10000` +DesiredCapacity | Set the initial desired capacity for the Amazon EC2 Auto Scaling group. After the scheduled action is applied, triggers adjust the desired capacity based on their settings. | None | `0` to `10000` @@ -252 +252 @@ Suspend | Set to `true` to deactivate a recurrent scheduled action temporarily. -Configure scaling triggers for your environment's Auto Scaling group. +Configure scaling triggers for your environment's Amazon EC2 Auto Scaling group. @@ -267 +267 @@ LowerThreshold | If the measurement falls below this number for the breach dura -MeasureName | The metric that's used for your Auto Scaling trigger. +MeasureName | The metric that's used for your Amazon EC2 Auto Scaling trigger. @@ -281 +281 @@ UpperThreshold | If the measurement is higher than this number for the breach d -Configure rolling updates your environment's Auto Scaling group. +Configure rolling updates your environment's Amazon EC2 Auto Scaling group. @@ -285,2 +285,2 @@ Namespace: `aws:autoscaling:updatepolicy:rollingupdate` **Name** | **Description -MaxBatchSize | The number of instances included in each batch of the rolling update. | One-third of the minimum size of the Auto Scaling group, rounded to the next highest integer. | `1` to `10000` -MinInstancesInService | The minimum number of instances that must be in service within the Auto Scaling group while other instances are terminated. | The minimum size of the Auto Scaling group or one fewer than the maximum size of the Auto Scaling group, whichever is lower. | `0` to `9999` +MaxBatchSize | The number of instances included in each batch of the rolling update. | One-third of the minimum size of the Amazon EC2 Auto Scaling group, rounded to the next highest integer. | `1` to `10000` +MinInstancesInService | The minimum number of instances that must be in service within the Amazon EC2 Auto Scaling group while other instances are terminated. | The minimum size of the Amazon EC2 Auto Scaling group or one fewer than the maximum size of the Amazon EC2 Auto Scaling group, whichever is lower. | `0` to `9999` @@ -292 +292 @@ If you use the Elastic Beanstalk console or EB CLI to create an environment, you -RollingUpdateType | This includes three types: time-based rolling updates, health-based rolling updates, and immutable updates. Time-based rolling updates apply a PauseTime between batches. Health-based rolling updates wait for new instances to pass health checks before moving on to the next batch. [Immutable updates](./environmentmgmt-updates-immutable.html) launch a full set of instances in a new Auto Scaling group. +RollingUpdateType | This includes three types: time-based rolling updates, health-based rolling updates, and immutable updates. Time-based rolling updates apply a PauseTime between batches. Health-based rolling updates wait for new instances to pass health checks before moving on to the next batch. [Immutable updates](./environmentmgmt-updates-immutable.html) launch a full set of instances in a new Amazon EC2 Auto Scaling group. @@ -304 +304 @@ Configure your environment's instances, including Spot options. This namespace c -For more information, see [Auto Scaling your Elastic Beanstalk environment instances](./using-features.managing.as.html). +For more information, see [Amazon EC2 Auto Scaling your Elastic Beanstalk environment instances](./using-features.managing.as.html). @@ -317 +317 @@ InstanceTypes | A comma-separated list of instance types that you want your env - * For more information on the available instance types across Regions, see [Available instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) in the _Amazon EC2 User Guide_. + * For more information on the available instance types across Regions, see [Available instance types](https://docs.aws.amazon.com//AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) in the _Amazon EC2 User Guide_. @@ -323 +323 @@ InstanceTypes | A comma-separated list of instance types that you want your env -Some older AWS accounts might provide Elastic Beanstalk with default instance types that don't support Spot Instances (for example, t1.micro). If you activate Spot Instance requests and you get an error about an instance type that doesn’t support Spot, be sure to configure instance types that support Spot. To choose Spot Instance types, use the [Spot Instance Advisor](https://aws.amazon.com/ec2/spot/instance-advisor/). When you update your environment configuration and remove one or more instance types from the `InstanceTypes` option, Elastic Beanstalk terminates any Amazon EC2 instances running on any of the removed instance types. Your environment's Auto Scaling group then launches new instances, as necessary to complete the desired capacity, using your current specified instance types. | A list of two instance types. Varies by account and Region. | One to forty EC2 instance types. We recommend at least two. Varies by account, Region, and Availability Zone. You can obtain a list of Amazon EC2 instance types filtered by these values. For more information, see [Available instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) in the _Amazon EC2 User Guide_. The instance types must all be part of the same architecture (`arm64`, `x86_64`, `i386`). `SupportedArchitectures` is also part of this namespace. If you provide any values for `SupportedArchitectures`, the value(s) you enter for `InstanceTypes` must belong to one, and only one, of the architectures you provide for `SupportedArchitectures`. +Some older AWS accounts might provide Elastic Beanstalk with default instance types that don't support Spot Instances (for example, t1.micro). If you activate Spot Instance requests and you get an error about an instance type that doesn’t support Spot, be sure to configure instance types that support Spot. To choose Spot Instance types, use the [Spot Instance Advisor](https://aws.amazon.com/ec2/spot/instance-advisor/). When you update your environment configuration and remove one or more instance types from the `InstanceTypes` option, Elastic Beanstalk terminates any Amazon EC2 instances running on any of the removed instance types. Your environment's Amazon EC2 Auto Scaling group then launches new instances, as necessary to complete the desired capacity, using your current specified instance types. | A list of two instance types. Varies by account and Region. | One to forty EC2 instance types. We recommend at least two. Varies by account, Region, and Availability Zone. You can obtain a list of Amazon EC2 instance types filtered by these values. For more information, see [Available instance types](https://docs.aws.amazon.com//AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes) in the _Amazon EC2 User Guide_. The instance types must all be part of the same architecture (`arm64`, `x86_64`, `i386`). `SupportedArchitectures` is also part of this namespace. If you provide any values for `SupportedArchitectures`, the value(s) you enter for `InstanceTypes` must belong to one, and only one, of the architectures you provide for `SupportedArchitectures`. @@ -325,2 +325,2 @@ SpotAllocationStrategy | Specifies the [spot instance allocation strategy](./en -SpotFleetOnDemandBase | The minimum number of On-Demand Instances that your Auto Scaling group provisions before considering Spot Instances as your environment scales up. This option is relevant only when `EnableSpot` is `true`. | `0` | `0` to `MaxSize` option in aws:autoscaling:asg namespace -SpotFleetOnDemandAboveBasePercentage | The percentage of On-Demand Instances as part of additional capacity that your Auto Scaling group provisions beyond the `SpotOnDemandBase` instances. This option is relevant only when `EnableSpot` is `true`. | `0` for a single-instance environment `70` for a load-balanced environment | `0` to `100` +SpotFleetOnDemandBase | The minimum number of On-Demand Instances that your Amazon EC2 Auto Scaling group provisions before considering Spot Instances as your environment scales up. This option is relevant only when `EnableSpot` is `true`. | `0` | `0` to `MaxSize` option in aws:autoscaling:asg namespace +SpotFleetOnDemandAboveBasePercentage | The percentage of On-Demand Instances as part of additional capacity that your Amazon EC2 Auto Scaling group provisions beyond the `SpotOnDemandBase` instances. This option is relevant only when `EnableSpot` is `true`. | `0` for a single-instance environment `70` for a load-balanced environment | `0` to `100` @@ -347 +347 @@ VPCId | The ID for your Amazon VPC. | None | -Subnets | The IDs of the Auto Scaling group subnet or subnets. If you have multiple subnets, specify the value as a single comma-separated string of subnet IDs (for example, `"subnet-11111111,subnet-22222222"`). | None | +Subnets | The IDs of the Amazon EC2 Auto Scaling group subnet or subnets. If you have multiple subnets, specify the value as a single comma-separated string of subnet IDs (for example, `"subnet-11111111,subnet-22222222"`). | None | @@ -429 +429 @@ If you use the Elastic Beanstalk console or EB CLI to create an environment, you -BatchSize | The percentage or the fixed number of Amazon EC2 instances in the Auto Scaling group to simultaneously perform deployments on. Valid values vary depending on the **BatchSizeType** setting used. +BatchSize | The percentage or the fixed number of Amazon EC2 instances in the Amazon EC2 Auto Scaling group to simultaneously perform deployments on. Valid values vary depending on the **BatchSizeType** setting used. @@ -464 +464 @@ DeregistrationDelay | The amount of time, in seconds, to wait for active reques -HealthCheckInterval | The interval of time, in seconds, that Elastic Load Balancing checks the health of the Amazon EC2 instances of your application. | With classic or application load balancer: `15` With network load balancer: `30` | With classic or application load balancer: `5` to `300` With network load balancer: `10`, `30` +HealthCheckInterval | The interval of time, in seconds, that ELB checks the health of the Amazon EC2 instances of your application. | With classic or application load balancer: `15` With network load balancer: `30` | With classic or application load balancer: `5` to `300` With network load balancer: `10`, `30` @@ -467 +467 @@ HealthCheckTimeout | The amount of time, in seconds, to wait for a response dur -HealthyThresholdCount | The number of consecutive successful requests before Elastic Load Balancing changes the instance health status. | With classic or application load balancer: `3` With network load balancer: `5` | `2` to `10` +HealthyThresholdCount | The number of consecutive successful requests before ELB changes the instance health status. | With classic or application load balancer: `3` With network load balancer: `5` | `2` to `10` @@ -474 +474 @@ StickinessType | Set to `lb_cookie` to use cookies for sticky sessions. This op -UnhealthyThresholdCount | The number of consecutive unsuccessful requests before Elastic Load Balancing changes the instance health status. | `5` | `2` to `10` +UnhealthyThresholdCount | The number of consecutive unsuccessful requests before ELB changes the instance health status. | `5` | `2` to `10` @@ -483 +483 @@ DeregistrationDelay | The amount of time, in seconds, to wait for active reques -HealthCheckInterval | The interval, in seconds, that Elastic Load Balancing checks the health of Amazon EC2 instances for your application. | With classic or application load balancer: `15` With network load balancer: `30` | With classic or application load balancer: `5` to `300` With network load balancer: `10`, `30` +HealthCheckInterval | The interval, in seconds, that ELB checks the health of Amazon EC2 instances for your application. | With classic or application load balancer: `15` With network load balancer: `30` | With classic or application load balancer: `5` to `300` With network load balancer: `10`, `30` @@ -486 +486 @@ HealthCheckTimeout | The amount of time, in seconds, to wait for a response dur -HealthyThresholdCount | The number of consecutive successful requests before Elastic Load Balancing changes the instance health status. | With classic or application load balancer: `3` With network load balancer: `5` | `2` to `10` +HealthyThresholdCount | The number of consecutive successful requests before ELB changes the instance health status. | With classic or application load balancer: `3` With network load balancer: `5` | `2` to `10` @@ -493 +493 @@ StickinessType | Set to `lb_cookie` to use cookies for sticky sessions. This op -UnhealthyThresholdCount | The number of consecutive unsuccessful requests before Elastic Load Balancing changes the instance health status. | `5` | `2` to `10` +UnhealthyThresholdCount | The number of consecutive unsuccessful requests before ELB changes the instance health status. | `5` | `2` to `10` @@ -636,4 +636,4 @@ Namespace: `aws:elb:healthcheck` **Name** | **Description** | **Default** | **Va -HealthyThreshold | The number of consecutive successful requests before Elastic Load Balancing changes the instance health status. | `3` | `2` to `10` -Interval | The interval that Elastic Load Balancing checks the health of your application's Amazon EC2 instances at. | `10` | `5` to `300` -Timeout | The amount of time, in seconds, that Elastic Load Balancing waits for a response before it considers the instance nonresponsive. | `5` | `2` to `60` -UnhealthyThreshold | The number of consecutive unsuccessful requests before Elastic Load Balancing changes the instance health status. | `5` | `2` to `10` +HealthyThreshold | The number of consecutive successful requests before ELB changes the instance health status. | `3` | `2` to `10` +Interval | The interval that ELB checks the health of your application's Amazon EC2 instances at. | `10` | `5` to `300` +Timeout | The amount of time, in seconds, that ELB waits for a response before it considers the instance nonresponsive. | `5` | `2` to `60` +UnhealthyThreshold | The number of consecutive unsuccessful requests before ELB changes the instance health status. | `5` | `2` to `10`