Interface ICfnComputeEnvironmentProps

Properties for defining a CfnComputeEnvironment.

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnComputeEnvironmentProps

Syntax (vb)

Public Interface ICfnComputeEnvironmentProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.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 cfnComputeEnvironmentProps = new CfnComputeEnvironmentProps {
                 Type = "type",

                 // the properties below are optional
                 ComputeEnvironmentName = "computeEnvironmentName",
                 ComputeResources = new ComputeResourcesProperty {
                     MaxvCpus = 123,
                     Subnets = new [] { "subnets" },
                     Type = "type",

                     // the properties below are optional
                     AllocationStrategy = "allocationStrategy",
                     BidPercentage = 123,
                     DesiredvCpus = 123,
                     Ec2Configuration = new [] { new Ec2ConfigurationObjectProperty {
                         ImageType = "imageType",

                         // the properties below are optional
                         ImageIdOverride = "imageIdOverride",
                         ImageKubernetesVersion = "imageKubernetesVersion"
                     } },
                     Ec2KeyPair = "ec2KeyPair",
                     ImageId = "imageId",
                     InstanceRole = "instanceRole",
                     InstanceTypes = new [] { "instanceTypes" },
                     LaunchTemplate = new LaunchTemplateSpecificationProperty {
                         LaunchTemplateId = "launchTemplateId",
                         LaunchTemplateName = "launchTemplateName",
                         Overrides = new [] { new LaunchTemplateSpecificationOverrideProperty {
                             LaunchTemplateId = "launchTemplateId",
                             LaunchTemplateName = "launchTemplateName",
                             TargetInstanceTypes = new [] { "targetInstanceTypes" },
                             UserdataType = "userdataType",
                             Version = "version"
                         } },
                         UserdataType = "userdataType",
                         Version = "version"
                     },
                     MinvCpus = 123,
                     PlacementGroup = "placementGroup",
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     SpotIamFleetRole = "spotIamFleetRole",
                     Tags = new Dictionary<string, string> {
                         { "tagsKey", "tags" }
                     },
                     UpdateToLatestImageVersion = false
                 },
                 Context = "context",
                 EksConfiguration = new EksConfigurationProperty {
                     EksClusterArn = "eksClusterArn",
                     KubernetesNamespace = "kubernetesNamespace"
                 },
                 ReplaceComputeEnvironment = false,
                 ServiceRole = "serviceRole",
                 State = "state",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 UnmanagedvCpus = 123,
                 UpdatePolicy = new UpdatePolicyProperty {
                     JobExecutionTimeoutMinutes = 123,
                     TerminateJobsOnUpdate = false
                 }
             };

Synopsis

Properties

ComputeEnvironmentName	The name for your compute environment.
ComputeResources	The ComputeResources property type specifies details of the compute resources managed by the compute environment.
Context	Reserved.
EksConfiguration	The details for the Amazon EKS cluster that supports the compute environment.
ReplaceComputeEnvironment	Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment.
ServiceRole	The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
State	The state of the compute environment.
Tags	The tags applied to the compute environment.
Type	The type of the compute environment: `MANAGED` or `UNMANAGED` .
UnmanagedvCpus	The maximum number of vCPUs for an unmanaged compute environment.
UpdatePolicy	Specifies the infrastructure update policy for the compute environment.

Properties

ComputeEnvironmentName

The name for your compute environment.

string? ComputeEnvironmentName { get; }

Property Value

string

Remarks

It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

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

ComputeResources

The ComputeResources property type specifies details of the compute resources managed by the compute environment.

object? ComputeResources { get; }

Property Value

object

Remarks

This parameter is required for managed compute environments. For more information, see Compute Environments in the ** .

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

Type union: either IResolvable or CfnComputeEnvironment.IComputeResourcesProperty

Context

Reserved.

string? Context { get; }

Property Value

string

Remarks

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

EksConfiguration

The details for the Amazon EKS cluster that supports the compute environment.

object? EksConfiguration { get; }

Property Value

object

Remarks

To create a compute environment that uses EKS resources, the caller must have permissions to call <code>eks:DescribeCluster</code> .

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

Type union: either IResolvable or CfnComputeEnvironment.IEksConfigurationProperty

ReplaceComputeEnvironment

Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment.

object? ReplaceComputeEnvironment { get; }

Property Value

object

Remarks

The default value is true . To enable more properties to be updated, set this property to false . When changing the value of this property to false , do not change any other properties at the same time. If other properties are changed at the same time, and the change needs to be rolled back but it can't, it's possible for the stack to go into the UPDATE_ROLLBACK_FAILED state. You can't update a stack that is in the UPDATE_ROLLBACK_FAILED state. However, if you can continue to roll it back, you can return the stack to its original settings and then try to update it again. For more information, see Continue rolling back an update in the AWS CloudFormation User Guide .

ReplaceComputeEnvironment is not applicable for Fargate compute environments. Fargate compute environments are always updated without interruption.

The properties that can't be changed without replacing the compute environment are in the ComputeResources property type: AllocationStrategy , BidPercentage , Ec2Configuration , Ec2KeyPair , Ec2KeyPair , ImageId , InstanceRole , InstanceTypes , LaunchTemplate , MaxvCpus , MinvCpus , PlacementGroup , SecurityGroupIds , Subnets , Tags , Type , and UpdateToLatestImageVersion .

Default: - true

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

Type union: either bool or IResolvable

ServiceRole

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

string? ServiceRole { get; }

Property Value

string

Remarks

For more information, see AWS Batch service IAM role in the AWS Batch User Guide .

If your account already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the AWS Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the AWS Batch service-linked role in your account.

If your specified role has a path other than / , then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ , specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide .

Depending on how you created your AWS Batch service role, its ARN might contain the <code>service-role</code> path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

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

State

The state of the compute environment.

string? State { get; }

Property Value

string

Remarks

If the state is ENABLED , then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

If the state is ENABLED , then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED , then the AWS Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out.

Compute environments in a <code>DISABLED</code> state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environment_parameters.html#compute_environment_state">State</a> in the <em>AWS Batch User Guide</em> .

When an instance is idle, the instance scales down to the minvCpus value. However, the instance size doesn't change. For example, consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36 . This instance doesn't scale down to a c5.large instance.

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

Type

The type of the compute environment: MANAGED or UNMANAGED .

string Type { get; }

Property Value

string

Remarks

For more information, see Compute Environments in the AWS Batch User Guide .

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

UnmanagedvCpus

The maximum number of vCPUs for an unmanaged compute environment.

double? UnmanagedvCpus { get; }

Property Value

double?

Remarks

This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.

This parameter is only supported when the <code>type</code> parameter is set to <code>UNMANAGED</code> .

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

UpdatePolicy

Specifies the infrastructure update policy for the compute environment.

object? UpdatePolicy { get; }

Property Value

object

Remarks

For more information about infrastructure updates, see Updating compute environments in the AWS Batch User Guide .

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

Type union: either IResolvable or CfnComputeEnvironment.IUpdatePolicyProperty