Package software.amazon.awscdk.services.ec2

Class PlacementGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ec2.PlacementGroup

All Implemented Interfaces:

IResource, IPlacementGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.231Z")
@Stability(Stable)
public class PlacementGroup
extends Resource
implements IPlacementGroup

Defines a placement group.

Placement groups give you fine-grained control over where your instances are provisioned.

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.*;
 PlacementGroup placementGroup = PlacementGroup.Builder.create(this, "MyPlacementGroup")
         .partitions(123)
         .placementGroupName("placementGroupName")
         .spreadLevel(PlacementGroupSpreadLevel.HOST)
         .strategy(PlacementGroupStrategy.CLUSTER)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PlacementGroup.Builder	A fluent builder for PlacementGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IPlacementGroup

IPlacementGroup.Jsii$Default, IPlacementGroup.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PlacementGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PlacementGroup(software.amazon.jsii.JsiiObjectRef objRef)
	PlacementGroup(software.constructs.Construct scope, String id)
	PlacementGroup(software.constructs.Construct scope, String id, PlacementGroupProps props)

Method Summary

Modifier and Type	Method	Description
static IPlacementGroup	fromPlacementGroupName(software.constructs.Construct scope, String id, String placementGroupName)	Import a PlacementGroup by its arn.
Number	getPartitions()	The number of partitions.
String	getPlacementGroupName()	The name of this placement group.
PlacementGroupSpreadLevel	getSpreadLevel()	Places instances on distinct hardware.
PlacementGroupStrategy	getStrategy()	Which strategy to use when launching instances.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

PlacementGroup

protected PlacementGroup(software.amazon.jsii.JsiiObjectRef objRef)

PlacementGroup

protected PlacementGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

PlacementGroup

@Stability(Stable)
public PlacementGroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 PlacementGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

PlacementGroup

@Stability(Stable)
public PlacementGroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromPlacementGroupName

@Stability(Stable)
@NotNull
public static IPlacementGroup fromPlacementGroupName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String placementGroupName)

Import a PlacementGroup by its arn.

Parameters:

scope - This parameter is required.

id - This parameter is required.

placementGroupName - This parameter is required.

getPlacementGroupName

@Stability(Stable)
@NotNull
public String getPlacementGroupName()

The name of this placement group.

Specified by:

getPlacementGroupName in interface IPlacementGroup

getPartitions

@Stability(Stable)
@Nullable
public Number getPartitions()

The number of partitions.

Valid only when Strategy is set to PARTITION.

Specified by:

getPartitions in interface IPlacementGroup

getSpreadLevel

@Stability(Stable)
@Nullable
public PlacementGroupSpreadLevel getSpreadLevel()

Places instances on distinct hardware.

Spread placement groups are recommended for applications that have a small number of critical instances that should be kept separate from each other. Launching instances in a spread level placement group reduces the risk of simultaneous failures that might occur when instances share the same equipment. Spread level placement groups provide access to distinct hardware, and are therefore suitable for mixing instance types or launching instances over time. If you start or launch an instance in a spread placement group and there is insufficient unique hardware to fulfill the request, the request fails. Amazon EC2 makes more distinct hardware available over time, so you can try your request again later. Placement groups can spread instances across racks or hosts. You can use host level spread placement groups only with AWS Outposts.

Specified by:

getSpreadLevel in interface IPlacementGroup

getStrategy

@Stability(Stable)
@Nullable
public PlacementGroupStrategy getStrategy()

Which strategy to use when launching instances.

Specified by:

getStrategy in interface IPlacementGroup