Show / Hide Table of Contents

Interface ICfnServiceEnvironmentProps

Properties for defining a CfnServiceEnvironment.

Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnServiceEnvironmentProps
Syntax (vb)
Public Interface ICfnServiceEnvironmentProps
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Batch;

             var cfnServiceEnvironmentProps = new CfnServiceEnvironmentProps {
                 CapacityLimits = new [] { new CapacityLimitProperty {
                     CapacityUnit = "capacityUnit",
                     MaxCapacity = 123
                 } },
                 ServiceEnvironmentType = "serviceEnvironmentType",

                 // the properties below are optional
                 ServiceEnvironmentName = "serviceEnvironmentName",
                 State = "state",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             };

Synopsis

Properties

CapacityLimits

The capacity limits for the service environment.

ServiceEnvironmentName

The name of the service environment.

ServiceEnvironmentType

The type of service environment.

State

The state of the service environment.

Tags

The tags associated with the service environment.

Properties

CapacityLimits

The capacity limits for the service environment.

object CapacityLimits { get; }
Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnServiceEnvironment.ICapacityLimitProperty)[]

ServiceEnvironmentName

The name of the service environment.

string? ServiceEnvironmentName { get; }
Property Value

string

Remarks

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

ServiceEnvironmentType

The type of service environment.

string ServiceEnvironmentType { get; }
Property Value

string

Remarks

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.

string? State { get; }
Property Value

string

Remarks

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.

IDictionary<string, string>? Tags { get; }
Property Value

IDictionary<string, string>

Remarks

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

Back to top Generated by DocFX