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

Interface ModifyInstanceAttributeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ModifyInstanceAttributeRequest.Builder,ModifyInstanceAttributeRequest>, Ec2Request.Builder, SdkBuilder<ModifyInstanceAttributeRequest.Builder,ModifyInstanceAttributeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ModifyInstanceAttributeRequest
public static interface ModifyInstanceAttributeRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<ModifyInstanceAttributeRequest.Builder,ModifyInstanceAttributeRequest>

  • Method Details

    • 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.

    • sourceDestCheck

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

      This is a convenience method that creates an instance of the AttributeBooleanValue.Builder avoiding the need to create one manually via AttributeBooleanValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceDestCheck(AttributeBooleanValue).

      Parameters:
      sourceDestCheck - a consumer that will call methods on AttributeBooleanValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • attribute

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

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

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

    • attribute

      ModifyInstanceAttributeRequest.Builder attribute(InstanceAttributeName 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

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

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

    • 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 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.

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

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

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

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

    • blockDeviceMappings

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

      This is a convenience method that creates an instance of the InstanceBlockDeviceMappingSpecification.Builder avoiding the need to create one manually via InstanceBlockDeviceMappingSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to blockDeviceMappings(List<InstanceBlockDeviceMappingSpecification>).

      Parameters:
      blockDeviceMappings - a consumer that will call methods on InstanceBlockDeviceMappingSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • disableApiTermination

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

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

    • disableApiTermination

      default ModifyInstanceAttributeRequest.Builder disableApiTermination(Consumer<AttributeBooleanValue.Builder> 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.

      This is a convenience method that creates an instance of the AttributeBooleanValue.Builder avoiding the need to create one manually via AttributeBooleanValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to disableApiTermination(AttributeBooleanValue).

      Parameters:
      disableApiTermination - a consumer that will call methods on AttributeBooleanValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dryRun

      ModifyInstanceAttributeRequest.Builder dryRun(Boolean 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.

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

    • ebsOptimized

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

      This is a convenience method that creates an instance of the AttributeBooleanValue.Builder avoiding the need to create one manually via AttributeBooleanValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ebsOptimized(AttributeBooleanValue).

      Parameters:
      ebsOptimized - a consumer that will call methods on AttributeBooleanValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • enaSupport

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

      This is a convenience method that creates an instance of the AttributeBooleanValue.Builder avoiding the need to create one manually via AttributeBooleanValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to enaSupport(AttributeBooleanValue).

      Parameters:
      enaSupport - a consumer that will call methods on AttributeBooleanValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • 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.

    • 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.

    • instanceInitiatedShutdownBehavior

      default ModifyInstanceAttributeRequest.Builder instanceInitiatedShutdownBehavior(Consumer<AttributeValue.Builder> instanceInitiatedShutdownBehavior)

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

      This is a convenience method that creates an instance of the AttributeValue.Builder avoiding the need to create one manually via AttributeValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceInitiatedShutdownBehavior(AttributeValue).

      Parameters:
      instanceInitiatedShutdownBehavior - a consumer that will call methods on AttributeValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • instanceType

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

      This is a convenience method that creates an instance of the AttributeValue.Builder avoiding the need to create one manually via AttributeValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceType(AttributeValue).

      Parameters:
      instanceType - a consumer that will call methods on AttributeValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • kernel

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

      This is a convenience method that creates an instance of the AttributeValue.Builder avoiding the need to create one manually via AttributeValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kernel(AttributeValue).

      Parameters:
      kernel - a consumer that will call methods on AttributeValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • ramdisk

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

      This is a convenience method that creates an instance of the AttributeValue.Builder avoiding the need to create one manually via AttributeValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ramdisk(AttributeValue).

      Parameters:
      ramdisk - a consumer that will call methods on AttributeValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • sriovNetSupport

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

      This is a convenience method that creates an instance of the AttributeValue.Builder avoiding the need to create one manually via AttributeValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sriovNetSupport(AttributeValue).

      Parameters:
      sriovNetSupport - a consumer that will call methods on AttributeValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userData

      ModifyInstanceAttributeRequest.Builder userData(BlobAttributeValue userData)

      Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.

      Parameters:
      userData - Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userData

      default ModifyInstanceAttributeRequest.Builder userData(Consumer<BlobAttributeValue.Builder> userData)

      Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.

      This is a convenience method that creates an instance of the BlobAttributeValue.Builder avoiding the need to create one manually via BlobAttributeValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userData(BlobAttributeValue).

      Parameters:
      userData - a consumer that will call methods on BlobAttributeValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • disableApiStop

      ModifyInstanceAttributeRequest.Builder disableApiStop(AttributeBooleanValue disableApiStop)

      Indicates whether an instance is enabled for stop protection. For more information, see Stop Protection.

      Parameters:
      disableApiStop - Indicates whether an instance is enabled for stop protection. For more information, see Stop Protection.

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

    • disableApiStop

      default ModifyInstanceAttributeRequest.Builder disableApiStop(Consumer<AttributeBooleanValue.Builder> disableApiStop)

      Indicates whether an instance is enabled for stop protection. For more information, see Stop Protection.

      This is a convenience method that creates an instance of the AttributeBooleanValue.Builder avoiding the need to create one manually via AttributeBooleanValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to disableApiStop(AttributeBooleanValue).

      Parameters:
      disableApiStop - a consumer that will call methods on AttributeBooleanValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ModifyInstanceAttributeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ModifyInstanceAttributeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.