ComputeEnvironmentDetail.Builder (AWS Java SDK :: Services

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

All Methods Instance Methods Abstract Methods Default Methods
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`	`containerOrchestrationType(OrchestrationType containerOrchestrationType)` The orchestration type of the compute environment.
`ComputeEnvironmentDetail.Builder`	`containerOrchestrationType(String containerOrchestrationType)` The orchestration type of the compute environment.
`ComputeEnvironmentDetail.Builder`	`ecsClusterArn(String ecsClusterArn)` The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.
`default ComputeEnvironmentDetail.Builder`	`eksConfiguration(Consumer<EksConfiguration.Builder> eksConfiguration)` The configuration for the Amazon EKS cluster that supports the Batch compute environment.
`ComputeEnvironmentDetail.Builder`	`eksConfiguration(EksConfiguration eksConfiguration)` The configuration for the Amazon EKS cluster that supports the Batch compute environment.
`ComputeEnvironmentDetail.Builder`	`serviceRole(String serviceRole)` The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services 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 for 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`.
`ComputeEnvironmentDetail.Builder`	`unmanagedvCpus(Integer unmanagedvCpus)` The maximum number of VCPUs expected to be used for an unmanaged compute environment.
`default ComputeEnvironmentDetail.Builder`	`updatePolicy(Consumer<UpdatePolicy.Builder> updatePolicy)` Specifies the infrastructure update policy for the compute environment.
`ComputeEnvironmentDetail.Builder`	`updatePolicy(UpdatePolicy updatePolicy)` Specifies the infrastructure update policy for the compute environment.
`ComputeEnvironmentDetail.Builder`	`uuid(String uuid)` Unique identifier for the compute environment.

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. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
    
    Parameters:
    
    computeEnvironmentName - The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
    
    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.
  - unmanagedvCpus
```
ComputeEnvironmentDetail.Builder unmanagedvCpus(Integer unmanagedvCpus)
```
    The maximum number of VCPUs expected to be used for an unmanaged compute environment.
    
    Parameters:
    
    unmanagedvCpus - The maximum number of VCPUs expected to be used for an unmanaged 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 that the compute environment uses.
    
    Parameters:
    
    ecsClusterArn - The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.
    
    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 Batch User Guide.
    
    Parameters:
    
    type - The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in the 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 Batch User Guide.
    
    Parameters:
    
    type - The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in the 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 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 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 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.
    
    Parameters:
    
    state - The state of the compute environment. The valid values are ENABLED or DISABLED.
    
    If the state is ENABLED, then the 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 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 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.
    
    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 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 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 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.
    
    Parameters:
    
    state - The state of the compute environment. The valid values are ENABLED or DISABLED.
    
    If the state is ENABLED, then the 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 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 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.
    
    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 for the current status of the compute environment.
    
    Parameters:
    
    statusReason - A short, human-readable string to provide additional details for 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 Batch User Guide.
    
    Parameters:
    
    computeResources - The compute resources defined for the compute environment. For more information, see Compute environments in the 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 Batch User Guide.
    This is a convenience method 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 that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
    
    Parameters:
    
    serviceRole - The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - updatePolicy
```
ComputeEnvironmentDetail.Builder updatePolicy(UpdatePolicy updatePolicy)
```
    Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
    
    Parameters:
    
    updatePolicy - Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - updatePolicy
```
default ComputeEnvironmentDetail.Builder updatePolicy(Consumer<UpdatePolicy.Builder> updatePolicy)
```
    Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
    This is a convenience method that creates an instance of the UpdatePolicy.Builder avoiding the need to create one manually via UpdatePolicy.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to updatePolicy(UpdatePolicy).
    
    Parameters:
    
    updatePolicy - a consumer that will call methods on UpdatePolicy.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    updatePolicy(UpdatePolicy)
  - eksConfiguration
```
ComputeEnvironmentDetail.Builder eksConfiguration(EksConfiguration eksConfiguration)
```
    The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.
    
    Parameters:
    
    eksConfiguration - The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - eksConfiguration
```
default ComputeEnvironmentDetail.Builder eksConfiguration(Consumer<EksConfiguration.Builder> eksConfiguration)
```
    The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.
    This is a convenience method that creates an instance of the EksConfiguration.Builder avoiding the need to create one manually via EksConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to eksConfiguration(EksConfiguration).
    
    Parameters:
    
    eksConfiguration - a consumer that will call methods on EksConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    eksConfiguration(EksConfiguration)
  - containerOrchestrationType
```
ComputeEnvironmentDetail.Builder containerOrchestrationType(String containerOrchestrationType)
```
    The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
    
    Parameters:
    
    containerOrchestrationType - The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrchestrationType, OrchestrationType
  - containerOrchestrationType
```
ComputeEnvironmentDetail.Builder containerOrchestrationType(OrchestrationType containerOrchestrationType)
```
    The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
    
    Parameters:
    
    containerOrchestrationType - The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OrchestrationType, OrchestrationType
  - uuid
```
ComputeEnvironmentDetail.Builder uuid(String uuid)
```
    Unique identifier for the compute environment.
    
    Parameters:
    
    uuid - Unique identifier for the compute environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface ComputeEnvironmentDetail.Builder

Method Summary

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

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

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

Method Detail

computeEnvironmentName

computeEnvironmentArn

unmanagedvCpus

ecsClusterArn

tags

type

type

state

state

status

status

statusReason

computeResources

computeResources

serviceRole

updatePolicy

updatePolicy

eksConfiguration

eksConfiguration

containerOrchestrationType

containerOrchestrationType

uuid