Package software.amazon.awscdk.services.ec2

Interface CfnLaunchTemplate.PlacementProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchTemplate.PlacementProperty.Jsii$Proxy

Enclosing class:

CfnLaunchTemplate

@Stability(Stable)
public static interface CfnLaunchTemplate.PlacementProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the placement of an instance.

Placement is a property of AWS::EC2::LaunchTemplate LaunchTemplateData .

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")
         .groupId("groupId")
         .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-launchtemplate-placement.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnLaunchTemplate.PlacementProperty.Builder	builder()
default String	getAffinity()	The affinity setting for an instance on a Dedicated Host.
default String	getAvailabilityZone()	The Availability Zone for the instance.
default String	getGroupId()	The Group Id of a placement group.
default String	getGroupName()	The name of the placement group for the instance.
default String	getHostId()	The ID of the Dedicated Host for the instance.
default String	getHostResourceGroupArn()	The ARN of the host resource group in which to launch the instances.
default Number	getPartitionNumber()	The number of the partition the instance should launch 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 an instance on a Dedicated Host.

See Also:

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

getAvailabilityZone

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

The Availability Zone for the instance.

See Also:

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

getGroupId

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

The Group Id of a placement group.

You must specify the Placement Group Group Id to launch an instance in a shared placement group.

See Also:

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

getGroupName

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

The name of the placement group for the instance.

See Also:

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

getHostId

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

The ID of the Dedicated Host for the instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-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 a host resource group ARN, omit the Tenancy parameter or set it to host .

See Also:

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

getPartitionNumber

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

The number of the partition the instance should launch in.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-placement.html#cfn-ec2-launchtemplate-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-launchtemplate-placement.html#cfn-ec2-launchtemplate-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.

See Also:

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

builder

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

Returns:

a CfnLaunchTemplate.PlacementProperty.Builder of CfnLaunchTemplate.PlacementProperty