ModifyInstancePlacementCommand

Suggest an Edit

Modifies the placement attributes for a specified instance. You can do the following:

  • Modify the affinity between an instance and a Dedicated Host . When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is started, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.

  • Change the Dedicated Host with which an instance is associated.

  • Change the instance tenancy of an instance.

  • Move an instance to or from a placement group .

At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.

To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, ModifyInstancePlacementCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, ModifyInstancePlacementCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // ModifyInstancePlacementRequest
  GroupName: "STRING_VALUE",
  PartitionNumber: Number("int"),
  HostResourceGroupArn: "STRING_VALUE",
  GroupId: "STRING_VALUE",
  InstanceId: "STRING_VALUE", // required
  Tenancy: "default" || "dedicated" || "host",
  Affinity: "default" || "host",
  HostId: "STRING_VALUE",
};
const command = new ModifyInstancePlacementCommand(input);
const response = await client.send(command);
// { // ModifyInstancePlacementResult
//   Return: true || false,
// };

ModifyInstancePlacementCommand Input

See ModifyInstancePlacementCommandInput for more details

Parameter
Type
Description
InstanceId
Required
string | undefined

The ID of the instance that you are modifying.

Affinity
Affinity | undefined

The affinity setting for the instance. For more information, see Host affinity  in the Amazon EC2 User Guide.

GroupId
string | undefined

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

GroupName
string | undefined

The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.

To remove an instance from a placement group, specify an empty string ("").

HostId
string | undefined

The ID of the Dedicated Host with which to associate the instance.

HostResourceGroupArn
string | undefined

The ARN of the host resource group in which to place the instance. The instance must have a tenancy of host to specify this parameter.

PartitionNumber
number | undefined

The number of the partition in which to place the instance. Valid only if the placement group strategy is set to partition.

Tenancy
HostTenancy | undefined

The tenancy for the instance.

For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of host. You can't change the tenancy from host to dedicated or default. Attempting to make one of these unsupported tenancy changes results in an InvalidRequest error code.

ModifyInstancePlacementCommand Output

See ModifyInstancePlacementCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Return
boolean | undefined

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

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.