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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagSpecifications() For responses, this returns true if the service returned a value for the TagSpecifications property.
HostMaintenance	hostMaintenance() Indicates whether to enable or disable host maintenance for the Dedicated Host.
String	hostMaintenanceAsString() Indicates whether to enable or disable host maintenance for the Dedicated Host.
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	instanceFamily() Specifies the instance family to be supported by the Dedicated Hosts.
String	instanceType() Specifies the instance type to be supported by the Dedicated Hosts.
String	outpostArn() The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
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 final 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

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 auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

See Also:

AutoPlacement

autoPlacementAsString

public final 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 auto-placement and affinity in the Amazon EC2 User Guide.

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 auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

See Also:

AutoPlacement

availabilityZone

public final 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 final String clientToken()

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

Returns:

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

instanceType

public final 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.

Returns:

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.

instanceFamily

public final 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.

Returns:

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.

quantity

public final 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.

hasTagSpecifications

public final boolean hasTagSpecifications()

For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tagSpecifications

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagSpecifications() method.

Returns:

The tags to apply to the Dedicated Host during creation.

hostRecovery

public final 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

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 EC2 User Guide.

Default: off

See Also:

HostRecovery

hostRecoveryAsString

public final 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 EC2 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 EC2 User Guide.

Default: off

See Also:

HostRecovery

outpostArn

public final String outpostArn()

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.

Returns:

The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.

hostMaintenance

public final 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.

Default: on

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

Returns:

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

Default: on

See Also:

HostMaintenance

hostMaintenanceAsString

public final String hostMaintenanceAsString()

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

Default: on

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

Returns:

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

Default: on

See Also:

HostMaintenance

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 final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo