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

Interface CfnServiceEnvironmentMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceEnvironmentMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.400Z")
@Stability(Stable)
public interface CfnServiceEnvironmentMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnServiceEnvironmentPropsMixin.

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.*;
 CfnServiceEnvironmentMixinProps cfnServiceEnvironmentMixinProps = CfnServiceEnvironmentMixinProps.builder()
         .capacityLimits(List.of(CapacityLimitProperty.builder()
                 .capacityUnit("capacityUnit")
                 .maxCapacity(123)
                 .build()))
         .serviceEnvironmentName("serviceEnvironmentName")
         .serviceEnvironmentType("serviceEnvironmentType")
         .state("state")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnServiceEnvironmentMixinProps.Builder	builder()
default Object	getCapacityLimits()	The capacity limits for the service environment.
default String	getServiceEnvironmentName()	The name of the service environment.
default String	getServiceEnvironmentType()	The type of service environment.
default String	getState()	The state of the service environment.
default Map<String,String>	getTags()	The tags associated with the service environment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCapacityLimits

@Stability(Stable)
@Nullable
default Object getCapacityLimits()

The capacity limits for the service environment.

This defines the maximum resources that can be used by service jobs in this environment.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnServiceEnvironmentPropsMixin.CapacityLimitProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-serviceenvironment.html#cfn-batch-serviceenvironment-capacitylimits

getServiceEnvironmentName

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

The name of the service environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-serviceenvironment.html#cfn-batch-serviceenvironment-serviceenvironmentname

getServiceEnvironmentType

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

The type of service environment.

For SageMaker Training jobs, this value is SAGEMAKER_TRAINING .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-serviceenvironment.html#cfn-batch-serviceenvironment-serviceenvironmenttype

getState

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

The state of the service environment.

Valid values are ENABLED and DISABLED .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-serviceenvironment.html#cfn-batch-serviceenvironment-state

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

The tags associated with the service environment.

Each tag consists of a key and an optional value. For more information, see Tagging your AWS Batch resources .

See Also:

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

builder

@Stability(Stable)
static CfnServiceEnvironmentMixinProps.Builder builder()

Returns:

a CfnServiceEnvironmentMixinProps.Builder of CfnServiceEnvironmentMixinProps