Class CfnServiceEnvironment

Creates a service environment for running service jobs.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnServiceEnvironment

Implements

IInspectable

IServiceEnvironmentRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnServiceEnvironment : CfnResource, IInspectable, IServiceEnvironmentRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnServiceEnvironment Inherits CfnResource Implements IInspectable, IServiceEnvironmentRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

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 cfnServiceEnvironment = new CfnServiceEnvironment(this, "MyCfnServiceEnvironment", 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

Constructors

CfnServiceEnvironment(Construct, string, ICfnServiceEnvironmentProps)

Create a new AWS::Batch::ServiceEnvironment.

Properties

AttrServiceEnvironmentArn	The Amazon Resource Name (ARN) of the service environment.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CapacityLimits	The capacity limits for the service environment.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Creates a service environment for running service jobs.
CfnPropertyNames	Creates a service environment for running service jobs.
ServiceEnvironmentName	The name of the service environment.
ServiceEnvironmentRef	A reference to a ServiceEnvironment resource.
ServiceEnvironmentType	The type of service environment.
State	The state of the service environment.
Tags	The tags associated with the service environment.

Methods

ArnForServiceEnvironment(IServiceEnvironmentRef)	Creates a service environment for running service jobs.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnServiceEnvironment(object)	Checks whether the given object is a CfnServiceEnvironment.
RenderProperties(IDictionary<string, object>)	Creates a service environment for running service jobs.

Constructors

CfnServiceEnvironment(Construct, string, ICfnServiceEnvironmentProps)

Create a new AWS::Batch::ServiceEnvironment.

public CfnServiceEnvironment(Construct scope, string id, ICfnServiceEnvironmentProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnServiceEnvironmentProps: Resource properties.

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

Properties

AttrServiceEnvironmentArn

The Amazon Resource Name (ARN) of the service environment.

public virtual string AttrServiceEnvironmentArn { get; }

Property Value

string

Remarks

CloudformationAttribute: ServiceEnvironmentArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

CapacityLimits

The capacity limits for the service environment.

public virtual object CapacityLimits { get; set; }

Property Value

object

Remarks

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

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

CfnProperties

Creates a service environment for running service jobs.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates a service environment for running service jobs.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

ServiceEnvironmentName

The name of the service environment.

public virtual string? ServiceEnvironmentName { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

ServiceEnvironmentRef

A reference to a ServiceEnvironment resource.

public virtual IServiceEnvironmentReference ServiceEnvironmentRef { get; }

Property Value

IServiceEnvironmentReference

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

ServiceEnvironmentType

The type of service environment.

public virtual string ServiceEnvironmentType { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

State

The state of the service environment.

public virtual string? State { get; set; }

Property Value

string

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

Methods

ArnForServiceEnvironment(IServiceEnvironmentRef)

Creates a service environment for running service jobs.

public static string ArnForServiceEnvironment(IServiceEnvironmentRef resource)

Parameters

resource IServiceEnvironmentRef

Returns

string

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

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 cfnServiceEnvironment = new CfnServiceEnvironment(this, "MyCfnServiceEnvironment", 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" }
                 }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

IsCfnServiceEnvironment(object)

Checks whether the given object is a CfnServiceEnvironment.

public static bool IsCfnServiceEnvironment(object x)

Parameters

x object

Returns

bool

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a service environment for running service jobs.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

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

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

CloudformationResource: AWS::Batch::ServiceEnvironment

ExampleMetadata: fixture=_generated

Implements

IInspectable

IServiceEnvironmentRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2