software.amazon.awscdk.services.ecs

Interface CfnCapacityProvider.AutoScalingGroupProviderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCapacityProvider.AutoScalingGroupProviderProperty.Jsii$Proxy

Enclosing class:

CfnCapacityProvider

@Stability(value=Stable)
public static interface CfnCapacityProvider.AutoScalingGroupProviderProperty
extends software.amazon.jsii.JsiiSerializable

The `AutoScalingGroupProvider` property specifies the details of the Auto Scaling group for the capacity provider.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 AutoScalingGroupProviderProperty autoScalingGroupProviderProperty = AutoScalingGroupProviderProperty.builder()
         .autoScalingGroupArn("autoScalingGroupArn")
         // the properties below are optional
         .managedScaling(ManagedScalingProperty.builder()
                 .instanceWarmupPeriod(123)
                 .maximumScalingStepSize(123)
                 .minimumScalingStepSize(123)
                 .status("status")
                 .targetCapacity(123)
                 .build())
         .managedTerminationProtection("managedTerminationProtection")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCapacityProvider.AutoScalingGroupProviderProperty.Builder A builder for CfnCapacityProvider.AutoScalingGroupProviderProperty
static class	CfnCapacityProvider.AutoScalingGroupProviderProperty.Jsii$Proxy An implementation for CfnCapacityProvider.AutoScalingGroupProviderProperty

Method Summary

Modifier and Type	Method and Description
static CfnCapacityProvider.AutoScalingGroupProviderProperty.Builder	builder()
String	getAutoScalingGroupArn() The Amazon Resource Name (ARN) or short name that identifies the Auto Scaling group.
default Object	getManagedScaling() The managed scaling settings for the Auto Scaling group capacity provider.
default String	getManagedTerminationProtection() The managed termination protection setting to use for the Auto Scaling group capacity provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAutoScalingGroupArn

@Stability(value=Stable)
 @NotNull
String getAutoScalingGroupArn()

The Amazon Resource Name (ARN) or short name that identifies the Auto Scaling group.

getManagedScaling

@Stability(value=Stable)
 @Nullable
default Object getManagedScaling()

The managed scaling settings for the Auto Scaling group capacity provider.

getManagedTerminationProtection

@Stability(value=Stable)
 @Nullable
default String getManagedTerminationProtection()

The managed termination protection setting to use for the Auto Scaling group capacity provider.

This determines whether the Auto Scaling group has managed termination protection. The default is disabled.

When using managed termination protection, managed scaling must also be used otherwise managed termination protection doesn't work.

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide .

When managed termination protection is disabled, your Amazon EC2 instances aren't protected from termination when the Auto Scaling group scales in.

builder

@Stability(value=Stable)
static CfnCapacityProvider.AutoScalingGroupProviderProperty.Builder builder()

Returns:

a CfnCapacityProvider.AutoScalingGroupProviderProperty.Builder of CfnCapacityProvider.AutoScalingGroupProviderProperty