public static final class AddCapacityOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements AddCapacityOptions
AddCapacityOptions
AddCapacityOptions.Builder, AddCapacityOptions.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(java.lang.Object o) |
java.lang.Boolean |
getAllowAllOutbound()
Whether the instances can initiate connections to anywhere by default.
|
java.lang.Boolean |
getAssociatePublicIpAddress()
Whether instances in the Auto Scaling Group should have public IP addresses associated with them.
|
java.lang.String |
getAutoScalingGroupName()
The name of the Auto Scaling group.
|
java.util.List<BlockDevice> |
getBlockDevices()
Specifies how block devices are exposed to the instance.
|
java.lang.Boolean |
getCanContainersAccessInstanceRole()
Specifies whether the containers can access the container instance role.
|
Duration |
getCooldown()
Default scaling cooldown for this AutoScalingGroup.
|
java.lang.Number |
getDesiredCapacity()
Initial amount of instances in the fleet.
|
java.util.List<GroupMetrics> |
getGroupMetrics()
Enable monitoring for group metrics, these metrics describe the group rather than any of its instances.
|
HealthCheck |
getHealthCheck()
Configuration for health checks.
|
java.lang.Boolean |
getIgnoreUnmodifiedSizeProperties()
If the ASG has scheduled actions, don't reset unchanged group sizes.
|
Monitoring |
getInstanceMonitoring()
Controls whether instances in this group are launched with detailed or basic monitoring.
|
InstanceType |
getInstanceType()
The EC2 instance type to use when launching instances into the AutoScalingGroup.
|
java.lang.String |
getKeyName()
Name of SSH keypair to grant access to instances.
|
IMachineImage |
getMachineImage()
The ECS-optimized AMI variant to use.
|
MachineImageType |
getMachineImageType()
What type of machine image this is.
|
java.lang.Number |
getMaxCapacity()
Maximum number of instances in the fleet.
|
Duration |
getMaxInstanceLifetime()
The maximum amount of time that an instance can be in service.
|
java.lang.Number |
getMinCapacity()
Minimum number of instances in the fleet.
|
java.lang.Boolean |
getNewInstancesProtectedFromScaleIn()
Whether newly-launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
|
java.util.List<NotificationConfiguration> |
getNotifications()
Configure autoscaling group to send notifications about fleet changes to an SNS topic(s).
|
ITopic |
getNotificationsTopic()
(deprecated) SNS topic to send notifications about fleet changes.
|
java.lang.Number |
getReplacingUpdateMinSuccessfulInstancesPercent()
(deprecated) Configuration for replacing updates.
|
java.lang.Number |
getResourceSignalCount()
(deprecated) How many ResourceSignal calls CloudFormation expects before the resource is considered created.
|
Duration |
getResourceSignalTimeout()
(deprecated) The length of time to wait for the resourceSignalCount.
|
RollingUpdateConfiguration |
getRollingUpdateConfiguration()
(deprecated) Configuration for rolling updates.
|
Signals |
getSignals()
Configure waiting for signals during deployment.
|
java.lang.Boolean |
getSpotInstanceDraining()
Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services.
|
java.lang.String |
getSpotPrice()
The maximum hourly price (in USD) to be paid for any Spot Instance launched to fulfill the request.
|
Duration |
getTaskDrainTime()
(deprecated) The time period to wait before force terminating an instance that is draining.
|
java.util.List<TerminationPolicy> |
getTerminationPolicies()
A policy or a list of policies that are used to select the instances to terminate.
|
IKey |
getTopicEncryptionKey()
If
AddAutoScalingGroupCapacityOptions.taskDrainTime is non-zero, then the ECS cluster creates an SNS Topic to as part of a system to drain instances of tasks when the instance is being shut down. |
UpdatePolicy |
getUpdatePolicy()
What to do when an AutoScalingGroup's instance configuration is changed.
|
UpdateType |
getUpdateType()
(deprecated) What to do when an AutoScalingGroup's instance configuration is changed.
|
SubnetSelection |
getVpcSubnets()
Where to place instances within the VPC.
|
int |
hashCode() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final InstanceType getInstanceType()
AddCapacityOptions
getInstanceType
in interface AddCapacityOptions
public final IMachineImage getMachineImage()
AddCapacityOptions
The default is to use an ECS-optimized AMI of Amazon Linux 2 which is automatically updated to the latest version on every deployment. This will replace the instances in the AutoScalingGroup. Make sure you have not disabled task draining, to avoid downtime when the AMI updates.
To use an image that does not update on every deployment, pass:
EcsOptimizedImage machineImage = EcsOptimizedImage.amazonLinux2(AmiHardwareType.STANDARD, EcsOptimizedImageOptions.builder() .cachedInContext(true) .build());
For more information, see Amazon ECS-optimized AMIs.
You must define either machineImage
or machineImageType
, not both.
Default: - Automatically updated, ECS-optimized Amazon Linux 2
getMachineImage
in interface AddCapacityOptions
public final java.lang.Boolean getCanContainersAccessInstanceRole()
AddAutoScalingGroupCapacityOptions
Default: false
getCanContainersAccessInstanceRole
in interface AddAutoScalingGroupCapacityOptions
public final MachineImageType getMachineImageType()
AddAutoScalingGroupCapacityOptions
Depending on the setting, different UserData will automatically be added
to the AutoScalingGroup
to configure it properly for use with ECS.
If you create an AutoScalingGroup
yourself and are adding it via
addAutoScalingGroup()
, you must specify this value. If you are adding an
autoScalingGroup
via addCapacity
, this value will be determined
from the machineImage
you pass.
Default: - Automatically determined from `machineImage`, if available, otherwise `MachineImageType.AMAZON_LINUX_2`.
getMachineImageType
in interface AddAutoScalingGroupCapacityOptions
public final java.lang.Boolean getSpotInstanceDraining()
AddAutoScalingGroupCapacityOptions
For more information, see Using Spot Instances.
Default: false
getSpotInstanceDraining
in interface AddAutoScalingGroupCapacityOptions
public final Duration getTaskDrainTime()
AddAutoScalingGroupCapacityOptions
This creates a Lambda function that is used by a lifecycle hook for the AutoScalingGroup that will delay instance termination until all ECS tasks have drained from the instance. Set to 0 to disable task draining.
Set to 0 to disable task draining.
Default: Duration.minutes(5)
getTaskDrainTime
in interface AddAutoScalingGroupCapacityOptions
public final IKey getTopicEncryptionKey()
AddAutoScalingGroupCapacityOptions
AddAutoScalingGroupCapacityOptions.taskDrainTime
is non-zero, then the ECS cluster creates an SNS Topic to as part of a system to drain instances of tasks when the instance is being shut down. If this property is provided, then this key will be used to encrypt the contents of that SNS Topic. See [SNS Data Encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-data-encryption.html) for more information.
Default: The SNS Topic will not be encrypted.
getTopicEncryptionKey
in interface AddAutoScalingGroupCapacityOptions
public final java.lang.Boolean getAllowAllOutbound()
CommonAutoScalingGroupProps
Default: true
getAllowAllOutbound
in interface CommonAutoScalingGroupProps
public final java.lang.Boolean getAssociatePublicIpAddress()
CommonAutoScalingGroupProps
Default: - Use subnet setting.
getAssociatePublicIpAddress
in interface CommonAutoScalingGroupProps
public final java.lang.String getAutoScalingGroupName()
CommonAutoScalingGroupProps
This name must be unique per Region per account.
Default: - Auto generated by CloudFormation
getAutoScalingGroupName
in interface CommonAutoScalingGroupProps
public final java.util.List<BlockDevice> getBlockDevices()
CommonAutoScalingGroupProps
Each instance that is launched has an associated root device volume, either an Amazon EBS volume or an instance store volume. You can use block device mappings to specify additional EBS volumes or instance store volumes to attach to an instance when it is launched.
Default: - Uses the block device mapping of the AMI
getBlockDevices
in interface CommonAutoScalingGroupProps
public final Duration getCooldown()
CommonAutoScalingGroupProps
Default: Duration.minutes(5)
getCooldown
in interface CommonAutoScalingGroupProps
public final java.lang.Number getDesiredCapacity()
CommonAutoScalingGroupProps
If this is set to a number, every deployment will reset the amount of instances to this number. It is recommended to leave this value blank.
Default: minCapacity, and leave unchanged during deployment
public final java.util.List<GroupMetrics> getGroupMetrics()
CommonAutoScalingGroupProps
To report all group metrics use GroupMetrics.all()
Group metrics are reported in a granularity of 1 minute at no additional charge.
Default: - no group metrics will be reported
getGroupMetrics
in interface CommonAutoScalingGroupProps
public final HealthCheck getHealthCheck()
CommonAutoScalingGroupProps
Default: - HealthCheck.ec2 with no grace period
getHealthCheck
in interface CommonAutoScalingGroupProps
public final java.lang.Boolean getIgnoreUnmodifiedSizeProperties()
CommonAutoScalingGroupProps
Only used if the ASG has scheduled actions (which may scale your ASG up or down regardless of cdk deployments). If true, the size of the group will only be reset if it has been changed in the CDK app. If false, the sizes will always be changed back to what they were in the CDK app on deployment.
Default: true
getIgnoreUnmodifiedSizeProperties
in interface CommonAutoScalingGroupProps
public final Monitoring getInstanceMonitoring()
CommonAutoScalingGroupProps
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes.
Default: - Monitoring.DETAILED
public final java.lang.String getKeyName()
CommonAutoScalingGroupProps
Default: - No SSH access will be possible.
getKeyName
in interface CommonAutoScalingGroupProps
public final java.lang.Number getMaxCapacity()
CommonAutoScalingGroupProps
Default: desiredCapacity
getMaxCapacity
in interface CommonAutoScalingGroupProps
public final Duration getMaxInstanceLifetime()
CommonAutoScalingGroupProps
The maximum duration applies to all current and future instances in the group. As an instance approaches its maximum duration, it is terminated and replaced, and cannot be used again.
You must specify a value of at least 604,800 seconds (7 days). To clear a previously set value, leave this property undefined.
Default: none
getMaxInstanceLifetime
in interface CommonAutoScalingGroupProps
public final java.lang.Number getMinCapacity()
CommonAutoScalingGroupProps
Default: 1
getMinCapacity
in interface CommonAutoScalingGroupProps
public final java.lang.Boolean getNewInstancesProtectedFromScaleIn()
CommonAutoScalingGroupProps
By default, Auto Scaling can terminate an instance at any time after launch when scaling in an Auto Scaling Group, subject to the group's termination policy. However, you may wish to protect newly-launched instances from being scaled in if they are going to run critical applications that should not be prematurely terminated.
This flag must be enabled if the Auto Scaling Group will be associated with an ECS Capacity Provider with managed termination protection.
Default: false
getNewInstancesProtectedFromScaleIn
in interface CommonAutoScalingGroupProps
public final java.util.List<NotificationConfiguration> getNotifications()
CommonAutoScalingGroupProps
Default: - No fleet change notifications will be sent.
public final ITopic getNotificationsTopic()
CommonAutoScalingGroupProps
Default: - No fleet change notifications will be sent.
getNotificationsTopic
in interface CommonAutoScalingGroupProps
public final java.lang.Number getReplacingUpdateMinSuccessfulInstancesPercent()
CommonAutoScalingGroupProps
Only used if updateType == UpdateType.ReplacingUpdate. Specifies how many instances must signal success for the update to succeed.
Default: minSuccessfulInstancesPercent
getReplacingUpdateMinSuccessfulInstancesPercent
in interface CommonAutoScalingGroupProps
public final java.lang.Number getResourceSignalCount()
CommonAutoScalingGroupProps
Default: 1 if resourceSignalTimeout is set, 0 otherwise
getResourceSignalCount
in interface CommonAutoScalingGroupProps
public final Duration getResourceSignalTimeout()
CommonAutoScalingGroupProps
The maximum value is 43200 (12 hours).
Default: Duration.minutes(5) if resourceSignalCount is set, N/A otherwise
getResourceSignalTimeout
in interface CommonAutoScalingGroupProps
public final RollingUpdateConfiguration getRollingUpdateConfiguration()
CommonAutoScalingGroupProps
Only used if updateType == UpdateType.RollingUpdate.
Default: - RollingUpdateConfiguration with defaults.
getRollingUpdateConfiguration
in interface CommonAutoScalingGroupProps
public final Signals getSignals()
CommonAutoScalingGroupProps
Use this to pause the CloudFormation deployment to wait for the instances
in the AutoScalingGroup to report successful startup during
creation and updates. The UserData script needs to invoke cfn-signal
with a success or failure code after it is done setting up the instance.
Without waiting for signals, the CloudFormation deployment will proceed as soon as the AutoScalingGroup has been created or updated but before the instances in the group have been started.
For example, to have instances wait for an Elastic Load Balancing health check before they signal success, add a health-check verification by using the cfn-init helper script. For an example, see the verify_instance_health command in the Auto Scaling rolling updates sample template:
https://github.com/awslabs/aws-cloudformation-templates/blob/master/aws/services/AutoScaling/AutoScalingRollingUpdates.yaml
Default: - Do not wait for signals
getSignals
in interface CommonAutoScalingGroupProps
public final java.lang.String getSpotPrice()
CommonAutoScalingGroupProps
Spot Instances are launched when the price you specify exceeds the current Spot market price.
Default: none
getSpotPrice
in interface CommonAutoScalingGroupProps
public final java.util.List<TerminationPolicy> getTerminationPolicies()
CommonAutoScalingGroupProps
The policies are executed in the order that you list them.
Default: - `TerminationPolicy.DEFAULT`
getTerminationPolicies
in interface CommonAutoScalingGroupProps
public final UpdatePolicy getUpdatePolicy()
CommonAutoScalingGroupProps
This is applied when any of the settings on the ASG are changed that affect how the instances should be created (VPC, instance type, startup scripts, etc.). It indicates how the existing instances should be replaced with new instances matching the new config. By default, nothing is done and only new instances are launched with the new config.
Default: - `UpdatePolicy.rollingUpdate()` if using `init`, `UpdatePolicy.none()` otherwise
getUpdatePolicy
in interface CommonAutoScalingGroupProps
public final UpdateType getUpdateType()
CommonAutoScalingGroupProps
This is applied when any of the settings on the ASG are changed that affect how the instances should be created (VPC, instance type, startup scripts, etc.). It indicates how the existing instances should be replaced with new instances matching the new config. By default, nothing is done and only new instances are launched with the new config.
Default: UpdateType.None
getUpdateType
in interface CommonAutoScalingGroupProps
public final SubnetSelection getVpcSubnets()
CommonAutoScalingGroupProps
Default: - All Private subnets.
getVpcSubnets
in interface CommonAutoScalingGroupProps
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()