Package software.amazon.awscdk.services.ecs

Interface CfnCapacityProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCapacityProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:18.444Z")
@Stability(Stable)
public interface CfnCapacityProviderProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCapacityProvider.

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.*;
 CfnCapacityProviderProps cfnCapacityProviderProps = CfnCapacityProviderProps.builder()
         .autoScalingGroupProvider(AutoScalingGroupProviderProperty.builder()
                 .autoScalingGroupArn("autoScalingGroupArn")
                 // the properties below are optional
                 .managedDraining("managedDraining")
                 .managedScaling(ManagedScalingProperty.builder()
                         .instanceWarmupPeriod(123)
                         .maximumScalingStepSize(123)
                         .minimumScalingStepSize(123)
                         .status("status")
                         .targetCapacity(123)
                         .build())
                 .managedTerminationProtection("managedTerminationProtection")
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCapacityProviderProps.Builder	builder()
default Object	getAutoScalingGroupProvider()	The Auto Scaling group settings for the capacity provider.
default String	getName()	The name of the capacity provider.
default List<CfnTag>	getTags()	The metadata that you apply to the capacity provider to help you categorize and organize it.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoScalingGroupProvider

@Stability(Stable)
@Nullable
default Object getAutoScalingGroupProvider()

The Auto Scaling group settings for the capacity provider.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-autoscalinggroupprovider

getName

@Stability(Stable)
@Nullable
default String getName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-name

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The metadata that you apply to the capacity provider to help you categorize and organize it.

Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50
• For each resource, each tag key must be unique, and each tag key can have only one value.
• Maximum key length - 128 Unicode characters in UTF-8
• Maximum value length - 256 Unicode characters in UTF-8
• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-capacityprovider.html#cfn-ecs-capacityprovider-tags

builder

@Stability(Stable)
static CfnCapacityProviderProps.Builder builder()

Returns:

a CfnCapacityProviderProps.Builder of CfnCapacityProviderProps