Package software.amazon.awscdk.services.batch

Interface CfnServiceEnvironmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-08-12T14:44:11.003Z")
@Stability(Stable)
public interface CfnServiceEnvironmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnServiceEnvironment.

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.batch.*;
 CfnServiceEnvironmentProps cfnServiceEnvironmentProps = CfnServiceEnvironmentProps.builder()
         .capacityLimits(List.of(CapacityLimitProperty.builder()
                 .capacityUnit("capacityUnit")
                 .maxCapacity(123)
                 .build()))
         .serviceEnvironmentType("serviceEnvironmentType")
         // the properties below are optional
         .serviceEnvironmentName("serviceEnvironmentName")
         .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	CfnServiceEnvironmentProps.Builder	A builder for CfnServiceEnvironmentProps
static final class	CfnServiceEnvironmentProps.Jsii$Proxy	An implementation for CfnServiceEnvironmentProps

Method Summary

Modifier and Type	Method	Description
static CfnServiceEnvironmentProps.Builder	builder()
Object	getCapacityLimits()	The capacity limits for the service environment.
default String	getServiceEnvironmentName()	The name of the service environment.
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)
@NotNull
Object getCapacityLimits()

The capacity limits for the service environment.

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

See Also:

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

getServiceEnvironmentType

@Stability(Stable)
@NotNull
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

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

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 CfnServiceEnvironmentProps.Builder builder()

Returns:

a CfnServiceEnvironmentProps.Builder of CfnServiceEnvironmentProps