PlacementGroup class

Provides an EC2 placement group. Read more about placement groups in AWS Docs.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const web = new aws.ec2.PlacementGroup("web", {
    name: "hunky-dory-pg",
    strategy: aws.ec2.PlacementStrategy.Cluster,
});
import pulumi
import pulumi_aws as aws

web = aws.ec2.PlacementGroup("web",
    name="hunky-dory-pg",
    strategy=aws.ec2.PlacementStrategy.CLUSTER)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var web = new Aws.Ec2.PlacementGroup("web", new()
    {
        Name = "hunky-dory-pg",
        Strategy = Aws.Ec2.PlacementStrategy.Cluster,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewPlacementGroup(ctx, "web", &ec2.PlacementGroupArgs{
			Name:     pulumi.String("hunky-dory-pg"),
			Strategy: pulumi.String(ec2.PlacementStrategyCluster),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_placementgroup" "web" {
  name     = "hunky-dory-pg"
  strategy = "cluster"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.PlacementGroup;
import com.pulumi.aws.ec2.PlacementGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var web = new PlacementGroup("web", PlacementGroupArgs.builder()
            .name("hunky-dory-pg")
            .strategy("cluster")
            .build());

    }
}
resources:
  web:
    type: aws:ec2:PlacementGroup
    properties:
      name: hunky-dory-pg
      strategy: cluster

Import

Using pulumi import, import placement groups using the name. For example:

$ pulumi import aws:ec2/placementGroup:PlacementGroup prod_pg production-placement-group

Constructors

PlacementGroup(String name, {PlacementGroupArgs? args, CustomResourceOptions? options})
Creates a new PlacementGroup. name The Pulumi resource name. args Arguments used to configure this PlacementGroup. The set of arguments for PlacementGroup. options Resource options controlling this resource's behavior.
PlacementGroup.reference(String urn)
Creates a typed reference to an existing PlacementGroup resource.

Properties

arn ↔ Output<String>
ARN of the placement group.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name of the placement group.
latefinal
partitionCount ↔ Output<int>
The number of partitions to create in the placement group. Can only be specified when the strategy is set to partition. Must be at least 1. (default is 2).
latefinal
placementGroupId ↔ Output<String>
The ID of the placement group.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spreadLevel ↔ Output<String>
Determines how placement groups spread instances. Can only be used when the strategy is set to spread. Can be host or rack. host can only be used for Outpost placement groups. Defaults to rack.
latefinal
strategy ↔ Output<String>
The placement strategy. Can be cluster, partition or spread.
latefinal
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {PlacementGroupState? state, CustomResourceOptions? options}) → PlacementGroup
Gets an existing PlacementGroup resource's state with the given name and id.