java.lang.Object
- software.amazon.awssdk.services.imagebuilder.model.Placement

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Placement.Builder,Placement>
```
@Generated("software.amazon.awssdk:codegen")
public final class Placement
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Placement.Builder,Placement>
```
By default, EC2 instances run on shared tenancy hardware. This means that multiple Amazon Web Services accounts might share the same physical hardware. When you use dedicated hardware, the physical server that hosts your instances is dedicated to your Amazon Web Services account. Instance placement settings contain the details for the physical hardware where instances that Image Builder launches during image creation will run.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Placement.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`availabilityZone()`	The Availability Zone where your build and test instances will launch.
`static Placement.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`hostId()`	The ID of the Dedicated Host on which build and test instances run.
`String`	`hostResourceGroupArn()`	The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Placement.Builder>`	`serializableBuilderClass()`
`TenancyType`	`tenancy()`	The tenancy of the instance.
`String`	`tenancyAsString()`	The tenancy of the instance.
`Placement.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - availabilityZone
```
public final String availabilityZone()
```
    The Availability Zone where your build and test instances will launch.
    
    Returns:
    
    The Availability Zone where your build and test instances will launch.
  - tenancy
```
public final TenancyType tenancy()
```
    The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware. An instance with a tenancy of host runs on a Dedicated Host.
    
    If tenancy is set to host, then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances.
    
    If the service returns an enum value that is not available in the current SDK version, tenancy will return TenancyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().
    
    Returns:
    
    The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware. An instance with a tenancy of host runs on a Dedicated Host.
    
    If tenancy is set to host, then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances.
    
    See Also:
    
    TenancyType
  - tenancyAsString
```
public final String tenancyAsString()
```
    The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware. An instance with a tenancy of host runs on a Dedicated Host.
    
    If tenancy is set to host, then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances.
    
    If the service returns an enum value that is not available in the current SDK version, tenancy will return TenancyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().
    
    Returns:
    
    The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware. An instance with a tenancy of host runs on a Dedicated Host.
    
    If tenancy is set to host, then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don't specify any placement target, Amazon EC2 will try to find an available host for your build and test instances.
    
    See Also:
    
    TenancyType
  - hostId
```
public final String hostId()
```
    The ID of the Dedicated Host on which build and test instances run. This only applies if tenancy is host. If you specify the host ID, you must not specify the resource group ARN. If you specify both, Image Builder returns an error.
    
    Returns:
    
    The ID of the Dedicated Host on which build and test instances run. This only applies if tenancy is host. If you specify the host ID, you must not specify the resource group ARN. If you specify both, Image Builder returns an error.
  - hostResourceGroupArn
```
public final String hostResourceGroupArn()
```
    The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. This only applies if tenancy is host. If you specify the resource group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. This only applies if tenancy is host. If you specify the resource group ARN, you must not specify the host ID. If you specify both, Image Builder returns an error.
  - toBuilder
```
public Placement.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Placement.Builder,Placement>
  - builder
```
public static Placement.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Placement.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Placement

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

availabilityZone

tenancy

tenancyAsString

hostId

hostResourceGroupArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField