Skip to content

/AWS1/IF_EC2=>MODIFYINSTANCEATTRIBUTE()

About ModifyInstanceAttribute

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 ModifyNetworkInterfaceAttribute action.

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

Method Signature

METHODS /AWS1/IF_EC2~MODIFYINSTANCEATTRIBUTE
  IMPORTING
    !IO_SOURCEDESTCHECK TYPE REF TO /AWS1/CL_EC2ATTRBOOLEANVALUE OPTIONAL
    !IO_DISABLEAPISTOP TYPE REF TO /AWS1/CL_EC2ATTRBOOLEANVALUE OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_INSTANCEID TYPE /AWS1/EC2INSTANCEID OPTIONAL
    !IV_ATTRIBUTE TYPE /AWS1/EC2INSTANCEATTRIBUTENAME OPTIONAL
    !IV_VALUE TYPE /AWS1/EC2STRING OPTIONAL
    !IT_BLOCKDEVICEMAPPINGS TYPE /AWS1/CL_EC2INSTBLKDEVMAPSPEC=>TT_INSTBLOCKDEVICEMAPSPECLIST OPTIONAL
    !IO_DISABLEAPITERMINATION TYPE REF TO /AWS1/CL_EC2ATTRBOOLEANVALUE OPTIONAL
    !IO_INSTANCETYPE TYPE REF TO /AWS1/CL_EC2ATTRIBUTEVALUE OPTIONAL
    !IO_KERNEL TYPE REF TO /AWS1/CL_EC2ATTRIBUTEVALUE OPTIONAL
    !IO_RAMDISK TYPE REF TO /AWS1/CL_EC2ATTRIBUTEVALUE OPTIONAL
    !IO_USERDATA TYPE REF TO /AWS1/CL_EC2BLOBATTRIBUTEVALUE OPTIONAL
    !IO_INSTINITIATEDSHUTDOWNBE00 TYPE REF TO /AWS1/CL_EC2ATTRIBUTEVALUE OPTIONAL
    !IT_GROUPS TYPE /AWS1/CL_EC2GROUPIDSTRLIST_W=>TT_GROUPIDSTRINGLIST OPTIONAL
    !IO_EBSOPTIMIZED TYPE REF TO /AWS1/CL_EC2ATTRBOOLEANVALUE OPTIONAL
    !IO_SRIOVNETSUPPORT TYPE REF TO /AWS1/CL_EC2ATTRIBUTEVALUE OPTIONAL
    !IO_ENASUPPORT TYPE REF TO /AWS1/CL_EC2ATTRBOOLEANVALUE OPTIONAL
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_instanceid TYPE /AWS1/EC2INSTANCEID /AWS1/EC2INSTANCEID

The ID of the instance.

Optional arguments:

io_sourcedestcheck TYPE REF TO /AWS1/CL_EC2ATTRBOOLEANVALUE /AWS1/CL_EC2ATTRBOOLEANVALUE

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.

io_disableapistop TYPE REF TO /AWS1/CL_EC2ATTRBOOLEANVALUE /AWS1/CL_EC2ATTRBOOLEANVALUE

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

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

iv_attribute TYPE /AWS1/EC2INSTANCEATTRIBUTENAME /AWS1/EC2INSTANCEATTRIBUTENAME

The name of the attribute to modify.

When changing the instance type: If the original instance type is configured for configurable bandwidth, and the desired instance type doesn't support configurable bandwidth, first set the existing bandwidth configuration to default using the ModifyInstanceNetworkPerformanceOptions operation.

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

iv_value TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

it_blockdevicemappings TYPE /AWS1/CL_EC2INSTBLKDEVMAPSPEC=>TT_INSTBLOCKDEVICEMAPSPECLIST TT_INSTBLOCKDEVICEMAPSPECLIST

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 Amazon Web Services-managed resources.

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.

io_disableapitermination TYPE REF TO /AWS1/CL_EC2ATTRBOOLEANVALUE /AWS1/CL_EC2ATTRBOOLEANVALUE

Enable or disable termination protection for the instance. If the value is true, you can't terminate the instance using the Amazon EC2 console, command line interface, or API. You can't enable termination protection for Spot Instances.

