Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

CreatePlacementGroup

Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.

A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.

For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

GroupName

A name for the placement group. Must be unique within the scope of your account for the Region.

Constraints: Up to 255 ASCII characters

Type: String

Required: No

PartitionCount

The number of partitions. Valid only when Strategy is set to partition.

Type: Integer

Required: No

Strategy

The placement strategy.

Type: String

Valid Values: cluster | spread | partition

Required: No

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

return

Is true if the request succeeds, and an error otherwise.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Examples

Example

This example creates a cluster placement group named XYZ-cluster.

Sample Request

https://ec2.amazonaws.com/?Action=CreatePlacementGroup &GroupName=XYZ-cluster &Strategy=cluster &AUTHPARAMS

Sample Response

<CreatePlacementGroupResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestId> <return>true</return> </CreatePlacementGroupResponse>

Example

This example creates a partition placement group named HDFS-Group-A with five partitions.

Sample Request

https://ec2.amazonaws.com/?Action=CreatePlacementGroup &GroupName=HDFS-Group-A &Strategy=partition &PartitionCount=5 &AUTHPARAMS

Sample Response

<CreatePlacementGroupResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>a1b2c3d4-82c2-4ea5-adfe-a9cc3EXAMPLE</requestId> <return>true</return> </CreatePlacementGroupResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: