software.amazon.awssdk.services.ec2.model

Interface Host.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Host.Builder,Host>, SdkBuilder<Host.Builder,Host>, SdkPojo

Enclosing class:

Host

public static interface Host.Builder
extends SdkPojo, CopyableBuilder<Host.Builder,Host>

Method Summary

Modifier and Type	Method and Description
Host.Builder	allocationTime(Instant allocationTime) The time that the Dedicated Host was allocated.
Host.Builder	allowsMultipleInstanceTypes(AllowsMultipleInstanceTypes allowsMultipleInstanceTypes) Indicates whether the Dedicated Host supports multiple instance types of the same instance family.
Host.Builder	allowsMultipleInstanceTypes(String allowsMultipleInstanceTypes) Indicates whether the Dedicated Host supports multiple instance types of the same instance family.
Host.Builder	assetId(String assetId) The ID of the Outpost hardware asset on which the Dedicated Host is allocated.
Host.Builder	autoPlacement(AutoPlacement autoPlacement) Whether auto-placement is on or off.
Host.Builder	autoPlacement(String autoPlacement) Whether auto-placement is on or off.
Host.Builder	availabilityZone(String availabilityZone) The Availability Zone of the Dedicated Host.
Host.Builder	availabilityZoneId(String availabilityZoneId) The ID of the Availability Zone in which the Dedicated Host is allocated.
Host.Builder	availableCapacity(AvailableCapacity availableCapacity) Information about the instances running on the Dedicated Host.
default Host.Builder	availableCapacity(Consumer<AvailableCapacity.Builder> availableCapacity) Information about the instances running on the Dedicated Host.
Host.Builder	clientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Host.Builder	hostId(String hostId) The ID of the Dedicated Host.
Host.Builder	hostMaintenance(HostMaintenance hostMaintenance) Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
Host.Builder	hostMaintenance(String hostMaintenance) Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
default Host.Builder	hostProperties(Consumer<HostProperties.Builder> hostProperties) The hardware specifications of the Dedicated Host.
Host.Builder	hostProperties(HostProperties hostProperties) The hardware specifications of the Dedicated Host.
Host.Builder	hostRecovery(HostRecovery hostRecovery) Indicates whether host recovery is enabled or disabled for the Dedicated Host.
Host.Builder	hostRecovery(String hostRecovery) Indicates whether host recovery is enabled or disabled for the Dedicated Host.
Host.Builder	hostReservationId(String hostReservationId) The reservation ID of the Dedicated Host.
Host.Builder	instances(Collection<HostInstance> instances) The IDs and instance type that are currently running on the Dedicated Host.
Host.Builder	instances(Consumer<HostInstance.Builder>... instances) The IDs and instance type that are currently running on the Dedicated Host.
Host.Builder	instances(HostInstance... instances) The IDs and instance type that are currently running on the Dedicated Host.
Host.Builder	memberOfServiceLinkedResourceGroup(Boolean memberOfServiceLinkedResourceGroup) Indicates whether the Dedicated Host is in a host resource group.
Host.Builder	outpostArn(String outpostArn) The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.
Host.Builder	ownerId(String ownerId) The ID of the Amazon Web Services account that owns the Dedicated Host.
Host.Builder	releaseTime(Instant releaseTime) The time that the Dedicated Host was released.
Host.Builder	state(AllocationState state) The Dedicated Host's state.
Host.Builder	state(String state) The Dedicated Host's state.
Host.Builder	tags(Collection<Tag> tags) Any tags assigned to the Dedicated Host.
Host.Builder	tags(Consumer<Tag.Builder>... tags) Any tags assigned to the Dedicated Host.
Host.Builder	tags(Tag... tags) Any tags assigned to the Dedicated Host.

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

Host.Builder autoPlacement(String autoPlacement)

Whether auto-placement is on or off.

Parameters:

autoPlacement - Whether auto-placement is on or off.

Returns:

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

See Also:

AutoPlacement, AutoPlacement

autoPlacement

Host.Builder autoPlacement(AutoPlacement autoPlacement)

Whether auto-placement is on or off.

Parameters:

autoPlacement - Whether auto-placement is on or off.

Returns:

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

See Also:

AutoPlacement, AutoPlacement

availabilityZone

Host.Builder availabilityZone(String availabilityZone)

The Availability Zone of the Dedicated Host.

Parameters:

availabilityZone - The Availability Zone of the Dedicated Host.

Returns:

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

availableCapacity

Host.Builder availableCapacity(AvailableCapacity availableCapacity)

Information about the instances running on the Dedicated Host.

Parameters:

availableCapacity - Information about the instances running on the Dedicated Host.

Returns:

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

availableCapacity

default Host.Builder availableCapacity(Consumer<AvailableCapacity.Builder> availableCapacity)

Information about the instances running on the Dedicated Host.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to availableCapacity(AvailableCapacity).

Parameters:

availableCapacity - a consumer that will call methods on AvailableCapacity.Builder

Returns:

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

See Also:

availableCapacity(AvailableCapacity)

clientToken

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

hostId

Host.Builder hostId(String hostId)

The ID of the Dedicated Host.

Parameters:

hostId - The ID of the Dedicated Host.

Returns:

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

hostProperties

Host.Builder hostProperties(HostProperties hostProperties)

The hardware specifications of the Dedicated Host.

Parameters:

hostProperties - The hardware specifications of the Dedicated Host.

Returns:

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

hostProperties

default Host.Builder hostProperties(Consumer<HostProperties.Builder> hostProperties)

