software.amazon.awssdk.services.batch.model

Interface ComputeEnvironmentDetail.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ComputeEnvironmentDetail.Builder,ComputeEnvironmentDetail>, SdkBuilder<ComputeEnvironmentDetail.Builder,ComputeEnvironmentDetail>, SdkPojo

Enclosing class:

ComputeEnvironmentDetail

public static interface ComputeEnvironmentDetail.Builder
extends SdkPojo, CopyableBuilder<ComputeEnvironmentDetail.Builder,ComputeEnvironmentDetail>

Method Summary

Modifier and Type	Method and Description
ComputeEnvironmentDetail.Builder	computeEnvironmentArn(String computeEnvironmentArn) The Amazon Resource Name (ARN) of the compute environment.
ComputeEnvironmentDetail.Builder	computeEnvironmentName(String computeEnvironmentName) The name of the compute environment.
ComputeEnvironmentDetail.Builder	computeResources(ComputeResource computeResources) The compute resources defined for the compute environment.
default ComputeEnvironmentDetail.Builder	computeResources(Consumer<ComputeResource.Builder> computeResources) The compute resources defined for the compute environment.
ComputeEnvironmentDetail.Builder	ecsClusterArn(String ecsClusterArn) The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
ComputeEnvironmentDetail.Builder	serviceRole(String serviceRole) The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.
ComputeEnvironmentDetail.Builder	state(CEState state) The state of the compute environment.
ComputeEnvironmentDetail.Builder	state(String state) The state of the compute environment.
ComputeEnvironmentDetail.Builder	status(CEStatus status) The current status of the compute environment (for example, CREATING or VALID).
ComputeEnvironmentDetail.Builder	status(String status) The current status of the compute environment (for example, CREATING or VALID).
ComputeEnvironmentDetail.Builder	statusReason(String statusReason) A short, human-readable string to provide additional details about the current status of the compute environment.
ComputeEnvironmentDetail.Builder	tags(Map<String,String> tags) The tags applied to the compute environment.
ComputeEnvironmentDetail.Builder	type(CEType type) The type of the compute environment: MANAGED or UNMANAGED.
ComputeEnvironmentDetail.Builder	type(String type) The type of the compute environment: MANAGED or UNMANAGED.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

computeEnvironmentName

ComputeEnvironmentDetail.Builder computeEnvironmentName(String computeEnvironmentName)

The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Parameters:

computeEnvironmentName - The name of the compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

Returns a reference to this object so that method calls can be chained together.

computeEnvironmentArn

ComputeEnvironmentDetail.Builder computeEnvironmentArn(String computeEnvironmentArn)

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

Parameters:

computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

ecsClusterArn

ComputeEnvironmentDetail.Builder ecsClusterArn(String ecsClusterArn)

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

Parameters:

ecsClusterArn - The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

ComputeEnvironmentDetail.Builder tags(Map<String,String> tags)

The tags applied to the compute environment.

Parameters:

tags - The tags applied to the compute environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

ComputeEnvironmentDetail.Builder type(String type)

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

Parameters:

type - The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CEType, CEType

type

ComputeEnvironmentDetail.Builder type(CEType type)

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

Parameters:

type - The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CEType, CEType

state

ComputeEnvironmentDetail.Builder state(String state)

The state of the compute environment. The valid values are ENABLED or DISABLED.

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. However, they scale in to minvCpus value after instances become idle.

Parameters:

state - The state of the compute environment. The valid values are ENABLED or DISABLED.

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. However, they scale in to minvCpus value after instances become idle.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CEState, CEState

state

ComputeEnvironmentDetail.Builder state(CEState state)

The state of the compute environment. The valid values are ENABLED or DISABLED.

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. However, they scale in to minvCpus value after instances become idle.

Parameters:

state - The state of the compute environment. The valid values are ENABLED or DISABLED.

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. However, they scale in to minvCpus value after instances become idle.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CEState, CEState

status

ComputeEnvironmentDetail.Builder status(String status)

The current status of the compute environment (for example, CREATING or VALID).

Parameters:

status - The current status of the compute environment (for example, CREATING or VALID).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CEStatus, CEStatus

status

ComputeEnvironmentDetail.Builder status(CEStatus status)

The current status of the compute environment (for example, CREATING or VALID).

Parameters:

status - The current status of the compute environment (for example, CREATING or VALID).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CEStatus, CEStatus

statusReason

ComputeEnvironmentDetail.Builder statusReason(String statusReason)

A short, human-readable string to provide additional details about the current status of the compute environment.

Parameters:

statusReason - A short, human-readable string to provide additional details about the current status of the compute environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

computeResources

ComputeEnvironmentDetail.Builder computeResources(ComputeResource computeResources)

The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

Parameters:

computeResources - The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

computeResources

default ComputeEnvironmentDetail.Builder computeResources(Consumer<ComputeResource.Builder> computeResources)

The compute resources defined for the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

This is a convenience that creates an instance of the ComputeResource.Builder avoiding the need to create one manually via ComputeResource.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to computeResources(ComputeResource).

Parameters:

computeResources - a consumer that will call methods on ComputeResource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

computeResources(ComputeResource)

serviceRole

ComputeEnvironmentDetail.Builder serviceRole(String serviceRole)

The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.

Parameters:

serviceRole - The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.