Class: Aws::EC2::Types::InstanceAttribute

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::InstanceAttribute

Defined in:

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

Overview

Describes an instance attribute.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>

  The block device mapping of the instance.

• #disable_api_stop ⇒ Types::AttributeBooleanValue

  To enable the instance for Amazon Web Services Stop Protection, set this parameter to true; otherwise, set it to false.

• #disable_api_termination ⇒ Types::AttributeBooleanValue

  If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

• #ebs_optimized ⇒ Types::AttributeBooleanValue

  Indicates whether the instance is optimized for Amazon EBS I/O.

• #ena_support ⇒ Types::AttributeBooleanValue

  Indicates whether enhanced networking with ENA is enabled.

• #enclave_options ⇒ Types::EnclaveOptions

  To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.

• #groups ⇒ Array<Types::GroupIdentifier>

  The security groups associated with the instance.

• #instance_id ⇒ String

  The ID of the instance.

• #instance_initiated_shutdown_behavior ⇒ Types::AttributeValue

  Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

• #instance_type ⇒ Types::AttributeValue

  The instance type.

• #kernel_id ⇒ Types::AttributeValue

  The kernel ID.

• #product_codes ⇒ Array<Types::ProductCode>

  A list of product codes.

• #ramdisk_id ⇒ Types::AttributeValue

  The RAM disk ID.

• #root_device_name ⇒ Types::AttributeValue

  The device name of the root device volume (for example, /dev/sda1).

• #source_dest_check ⇒ Types::AttributeBooleanValue

  Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives.

• #sriov_net_support ⇒ Types::AttributeValue

  Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

• #user_data ⇒ Types::AttributeValue

  The user data.

Instance Attribute Details

#block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>

The block device mapping of the instance.

Returns:

• (Array<Types::InstanceBlockDeviceMapping>)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#disable_api_stop ⇒ Types::AttributeBooleanValue

To enable the instance for Amazon Web Services Stop Protection, set this parameter to true; otherwise, set it to false.

Returns:

• (Types::AttributeBooleanValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#disable_api_termination ⇒ Types::AttributeBooleanValue

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

Returns:

• (Types::AttributeBooleanValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#ebs_optimized ⇒ Types::AttributeBooleanValue

Indicates whether the instance is optimized for Amazon EBS I/O.

Returns:

• (Types::AttributeBooleanValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#ena_support ⇒ Types::AttributeBooleanValue

Indicates whether enhanced networking with ENA is enabled.

Returns:

• (Types::AttributeBooleanValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#enclave_options ⇒ Types::EnclaveOptions

To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.

Returns:

• (Types::EnclaveOptions)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#groups ⇒ Array<Types::GroupIdentifier>

The security groups associated with the instance.

Returns:

• (Array<Types::GroupIdentifier>)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The ID of the instance.

Returns:

• (String)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#instance_initiated_shutdown_behavior ⇒ Types::AttributeValue

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Returns:

• (Types::AttributeValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ Types::AttributeValue

The instance type.

Returns:

• (Types::AttributeValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#kernel_id ⇒ Types::AttributeValue

The kernel ID.

Returns:

• (Types::AttributeValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#product_codes ⇒ Array<Types::ProductCode>

A list of product codes.

Returns:

• (Array<Types::ProductCode>)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#ramdisk_id ⇒ Types::AttributeValue

The RAM disk ID.

Returns:

• (Types::AttributeValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#root_device_name ⇒ Types::AttributeValue

The device name of the root device volume (for example, /dev/sda1).

Returns:

• (Types::AttributeValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#source_dest_check ⇒ Types::AttributeBooleanValue

Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

Returns:

• (Types::AttributeBooleanValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#sriov_net_support ⇒ Types::AttributeValue

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

Returns:

• (Types::AttributeValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end

#user_data ⇒ Types::AttributeValue

The user data.

Returns:

• (Types::AttributeValue)

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

class InstanceAttribute < Struct.new(
  :groups,
  :block_device_mappings,
  :disable_api_termination,
  :ena_support,
  :enclave_options,
  :ebs_optimized,
  :instance_id,
  :instance_initiated_shutdown_behavior,
  :instance_type,
  :kernel_id,
  :product_codes,
  :ramdisk_id,
  :root_device_name,
  :source_dest_check,
  :sriov_net_support,
  :user_data,
  :disable_api_stop)
  SENSITIVE = []
  include Aws::Structure
end