Package 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(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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 that 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAffinity

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

The affinity setting for the instance on the Dedicated Host.

This parameter is not supported for CreateFleet or ImportInstance .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-affinity

getAvailabilityZone

@Stability(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 for CreateFleet .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-availabilityzone

getGroupName

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

The name of the placement group that the instance is in.

If you specify GroupName , you can't specify GroupId .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-groupname

getHostId

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

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

This parameter is not supported for CreateFleet or ImportInstance .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-hostid

getHostResourceGroupArn

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

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

If you specify this parameter, either omit the Tenancy parameter or set it to host .

This parameter is not supported for CreateFleet .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-hostresourcegrouparn

getPartitionNumber

@Stability(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 for CreateFleet .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-partitionnumber

getSpreadDomain

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

Reserved for future use.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-spreaddomain

getTenancy

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

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

This parameter is not supported for CreateFleet . The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ec2fleet-placement.html#cfn-ec2-ec2fleet-placement-tenancy

builder

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

Returns:

a CfnEC2Fleet.PlacementProperty.Builder of CfnEC2Fleet.PlacementProperty