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

Class ModifyInstanceAttributeRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ec2.model.Ec2Request
software.amazon.awssdk.services.ec2.model.ModifyInstanceAttributeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyInstanceAttributeRequest.Builder,ModifyInstanceAttributeRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyInstanceAttributeRequest extends Ec2Request implements ToCopyableBuilder<ModifyInstanceAttributeRequest.Builder,ModifyInstanceAttributeRequest>

  • Method Details

    • sourceDestCheck

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

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

    • attribute

      public final 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

      If the service returns an enum value that is not available in the current SDK version, attribute will return InstanceAttributeName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeAsString().

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

      See Also:

    • attributeAsString

      public final String attributeAsString()

      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

      If the service returns an enum value that is not available in the current SDK version, attribute will return InstanceAttributeName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeAsString().

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

      See Also:

    • hasBlockDeviceMappings

      public final boolean hasBlockDeviceMappings()
      For responses, this returns true if the service returned a value for the BlockDeviceMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • blockDeviceMappings

      public final List<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.

      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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlockDeviceMappings() method.

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

      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.

    • disableApiTermination

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

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

    • dryRun

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

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

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

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

    • enaSupport

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

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

    • hasGroups

      public final boolean hasGroups()
      For responses, this returns true if the service returned a value for the Groups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • groups

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroups() method.

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

    • instanceId

      public final String instanceId()

      The ID of the instance.

      Returns:
      The ID of the instance.

    • instanceInitiatedShutdownBehavior

      public final AttributeValue instanceInitiatedShutdownBehavior()

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

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

    • instanceType

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

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

    • kernel

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

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

    • ramdisk

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

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

    • sriovNetSupport

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

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

    • userData

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

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

    • value

      public final String value()

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

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

    • disableApiStop

      public final AttributeBooleanValue disableApiStop()

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

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

    • toBuilder

      public ModifyInstanceAttributeRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ModifyInstanceAttributeRequest.Builder,ModifyInstanceAttributeRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static ModifyInstanceAttributeRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyInstanceAttributeRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.