Package software.amazon.awssdk.services.ec2.model

Interface ModifyInstanceAttributeRequest.Builder

    • Method Detail

      • sourceDestCheck

        ModifyInstanceAttributeRequest.Builder sourceDestCheck​(AttributeBooleanValue 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dryRun

        ModifyInstanceAttributeRequest.Builder dryRun​(Boolean dryRun)

        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.

        Parameters:
        dryRun - 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:
        Returns a reference to this object so that method calls can be chained together.

      • instanceId

        ModifyInstanceAttributeRequest.Builder instanceId​(String instanceId)

        The ID of the instance.

        Parameters:
        instanceId - The ID of the instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • attribute

        ModifyInstanceAttributeRequest.Builder attribute​(String attribute)

        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

        Parameters:
        attribute - 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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InstanceAttributeName, InstanceAttributeName

      • attribute

        ModifyInstanceAttributeRequest.Builder attribute​(InstanceAttributeName attribute)

        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

        Parameters:
        attribute - 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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InstanceAttributeName, InstanceAttributeName

      • value

        ModifyInstanceAttributeRequest.Builder value​(String value)

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

        Parameters:
        value - A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • blockDeviceMappings

        ModifyInstanceAttributeRequest.Builder blockDeviceMappings​(Collection<InstanceBlockDeviceMappingSpecification> 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 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.

        Parameters:
        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 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • blockDeviceMappings

        ModifyInstanceAttributeRequest.Builder blockDeviceMappings​(InstanceBlockDeviceMappingSpecification... 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 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.

        Parameters:
        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 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • disableApiTermination

        ModifyInstanceAttributeRequest.Builder disableApiTermination​(AttributeBooleanValue disableApiTermination)

        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.

        Parameters:
        disableApiTermination - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceType

        ModifyInstanceAttributeRequest.Builder instanceType​(AttributeValue 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kernel

        ModifyInstanceAttributeRequest.Builder kernel​(AttributeValue 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ramdisk

        ModifyInstanceAttributeRequest.Builder ramdisk​(AttributeValue 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userData

        ModifyInstanceAttributeRequest.Builder userData​(BlobAttributeValue 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceInitiatedShutdownBehavior

        ModifyInstanceAttributeRequest.Builder instanceInitiatedShutdownBehavior​(AttributeValue instanceInitiatedShutdownBehavior)

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

        Parameters:
        instanceInitiatedShutdownBehavior - Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • groups

        ModifyInstanceAttributeRequest.Builder groups​(Collection<String> 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • groups

        ModifyInstanceAttributeRequest.Builder groups​(String... 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ebsOptimized

        ModifyInstanceAttributeRequest.Builder ebsOptimized​(AttributeBooleanValue 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sriovNetSupport

        ModifyInstanceAttributeRequest.Builder sriovNetSupport​(AttributeValue 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enaSupport

        ModifyInstanceAttributeRequest.Builder enaSupport​(AttributeBooleanValue 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.