EC2 / Client / modify_instance_attribute

modify_instance_attribute

EC2.Client.modify_instance_attribute(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.modify_instance_attribute(
    SourceDestCheck={
        'Value': True|False
    },
    Attribute='instanceType'|'kernel'|'ramdisk'|'userData'|'disableApiTermination'|'instanceInitiatedShutdownBehavior'|'rootDeviceName'|'blockDeviceMapping'|'productCodes'|'sourceDestCheck'|'groupSet'|'ebsOptimized'|'sriovNetSupport'|'enaSupport'|'enclaveOptions'|'disableApiStop',
    BlockDeviceMappings=[
        {
            'DeviceName': 'string',
            'Ebs': {
                'DeleteOnTermination': True|False,
                'VolumeId': 'string'
            },
            'NoDevice': 'string',
            'VirtualName': 'string'
        },
    ],
    DisableApiTermination={
        'Value': True|False
    },
    DryRun=True|False,
    EbsOptimized={
        'Value': True|False
    },
    EnaSupport={
        'Value': True|False
    },
    Groups=[
        'string',
    ],
    InstanceId='string',
    InstanceInitiatedShutdownBehavior={
        'Value': 'string'
    },
    InstanceType={
        'Value': 'string'
    },
    Kernel={
        'Value': 'string'
    },
    Ramdisk={
        'Value': 'string'
    },
    SriovNetSupport={
        'Value': 'string'
    },
    UserData={
        'Value': b'bytes'
    },
    Value='string',
    DisableApiStop={
        'Value': True|False
    }
)

Parameters:

• SourceDestCheck (dict) –

  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.

  • Value (boolean) –

    The attribute value. The valid values are true or false.

• Attribute (string) –

  The name of the attribute to modify.

  Warning

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

• BlockDeviceMappings (list) –

  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.

  • (dict) –

    Describes a block device mapping entry.

    • DeviceName (string) –

      The device name (for example, /dev/sdh or xvdh).

    • Ebs (dict) –

      Parameters used to automatically set up EBS volumes when the instance is launched.

      • DeleteOnTermination (boolean) –

        Indicates whether the volume is deleted on instance termination.

      • VolumeId (string) –

        The ID of the EBS volume.

    • NoDevice (string) –

      suppress the specified device included in the block device mapping.

    • VirtualName (string) –

      The virtual device name.

• DisableApiTermination (dict) –

  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.

  • Value (boolean) –

    The attribute value. The valid values are true or false.

• DryRun (boolean) – 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 (dict) –

  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.

  • Value (boolean) –

    The attribute value. The valid values are true or false.

• EnaSupport (dict) –

  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.

  • Value (boolean) –

    The attribute value. The valid values are true or false.

• Groups (list) –

  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.

  • (string) –

• InstanceId (string) –

  [REQUIRED]

  The ID of the instance.

• InstanceInitiatedShutdownBehavior (dict) –

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

  • Value (string) –

    The attribute value. The value is case-sensitive.

• InstanceType (dict) –

  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.

  • Value (string) –

    The attribute value. The value is case-sensitive.

• Kernel (dict) –

  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.

  • Value (string) –

    The attribute value. The value is case-sensitive.

• Ramdisk (dict) –

  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.

  • Value (string) –

    The attribute value. The value is case-sensitive.

• SriovNetSupport (dict) –

  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.

  • Value (string) –

    The attribute value. The value is case-sensitive.

• UserData (dict) –

  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 (bytes) –

• Value (string) – A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

• DisableApiStop (dict) –

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

  • Value (boolean) –

    The attribute value. The valid values are true or false.

Returns:

None

Examples

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

response = client.modify_instance_attribute(
    InstanceId='i-1234567890abcdef0',
    InstanceType={
        'Value': 'm5.large',
    },
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

This example enables enhanced networking for the specified stopped instance.

response = client.modify_instance_attribute(
    EnaSupport={
        'Value': True,
    },
    InstanceId='i-1234567890abcdef0',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}