Skip to content

/AWS1/CL_EC2=>MODIFYINSTANCEPLACEMENT()

About ModifyInstancePlacement

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.

Method Signature

IMPORTING

Required arguments:

IV_INSTANCEID TYPE /AWS1/EC2INSTANCEID /AWS1/EC2INSTANCEID

The ID of the instance that you are modifying.

Optional arguments:

IV_AFFINITY TYPE /AWS1/EC2AFFINITY /AWS1/EC2AFFINITY

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

IV_GROUPNAME TYPE /AWS1/EC2PLACEMENTGROUPNAME /AWS1/EC2PLACEMENTGROUPNAME

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 ("").

IV_HOSTID TYPE /AWS1/EC2DEDICATEDHOSTID /AWS1/EC2DEDICATEDHOSTID

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

IV_TENANCY TYPE /AWS1/EC2HOSTTENANCY /AWS1/EC2HOSTTENANCY

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.

IV_PARTITIONNUMBER TYPE /AWS1/EC2INTEGER /AWS1/EC2INTEGER

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

IV_HOSTRESOURCEGROUPARN TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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.

IV_GROUPID TYPE /AWS1/EC2PLACEMENTGROUPID /AWS1/EC2PLACEMENTGROUPID

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_EC2MDFYINSTPLCMTRSLT /AWS1/CL_EC2MDFYINSTPLCMTRSLT