Package software.amazon.awscdk.services.ecs

Class CfnCapacityProvider.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.CfnCapacityProvider.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCapacityProvider>

Enclosing class:

CfnCapacityProvider

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

A fluent builder for CfnCapacityProvider.

Method Summary

Modifier and Type	Method	Description
CfnCapacityProvider.Builder	autoScalingGroupProvider(IResolvable autoScalingGroupProvider)	The Auto Scaling group settings for the capacity provider.
CfnCapacityProvider.Builder	autoScalingGroupProvider(CfnCapacityProvider.AutoScalingGroupProviderProperty autoScalingGroupProvider)	The Auto Scaling group settings for the capacity provider.
CfnCapacityProvider	build()
CfnCapacityProvider.Builder	clusterName(String clusterName)	The cluster that this capacity provider is associated with.
static CfnCapacityProvider.Builder	create(software.constructs.Construct scope, String id)
CfnCapacityProvider.Builder	managedInstancesProvider(IResolvable managedInstancesProvider)	The configuration for the Amazon ECS Managed Instances provider.
CfnCapacityProvider.Builder	managedInstancesProvider(CfnCapacityProvider.ManagedInstancesProviderProperty managedInstancesProvider)	The configuration for the Amazon ECS Managed Instances provider.
CfnCapacityProvider.Builder	name(String name)	The name of the capacity provider.
CfnCapacityProvider.Builder	tags(List<? extends CfnTag> tags)	The metadata that you apply to the capacity provider to help you categorize and organize it.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnCapacityProvider.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnCapacityProvider.Builder.

autoScalingGroupProvider

@Stability(Stable)
public CfnCapacityProvider.Builder autoScalingGroupProvider(IResolvable autoScalingGroupProvider)

The Auto Scaling group settings for the capacity provider.

Parameters:

autoScalingGroupProvider - The Auto Scaling group settings for the capacity provider. This parameter is required.

Returns:

this

See Also:

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

autoScalingGroupProvider

@Stability(Stable)
public CfnCapacityProvider.Builder autoScalingGroupProvider(CfnCapacityProvider.AutoScalingGroupProviderProperty autoScalingGroupProvider)

The Auto Scaling group settings for the capacity provider.

Parameters:

autoScalingGroupProvider - The Auto Scaling group settings for the capacity provider. This parameter is required.

Returns:

this

See Also:

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

clusterName

@Stability(Stable)
public CfnCapacityProvider.Builder clusterName(String clusterName)

The cluster that this capacity provider is associated with.

Managed instances capacity providers are cluster-scoped, meaning they can only be used within their associated cluster.

This is required for Managed instances.

Parameters:

clusterName - The cluster that this capacity provider is associated with. This parameter is required.

Returns:

this

See Also:

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

managedInstancesProvider

@Stability(Stable)
public CfnCapacityProvider.Builder managedInstancesProvider(IResolvable managedInstancesProvider)

The configuration for the Amazon ECS Managed Instances provider.

This includes the infrastructure role, the launch template configuration, and tag propagation settings.

Parameters:

managedInstancesProvider - The configuration for the Amazon ECS Managed Instances provider. This parameter is required.

Returns:

this

See Also:

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

managedInstancesProvider

@Stability(Stable)
public CfnCapacityProvider.Builder managedInstancesProvider(CfnCapacityProvider.ManagedInstancesProviderProperty managedInstancesProvider)

The configuration for the Amazon ECS Managed Instances provider.

This includes the infrastructure role, the launch template configuration, and tag propagation settings.

Parameters:

managedInstancesProvider - The configuration for the Amazon ECS Managed Instances provider. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnCapacityProvider.Builder name(String name)

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.

Parameters:

name - The name of the capacity provider. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnCapacityProvider.Builder tags(List<? extends CfnTag> tags)

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: + - = . _ : /

Parameters:

tags - The metadata that you apply to the capacity provider to help you categorize and organize it. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnCapacityProvider build()

Specified by:

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

Returns:

a newly built instance of CfnCapacityProvider.