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

Interface ComputeResource.Builder

All Superinterfaces:

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

Enclosing class:

ComputeResource

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

Method Summary

Modifier and Type	Method	Description
ComputeResource.Builder	bidPercentage(Integer bidPercentage)	The minimum percentage that a Spot Instance price must 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 role applied to Amazon EC2 instances in a compute environment.
ComputeResource.Builder	instanceTypes(String... instanceTypes)	The instances types that may launched.
ComputeResource.Builder	instanceTypes(Collection<String> instanceTypes)	The instances types that may launched.
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.
ComputeResource.Builder	securityGroupIds(String... securityGroupIds)	The EC2 security group that is associated with instances launched in the compute environment.
ComputeResource.Builder	securityGroupIds(Collection<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(String... subnets)	The VPC subnets into which the compute resources are launched.
ComputeResource.Builder	subnets(Collection<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(String type)	The type of compute environment.
ComputeResource.Builder	type(CRType type)	The type of compute environment.

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

copy

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

apply, 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

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

minvCpus

ComputeResource.Builder minvCpus(Integer minvCpus)

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

Parameters:

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

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

Parameters:

instanceTypes - The instances types that may launched.

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

NOTE: This method appends the values to the existing list (if any). Use #setInstanceTypes(java.util.Collection) or #withInstanceTypes(java.util.Collection) if you want to override the existing values.

Parameters:

instanceTypes - The instances types that may launched.

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.

NOTE: This method appends the values to the existing list (if any). Use #setSubnets(java.util.Collection) or #withSubnets(java.util.Collection) if you want to override the existing values.

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.

NOTE: This method appends the values to the existing list (if any). Use #setSecurityGroupIds(java.util.Collection) or #withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

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 role applied to Amazon EC2 instances in a compute environment.

Parameters:

instanceRole - The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.

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.

bidPercentage

ComputeResource.Builder bidPercentage(Integer bidPercentage)

The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.

Parameters:

bidPercentage - The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.

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.