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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ModifyInstanceAttributeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description InstanceAttributeName
attribute()
The name of the attribute to modify.String
attributeAsString()
The name of the attribute to modify.List<InstanceBlockDeviceMappingSpecification>
blockDeviceMappings()
Modifies theDeleteOnTermination
attribute for volumes that are currently attached.static ModifyInstanceAttributeRequest.Builder
builder()
AttributeBooleanValue
disableApiStop()
Indicates whether an instance is enabled for stop protection.AttributeBooleanValue
disableApiTermination()
If the value istrue
, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.AttributeBooleanValue
ebsOptimized()
Specifies whether the instance is optimized for Amazon EBS I/O.AttributeBooleanValue
enaSupport()
Set totrue
to enable enhanced networking with ENA for the instance.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
List<String>
groups()
Replaces the security groups of the instance with the specified security groups.boolean
hasBlockDeviceMappings()
For responses, this returns true if the service returned a value for the BlockDeviceMappings property.boolean
hasGroups()
For responses, this returns true if the service returned a value for the Groups property.int
hashCode()
String
instanceId()
The ID of the instance.AttributeValue
instanceInitiatedShutdownBehavior()
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).AttributeValue
instanceType()
Changes the instance type to the specified value.AttributeValue
kernel()
Changes the instance's kernel to the specified value.AttributeValue
ramdisk()
Changes the instance's RAM disk to the specified value.List<SdkField<?>>
sdkFields()
static Class<? extends ModifyInstanceAttributeRequest.Builder>
serializableBuilderClass()
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.AttributeValue
sriovNetSupport()
Set tosimple
to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.ModifyInstanceAttributeRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.BlobAttributeValue
userData()
Changes the instance's user data to the specified value.String
value()
A new value for the attribute.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 istrue
. 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 istrue
. 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 returnInstanceAttributeName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattributeAsString()
.- 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:
InstanceAttributeName
-
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 returnInstanceAttributeName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattributeAsString()
.- 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:
InstanceAttributeName
-
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 theisEmpty()
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 forDeleteOnTermination
, the default istrue
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 forDeleteOnTermination
, the default istrue
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 isUnauthorizedOperation
.- 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 isUnauthorizedOperation
.
-
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 theisEmpty()
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
, orinstanceInitiatedShutdownBehavior
attribute.- Returns:
- A new value for the attribute. Use only with the
kernel
,ramdisk
,userData
,disableApiTermination
, orinstanceInitiatedShutdownBehavior
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModifyInstanceAttributeRequest.Builder,ModifyInstanceAttributeRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static ModifyInstanceAttributeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyInstanceAttributeRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-