Package software.amazon.awscdk.services.batch

Class CfnServiceEnvironment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.batch.CfnServiceEnvironment
All Implemented Interfaces:
IInspectable, IServiceEnvironmentRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:15.180Z") @Stability(Stable) public class CfnServiceEnvironment extends CfnResource implements IInspectable, IServiceEnvironmentRef, ITaggableV2
Creates a service environment for running service jobs.

Service environments define capacity limits for specific service types such as SageMaker Training jobs.

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.*;
 CfnServiceEnvironment cfnServiceEnvironment = CfnServiceEnvironment.Builder.create(this, "MyCfnServiceEnvironment")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnServiceEnvironment

      protected CfnServiceEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnServiceEnvironment

      protected CfnServiceEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnServiceEnvironment

      @Stability(Stable) public CfnServiceEnvironment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnServiceEnvironmentProps props)
      Create a new AWS::Batch::ServiceEnvironment.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForServiceEnvironment

      @Stability(Stable) @NotNull public static String arnForServiceEnvironment(@NotNull IServiceEnvironmentRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnServiceEnvironment

      @Stability(Stable) @NotNull public static Boolean isCfnServiceEnvironment(@NotNull Object x)
      Checks whether the given object is a CfnServiceEnvironment.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrServiceEnvironmentArn

      @Stability(Stable) @NotNull public String getAttrServiceEnvironmentArn()
      The Amazon Resource Name (ARN) of the service environment.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getServiceEnvironmentRef

      @Stability(Stable) @NotNull public ServiceEnvironmentReference getServiceEnvironmentRef()
      A reference to a ServiceEnvironment resource.
      Specified by:
      getServiceEnvironmentRef in interface IServiceEnvironmentRef

    • getCapacityLimits

      @Stability(Stable) @NotNull public Object getCapacityLimits()
      The capacity limits for the service environment.

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

    • setCapacityLimits

      @Stability(Stable) public void setCapacityLimits(@NotNull IResolvable value)
      The capacity limits for the service environment.

    • setCapacityLimits

      @Stability(Stable) public void setCapacityLimits(@NotNull List<Object> value)
      The capacity limits for the service environment.

    • getServiceEnvironmentType

      @Stability(Stable) @NotNull public String getServiceEnvironmentType()
      The type of service environment.

    • setServiceEnvironmentType

      @Stability(Stable) public void setServiceEnvironmentType(@NotNull String value)
      The type of service environment.

    • getServiceEnvironmentName

      @Stability(Stable) @Nullable public String getServiceEnvironmentName()
      The name of the service environment.

    • setServiceEnvironmentName

      @Stability(Stable) public void setServiceEnvironmentName(@Nullable String value)
      The name of the service environment.

    • getState

      @Stability(Stable) @Nullable public String getState()
      The state of the service environment.

    • setState

      @Stability(Stable) public void setState(@Nullable String value)
      The state of the service environment.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      The tags associated with the service environment.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      The tags associated with the service environment.