Package software.amazon.awssdk.services.batch.model

Interface UpdateComputeEnvironmentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BatchRequest.Builder, Buildable, CopyableBuilder<UpdateComputeEnvironmentRequest.Builder,UpdateComputeEnvironmentRequest>, SdkBuilder<UpdateComputeEnvironmentRequest.Builder,UpdateComputeEnvironmentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateComputeEnvironmentRequest
public static interface UpdateComputeEnvironmentRequest.Builder extends BatchRequest.Builder, SdkPojo, CopyableBuilder<UpdateComputeEnvironmentRequest.Builder,UpdateComputeEnvironmentRequest>

  • Method Details

    • computeEnvironment

      UpdateComputeEnvironmentRequest.Builder computeEnvironment(String computeEnvironment)

      The name or full Amazon Resource Name (ARN) of the compute environment to update.

      Parameters:
      computeEnvironment - The name or full Amazon Resource Name (ARN) of the compute environment to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      UpdateComputeEnvironmentRequest.Builder state(String state)

      The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

      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. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

      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:

    • state

      UpdateComputeEnvironmentRequest.Builder state(CEState state)

      The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

      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. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

      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:

    • unmanagedvCpus

      UpdateComputeEnvironmentRequest.Builder unmanagedvCpus(Integer unmanagedvCpus)

      The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed 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.

      Parameters:
      unmanagedvCpus - The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • computeResources

      UpdateComputeEnvironmentRequest.Builder computeResources(ComputeResourceUpdate computeResources)

      Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.

      Parameters:
      computeResources - Details of the compute resources managed by the compute environment. Required for a managed 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 UpdateComputeEnvironmentRequest.Builder computeResources(Consumer<ComputeResourceUpdate.Builder> computeResources)

      Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.

      This is a convenience method that creates an instance of the ComputeResourceUpdate.Builder avoiding the need to create one manually via ComputeResourceUpdate.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to computeResources(ComputeResourceUpdate).

      Parameters:
      computeResources - a consumer that will call methods on ComputeResourceUpdate.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serviceRole

      UpdateComputeEnvironmentRequest.Builder serviceRole(String serviceRole)

      The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

      If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.

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

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

      Parameters:
      serviceRole - The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

      If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.

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

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

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

    • updatePolicy

      UpdateComputeEnvironmentRequest.Builder updatePolicy(UpdatePolicy updatePolicy)

      Specifies the updated 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 updated 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 UpdateComputeEnvironmentRequest.Builder updatePolicy(Consumer<UpdatePolicy.Builder> updatePolicy)

      Specifies the updated 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:

    • overrideConfiguration

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

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