CfnServiceEnvironmentProps

class aws_cdk.aws_batch.CfnServiceEnvironmentProps(*, capacity_limits, service_environment_type, service_environment_name=None, state=None, tags=None)

Bases: object

Properties for defining a CfnServiceEnvironment.

Parameters:
  • capacity_limits (Union[IResolvable, Sequence[Union[IResolvable, CapacityLimitProperty, Dict[str, Any]]]]) – The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.

  • service_environment_type (str) – The type of service environment. For SageMaker Training jobs, this value is SAGEMAKER_TRAINING .

  • service_environment_name (Optional[str]) – The name of the service environment.

  • state (Optional[str]) – The state of the service environment. Valid values are ENABLED and DISABLED .

  • tags (Optional[Mapping[str, str]]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_batch as batch

cfn_service_environment_props = batch.CfnServiceEnvironmentProps(
    capacity_limits=[batch.CfnServiceEnvironment.CapacityLimitProperty(
        capacity_unit="capacityUnit",
        max_capacity=123
    )],
    service_environment_type="serviceEnvironmentType",

    # the properties below are optional
    service_environment_name="serviceEnvironmentName",
    state="state",
    tags={
        "tags_key": "tags"
    }
)

Attributes

capacity_limits

The capacity limits for the service environment.

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

See:

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

service_environment_name

The name of the service environment.

See:

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

service_environment_type

The type of service environment.

For SageMaker Training jobs, this value is SAGEMAKER_TRAINING .

See:

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

state

The state of the service environment.

Valid values are ENABLED and DISABLED .

See:

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

tags

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:

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