software.amazon.awscdk.services.ec2

Interface CfnEC2Fleet.PlacementProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEC2Fleet.PlacementProperty.Jsii$Proxy

Enclosing class:

CfnEC2Fleet

@Stability(value=Stable)
public static interface CfnEC2Fleet.PlacementProperty
extends software.amazon.jsii.JsiiSerializable

Describes the placement of an instance.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 PlacementProperty placementProperty = PlacementProperty.builder()
         .affinity("affinity")
         .availabilityZone("availabilityZone")
         .groupName("groupName")
         .hostId("hostId")
         .hostResourceGroupArn("hostResourceGroupArn")
         .partitionNumber(123)
         .spreadDomain("spreadDomain")
         .tenancy("tenancy")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnEC2Fleet.PlacementProperty.Builder A builder for CfnEC2Fleet.PlacementProperty
static class	CfnEC2Fleet.PlacementProperty.Jsii$Proxy An implementation for CfnEC2Fleet.PlacementProperty

Method Summary

Modifier and Type	Method and Description
static CfnEC2Fleet.PlacementProperty.Builder	builder()
default String	getAffinity() The affinity setting for the instance on the Dedicated Host.
default String	getAvailabilityZone() The Availability Zone of the instance.
default String	getGroupName() The name of the placement group the instance is in.
default String	getHostId() The ID of the Dedicated Host on which the instance resides.
default String	getHostResourceGroupArn() The ARN of the host resource group in which to launch the instances.
default Number	getPartitionNumber() The number of the partition that the instance is in.
default String	getSpreadDomain() Reserved for future use.
default String	getTenancy() The tenancy of the instance (if the instance is running in a VPC).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAffinity

@Stability(value=Stable)
 @Nullable
default String getAffinity()

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) command.

This parameter is not supported by CreateFleet .

getAvailabilityZone

@Stability(value=Stable)
 @Nullable
default String getAvailabilityZone()

The Availability Zone of the instance.

If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

This parameter is not supported by CreateFleet .

getGroupName

@Stability(value=Stable)
 @Nullable
default String getGroupName()

The name of the placement group the instance is in.

getHostId

@Stability(value=Stable)
 @Nullable
default String getHostId()

The ID of the Dedicated Host on which the instance resides.

This parameter is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet .

getHostResourceGroupArn

@Stability(value=Stable)
 @Nullable
default String getHostResourceGroupArn()

The ARN of the host resource group in which to launch the instances.

If you specify a host resource group ARN, omit the Tenancy parameter or set it to host .

This parameter is not supported by CreateFleet .

getPartitionNumber

@Stability(value=Stable)
 @Nullable
default Number getPartitionNumber()

The number of the partition that the instance is in.

Valid only if the placement group strategy is set to partition .

This parameter is not supported by CreateFleet .

getSpreadDomain

@Stability(value=Stable)
 @Nullable
default String getSpreadDomain()

Reserved for future use.

This parameter is not supported by CreateFleet .

getTenancy

@Stability(value=Stable)
 @Nullable
default String getTenancy()

The tenancy of the instance (if the instance is running in a VPC).

An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

This parameter is not supported by CreateFleet .

T3 instances that use the unlimited CPU credit option do not support host tenancy.

builder

@Stability(value=Stable)
static CfnEC2Fleet.PlacementProperty.Builder builder()

Returns:

a CfnEC2Fleet.PlacementProperty.Builder of CfnEC2Fleet.PlacementProperty