software.amazon.awssdk.services.batch.model

Interface CreateComputeEnvironmentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BatchRequest.Builder, Buildable, CopyableBuilder<CreateComputeEnvironmentRequest.Builder,CreateComputeEnvironmentRequest>, SdkBuilder<CreateComputeEnvironmentRequest.Builder,CreateComputeEnvironmentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateComputeEnvironmentRequest

public static interface CreateComputeEnvironmentRequest.Builder
extends BatchRequest.Builder, SdkPojo, CopyableBuilder<CreateComputeEnvironmentRequest.Builder,CreateComputeEnvironmentRequest>

Method Summary

Modifier and Type	Method and Description
CreateComputeEnvironmentRequest.Builder	computeEnvironmentName(String computeEnvironmentName) The name for your compute environment.
CreateComputeEnvironmentRequest.Builder	computeResources(ComputeResource computeResources) Details of the compute resources managed by the compute environment.
default CreateComputeEnvironmentRequest.Builder	computeResources(Consumer<ComputeResource.Builder> computeResources) Details of the compute resources managed by the compute environment.
CreateComputeEnvironmentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateComputeEnvironmentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateComputeEnvironmentRequest.Builder	serviceRole(String 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.
CreateComputeEnvironmentRequest.Builder	state(CEState state) The state of the compute environment.
CreateComputeEnvironmentRequest.Builder	state(String state) The state of the compute environment.
CreateComputeEnvironmentRequest.Builder	type(CEType type) The type of the compute environment.
CreateComputeEnvironmentRequest.Builder	type(String type) The type of the compute environment.

Methods inherited from interface software.amazon.awssdk.services.batch.model.BatchRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

CreateComputeEnvironmentRequest.Builder computeEnvironmentName(String computeEnvironmentName)

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

Parameters:

computeEnvironmentName - The name for your 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.

type

CreateComputeEnvironmentRequest.Builder type(String type)

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

Parameters:

type - The type of 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.

See Also:

CEType, CEType

type

CreateComputeEnvironmentRequest.Builder type(CEType type)

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

Parameters:

type - The type of 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.

See Also:

CEType, CEType

state

CreateComputeEnvironmentRequest.Builder state(String state)

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.

Parameters:

state - 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.

Returns:

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

See Also:

CEState, CEState

state

CreateComputeEnvironmentRequest.Builder state(CEState state)

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.

Parameters:

state - 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.

Returns:

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

See Also:

CEState, CEState

computeResources

CreateComputeEnvironmentRequest.Builder computeResources(ComputeResource computeResources)

Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments.

Parameters:

computeResources - Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments.

Returns:

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

computeResources

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

Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments.

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

CreateComputeEnvironmentRequest.Builder serviceRole(String 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.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not 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.

Parameters:

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.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not 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.

Returns:

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

overrideConfiguration

CreateComputeEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateComputeEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.