Interface IPlacementGroupProps

Props for a PlacementGroup.

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IPlacementGroupProps

Syntax (vb)

Public Interface IPlacementGroupProps

Remarks

ExampleMetadata: fixture=with-vpc infused

Examples

InstanceType instanceType;


var pg = new PlacementGroup(this, "test-pg", new PlacementGroupProps {
    Strategy = PlacementGroupStrategy.SPREAD
});

new Instance(this, "Instance", new InstanceProps {
    Vpc = vpc,
    InstanceType = instanceType,
    MachineImage = MachineImage.LatestAmazonLinux2023(),
    PlacementGroup = pg
});

Synopsis

Properties

Partitions	The number of partitions.
PlacementGroupName	the name of this placement group.
SpreadLevel	Places instances on distinct hardware.
Strategy	Which strategy to use when launching instances.

Properties

Partitions

The number of partitions.

virtual Nullable<double> Partitions { get; }

Property Value

System.Nullable<System.Double>

Remarks

Valid only when Strategy is set to partition.

Default: 0

PlacementGroupName

the name of this placement group.

virtual string PlacementGroupName { get; }

Property Value

System.String

Remarks

Default: - generated by CFN

Attribute: true

SpreadLevel

Places instances on distinct hardware.

virtual Nullable<PlacementGroupSpreadLevel> SpreadLevel { get; }

Property Value

System.Nullable<PlacementGroupSpreadLevel>

Remarks

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.

Default: - no spread level

Strategy

Which strategy to use when launching instances.

virtual Nullable<PlacementGroupStrategy> Strategy { get; }

Property Value

System.Nullable<PlacementGroupStrategy>

Remarks

Default: - PlacementGroupStrategy.PARTITION if partitions is defined, CLUSTER otherwise