Package software.amazon.awscdk.services.ecs

Class CfnClusterCapacityProviderAssociations

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ecs.CfnClusterCapacityProviderAssociations

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:07.385Z")
@Stability(Stable)
public class CfnClusterCapacityProviderAssociations
extends CfnResource
implements IInspectable

The AWS::ECS::ClusterCapacityProviderAssociations resource associates one or more capacity providers and a default capacity provider strategy with a cluster.

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.*;
 CfnClusterCapacityProviderAssociations cfnClusterCapacityProviderAssociations = CfnClusterCapacityProviderAssociations.Builder.create(this, "MyCfnClusterCapacityProviderAssociations")
         .capacityProviders(List.of("capacityProviders"))
         .cluster("cluster")
         .defaultCapacityProviderStrategy(List.of(CapacityProviderStrategyProperty.builder()
                 .capacityProvider("capacityProvider")
                 // the properties below are optional
                 .base(123)
                 .weight(123)
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnClusterCapacityProviderAssociations.Builder	A fluent builder for CfnClusterCapacityProviderAssociations.
static interface	CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty	The CapacityProviderStrategy property specifies the details of the default capacity provider strategy for the cluster.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnClusterCapacityProviderAssociations(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnClusterCapacityProviderAssociations(software.amazon.jsii.JsiiObjectRef objRef)
	CfnClusterCapacityProviderAssociations(software.constructs.Construct scope, String id, CfnClusterCapacityProviderAssociationsProps props)

Method Summary

Modifier and Type	Method	Description
List<String>	getCapacityProviders()	The capacity providers to associate with the cluster.
protected Map<String,Object>	getCfnProperties()
String	getCluster()	The cluster the capacity provider association is the target of.
Object	getDefaultCapacityProviderStrategy()	The default capacity provider strategy to associate with the cluster.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCapacityProviders(List<String> value)	The capacity providers to associate with the cluster.
void	setCluster(String value)	The cluster the capacity provider association is the target of.
void	setDefaultCapacityProviderStrategy(List<Object> value)	The default capacity provider strategy to associate with the cluster.
void	setDefaultCapacityProviderStrategy(IResolvable value)	The default capacity provider strategy to associate with the cluster.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnClusterCapacityProviderAssociations

protected CfnClusterCapacityProviderAssociations(software.amazon.jsii.JsiiObjectRef objRef)

CfnClusterCapacityProviderAssociations

protected CfnClusterCapacityProviderAssociations(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnClusterCapacityProviderAssociations

@Stability(Stable)
public CfnClusterCapacityProviderAssociations(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnClusterCapacityProviderAssociationsProps props)

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.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCapacityProviders

@Stability(Stable)
@NotNull
public List<String> getCapacityProviders()

The capacity providers to associate with the cluster.

setCapacityProviders

@Stability(Stable)
public void setCapacityProviders(@NotNull
 List<String> value)

The capacity providers to associate with the cluster.

getCluster

@Stability(Stable)
@NotNull
public String getCluster()

The cluster the capacity provider association is the target of.

setCluster

@Stability(Stable)
public void setCluster(@NotNull
 String value)

The cluster the capacity provider association is the target of.

getDefaultCapacityProviderStrategy

@Stability(Stable)
@NotNull
public Object getDefaultCapacityProviderStrategy()

The default capacity provider strategy to associate with the cluster.

setDefaultCapacityProviderStrategy

@Stability(Stable)
public void setDefaultCapacityProviderStrategy(@NotNull
 IResolvable value)

The default capacity provider strategy to associate with the cluster.

setDefaultCapacityProviderStrategy

@Stability(Stable)
public void setDefaultCapacityProviderStrategy(@NotNull
 List<Object> value)

The default capacity provider strategy to associate with the cluster.