io_instancetype TYPE REF TO /AWS1/CL_EC2ATTRIBUTEVALUE /AWS1/CL_EC2ATTRIBUTEVALUE

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.

io_kernel TYPE REF TO /AWS1/CL_EC2ATTRIBUTEVALUE /AWS1/CL_EC2ATTRIBUTEVALUE

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.

io_ramdisk TYPE REF TO /AWS1/CL_EC2ATTRIBUTEVALUE /AWS1/CL_EC2ATTRIBUTEVALUE

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.

io_userdata TYPE REF TO /AWS1/CL_EC2BLOBATTRIBUTEVALUE /AWS1/CL_EC2BLOBATTRIBUTEVALUE

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.

io_instinitiatedshutdownbe00 TYPE REF TO /AWS1/CL_EC2ATTRIBUTEVALUE /AWS1/CL_EC2ATTRIBUTEVALUE

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

it_groups TYPE /AWS1/CL_EC2GROUPIDSTRLIST_W=>TT_GROUPIDSTRINGLIST TT_GROUPIDSTRINGLIST

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.

io_ebsoptimized TYPE REF TO /AWS1/CL_EC2ATTRBOOLEANVALUE /AWS1/CL_EC2ATTRBOOLEANVALUE

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.

io_sriovnetsupport TYPE REF TO /AWS1/CL_EC2ATTRIBUTEVALUE /AWS1/CL_EC2ATTRIBUTEVALUE

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.

io_enasupport TYPE REF TO /AWS1/CL_EC2ATTRBOOLEANVALUE /AWS1/CL_EC2ATTRBOOLEANVALUE

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.

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->modifyinstanceattribute(
  io_disableapistop = new /aws1/cl_ec2attrbooleanvalue( ABAP_TRUE )
  io_disableapitermination = new /aws1/cl_ec2attrbooleanvalue( ABAP_TRUE )
  io_ebsoptimized = new /aws1/cl_ec2attrbooleanvalue( ABAP_TRUE )
  io_enasupport = new /aws1/cl_ec2attrbooleanvalue( ABAP_TRUE )
  io_instancetype = new /aws1/cl_ec2attributevalue( |string| )
  io_instinitiatedshutdownbe00 = new /aws1/cl_ec2attributevalue( |string| )
  io_kernel = new /aws1/cl_ec2attributevalue( |string| )
  io_ramdisk = new /aws1/cl_ec2attributevalue( |string| )
  io_sourcedestcheck = new /aws1/cl_ec2attrbooleanvalue( ABAP_TRUE )
  io_sriovnetsupport = new /aws1/cl_ec2attributevalue( |string| )
  io_userdata = new /aws1/cl_ec2blobattributevalue( '5347567362473873563239796247513D' )
  it_blockdevicemappings = VALUE /aws1/cl_ec2instblkdevmapspec=>tt_instblockdevicemapspeclist(
    (
      new /aws1/cl_ec2instblkdevmapspec(
        io_ebs = new /aws1/cl_ec2ebsinstblkdevspec(
          iv_deleteontermination = ABAP_TRUE
          iv_volumeid = |string|
        )
        iv_devicename = |string|
        iv_nodevice = |string|
        iv_virtualname = |string|
      )
    )
  )
  it_groups = VALUE /aws1/cl_ec2groupidstrlist_w=>tt_groupidstringlist(
    ( new /aws1/cl_ec2groupidstrlist_w( |string| ) )
  )
  iv_attribute = |string|
  iv_dryrun = ABAP_TRUE
  iv_instanceid = |string|
  iv_value = |string|
).

To enable enhanced networking

This example enables enhanced networking for the specified stopped instance.

lo_client->modifyinstanceattribute(
  io_enasupport = new /aws1/cl_ec2attrbooleanvalue( ABAP_TRUE )
  iv_instanceid = |i-1234567890abcdef0|
).

To modify the instance type

This example modifies the instance type of the specified stopped instance.

lo_client->modifyinstanceattribute(
  io_instancetype = new /aws1/cl_ec2attributevalue( |m5.large| )
  iv_instanceid = |i-1234567890abcdef0|
).