Class: Aws::EC2::Types::ModifyInstanceAttributeRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ModifyInstanceAttributeRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attribute ⇒ String

  The name of the attribute to modify.

• #block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMappingSpecification>

  Modifies the ‘DeleteOnTermination` attribute for volumes that are currently attached.

• #disable_api_stop ⇒ Types::AttributeBooleanValue

  Indicates whether an instance is enabled for stop protection.

• #disable_api_termination ⇒ Types::AttributeBooleanValue

  If the value is ‘true`, you can’t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response.

• #ebs_optimized ⇒ Types::AttributeBooleanValue

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

• #ena_support ⇒ Types::AttributeBooleanValue

  Set to ‘true` to enable enhanced networking with ENA for the instance.

• #groups ⇒ Array<String>

  Replaces the security groups of the instance with the specified security groups.

• #instance_id ⇒ String

  The ID of the instance.

• #instance_initiated_shutdown_behavior ⇒ Types::AttributeValue

  Specifies 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

  Changes the instance type to the specified value.

• #kernel ⇒ Types::AttributeValue

  Changes the instance’s kernel to the specified value.

• #ramdisk ⇒ Types::AttributeValue

  Changes the instance’s RAM disk to the specified value.

• #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

  Set to ‘simple` to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

• #user_data ⇒ Types::BlobAttributeValue

  Changes the instance’s user data to the specified value.

• #value ⇒ String

  A new value for the attribute.

Instance Attribute Details

#attribute ⇒ String

The name of the attribute to modify.

You can modify the following attributes only: ‘disableApiTermination` | `instanceType` | `kernel` | `ramdisk` | `instanceInitiatedShutdownBehavior` | `blockDeviceMapping` | `userData` | `sourceDestCheck` | `groupSet` | `ebsOptimized` | `sriovNetSupport` | `enaSupport` | `nvmeSupport` | `disableApiStop` | `enclaveOptions`

Returns:

• (String)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMappingSpecification>

Modifies the ‘DeleteOnTermination` attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for `DeleteOnTermination`, the default is `true` and the volume is deleted when the instance is terminated. You can’t modify the ‘DeleteOnTermination` attribute for volumes that are attached to Fargate tasks.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see [Update the block device mapping when launching an instance] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM

Returns:

• (Array<Types::InstanceBlockDeviceMappingSpecification>)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#disable_api_stop ⇒ Types::AttributeBooleanValue

Indicates whether an instance is enabled for stop protection. For more information, see [Enable stop protection for your instance].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html

Returns:

• (Types::AttributeBooleanValue)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#disable_api_termination ⇒ Types::AttributeBooleanValue

If the value is ‘true`, you can’t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.

Returns:

• (Types::AttributeBooleanValue)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ Boolean

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

• (Boolean)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#ebs_optimized ⇒ Types::AttributeBooleanValue

Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Returns:

• (Types::AttributeBooleanValue)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#ena_support ⇒ Types::AttributeBooleanValue

Set to ‘true` to enable enhanced networking with ENA for the instance.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

Returns:

• (Types::AttributeBooleanValue)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#groups ⇒ Array<String>

Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it’s just the default security group for the VPC.

Returns:

• (Array<String>)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The ID of the instance.

Returns:

• (String)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#instance_initiated_shutdown_behavior ⇒ Types::AttributeValue

Specifies 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 'lib/aws-sdk-ec2/types.rb', line 51374

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ Types::AttributeValue

Changes the instance type to the specified value. For more information, see [Instance types] in the *Amazon EC2 User Guide*. If the instance type is not valid, the error returned is ‘InvalidInstanceAttributeValue`.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html

Returns:

• (Types::AttributeValue)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#kernel ⇒ Types::AttributeValue

Changes the instance’s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html

Returns:

• (Types::AttributeValue)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#ramdisk ⇒ Types::AttributeValue

Changes the instance’s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html

Returns:

• (Types::AttributeValue)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  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 'lib/aws-sdk-ec2/types.rb', line 51374

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#sriov_net_support ⇒ Types::AttributeValue

Set to ‘simple` to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

Returns:

• (Types::AttributeValue)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#user_data ⇒ Types::BlobAttributeValue

Changes the instance’s user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you’re using, the base64-encoding might be performed for you. For more information, see [Work with instance user data].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html

Returns:

• (Types::BlobAttributeValue)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ String

A new value for the attribute. Use only with the ‘kernel`, `ramdisk`, `userData`, `disableApiTermination`, or `instanceInitiatedShutdownBehavior` attribute.

Returns:

• (String)

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

class ModifyInstanceAttributeRequest < Struct.new(
  :source_dest_check,
  :disable_api_stop,
  :dry_run,
  :instance_id,
  :attribute,
  :value,
  :block_device_mappings,
  :disable_api_termination,
  :instance_type,
  :kernel,
  :ramdisk,
  :user_data,
  :instance_initiated_shutdown_behavior,
  :groups,
  :ebs_optimized,
  :sriov_net_support,
  :ena_support)
  SENSITIVE = []
  include Aws::Structure
end