software.amazon.awssdk.services.ec2.model

Interface AllocateHostsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<AllocateHostsRequest.Builder,AllocateHostsRequest>, Ec2Request.Builder, SdkBuilder<AllocateHostsRequest.Builder,AllocateHostsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

AllocateHostsRequest

public static interface AllocateHostsRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<AllocateHostsRequest.Builder,AllocateHostsRequest>

Method Summary

Modifier and Type	Method and Description
AllocateHostsRequest.Builder	assetIds(Collection<String> assetIds) The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts.
AllocateHostsRequest.Builder	assetIds(String... assetIds) The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts.
AllocateHostsRequest.Builder	autoPlacement(AutoPlacement autoPlacement) Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.
AllocateHostsRequest.Builder	autoPlacement(String autoPlacement) Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID.
AllocateHostsRequest.Builder	availabilityZone(String availabilityZone) The Availability Zone in which to allocate the Dedicated Host.
AllocateHostsRequest.Builder	clientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
AllocateHostsRequest.Builder	hostMaintenance(HostMaintenance hostMaintenance) Indicates whether to enable or disable host maintenance for the Dedicated Host.
AllocateHostsRequest.Builder	hostMaintenance(String hostMaintenance) Indicates whether to enable or disable host maintenance for the Dedicated Host.
AllocateHostsRequest.Builder	hostRecovery(HostRecovery hostRecovery) Indicates whether to enable or disable host recovery for the Dedicated Host.
AllocateHostsRequest.Builder	hostRecovery(String hostRecovery) Indicates whether to enable or disable host recovery for the Dedicated Host.
AllocateHostsRequest.Builder	instanceFamily(String instanceFamily) Specifies the instance family to be supported by the Dedicated Hosts.
AllocateHostsRequest.Builder	instanceType(String instanceType) Specifies the instance type to be supported by the Dedicated Hosts.
AllocateHostsRequest.Builder	outpostArn(String outpostArn) The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
AllocateHostsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AllocateHostsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AllocateHostsRequest.Builder	quantity(Integer quantity) The number of Dedicated Hosts to allocate to your account with these parameters.
AllocateHostsRequest.Builder	tagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the Dedicated Host during creation.
AllocateHostsRequest.Builder	tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to apply to the Dedicated Host during creation.
AllocateHostsRequest.Builder	tagSpecifications(TagSpecification... tagSpecifications) The tags to apply to the Dedicated Host during creation.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

autoPlacement

AllocateHostsRequest.Builder autoPlacement(String autoPlacement)

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

Parameters:

autoPlacement - Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

Returns:

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

See Also:

AutoPlacement, AutoPlacement

autoPlacement

AllocateHostsRequest.Builder autoPlacement(AutoPlacement autoPlacement)

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

Parameters:

autoPlacement - Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

Returns:

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

See Also:

AutoPlacement, AutoPlacement

availabilityZone

AllocateHostsRequest.Builder availabilityZone(String availabilityZone)

The Availability Zone in which to allocate the Dedicated Host.

Parameters:

availabilityZone - The Availability Zone in which to allocate the Dedicated Host.

Returns:

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

clientToken

AllocateHostsRequest.Builder clientToken(String clientToken)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Parameters:

clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Returns:

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

instanceType

AllocateHostsRequest.Builder instanceType(String instanceType)

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

Parameters:

instanceType - Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

Returns:

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

instanceFamily

AllocateHostsRequest.Builder instanceFamily(String instanceFamily)

Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

Parameters:

instanceFamily - Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

Returns:

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

quantity

AllocateHostsRequest.Builder quantity(Integer quantity)

The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both AssetIds and Quantity, then the value that you specify for Quantity must be equal to the number of asset IDs specified.

Parameters:

quantity - The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both AssetIds and Quantity, then the value that you specify for Quantity must be equal to the number of asset IDs specified.

Returns:

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

tagSpecifications

AllocateHostsRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the Dedicated Host during creation.

Parameters:

tagSpecifications - The tags to apply to the Dedicated Host during creation.

Returns:

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

tagSpecifications

AllocateHostsRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the Dedicated Host during creation.

Parameters:

tagSpecifications - The tags to apply to the Dedicated Host during creation.

Returns:

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

tagSpecifications

AllocateHostsRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

The tags to apply to the Dedicated Host during creation.

This is a convenience method that creates an instance of the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tagSpecifications(List).

Parameters:

tagSpecifications - a consumer that will call methods on TagSpecification.Builder

Returns:

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

See Also:

#tagSpecifications(java.util.Collection)

hostRecovery

AllocateHostsRequest.Builder hostRecovery(String hostRecovery)

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

Parameters:

hostRecovery - Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

Returns:

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

See Also:

HostRecovery, HostRecovery

hostRecovery

AllocateHostsRequest.Builder hostRecovery(HostRecovery hostRecovery)

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

Parameters:

hostRecovery - Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

Returns:

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

See Also:

HostRecovery, HostRecovery

outpostArn

AllocateHostsRequest.Builder outpostArn(String outpostArn)

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. If you specify OutpostArn, you can optionally specify AssetIds.

If you are allocating the Dedicated Host in a Region, omit this parameter.

Parameters:

outpostArn - The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host. If you specify OutpostArn, you can optionally specify AssetIds.

If you are allocating the Dedicated Host in a Region, omit this parameter.

Returns:

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

hostMaintenance

AllocateHostsRequest.Builder hostMaintenance(String hostMaintenance)

Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.

Parameters:

hostMaintenance - Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.

Returns:

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

See Also:

HostMaintenance, HostMaintenance

hostMaintenance

AllocateHostsRequest.Builder hostMaintenance(HostMaintenance hostMaintenance)

Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.

Parameters:

hostMaintenance - Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.

Returns:

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

See Also:

HostMaintenance, HostMaintenance

assetIds

AllocateHostsRequest.Builder assetIds(Collection<String> assetIds)

The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.

• If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.

• If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.

Parameters:

assetIds - The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.

• If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.

• If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.

Returns:

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

assetIds

AllocateHostsRequest.Builder assetIds(String... assetIds)

The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.

• If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.

• If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.

Parameters:

assetIds - The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.

• If you specify this parameter, you can omit Quantity. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset.

• If you specify both AssetIds and Quantity, then the value for Quantity must be equal to the number of asset IDs specified.

Returns:

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

overrideConfiguration

AllocateHostsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

AllocateHostsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder