Class CfnServiceEnvironment.CapacityLimitProperty

Defines the capacity limit for a service environment.

Inheritance
object
CfnServiceEnvironment.CapacityLimitProperty
Inherited Members
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnServiceEnvironment.CapacityLimitProperty : CfnServiceEnvironment.ICapacityLimitProperty
Syntax (vb)
Public Class CfnServiceEnvironment.CapacityLimitProperty Implements CfnServiceEnvironment.ICapacityLimitProperty
Remarks

This structure specifies the maximum amount of resources that can be used by service jobs in the environment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-serviceenvironment-capacitylimit.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.Batch;

             var capacityLimitProperty = new CapacityLimitProperty {
                 CapacityUnit = "capacityUnit",
                 MaxCapacity = 123
             };

Synopsis

Constructors

CapacityLimitProperty()

Defines the capacity limit for a service environment.

Properties

CapacityUnit

The unit of measure for the capacity limit.
MaxCapacity

The maximum capacity available for the service environment.

Constructors

CapacityLimitProperty()

Defines the capacity limit for a service environment.

public CapacityLimitProperty()
Remarks

This structure specifies the maximum amount of resources that can be used by service jobs in the environment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-serviceenvironment-capacitylimit.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.Batch;

             var capacityLimitProperty = new CapacityLimitProperty {
                 CapacityUnit = "capacityUnit",
                 MaxCapacity = 123
             };

Properties

CapacityUnit

The unit of measure for the capacity limit.

public string? CapacityUnit { get; set; }
Property Value

string

Remarks

This defines how the maxCapacity value should be interpreted. For SAGEMAKER_TRAINING jobs, use NUM_INSTANCES .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-serviceenvironment-capacitylimit.html#cfn-batch-serviceenvironment-capacitylimit-capacityunit

MaxCapacity

The maximum capacity available for the service environment.

public double? MaxCapacity { get; set; }
Property Value

double?

Remarks

This value represents the maximum amount resources that can be allocated to service jobs.

For example, maxCapacity=50 , capacityUnit=NUM_INSTANCES . This indicates that the maximum number of instances that can be run on this service environment is 50. You could then run 5 SageMaker Training jobs that each use 10 instances. However, if you submit another job that requires 10 instances, it will wait in the queue.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-serviceenvironment-capacitylimit.html#cfn-batch-serviceenvironment-capacitylimit-maxcapacity

Implements