software.amazon.awssdk.services.batch.model

Class ComputeResource

java.lang.Object

software.amazon.awssdk.services.batch.model.ComputeResource

All Implemented Interfaces:

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

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

An object representing an AWS Batch compute resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ComputeResource.Builder

Method Summary

Modifier and Type	Method and Description
Integer	bidPercentage() The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched.
static ComputeResource.Builder	builder()
Integer	desiredvCpus() The desired number of EC2 vCPUS in the compute environment.
String	ec2KeyPair() The EC2 key pair that is used for instances launched in the compute environment.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	imageId() The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
String	instanceRole() The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
List<String>	instanceTypes() The instances types that may be launched.
LaunchTemplateSpecification	launchTemplate() The launch template to use for your compute resources.
Integer	maxvCpus() The maximum number of EC2 vCPUs that an environment can reach.
Integer	minvCpus() The minimum number of EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
String	placementGroup() The Amazon EC2 placement group to associate with your compute resources.
List<SdkField<?>>	sdkFields()
List<String>	securityGroupIds() The EC2 security group that is associated with instances launched in the compute environment.
static Class<? extends ComputeResource.Builder>	serializableBuilderClass()
String	spotIamFleetRole() The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
List<String>	subnets() The VPC subnets into which the compute resources are launched.
Map<String,String>	tags() Key-value pair tags to be applied to resources that are launched in the compute environment.
ComputeResource.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
CRType	type() The type of compute environment.
String	typeAsString() The type of compute environment.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

type

public CRType type()

The type of compute environment.

If the service returns an enum value that is not available in the current SDK version, type will return CRType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of compute environment.

See Also:

CRType

typeAsString

public String typeAsString()

The type of compute environment.

If the service returns an enum value that is not available in the current SDK version, type will return CRType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of compute environment.

See Also:

CRType

minvCpus

public Integer minvCpus()

The minimum number of EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

Returns:

The minimum number of EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

maxvCpus

public Integer maxvCpus()

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

Returns:

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

desiredvCpus

public Integer desiredvCpus()

The desired number of EC2 vCPUS in the compute environment.

Returns:

The desired number of EC2 vCPUS in the compute environment.

instanceTypes

public List<String> instanceTypes()

The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c4 or p3), or you can specify specific sizes within a family (such as c4.8xlarge). You can also choose optimal to pick instance types (from the latest C, M, and R instance families) on the fly that match the demand of your job queues.

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

Returns:

The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c4 or p3), or you can specify specific sizes within a family (such as c4.8xlarge). You can also choose optimal to pick instance types (from the latest C, M, and R instance families) on the fly that match the demand of your job queues.

imageId

public String imageId()

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

Returns:

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

subnets

public List<String> subnets()

The VPC subnets into which the compute resources are launched.

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

Returns:

The VPC subnets into which the compute resources are launched.

securityGroupIds

public List<String> securityGroupIds()

The EC2 security group that is associated with instances launched in the compute environment.

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

Returns:

The EC2 security group that is associated with instances launched in the compute environment.

ec2KeyPair

public String ec2KeyPair()

The EC2 key pair that is used for instances launched in the compute environment.

Returns:

The EC2 key pair that is used for instances launched in the compute environment.

instanceRole

public String instanceRole()

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole. For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.

Returns:

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole. For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.

tags

public Map<String,String> tags()

Key-value pair tags to be applied to resources that are launched in the compute environment.

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

Returns:

Key-value pair tags to be applied to resources that are launched in the compute environment.

placementGroup

public String placementGroup()

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

Returns:

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

bidPercentage

public Integer bidPercentage()

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.

Returns:

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.

spotIamFleetRole

public String spotIamFleetRole()

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.

Returns:

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.

launchTemplate

public LaunchTemplateSpecification launchTemplate()

The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both.

Returns:

The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both.

toBuilder

public ComputeResource.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ComputeResource.Builder,ComputeResource>

Returns:

a builder for type T

builder

public static ComputeResource.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.