Package software.amazon.awscdk.cfnpropertymixins.services.batch

Interface CfnServiceEnvironmentPropsMixin.CapacityLimitProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceEnvironmentPropsMixin.CapacityLimitProperty.Jsii$Proxy

Enclosing class:

CfnServiceEnvironmentPropsMixin

@Stability(Stable)
public static interface CfnServiceEnvironmentPropsMixin.CapacityLimitProperty
extends software.amazon.jsii.JsiiSerializable

Defines the capacity limit for a service environment.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.batch.*;
 CapacityLimitProperty capacityLimitProperty = CapacityLimitProperty.builder()
         .capacityUnit("capacityUnit")
         .maxCapacity(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-serviceenvironment-capacitylimit.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnServiceEnvironmentPropsMixin.CapacityLimitProperty.Builder	builder()
default String	getCapacityUnit()	The unit of measure for the capacity limit.
default Number	getMaxCapacity()	The maximum capacity available for the service environment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCapacityUnit

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

The unit of measure for the capacity limit.

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

See Also:

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

getMaxCapacity

@Stability(Stable)
@Nullable
default Number getMaxCapacity()

The maximum capacity available for the service environment.

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 Also:

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

builder

@Stability(Stable)
static CfnServiceEnvironmentPropsMixin.CapacityLimitProperty.Builder builder()

Returns:

a CfnServiceEnvironmentPropsMixin.CapacityLimitProperty.Builder of CfnServiceEnvironmentPropsMixin.CapacityLimitProperty