Package software.amazon.awscdk.services.batch

Class CfnComputeEnvironmentProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.batch.CfnComputeEnvironmentProps.Jsii$Proxy

All Implemented Interfaces:

CfnComputeEnvironmentProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnComputeEnvironmentProps

@Stability(Stable)
@Internal
public static final class CfnComputeEnvironmentProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnComputeEnvironmentProps

An implementation for CfnComputeEnvironmentProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.CfnComputeEnvironmentProps

CfnComputeEnvironmentProps.Builder, CfnComputeEnvironmentProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnComputeEnvironmentProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnComputeEnvironmentProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getComputeEnvironmentName()	The name for your compute environment.
final Object	getComputeResources()	The ComputeResources property type specifies details of the compute resources managed by the compute environment.
final String	getContext()	Reserved.
final Object	getEksConfiguration()	The details for the Amazon EKS cluster that supports the compute environment.
final Object	getReplaceComputeEnvironment()	Specifies whether the compute environment is replaced if an update is made that requires replacing the instances in the compute environment.
final String	getServiceRole()	The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
final String	getState()	The state of the compute environment.
final Map<String,String>	getTags()	The tags applied to the compute environment.
final String	getType()	The type of the compute environment: MANAGED or UNMANAGED .
final Number	getUnmanagedvCpus()	The maximum number of vCPUs for an unmanaged compute environment.
final Object	getUpdatePolicy()	Specifies the infrastructure update policy for the compute environment.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnComputeEnvironmentProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnComputeEnvironmentProps.Builder.

Method Details

getType

public final String getType()

Description copied from interface: CfnComputeEnvironmentProps

The type of the compute environment: MANAGED or UNMANAGED .

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

Specified by:

getType in interface CfnComputeEnvironmentProps

See Also:

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

getComputeEnvironmentName

public final String getComputeEnvironmentName()

Description copied from interface: CfnComputeEnvironmentProps

The name for your compute environment.

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

Specified by:

getComputeEnvironmentName in interface CfnComputeEnvironmentProps

See Also:

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

getComputeResources

public final Object getComputeResources()

Description copied from interface: CfnComputeEnvironmentProps

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

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

Returns union: either IResolvable or CfnComputeEnvironment.ComputeResourcesProperty

Specified by:

getComputeResources in interface CfnComputeEnvironmentProps

See Also:

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

getContext

public final String getContext()

Description copied from interface: CfnComputeEnvironmentProps

Reserved.

Specified by:

getContext in interface CfnComputeEnvironmentProps

See Also:

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

getEksConfiguration

public final Object getEksConfiguration()

Description copied from interface: CfnComputeEnvironmentProps

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

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

Returns union: either IResolvable or CfnComputeEnvironment.EksConfigurationProperty

Specified by:

getEksConfiguration in interface CfnComputeEnvironmentProps

See Also:

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

getReplaceComputeEnvironment

public final Object getReplaceComputeEnvironment()

Description copied from interface: CfnComputeEnvironmentProps

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

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 .

Returns union: either Boolean or IResolvable

Default: - true

Specified by:

getReplaceComputeEnvironment in interface CfnComputeEnvironmentProps

See Also:

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

getServiceRole

public final String getServiceRole()

Description copied from interface: CfnComputeEnvironmentProps

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

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 service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

Specified by:

getServiceRole in interface CfnComputeEnvironmentProps

See Also:

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

getState

public final String getState()

Description copied from interface: CfnComputeEnvironmentProps

The state of the compute environment.

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 DISABLED state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the AWS Batch User Guide .

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.

Specified by:

getState in interface CfnComputeEnvironmentProps

See Also:

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

getTags

public final Map<String,String> getTags()

Description copied from interface: CfnComputeEnvironmentProps

The tags applied to the compute environment.

Specified by:

getTags in interface CfnComputeEnvironmentProps

See Also:

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

getUnmanagedvCpus

public final Number getUnmanagedvCpus()

Description copied from interface: CfnComputeEnvironmentProps

The maximum number of vCPUs for an unmanaged compute environment.

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 type parameter is set to UNMANAGED .

Specified by:

getUnmanagedvCpus in interface CfnComputeEnvironmentProps

See Also:

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

getUpdatePolicy

public final Object getUpdatePolicy()

Description copied from interface: CfnComputeEnvironmentProps

Specifies the infrastructure update policy for the compute environment.

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

Returns union: either IResolvable or CfnComputeEnvironment.UpdatePolicyProperty

Specified by:

getUpdatePolicy in interface CfnComputeEnvironmentProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object