You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::Placement

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::Placement

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

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

{
  availability_zone: "String",
  affinity: "String",
  group_name: "String",
  partition_number: 1,
  host_id: "String",
  tenancy: "default", # accepts default, dedicated, host
  spread_domain: "String",
  host_resource_group_arn: "String",
}

Describes the placement of an instance.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #affinity ⇒ String

  The affinity setting for the instance on the Dedicated Host.

• #availability_zone ⇒ String

  The Availability Zone of the instance.

• #group_name ⇒ String

  The name of the placement group the instance is in.

• #host_id ⇒ String

  The ID of the Dedicated Host on which the instance resides.

• #host_resource_group_arn ⇒ String

  The ARN of the host resource group in which to launch the instances.

• #partition_number ⇒ Integer

  The number of the partition the instance is in.

• #spread_domain ⇒ String

  Reserved for future use.

• #tenancy ⇒ String

  The tenancy of the instance (if the instance is running in a VPC).

Instance Attribute Details

#affinity ⇒ String

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

Returns:

• (String)

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

class Placement < Struct.new(
  :availability_zone,
  :affinity,
  :group_name,
  :partition_number,
  :host_id,
  :tenancy,
  :spread_domain,
  :host_resource_group_arn)
  include Aws::Structure
end

#availability_zone ⇒ String

The Availability Zone of the instance.

If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

Returns:

• (String)

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

class Placement < Struct.new(
  :availability_zone,
  :affinity,
  :group_name,
  :partition_number,
  :host_id,
  :tenancy,
  :spread_domain,
  :host_resource_group_arn)
  include Aws::Structure
end

#group_name ⇒ String

The name of the placement group the instance is in.

Returns:

• (String)

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

class Placement < Struct.new(
  :availability_zone,
  :affinity,
  :group_name,
  :partition_number,
  :host_id,
  :tenancy,
  :spread_domain,
  :host_resource_group_arn)
  include Aws::Structure
end

#host_id ⇒ String

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

Returns:

• (String)

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

class Placement < Struct.new(
  :availability_zone,
  :affinity,
  :group_name,
  :partition_number,
  :host_id,
  :tenancy,
  :spread_domain,
  :host_resource_group_arn)
  include Aws::Structure
end

#host_resource_group_arn ⇒ String

The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.

Returns:

• (String)

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

class Placement < Struct.new(
  :availability_zone,
  :affinity,
  :group_name,
  :partition_number,
  :host_id,
  :tenancy,
  :spread_domain,
  :host_resource_group_arn)
  include Aws::Structure
end

#partition_number ⇒ Integer

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

Returns:

• (Integer)

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

class Placement < Struct.new(
  :availability_zone,
  :affinity,
  :group_name,
  :partition_number,
  :host_id,
  :tenancy,
  :spread_domain,
  :host_resource_group_arn)
  include Aws::Structure
end

#spread_domain ⇒ String

Reserved for future use.

Returns:

• (String)

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

class Placement < Struct.new(
  :availability_zone,
  :affinity,
  :group_name,
  :partition_number,
  :host_id,
  :tenancy,
  :spread_domain,
  :host_resource_group_arn)
  include Aws::Structure
end

#tenancy ⇒ String

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

Returns:

• (String)

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

class Placement < Struct.new(
  :availability_zone,
  :affinity,
  :group_name,
  :partition_number,
  :host_id,
  :tenancy,
  :spread_domain,
  :host_resource_group_arn)
  include Aws::Structure
end