Class: Aws::EC2::Types::ModifyInstancePlacementRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ModifyInstancePlacementRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #affinity ⇒ String

  The affinity setting for the instance.

• #group_id ⇒ String

  The Group Id of a placement group.

• #group_name ⇒ String

  The name of the placement group in which to place the instance.

• #host_id ⇒ String

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

• #host_resource_group_arn ⇒ String

  The ARN of the host resource group in which to place the instance.

• #instance_id ⇒ String

  The ID of the instance that you are modifying.

• #partition_number ⇒ Integer

  The number of the partition in which to place the instance.

• #tenancy ⇒ String

  The tenancy for the instance.

Instance Attribute Details

#affinity ⇒ String

The affinity setting for the instance. For more information, see

Host affinity][1

in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-affinity

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 51725

class ModifyInstancePlacementRequest < Struct.new(
  :group_name,
  :partition_number,
  :host_resource_group_arn,
  :group_id,
  :instance_id,
  :tenancy,
  :affinity,
  :host_id)
  SENSITIVE = []
  include Aws::Structure
end

#group_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 51725

class ModifyInstancePlacementRequest < Struct.new(
  :group_name,
  :partition_number,
  :host_resource_group_arn,
  :group_id,
  :instance_id,
  :tenancy,
  :affinity,
  :host_id)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ String

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 (“”).

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 51725

class ModifyInstancePlacementRequest < Struct.new(
  :group_name,
  :partition_number,
  :host_resource_group_arn,
  :group_id,
  :instance_id,
  :tenancy,
  :affinity,
  :host_id)
  SENSITIVE = []
  include Aws::Structure
end

#host_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 51725

class ModifyInstancePlacementRequest < Struct.new(
  :group_name,
  :partition_number,
  :host_resource_group_arn,
  :group_id,
  :instance_id,
  :tenancy,
  :affinity,
  :host_id)
  SENSITIVE = []
  include Aws::Structure
end

#host_resource_group_arn ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 51725

class ModifyInstancePlacementRequest < Struct.new(
  :group_name,
  :partition_number,
  :host_resource_group_arn,
  :group_id,
  :instance_id,
  :tenancy,
  :affinity,
  :host_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The ID of the instance that you are modifying.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 51725

class ModifyInstancePlacementRequest < Struct.new(
  :group_name,
  :partition_number,
  :host_resource_group_arn,
  :group_id,
  :instance_id,
  :tenancy,
  :affinity,
  :host_id)
  SENSITIVE = []
  include Aws::Structure
end

#partition_number ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 51725

class ModifyInstancePlacementRequest < Struct.new(
  :group_name,
  :partition_number,
  :host_resource_group_arn,
  :group_id,
  :instance_id,
  :tenancy,
  :affinity,
  :host_id)
  SENSITIVE = []
  include Aws::Structure
end

#tenancy ⇒ String

The tenancy for the instance.

<note markdown=“1”> 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.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 51725

class ModifyInstancePlacementRequest < Struct.new(
  :group_name,
  :partition_number,
  :host_resource_group_arn,
  :group_id,
  :instance_id,
  :tenancy,
  :affinity,
  :host_id)
  SENSITIVE = []
  include Aws::Structure
end