software.amazon.awssdk.services.batch.model

Interface ComputeResource.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ComputeResource.Builder,ComputeResource>, SdkBuilder<ComputeResource.Builder,ComputeResource>, SdkPojo

Enclosing class:

ComputeResource

public static interface ComputeResource.Builder
extends SdkPojo, CopyableBuilder<ComputeResource.Builder,ComputeResource>

Method Summary

Modifier and Type	Method and Description
ComputeResource.Builder	bidPercentage(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.
ComputeResource.Builder	desiredvCpus(Integer desiredvCpus) The desired number of EC2 vCPUS in the compute environment.
ComputeResource.Builder	ec2KeyPair(String ec2KeyPair) The EC2 key pair that is used for instances launched in the compute environment.
ComputeResource.Builder	imageId(String imageId) The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
ComputeResource.Builder	instanceRole(String instanceRole) The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
ComputeResource.Builder	instanceTypes(Collection<String> instanceTypes) The instances types that may be launched.
ComputeResource.Builder	instanceTypes(String... instanceTypes) The instances types that may be launched.
default ComputeResource.Builder	launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate) The launch template to use for your compute resources.
ComputeResource.Builder	launchTemplate(LaunchTemplateSpecification launchTemplate) The launch template to use for your compute resources.
ComputeResource.Builder	maxvCpus(Integer maxvCpus) The maximum number of EC2 vCPUs that an environment can reach.
ComputeResource.Builder	minvCpus(Integer minvCpus) The minimum number of EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
ComputeResource.Builder	placementGroup(String placementGroup) The Amazon EC2 placement group to associate with your compute resources.
ComputeResource.Builder	securityGroupIds(Collection<String> securityGroupIds) The EC2 security group that is associated with instances launched in the compute environment.
ComputeResource.Builder	securityGroupIds(String... securityGroupIds) The EC2 security group that is associated with instances launched in the compute environment.
ComputeResource.Builder	spotIamFleetRole(String spotIamFleetRole) The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
ComputeResource.Builder	subnets(Collection<String> subnets) The VPC subnets into which the compute resources are launched.
ComputeResource.Builder	subnets(String... subnets) The VPC subnets into which the compute resources are launched.
ComputeResource.Builder	tags(Map<String,String> tags) Key-value pair tags to be applied to resources that are launched in the compute environment.
ComputeResource.Builder	type(CRType type) The type of compute environment.
ComputeResource.Builder	type(String type) The type of compute environment.

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

type

ComputeResource.Builder type(String type)

The type of compute environment.

Parameters:

type - The type of compute environment.

Returns:

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

See Also:

CRType, CRType

type

ComputeResource.Builder type(CRType type)

The type of compute environment.

Parameters:

type - The type of compute environment.

Returns:

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

See Also:

CRType, CRType

minvCpus

ComputeResource.Builder minvCpus(Integer minvCpus)

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

Parameters:

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

Returns:

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

maxvCpus

ComputeResource.Builder maxvCpus(Integer maxvCpus)

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

Parameters:

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

Returns:

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

desiredvCpus

ComputeResource.Builder desiredvCpus(Integer desiredvCpus)

The desired number of EC2 vCPUS in the compute environment.

Parameters:

desiredvCpus - The desired number of EC2 vCPUS in the compute environment.

Returns:

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

instanceTypes

ComputeResource.Builder instanceTypes(Collection<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.

Parameters:

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.

Returns:

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

instanceTypes

ComputeResource.Builder instanceTypes(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.

Parameters:

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.

Returns:

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

imageId

ComputeResource.Builder imageId(String imageId)

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

Parameters:

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

Returns:

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

subnets

ComputeResource.Builder subnets(Collection<String> subnets)

The VPC subnets into which the compute resources are launched.

Parameters:

subnets - The VPC subnets into which the compute resources are launched.

Returns:

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

subnets

ComputeResource.Builder subnets(String... subnets)

The VPC subnets into which the compute resources are launched.

Parameters:

subnets - The VPC subnets into which the compute resources are launched.

Returns:

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

securityGroupIds

ComputeResource.Builder securityGroupIds(Collection<String> securityGroupIds)

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

Parameters:

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

Returns:

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

securityGroupIds

ComputeResource.Builder securityGroupIds(String... securityGroupIds)

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

Parameters:

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

Returns:

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

ec2KeyPair

ComputeResource.Builder ec2KeyPair(String ec2KeyPair)

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

Parameters:

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

Returns:

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

instanceRole

ComputeResource.Builder instanceRole(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.

Parameters:

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:

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

tags

ComputeResource.Builder tags(Map<String,String> tags)

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

Parameters:

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

Returns:

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

placementGroup

ComputeResource.Builder placementGroup(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.

Parameters:

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:

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

bidPercentage

ComputeResource.Builder bidPercentage(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.

Parameters:

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:

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

spotIamFleetRole

ComputeResource.Builder spotIamFleetRole(String spotIamFleetRole)

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

Parameters:

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

Returns:

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

launchTemplate

ComputeResource.Builder launchTemplate(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.

Parameters:

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:

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

launchTemplate

default ComputeResource.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> 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.

This is a convenience that creates an instance of the LaunchTemplateSpecification.Builder avoiding the need to create one manually via LaunchTemplateSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to launchTemplate(LaunchTemplateSpecification).

Parameters:

launchTemplate - a consumer that will call methods on LaunchTemplateSpecification.Builder

Returns:

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

See Also:

launchTemplate(LaunchTemplateSpecification)