software.amazon.awscdk.services.ecs

Class AddCapacityOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.AddCapacityOptions.Jsii$Proxy

All Implemented Interfaces:

CommonAutoScalingGroupProps, AddAutoScalingGroupCapacityOptions, AddCapacityOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

AddCapacityOptions

@Stability(value=Stable)
 @Internal
public static final class AddCapacityOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements AddCapacityOptions

An implementation for AddCapacityOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.AddCapacityOptions

AddCapacityOptions.Builder, AddCapacityOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(AddCapacityOptions.Builder builder) Constructor that initializes the object based on literal property values passed by the AddCapacityOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Boolean	getAllowAllOutbound()
Boolean	getAssociatePublicIpAddress()
String	getAutoScalingGroupName()
List<BlockDevice>	getBlockDevices()
Boolean	getCanContainersAccessInstanceRole() Specifies whether the containers can access the container instance role.
Duration	getCooldown()
Number	getDesiredCapacity()
List<GroupMetrics>	getGroupMetrics()
HealthCheck	getHealthCheck()
Boolean	getIgnoreUnmodifiedSizeProperties()
Monitoring	getInstanceMonitoring()
InstanceType	getInstanceType() The EC2 instance type to use when launching instances into the AutoScalingGroup.
String	getKeyName()
IMachineImage	getMachineImage() The ECS-optimized AMI variant to use.
MachineImageType	getMachineImageType() What type of machine image this is.
Number	getMaxCapacity()
Duration	getMaxInstanceLifetime()
Number	getMinCapacity()
Boolean	getNewInstancesProtectedFromScaleIn()
List<NotificationConfiguration>	getNotifications()
ITopic	getNotificationsTopic()
Number	getReplacingUpdateMinSuccessfulInstancesPercent()
Number	getResourceSignalCount()
Duration	getResourceSignalTimeout()
RollingUpdateConfiguration	getRollingUpdateConfiguration()
Signals	getSignals()
Boolean	getSpotInstanceDraining() Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services.
String	getSpotPrice()
Duration	getTaskDrainTime() (deprecated) The time period to wait before force terminating an instance that is draining.
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()
UpdateType	getUpdateType()
SubnetSelection	getVpcSubnets()
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.ecs.AddCapacityOptions

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(AddCapacityOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the AddCapacityOptions.Builder.

Method Detail

getInstanceType

public final InstanceType getInstanceType()

Description copied from interface: AddCapacityOptions

The EC2 instance type to use when launching instances into the AutoScalingGroup.

Specified by:

getInstanceType in interface AddCapacityOptions

getMachineImage

public final IMachineImage getMachineImage()

Description copied from interface: AddCapacityOptions

The ECS-optimized AMI variant to use.

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

Specified by:

getMachineImage in interface AddCapacityOptions

getCanContainersAccessInstanceRole

public final Boolean getCanContainersAccessInstanceRole()

Description copied from interface: AddAutoScalingGroupCapacityOptions

Specifies whether the containers can access the container instance role.

Default: false

Specified by:

getCanContainersAccessInstanceRole in interface AddAutoScalingGroupCapacityOptions

getMachineImageType

public final MachineImageType getMachineImageType()

Description copied from interface: AddAutoScalingGroupCapacityOptions

What type of machine image this is.

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`.

Specified by:

getMachineImageType in interface AddAutoScalingGroupCapacityOptions

getSpotInstanceDraining

public final Boolean getSpotInstanceDraining()

Description copied from interface: AddAutoScalingGroupCapacityOptions

Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services.

For more information, see Using Spot Instances.

Default: false

Specified by:

getSpotInstanceDraining in interface AddAutoScalingGroupCapacityOptions

getTaskDrainTime

public final Duration getTaskDrainTime()

Description copied from interface: AddAutoScalingGroupCapacityOptions

(deprecated) The time period to wait before force terminating an instance that is draining.

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)

Specified by:

getTaskDrainTime in interface AddAutoScalingGroupCapacityOptions

getTopicEncryptionKey

public final IKey getTopicEncryptionKey()

Description copied from interface: AddAutoScalingGroupCapacityOptions

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. 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.

Specified by:

getTopicEncryptionKey in interface AddAutoScalingGroupCapacityOptions

getAllowAllOutbound

public final Boolean getAllowAllOutbound()

Specified by:

getAllowAllOutbound in interface CommonAutoScalingGroupProps

getAssociatePublicIpAddress

public final Boolean getAssociatePublicIpAddress()

Specified by:

getAssociatePublicIpAddress in interface CommonAutoScalingGroupProps

getAutoScalingGroupName

public final String getAutoScalingGroupName()

Specified by:

getAutoScalingGroupName in interface CommonAutoScalingGroupProps

getBlockDevices

public final List<BlockDevice> getBlockDevices()

Specified by:

getBlockDevices in interface CommonAutoScalingGroupProps

getCooldown

public final Duration getCooldown()

Specified by:

getCooldown in interface CommonAutoScalingGroupProps

getDesiredCapacity

public final Number getDesiredCapacity()

Specified by:

getDesiredCapacity in interface CommonAutoScalingGroupProps

getGroupMetrics

public final List<GroupMetrics> getGroupMetrics()

Specified by:

getGroupMetrics in interface CommonAutoScalingGroupProps

getHealthCheck

public final HealthCheck getHealthCheck()

Specified by:

getHealthCheck in interface CommonAutoScalingGroupProps

getIgnoreUnmodifiedSizeProperties

public final Boolean getIgnoreUnmodifiedSizeProperties()

Specified by:

getIgnoreUnmodifiedSizeProperties in interface CommonAutoScalingGroupProps

getInstanceMonitoring

public final Monitoring getInstanceMonitoring()

Specified by:

getInstanceMonitoring in interface CommonAutoScalingGroupProps

getKeyName

public final String getKeyName()

Specified by:

getKeyName in interface CommonAutoScalingGroupProps

getMaxCapacity

public final Number getMaxCapacity()

Specified by:

getMaxCapacity in interface CommonAutoScalingGroupProps

getMaxInstanceLifetime

public final Duration getMaxInstanceLifetime()

Specified by:

getMaxInstanceLifetime in interface CommonAutoScalingGroupProps

getMinCapacity

public final Number getMinCapacity()

Specified by:

getMinCapacity in interface CommonAutoScalingGroupProps

getNewInstancesProtectedFromScaleIn

public final Boolean getNewInstancesProtectedFromScaleIn()

Specified by:

getNewInstancesProtectedFromScaleIn in interface CommonAutoScalingGroupProps

getNotifications

public final List<NotificationConfiguration> getNotifications()

Specified by:

getNotifications in interface CommonAutoScalingGroupProps

getNotificationsTopic

public final ITopic getNotificationsTopic()

Specified by:

getNotificationsTopic in interface CommonAutoScalingGroupProps

getReplacingUpdateMinSuccessfulInstancesPercent

public final Number getReplacingUpdateMinSuccessfulInstancesPercent()

Specified by:

getReplacingUpdateMinSuccessfulInstancesPercent in interface CommonAutoScalingGroupProps

getResourceSignalCount

public final Number getResourceSignalCount()

Specified by:

getResourceSignalCount in interface CommonAutoScalingGroupProps

getResourceSignalTimeout

public final Duration getResourceSignalTimeout()

Specified by:

getResourceSignalTimeout in interface CommonAutoScalingGroupProps

getRollingUpdateConfiguration

public final RollingUpdateConfiguration getRollingUpdateConfiguration()

Specified by:

getRollingUpdateConfiguration in interface CommonAutoScalingGroupProps

getSignals

public final Signals getSignals()

Specified by:

getSignals in interface CommonAutoScalingGroupProps

getSpotPrice

public final String getSpotPrice()

Specified by:

getSpotPrice in interface CommonAutoScalingGroupProps

getUpdatePolicy

public final UpdatePolicy getUpdatePolicy()

Specified by:

getUpdatePolicy in interface CommonAutoScalingGroupProps

getUpdateType

public final UpdateType getUpdateType()

Specified by:

getUpdateType in interface CommonAutoScalingGroupProps

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Specified by:

getVpcSubnets in interface CommonAutoScalingGroupProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object