Package software.amazon.awscdk.services.ecs

Class AsgCapacityProviderProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.AsgCapacityProviderProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AsgCapacityProviderProps>

Enclosing interface:

AsgCapacityProviderProps

@Stability(Stable)
public static final class AsgCapacityProviderProps.Builder
extends Object
implements software.amazon.jsii.Builder<AsgCapacityProviderProps>

A builder for AsgCapacityProviderProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AsgCapacityProviderProps.Builder	autoScalingGroup(IAutoScalingGroup autoScalingGroup)	Sets the value of AsgCapacityProviderProps.getAutoScalingGroup()
AsgCapacityProviderProps	build()	Builds the configured instance.
AsgCapacityProviderProps.Builder	canContainersAccessInstanceRole(Boolean canContainersAccessInstanceRole)	Sets the value of AddAutoScalingGroupCapacityOptions.getCanContainersAccessInstanceRole()
AsgCapacityProviderProps.Builder	capacityProviderName(String capacityProviderName)	Sets the value of AsgCapacityProviderProps.getCapacityProviderName()
AsgCapacityProviderProps.Builder	enableManagedScaling(Boolean enableManagedScaling)	Sets the value of AsgCapacityProviderProps.getEnableManagedScaling()
AsgCapacityProviderProps.Builder	enableManagedTerminationProtection(Boolean enableManagedTerminationProtection)	Sets the value of AsgCapacityProviderProps.getEnableManagedTerminationProtection()
AsgCapacityProviderProps.Builder	machineImageType(MachineImageType machineImageType)	Sets the value of AddAutoScalingGroupCapacityOptions.getMachineImageType()
AsgCapacityProviderProps.Builder	maximumScalingStepSize(Number maximumScalingStepSize)	Sets the value of AsgCapacityProviderProps.getMaximumScalingStepSize()
AsgCapacityProviderProps.Builder	minimumScalingStepSize(Number minimumScalingStepSize)	Sets the value of AsgCapacityProviderProps.getMinimumScalingStepSize()
AsgCapacityProviderProps.Builder	spotInstanceDraining(Boolean spotInstanceDraining)	Sets the value of AddAutoScalingGroupCapacityOptions.getSpotInstanceDraining()
AsgCapacityProviderProps.Builder	targetCapacityPercent(Number targetCapacityPercent)	Sets the value of AsgCapacityProviderProps.getTargetCapacityPercent()
AsgCapacityProviderProps.Builder	taskDrainTime(Duration taskDrainTime)	Deprecated. The lifecycle draining hook is not configured if using the EC2 Capacity Provider.
AsgCapacityProviderProps.Builder	topicEncryptionKey(IKey topicEncryptionKey)	Sets the value of AddAutoScalingGroupCapacityOptions.getTopicEncryptionKey()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

autoScalingGroup

@Stability(Stable)
public AsgCapacityProviderProps.Builder autoScalingGroup(IAutoScalingGroup autoScalingGroup)

Sets the value of AsgCapacityProviderProps.getAutoScalingGroup()

Parameters:

autoScalingGroup - The autoscaling group to add as a Capacity Provider. This parameter is required.

Returns:

this

capacityProviderName

@Stability(Stable)
public AsgCapacityProviderProps.Builder capacityProviderName(String capacityProviderName)

Sets the value of AsgCapacityProviderProps.getCapacityProviderName()

Parameters:

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

Returns:

this

enableManagedScaling

@Stability(Stable)
public AsgCapacityProviderProps.Builder enableManagedScaling(Boolean enableManagedScaling)

Sets the value of AsgCapacityProviderProps.getEnableManagedScaling()

Parameters:

enableManagedScaling - Whether to enable managed scaling.

Returns:

this

enableManagedTerminationProtection

@Stability(Stable)
public AsgCapacityProviderProps.Builder enableManagedTerminationProtection(Boolean enableManagedTerminationProtection)

Sets the value of AsgCapacityProviderProps.getEnableManagedTerminationProtection()

Parameters:

enableManagedTerminationProtection - Whether to enable managed termination protection.

Returns:

this

maximumScalingStepSize

@Stability(Stable)
public AsgCapacityProviderProps.Builder maximumScalingStepSize(Number maximumScalingStepSize)

Sets the value of AsgCapacityProviderProps.getMaximumScalingStepSize()

Parameters:

maximumScalingStepSize - Maximum scaling step size. In most cases this should be left alone.

Returns:

this

minimumScalingStepSize

@Stability(Stable)
public AsgCapacityProviderProps.Builder minimumScalingStepSize(Number minimumScalingStepSize)

Sets the value of AsgCapacityProviderProps.getMinimumScalingStepSize()

Parameters:

minimumScalingStepSize - Minimum scaling step size. In most cases this should be left alone.

Returns:

this

targetCapacityPercent

@Stability(Stable)
public AsgCapacityProviderProps.Builder targetCapacityPercent(Number targetCapacityPercent)

Sets the value of AsgCapacityProviderProps.getTargetCapacityPercent()

Parameters:

targetCapacityPercent - Target capacity percent. In most cases this should be left alone.

Returns:

this

canContainersAccessInstanceRole

@Stability(Stable)
public AsgCapacityProviderProps.Builder canContainersAccessInstanceRole(Boolean canContainersAccessInstanceRole)

Sets the value of AddAutoScalingGroupCapacityOptions.getCanContainersAccessInstanceRole()

Parameters:

canContainersAccessInstanceRole - Specifies whether the containers can access the container instance role.

Returns:

this

machineImageType

@Stability(Stable)
public AsgCapacityProviderProps.Builder machineImageType(MachineImageType machineImageType)

Sets the value of AddAutoScalingGroupCapacityOptions.getMachineImageType()

Parameters:

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

Returns:

this

spotInstanceDraining

@Stability(Stable)
public AsgCapacityProviderProps.Builder spotInstanceDraining(Boolean spotInstanceDraining)

Sets the value of AddAutoScalingGroupCapacityOptions.getSpotInstanceDraining()

Parameters:

spotInstanceDraining - Specify whether to enable Automated Draining for Spot Instances running Amazon ECS Services. For more information, see Using Spot Instances.

Returns:

this

taskDrainTime

@Stability(Deprecated)
@Deprecated
public AsgCapacityProviderProps.Builder taskDrainTime(Duration taskDrainTime)

Deprecated.

The lifecycle draining hook is not configured if using the EC2 Capacity Provider. Enable managed termination protection instead.

Sets the value of AddAutoScalingGroupCapacityOptions.getTaskDrainTime()

Parameters:

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

Returns:

this

topicEncryptionKey

@Stability(Stable)
public AsgCapacityProviderProps.Builder topicEncryptionKey(IKey topicEncryptionKey)

Sets the value of AddAutoScalingGroupCapacityOptions.getTopicEncryptionKey()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public AsgCapacityProviderProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AsgCapacityProviderProps>

Returns:

a new instance of AsgCapacityProviderProps

Throws:

NullPointerException - if any required attribute was not provided