interface CfnServiceEnvironmentProps

Language	Type name
.NET	Amazon.CDK.AWS.Batch.CfnServiceEnvironmentProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#CfnServiceEnvironmentProps
Java	software.amazon.awscdk.services.batch.CfnServiceEnvironmentProps
Python	aws_cdk.aws_batch.CfnServiceEnvironmentProps
TypeScript	aws-cdk-lib » aws_batch » CfnServiceEnvironmentProps

Properties for defining a CfnServiceEnvironment.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_batch as batch } from 'aws-cdk-lib';
const cfnServiceEnvironmentProps: batch.CfnServiceEnvironmentProps = {
  capacityLimits: [{
    capacityUnit: 'capacityUnit',
    maxCapacity: 123,
  }],
  serviceEnvironmentType: 'serviceEnvironmentType',

  // the properties below are optional
  serviceEnvironmentName: 'serviceEnvironmentName',
  state: 'state',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
capacityLimits	IResolvable | IResolvable | CapacityLimitProperty[]	The capacity limits for the service environment.
serviceEnvironmentType	string	The type of service environment.
serviceEnvironmentName?	string	The name of the service environment.
state?	string	The state of the service environment.
tags?	{ [string]: string }	The tags associated with the service environment.

---

capacityLimits

Type: IResolvable | IResolvable | CapacityLimitProperty[]

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

---

serviceEnvironmentType

Type: string

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

---

serviceEnvironmentName?

Type: string (optional)

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

---

state?

Type: string (optional)

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

---

tags?

Type: { [string]: string } (optional)

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