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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass ModifyInstancePlacementRequest data as a hash:

{
  affinity: "default", # accepts default, host
  group_name: "PlacementGroupName",
  host_id: "DedicatedHostId",
  instance_id: "InstanceId", # required
  tenancy: "dedicated", # accepts dedicated, host
  partition_number: 1,
  host_resource_group_arn: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#affinityString

The affinity setting for the instance.

Returns:

  • (String)


43960
43961
43962
43963
43964
43965
43966
43967
43968
43969
43970
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43960

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

#group_nameString

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)


43960
43961
43962
43963
43964
43965
43966
43967
43968
43969
43970
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43960

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

#host_idString

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

Returns:

  • (String)


43960
43961
43962
43963
43964
43965
43966
43967
43968
43969
43970
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43960

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

#host_resource_group_arnString

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

Returns:

  • (String)


43960
43961
43962
43963
43964
43965
43966
43967
43968
43969
43970
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43960

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

#instance_idString

The ID of the instance that you are modifying.

Returns:

  • (String)


43960
43961
43962
43963
43964
43965
43966
43967
43968
43969
43970
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43960

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

#partition_numberInteger

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

Returns:

  • (Integer)


43960
43961
43962
43963
43964
43965
43966
43967
43968
43969
43970
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43960

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

#tenancyString

The tenancy for the instance.

For T3 instances, you can't change the tenancy from dedicated to host, or from host to dedicated. Attempting to make one of these unsupported tenancy changes results in the InvalidTenancy error code.

Returns:

  • (String)


43960
43961
43962
43963
43964
43965
43966
43967
43968
43969
43970
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 43960

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