The hardware specifications of the Dedicated Host.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hostProperties(HostProperties).

Parameters:

hostProperties - a consumer that will call methods on HostProperties.Builder

Returns:

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

See Also:

hostProperties(HostProperties)

hostReservationId

Host.Builder hostReservationId(String hostReservationId)

The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.

Parameters:

hostReservationId - The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.

Returns:

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

instances

Host.Builder instances(Collection<HostInstance> instances)

The IDs and instance type that are currently running on the Dedicated Host.

Parameters:

instances - The IDs and instance type that are currently running on the Dedicated Host.

Returns:

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

instances

Host.Builder instances(HostInstance... instances)

The IDs and instance type that are currently running on the Dedicated Host.

Parameters:

instances - The IDs and instance type that are currently running on the Dedicated Host.

Returns:

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

instances

Host.Builder instances(Consumer<HostInstance.Builder>... instances)

The IDs and instance type that are currently running on the Dedicated Host.

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

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

Parameters:

instances - a consumer that will call methods on HostInstance.Builder

Returns:

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

See Also:

#instances(java.util.Collection)

state

Host.Builder state(String state)

The Dedicated Host's state.

Parameters:

state - The Dedicated Host's state.

Returns:

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

See Also:

AllocationState, AllocationState

state

Host.Builder state(AllocationState state)

The Dedicated Host's state.

Parameters:

state - The Dedicated Host's state.

Returns:

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

See Also:

AllocationState, AllocationState

allocationTime

Host.Builder allocationTime(Instant allocationTime)

The time that the Dedicated Host was allocated.

Parameters:

allocationTime - The time that the Dedicated Host was allocated.

Returns:

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

releaseTime

Host.Builder releaseTime(Instant releaseTime)

The time that the Dedicated Host was released.

Parameters:

releaseTime - The time that the Dedicated Host was released.

Returns:

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

tags

Host.Builder tags(Collection<Tag> tags)

Any tags assigned to the Dedicated Host.

Parameters:

tags - Any tags assigned to the Dedicated Host.

Returns:

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

tags

Host.Builder tags(Tag... tags)

Any tags assigned to the Dedicated Host.

Parameters:

tags - Any tags assigned to the Dedicated Host.

Returns:

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

tags

Host.Builder tags(Consumer<Tag.Builder>... tags)

Any tags assigned to the Dedicated Host.

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

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

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

hostRecovery

Host.Builder hostRecovery(String hostRecovery)

Indicates whether host recovery is enabled or disabled for the Dedicated Host.

Parameters:

hostRecovery - Indicates whether host recovery is enabled or disabled for the Dedicated Host.

Returns:

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

See Also:

HostRecovery, HostRecovery

hostRecovery

Host.Builder hostRecovery(HostRecovery hostRecovery)

Indicates whether host recovery is enabled or disabled for the Dedicated Host.

Parameters:

hostRecovery - Indicates whether host recovery is enabled or disabled for the Dedicated Host.

Returns:

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

See Also:

HostRecovery, HostRecovery

allowsMultipleInstanceTypes

Host.Builder allowsMultipleInstanceTypes(String allowsMultipleInstanceTypes)

Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.

Parameters:

allowsMultipleInstanceTypes - Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.

Returns:

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

See Also:

AllowsMultipleInstanceTypes, AllowsMultipleInstanceTypes

allowsMultipleInstanceTypes

Host.Builder allowsMultipleInstanceTypes(AllowsMultipleInstanceTypes allowsMultipleInstanceTypes)

Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.

Parameters:

allowsMultipleInstanceTypes - Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.

Returns:

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

See Also:

AllowsMultipleInstanceTypes, AllowsMultipleInstanceTypes

ownerId

Host.Builder ownerId(String ownerId)

The ID of the Amazon Web Services account that owns the Dedicated Host.

Parameters:

ownerId - The ID of the Amazon Web Services account that owns the Dedicated Host.

Returns:

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

availabilityZoneId

Host.Builder availabilityZoneId(String availabilityZoneId)

The ID of the Availability Zone in which the Dedicated Host is allocated.

Parameters:

availabilityZoneId - The ID of the Availability Zone in which the Dedicated Host is allocated.

Returns:

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

memberOfServiceLinkedResourceGroup

Host.Builder memberOfServiceLinkedResourceGroup(Boolean memberOfServiceLinkedResourceGroup)

Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the host is in a host resource group; otherwise, it is not.

Parameters:

memberOfServiceLinkedResourceGroup - Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the host is in a host resource group; otherwise, it is not.

Returns:

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

outpostArn

Host.Builder outpostArn(String outpostArn)

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

Parameters:

outpostArn - The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.

Returns:

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

hostMaintenance

Host.Builder hostMaintenance(String hostMaintenance)

Indicates whether host maintenance is enabled or disabled for the Dedicated Host.

Parameters:

hostMaintenance - Indicates whether host maintenance is enabled or disabled for the Dedicated Host.

Returns:

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

See Also:

HostMaintenance, HostMaintenance

hostMaintenance

Host.Builder hostMaintenance(HostMaintenance hostMaintenance)

Indicates whether host maintenance is enabled or disabled for the Dedicated Host.

Parameters:

hostMaintenance - Indicates whether host maintenance is enabled or disabled for the Dedicated Host.

Returns:

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

See Also:

HostMaintenance, HostMaintenance

assetId

Host.Builder assetId(String assetId)

The ID of the Outpost hardware asset on which the Dedicated Host is allocated.

Parameters:

assetId - The ID of the Outpost hardware asset on which the Dedicated Host is allocated.

Returns:

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