ModifyInstancePlacementRequest Class

Container for the parameters to the ModifyInstancePlacement operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.ModifyInstancePlacementRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

public class ModifyInstancePlacementRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The ModifyInstancePlacementRequest type exposes the following members

Constructors

	Name	Description
	ModifyInstancePlacementRequest()

Properties

Name	Type	Description
Affinity	Amazon.EC2.Affinity	Gets and sets the property Affinity. The affinity setting for the instance. For more information, see Host affinity in the Amazon EC2 User Guide.
GroupId	System.String	Gets and sets the property GroupId. 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	System.String	Gets and sets the property GroupName. 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	System.String	Gets and sets the property HostId. The ID of the Dedicated Host with which to associate the instance.
HostResourceGroupArn	System.String	Gets and sets the property HostResourceGroupArn. 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.
InstanceId	System.String	Gets and sets the property InstanceId. The ID of the instance that you are modifying.
PartitionNumber	System.Int32	Gets and sets the property PartitionNumber. The number of the partition in which to place the instance. Valid only if the placement group strategy is set to `partition`.
Tenancy	Amazon.EC2.HostTenancy	Gets and sets the property Tenancy. 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5