modify_instance_attribute ¶

def modify_instance_attribute(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    source_dest_check: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
    enclave_options: Optional[
        "capo_ec2.types.enclave_options_request.EnclaveOptionsRequest"
    ] = None,
    disable_api_stop: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    instance_id: Optional["capo_ec2.types.instance_id.InstanceId"] = None,
    attribute: Optional[
        "capo_ec2.types.instance_attribute_name.InstanceAttributeName"
    ] = None,
    value: Optional[
        "capo_ec2.types.modify_instance_attribute_value.ModifyInstanceAttributeValue"
    ] = None,
    block_device_mappings: Optional[
        "capo_ec2.types.instance_block_device_mapping_specification_list.InstanceBlockDeviceMappingSpecificationList"
    ] = None,
    disable_api_termination: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
    instance_type: Optional["capo_ec2.types.attribute_value.AttributeValue"] = None,
    kernel: Optional["capo_ec2.types.attribute_value.AttributeValue"] = None,
    ramdisk: Optional["capo_ec2.types.attribute_value.AttributeValue"] = None,
    user_data: Optional[
        "capo_ec2.types.secure_blob_attribute_value.SecureBlobAttributeValue"
    ] = None,
    instance_initiated_shutdown_behavior: Optional[
        "capo_ec2.types.attribute_value.AttributeValue"
    ] = None,
    groups: Optional[
        "capo_ec2.types.group_id_string_list.GroupIdStringList"
    ] = None,
    ebs_optimized: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
    sriov_net_support: Optional[
        "capo_ec2.types.attribute_value.AttributeValue"
    ] = None,
    ena_support: Optional[
        "capo_ec2.types.attribute_boolean_value.AttributeBooleanValue"
    ] = None,
) -> None:
    """<p>Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.</p> <p> <b>Note: </b>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 <a>ModifyNetworkInterfaceAttribute</a> action.</p> <p>To modify some attributes, the instance must be stopped. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html">Modify a stopped instance</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        source_dest_check: <p>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 <code>true</code>, source/destination checks are enabled; otherwise, they are disabled. The default value is <code>true</code>. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.</p>
        enclave_options: <p>Enables or disables the instance for Amazon Web Services Nitro Enclaves. For more information, see the <a href="https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html">Amazon Web Services Nitro Enclaves User Guide</a>.</p>
        disable_api_stop: <p>Indicates whether an instance is enabled for stop protection. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html">Enable stop protection for your instance</a>.</p> <p></p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        instance_id: <p>The ID of the instance.</p>
        attribute: <p>The name of the attribute to modify.</p> <note> <p>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 <code>default</code> using the <a>ModifyInstanceNetworkPerformanceOptions</a> operation.</p> </note> <important> <p>You can modify the following attributes only: <code>disableApiTermination</code> | <code>instanceType</code> | <code>kernel</code> | <code>ramdisk</code> | <code>instanceInitiatedShutdownBehavior</code> | <code>blockDeviceMapping</code> | <code>userData</code> | <code>sourceDestCheck</code> | <code>groupSet</code> | <code>ebsOptimized</code> | <code>sriovNetSupport</code> | <code>enaSupport</code> | <code>nvmeSupport</code> | <code>disableApiStop</code> | <code>enclaveOptions</code> </p> </important>
        value: <p>A new value for the attribute. Use only with the <code>kernel</code>, <code>ramdisk</code>, <code>userData</code>, <code>disableApiTermination</code>, or <code>instanceInitiatedShutdownBehavior</code> attribute.</p>
        block_device_mappings: <p>Modifies the <code>DeleteOnTermination</code> attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for <code>DeleteOnTermination</code>, the default is <code>true</code> and the volume is deleted when the instance is terminated. You can't modify the <code>DeleteOnTermination</code> attribute for volumes that are attached to Amazon Web Services-managed resources.</p> <p>To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM">Update the block device mapping when launching an instance</a> in the <i>Amazon EC2 User Guide</i>.</p>
        disable_api_termination: <p>Enable or disable termination protection for the instance. If the value is <code>true</code>, 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.</p>
        instance_type: <p>Changes the instance type to the specified value. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon EC2 User Guide</i>. If the instance type is not valid, the error returned is <code>InvalidInstanceAttributeValue</code>.</p>
        kernel: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">PV-GRUB</a>.</p>
        ramdisk: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">PV-GRUB</a>.</p>
        user_data: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html">Work with instance user data</a>.</p>
        instance_initiated_shutdown_behavior: <p>Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).</p>
        groups: <p>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.</p>
        ebs_optimized: <p>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.</p>
        sriov_net_support: <p>Set to <code>simple</code> to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.</p> <p>There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.</p> <p>This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.</p>
        ena_support: <p>Set to <code>true</code> to enable enhanced networking with ENA for the instance.</p> <p>This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To enable enhanced networking
        This example enables enhanced networking for the specified stopped instance.

        >>> client.modify_instance_attribute(instance_id='i-1234567890abcdef0', ena_support={'Value': True})
        To modify the instance type
        This example modifies the instance type of the specified stopped instance.

        >>> client.modify_instance_attribute(instance_id='i-1234567890abcdef0', instance_type={'Value': 'm5.large'})
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.modify_instance_attribute_request.ModifyInstanceAttributeRequest]",
    ) -> OperationResponse[None]:
        import capo_ec2._operations.amazon_ec2.modify_instance_attribute

        output, http_response = (
            capo_ec2._operations.amazon_ec2.modify_instance_attribute.modify_instance_attribute(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_ec2.types.modify_instance_attribute_request.ModifyInstanceAttributeRequest",
    ) -> dict[str, Any]:
        import capo_ec2.types.modify_instance_attribute_request

        return capo_ec2.types.modify_instance_attribute_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ModifyInstanceAttribute", redact_input=_redact_input),
    )
    input_: capo_ec2.types.modify_instance_attribute_request.ModifyInstanceAttributeRequest = {}
    if source_dest_check is not None:
        input_["source_dest_check"] = source_dest_check
    if enclave_options is not None:
        input_["enclave_options"] = enclave_options
    if disable_api_stop is not None:
        input_["disable_api_stop"] = disable_api_stop
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if instance_id is not None:
        input_["instance_id"] = instance_id
    if attribute is not None:
        input_["attribute"] = attribute
    if value is not None:
        input_["value"] = value
    if block_device_mappings is not None:
        input_["block_device_mappings"] = block_device_mappings
    if disable_api_termination is not None:
        input_["disable_api_termination"] = disable_api_termination
    if instance_type is not None:
        input_["instance_type"] = instance_type
    if kernel is not None:
        input_["kernel"] = kernel
    if ramdisk is not None:
        input_["ramdisk"] = ramdisk
    if user_data is not None:
        input_["user_data"] = user_data
    if instance_initiated_shutdown_behavior is not None:
        input_["instance_initiated_shutdown_behavior"] = (
            instance_initiated_shutdown_behavior
        )
    if groups is not None:
        input_["groups"] = groups
    if ebs_optimized is not None:
        input_["ebs_optimized"] = ebs_optimized
    if sriov_net_support is not None:
        input_["sriov_net_support"] = sriov_net_support
    if ena_support is not None:
        input_["ena_support"] = ena_support

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output