Class CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty

The CapacityProviderStrategy property specifies the details of the default capacity provider strategy for the cluster.

Inheritance

object

CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty

Implements

CfnClusterCapacityProviderAssociations.ICapacityProviderStrategyProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty : CfnClusterCapacityProviderAssociations.ICapacityProviderStrategyProperty

Syntax (vb)

Public Class CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty Implements CfnClusterCapacityProviderAssociations.ICapacityProviderStrategyProperty

Remarks

When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ECS;

             var capacityProviderStrategyProperty = new CapacityProviderStrategyProperty {
                 CapacityProvider = "capacityProvider",

                 // the properties below are optional
                 Base = 123,
                 Weight = 123
             };

Synopsis

Constructors

CapacityProviderStrategyProperty()

The CapacityProviderStrategy property specifies the details of the default capacity provider strategy for the cluster.

Properties

Base	The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service.
CapacityProvider	The short name of the capacity provider.
Weight	The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

Constructors

CapacityProviderStrategyProperty()

The CapacityProviderStrategy property specifies the details of the default capacity provider strategy for the cluster.

public CapacityProviderStrategyProperty()

Remarks

When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ECS;

             var capacityProviderStrategyProperty = new CapacityProviderStrategyProperty {
                 CapacityProvider = "capacityProvider",

                 // the properties below are optional
                 Base = 123,
                 Weight = 123
             };

Properties

Base

The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service.

public double? Base { get; set; }

Property Value

double?

Remarks

Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

Base value characteristics:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-clustercapacityproviderassociations-capacityproviderstrategy.html#cfn-ecs-clustercapacityproviderassociations-capacityproviderstrategy-base

CapacityProvider

The short name of the capacity provider.

public string CapacityProvider { get; set; }

Property Value

string

Remarks

This can be either an AWS managed capacity provider ( FARGATE or FARGATE_SPOT ) or the name of a custom capacity provider that you created.

Weight

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

public double? Weight { get; set; }

Property Value

double?

Remarks

The weight value is taken into consideration after the base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0 , any RunTask or CreateService actions using the capacity provider strategy will fail.

Weight value characteristics:

Task distribution logic:

Examples:

Equal Distribution: Two capacity providers both with weight 1 will split tasks evenly after base requirements are met.

Weighted Distribution: If capacityProviderA has weight 1 and capacityProviderB has weight 4 , then for every 1 task on A, 4 tasks will run on B.

Implements

CfnClusterCapacityProviderAssociations.ICapacityProviderStrategyProperty