Package software.amazon.awscdk.services.ecs

Class AsgCapacityProviderProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

AddAutoScalingGroupCapacityOptions, AsgCapacityProviderProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

AsgCapacityProviderProps

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

An implementation for AsgCapacityProviderProps

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

AsgCapacityProviderProps.Builder, AsgCapacityProviderProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(AsgCapacityProviderProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the AsgCapacityProviderProps.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	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final IAutoScalingGroup	getAutoScalingGroup()	The autoscaling group to add as a Capacity Provider.
final Boolean	getCanContainersAccessInstanceRole()	Specifies whether the containers can access the container instance role.
final String	getCapacityProviderName()	The name of the capacity provider.
final Boolean	getEnableManagedScaling()	Whether to enable managed scaling.
final Boolean	getEnableManagedTerminationProtection()	Whether to enable managed termination protection.
final MachineImageType	getMachineImageType()	What type of machine image this is.
final Number	getMaximumScalingStepSize()	Maximum scaling step size.
final Number	getMinimumScalingStepSize()	Minimum scaling step size.
final Boolean	getSpotInstanceDraining()	Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services.
final Number	getTargetCapacityPercent()	Target capacity percent.
final Duration	getTaskDrainTime()	(deprecated) The time period to wait before force terminating an instance that is draining.
final 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.
final 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

Constructor Details

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(AsgCapacityProviderProps.Builder builder)

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

Method Details

getAutoScalingGroup

public final IAutoScalingGroup getAutoScalingGroup()

Description copied from interface: AsgCapacityProviderProps

The autoscaling group to add as a Capacity Provider.

Specified by:

getAutoScalingGroup in interface AsgCapacityProviderProps

getCapacityProviderName

public final String getCapacityProviderName()

Description copied from interface: AsgCapacityProviderProps

The name of the capacity provider.

If a name is specified, it cannot start with aws, ecs, or fargate. If no name is specified, a default name in the CFNStackName-CFNResourceName-RandomString format is used.

Default: CloudFormation-generated name

Specified by:

getCapacityProviderName in interface AsgCapacityProviderProps

getEnableManagedScaling

public final Boolean getEnableManagedScaling()

Description copied from interface: AsgCapacityProviderProps

Whether to enable managed scaling.

Default: true

Specified by:

getEnableManagedScaling in interface AsgCapacityProviderProps

getEnableManagedTerminationProtection

public final Boolean getEnableManagedTerminationProtection()

Description copied from interface: AsgCapacityProviderProps

Whether to enable managed termination protection.

Default: true

Specified by:

getEnableManagedTerminationProtection in interface AsgCapacityProviderProps

getMaximumScalingStepSize

public final Number getMaximumScalingStepSize()

Description copied from interface: AsgCapacityProviderProps

Maximum scaling step size.

In most cases this should be left alone.

Default: 1000

Specified by:

getMaximumScalingStepSize in interface AsgCapacityProviderProps

getMinimumScalingStepSize

public final Number getMinimumScalingStepSize()

Description copied from interface: AsgCapacityProviderProps

Minimum scaling step size.

In most cases this should be left alone.

Default: 1

Specified by:

getMinimumScalingStepSize in interface AsgCapacityProviderProps

getTargetCapacityPercent

public final Number getTargetCapacityPercent()

Description copied from interface: AsgCapacityProviderProps

Target capacity percent.

In most cases this should be left alone.

Default: 100

Specified by:

getTargetCapacityPercent in interface AsgCapacityProviderProps

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

$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