software.amazon.awssdk.services.ec2.model

Class AllocateHostsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.AllocateHostsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AllocateHostsRequest.Builder,AllocateHostsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class AllocateHostsRequest
extends Ec2Request
implements ToCopyableBuilder<AllocateHostsRequest.Builder,AllocateHostsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AllocateHostsRequest.Builder

Method Summary

Modifier and Type	Method and Description
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.
String	autoPlacementAsString() 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.
String	availabilityZone() The Availability Zone in which to allocate the Dedicated Host.
static AllocateHostsRequest.Builder	builder()
String	clientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HostRecovery	hostRecovery() Indicates whether to enable or disable host recovery for the Dedicated Host.
String	hostRecoveryAsString() Indicates whether to enable or disable host recovery for the Dedicated Host.
String	instanceType() Specifies the instance type for which to configure your Dedicated Hosts.
Integer	quantity() The number of Dedicated Hosts to allocate to your account with these parameters.
List<SdkField<?>>	sdkFields()
static Class<? extends AllocateHostsRequest.Builder>	serializableBuilderClass()
List<TagSpecification>	tagSpecifications() The tags to apply to the Dedicated Host during creation.
AllocateHostsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

autoPlacement

public 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 Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.

Default: on

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

Returns:

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 Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.

Default: on

See Also:

AutoPlacement

autoPlacementAsString

public String autoPlacementAsString()

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 Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.

Default: on

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

Returns:

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 Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.

Default: on

See Also:

AutoPlacement

availabilityZone

public String availabilityZone()

The Availability Zone in which to allocate the Dedicated Host.

Returns:

The Availability Zone in which to allocate the Dedicated Host.

clientToken

public String clientToken()

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

Returns:

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

instanceType

public String instanceType()

Specifies the instance type for which to configure your Dedicated Hosts. When you specify the instance type, that is the only instance type that you can launch onto that host.

Returns:

Specifies the instance type for which to configure your Dedicated Hosts. When you specify the instance type, that is the only instance type that you can launch onto that host.

quantity

public Integer quantity()

The number of Dedicated Hosts to allocate to your account with these parameters.

Returns:

The number of Dedicated Hosts to allocate to your account with these parameters.

tagSpecifications

public List<TagSpecification> tagSpecifications()

The tags to apply to the Dedicated Host during creation.

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

Returns:

The tags to apply to the Dedicated Host during creation.

hostRecovery

public 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 Elastic Compute Cloud User Guide.

Default: off

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

Returns:

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 Elastic Compute Cloud User Guide.

Default: off

See Also:

HostRecovery

hostRecoveryAsString

public String hostRecoveryAsString()

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 Elastic Compute Cloud User Guide.

Default: off

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

Returns:

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 Elastic Compute Cloud User Guide.

Default: off

See Also:

HostRecovery

toBuilder

public AllocateHostsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AllocateHostsRequest.Builder,AllocateHostsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static AllocateHostsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AllocateHostsRequest.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()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo