software.amazon.awssdk.services.batch.model

Class ComputeResourceUpdate

java.lang.Object

software.amazon.awssdk.services.batch.model.ComputeResourceUpdate

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ComputeResourceUpdate.Builder,ComputeResourceUpdate>

@Generated(value="software.amazon.awssdk:codegen")
public final class ComputeResourceUpdate
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ComputeResourceUpdate.Builder,ComputeResourceUpdate>

An object representing the attributes of a compute environment that can be updated. For more information, see Compute Environments in the AWS Batch User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ComputeResourceUpdate.Builder

Method Summary

Modifier and Type	Method and Description
static ComputeResourceUpdate.Builder	builder()
Integer	desiredvCpus() The desired number of Amazon EC2 vCPUS in the compute environment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSecurityGroupIds() Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSubnets() Returns true if the Subnets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Integer	maxvCpus() The maximum number of Amazon EC2 vCPUs that an environment can reach.
Integer	minvCpus() The minimum number of Amazon EC2 vCPUs that an environment should maintain.
List<SdkField<?>>	sdkFields()
List<String>	securityGroupIds() The Amazon EC2 security groups associated with instances launched in the compute environment.
static Class<? extends ComputeResourceUpdate.Builder>	serializableBuilderClass()
List<String>	subnets() The VPC subnets that the compute resources are launched into.
ComputeResourceUpdate.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

minvCpus

public final Integer minvCpus()

The minimum number of Amazon EC2 vCPUs that an environment should maintain.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

Returns:

The minimum number of Amazon EC2 vCPUs that an environment should maintain.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

maxvCpus

public final Integer maxvCpus()

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.

Returns:

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies, AWS Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.

desiredvCpus

public final Integer desiredvCpus()

The desired number of Amazon EC2 vCPUS in the compute environment.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

Returns:

The desired number of Amazon EC2 vCPUS in the compute environment.

This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.

hasSubnets

public final boolean hasSubnets()

Returns true if the Subnets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

subnets

public final List<String> subnets()

The VPC subnets that the compute resources are launched into. Fargate compute resources can contain up to 16 subnets. Providing an empty list will be handled as if this parameter wasn't specified and no change is made. This can't be specified for EC2 compute resources. For more information, see VPCs and Subnets in the Amazon VPC User Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSubnets() to see if a value was sent in this field.

Returns:

The VPC subnets that the compute resources are launched into. Fargate compute resources can contain up to 16 subnets. Providing an empty list will be handled as if this parameter wasn't specified and no change is made. This can't be specified for EC2 compute resources. For more information, see VPCs and Subnets in the Amazon VPC User Guide.

hasSecurityGroupIds

public final boolean hasSecurityGroupIds()

Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

securityGroupIds

public final List<String> securityGroupIds()

The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no change is made.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSecurityGroupIds() to see if a value was sent in this field.

Returns:

The Amazon EC2 security groups associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. This can't be specified for EC2 compute resources. Providing an empty list is handled as if this parameter wasn't specified and no change is made.

toBuilder

public ComputeResourceUpdate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComputeResourceUpdate.Builder,ComputeResourceUpdate>

builder

public static ComputeResourceUpdate.Builder builder()

serializableBuilderClass

public static Class<? extends ComputeResourceUpdate.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo