Interface CreateComputeNodeGroupRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateComputeNodeGroupRequest.Builder,CreateComputeNodeGroupRequest>,PcsRequest.Builder,SdkBuilder<CreateComputeNodeGroupRequest.Builder,CreateComputeNodeGroupRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateComputeNodeGroupRequest
public static interface CreateComputeNodeGroupRequest.Builder extends PcsRequest.Builder, SdkPojo, CopyableBuilder<CreateComputeNodeGroupRequest.Builder,CreateComputeNodeGroupRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CreateComputeNodeGroupRequest.BuilderamiId(String amiId)The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances).CreateComputeNodeGroupRequest.BuilderclientToken(String clientToken)A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.CreateComputeNodeGroupRequest.BuilderclusterIdentifier(String clusterIdentifier)The name or ID of the cluster to create a compute node group in.CreateComputeNodeGroupRequest.BuildercomputeNodeGroupName(String computeNodeGroupName)A name to identify the cluster.default CreateComputeNodeGroupRequest.BuildercustomLaunchTemplate(Consumer<CustomLaunchTemplate.Builder> customLaunchTemplate)Sets the value of the CustomLaunchTemplate property for this object.CreateComputeNodeGroupRequest.BuildercustomLaunchTemplate(CustomLaunchTemplate customLaunchTemplate)Sets the value of the CustomLaunchTemplate property for this object.CreateComputeNodeGroupRequest.BuilderiamInstanceProfileArn(String iamInstanceProfileArn)The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.CreateComputeNodeGroupRequest.BuilderinstanceConfigs(Collection<InstanceConfig> instanceConfigs)A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.CreateComputeNodeGroupRequest.BuilderinstanceConfigs(Consumer<InstanceConfig.Builder>... instanceConfigs)A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.CreateComputeNodeGroupRequest.BuilderinstanceConfigs(InstanceConfig... instanceConfigs)A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.CreateComputeNodeGroupRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateComputeNodeGroupRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateComputeNodeGroupRequest.BuilderpurchaseOption(String purchaseOption)Specifies how EC2 instances are purchased on your behalf.CreateComputeNodeGroupRequest.BuilderpurchaseOption(PurchaseOption purchaseOption)Specifies how EC2 instances are purchased on your behalf.default CreateComputeNodeGroupRequest.BuilderscalingConfiguration(Consumer<ScalingConfigurationRequest.Builder> scalingConfiguration)Specifies the boundaries of the compute node group auto scaling.CreateComputeNodeGroupRequest.BuilderscalingConfiguration(ScalingConfigurationRequest scalingConfiguration)Specifies the boundaries of the compute node group auto scaling.default CreateComputeNodeGroupRequest.BuilderslurmConfiguration(Consumer<ComputeNodeGroupSlurmConfigurationRequest.Builder> slurmConfiguration)Additional options related to the Slurm scheduler.CreateComputeNodeGroupRequest.BuilderslurmConfiguration(ComputeNodeGroupSlurmConfigurationRequest slurmConfiguration)Additional options related to the Slurm scheduler.default CreateComputeNodeGroupRequest.BuilderspotOptions(Consumer<SpotOptions.Builder> spotOptions)Sets the value of the SpotOptions property for this object.CreateComputeNodeGroupRequest.BuilderspotOptions(SpotOptions spotOptions)Sets the value of the SpotOptions property for this object.CreateComputeNodeGroupRequest.BuildersubnetIds(String... subnetIds)The list of subnet IDs where the compute node group launches instances.CreateComputeNodeGroupRequest.BuildersubnetIds(Collection<String> subnetIds)The list of subnet IDs where the compute node group launches instances.CreateComputeNodeGroupRequest.Buildertags(Map<String,String> tags)1 or more tags added to the resource.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.pcs.model.PcsRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
clusterIdentifier
CreateComputeNodeGroupRequest.Builder clusterIdentifier(String clusterIdentifier)
The name or ID of the cluster to create a compute node group in.
- Parameters:
clusterIdentifier- The name or ID of the cluster to create a compute node group in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
computeNodeGroupName
CreateComputeNodeGroupRequest.Builder computeNodeGroupName(String computeNodeGroupName)
A name to identify the cluster. Example:
MyCluster- Parameters:
computeNodeGroupName- A name to identify the cluster. Example:MyCluster- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
amiId
CreateComputeNodeGroupRequest.Builder amiId(String amiId)
The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.
- Parameters:
amiId- The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
CreateComputeNodeGroupRequest.Builder subnetIds(Collection<String> subnetIds)
The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.
- Parameters:
subnetIds- The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
CreateComputeNodeGroupRequest.Builder subnetIds(String... subnetIds)
The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.
- Parameters:
subnetIds- The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
purchaseOption
CreateComputeNodeGroupRequest.Builder purchaseOption(String purchaseOption)
Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
- Parameters:
purchaseOption- Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PurchaseOption,PurchaseOption
-
purchaseOption
CreateComputeNodeGroupRequest.Builder purchaseOption(PurchaseOption purchaseOption)
Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.
- Parameters:
purchaseOption- Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don't provide this option, it defaults to On-Demand.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PurchaseOption,PurchaseOption
-
customLaunchTemplate
CreateComputeNodeGroupRequest.Builder customLaunchTemplate(CustomLaunchTemplate customLaunchTemplate)
Sets the value of the CustomLaunchTemplate property for this object.- Parameters:
customLaunchTemplate- The new value for the CustomLaunchTemplate property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customLaunchTemplate
default CreateComputeNodeGroupRequest.Builder customLaunchTemplate(Consumer<CustomLaunchTemplate.Builder> customLaunchTemplate)
Sets the value of the CustomLaunchTemplate property for this object. This is a convenience method that creates an instance of theCustomLaunchTemplate.Builderavoiding the need to create one manually viaCustomLaunchTemplate.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocustomLaunchTemplate(CustomLaunchTemplate).- Parameters:
customLaunchTemplate- a consumer that will call methods onCustomLaunchTemplate.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
customLaunchTemplate(CustomLaunchTemplate)
-
iamInstanceProfileArn
CreateComputeNodeGroupRequest.Builder iamInstanceProfileArn(String iamInstanceProfileArn)
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have
pcs:RegisterComputeNodeGroupInstancepermissions attached in order to provision instances correctly. The resource identifier of the ARN must start withAWSPCS. For example,arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile.- Parameters:
iamInstanceProfileArn- The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must havepcs:RegisterComputeNodeGroupInstancepermissions attached in order to provision instances correctly. The resource identifier of the ARN must start withAWSPCS. For example,arn:aws:iam:123456789012:instance-profile/AWSPCSMyComputeNodeInstanceProfile.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scalingConfiguration
CreateComputeNodeGroupRequest.Builder scalingConfiguration(ScalingConfigurationRequest scalingConfiguration)
Specifies the boundaries of the compute node group auto scaling.
- Parameters:
scalingConfiguration- Specifies the boundaries of the compute node group auto scaling.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scalingConfiguration
default CreateComputeNodeGroupRequest.Builder scalingConfiguration(Consumer<ScalingConfigurationRequest.Builder> scalingConfiguration)
Specifies the boundaries of the compute node group auto scaling.
This is a convenience method that creates an instance of theScalingConfigurationRequest.Builderavoiding the need to create one manually viaScalingConfigurationRequest.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toscalingConfiguration(ScalingConfigurationRequest).- Parameters:
scalingConfiguration- a consumer that will call methods onScalingConfigurationRequest.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
scalingConfiguration(ScalingConfigurationRequest)
-
instanceConfigs
CreateComputeNodeGroupRequest.Builder instanceConfigs(Collection<InstanceConfig> instanceConfigs)
A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
- Parameters:
instanceConfigs- A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceConfigs
CreateComputeNodeGroupRequest.Builder instanceConfigs(InstanceConfig... instanceConfigs)
A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
- Parameters:
instanceConfigs- A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceConfigs
CreateComputeNodeGroupRequest.Builder instanceConfigs(Consumer<InstanceConfig.Builder>... instanceConfigs)
A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
This is a convenience method that creates an instance of theInstanceConfig.Builderavoiding the need to create one manually viaInstanceConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#instanceConfigs(List.) - Parameters:
instanceConfigs- a consumer that will call methods onInstanceConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#instanceConfigs(java.util.Collection)
-
spotOptions
CreateComputeNodeGroupRequest.Builder spotOptions(SpotOptions spotOptions)
Sets the value of the SpotOptions property for this object.- Parameters:
spotOptions- The new value for the SpotOptions property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
spotOptions
default CreateComputeNodeGroupRequest.Builder spotOptions(Consumer<SpotOptions.Builder> spotOptions)
Sets the value of the SpotOptions property for this object. This is a convenience method that creates an instance of theSpotOptions.Builderavoiding the need to create one manually viaSpotOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tospotOptions(SpotOptions).- Parameters:
spotOptions- a consumer that will call methods onSpotOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
spotOptions(SpotOptions)
-
slurmConfiguration
CreateComputeNodeGroupRequest.Builder slurmConfiguration(ComputeNodeGroupSlurmConfigurationRequest slurmConfiguration)
Additional options related to the Slurm scheduler.
- Parameters:
slurmConfiguration- Additional options related to the Slurm scheduler.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
slurmConfiguration
default CreateComputeNodeGroupRequest.Builder slurmConfiguration(Consumer<ComputeNodeGroupSlurmConfigurationRequest.Builder> slurmConfiguration)
Additional options related to the Slurm scheduler.
This is a convenience method that creates an instance of theComputeNodeGroupSlurmConfigurationRequest.Builderavoiding the need to create one manually viaComputeNodeGroupSlurmConfigurationRequest.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toslurmConfiguration(ComputeNodeGroupSlurmConfigurationRequest).- Parameters:
slurmConfiguration- a consumer that will call methods onComputeNodeGroupSlurmConfigurationRequest.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
slurmConfiguration(ComputeNodeGroupSlurmConfigurationRequest)
-
clientToken
CreateComputeNodeGroupRequest.Builder clientToken(String clientToken)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.
- Parameters:
clientToken- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don't specify a client token, the CLI and SDK automatically generate 1 for you.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateComputeNodeGroupRequest.Builder tags(Map<String,String> tags)
1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.
- Parameters:
tags- 1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateComputeNodeGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateComputeNodeGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-