Modify Instance Attribute

ec2_modify_instance_attribute

R Documentation

Modifies the specified attribute of the specified instance

Description

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the modify_network_interface_attribute action.

To modify some attributes, the instance must be stopped. For more information, see Modify a stopped instance in the Amazon EC2 User Guide.

Usage

ec2_modify_instance_attribute(SourceDestCheck, Attribute,
  BlockDeviceMappings, DisableApiTermination, DryRun, EbsOptimized,
  EnaSupport, Groups, InstanceId, InstanceInitiatedShutdownBehavior,
  InstanceType, Kernel, Ramdisk, SriovNetSupport, UserData, Value,
  DisableApiStop)

Arguments

SourceDestCheck

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.

Attribute

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

BlockDeviceMappings

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.

DisableApiTermination

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.

DryRun

Checks whether you have the required permissions for the action, 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.

EbsOptimized

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.

EnaSupport

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.

Groups

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.

InstanceId

[required] The ID of the instance.

InstanceInitiatedShutdownBehavior

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

InstanceType

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.

Kernel

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.

Ramdisk

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.

SriovNetSupport

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.

UserData

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.

Value

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

DisableApiStop

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

Value

An empty list.

Request syntax

svc$modify_instance_attribute(
  SourceDestCheck = list(
    Value = TRUE|FALSE
  ),
  Attribute = "instanceType"|"kernel"|"ramdisk"|"userData"|"disableApiTermination"|"instanceInitiatedShutdownBehavior"|"rootDeviceName"|"blockDeviceMapping"|"productCodes"|"sourceDestCheck"|"groupSet"|"ebsOptimized"|"sriovNetSupport"|"enaSupport"|"enclaveOptions"|"disableApiStop",
  BlockDeviceMappings = list(
    list(
      DeviceName = "string",
      Ebs = list(
        DeleteOnTermination = TRUE|FALSE,
        VolumeId = "string"
      ),
      NoDevice = "string",
      VirtualName = "string"
    )
  ),
  DisableApiTermination = list(
    Value = TRUE|FALSE
  ),
  DryRun = TRUE|FALSE,
  EbsOptimized = list(
    Value = TRUE|FALSE
  ),
  EnaSupport = list(
    Value = TRUE|FALSE
  ),
  Groups = list(
    "string"
  ),
  InstanceId = "string",
  InstanceInitiatedShutdownBehavior = list(
    Value = "string"
  ),
  InstanceType = list(
    Value = "string"
  ),
  Kernel = list(
    Value = "string"
  ),
  Ramdisk = list(
    Value = "string"
  ),
  SriovNetSupport = list(
    Value = "string"
  ),
  UserData = list(
    Value = raw
  ),
  Value = "string",
  DisableApiStop = list(
    Value = TRUE|FALSE
  )
)

Examples

## Not run: 
# This example modifies the instance type of the specified stopped
# instance.
svc$modify_instance_attribute(
  InstanceId = "i-1234567890abcdef0",
  InstanceType = list(
    Value = "m5.large"
  )
)

# This example enables enhanced networking for the specified stopped
# instance.
svc$modify_instance_attribute(
  EnaSupport = list(
    Value = TRUE
  ),
  InstanceId = "i-1234567890abcdef0"
)

## End(Not run)