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(value="software.amazon.awssdk:codegen")
public final class ModifyInstanceAttributeRequest
extends Ec2Request
implements ToCopyableBuilder<ModifyInstanceAttributeRequest.Builder,ModifyInstanceAttributeRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyInstanceAttributeRequest.Builder

Method Summary

Modifier and Type	Method and Description
InstanceAttributeName	attribute() The name of the attribute.
String	attributeAsString() The name of the attribute.
List<InstanceBlockDeviceMappingSpecification>	blockDeviceMappings() Modifies the DeleteOnTermination attribute for volumes that are currently attached.
static ModifyInstanceAttributeRequest.Builder	builder()
AttributeBooleanValue	disableApiTermination() If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
AttributeBooleanValue	ebsOptimized() Specifies whether the instance is optimized for Amazon EBS I/O.
AttributeBooleanValue	enaSupport() Set to true to enable enhanced networking with ENA for the instance.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<String>	groups() [EC2-VPC] Changes the security groups of the instance.
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() Specifies whether source/destination checking is enabled.
AttributeValue	sriovNetSupport() Set to simple 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 AttributeBooleanValue sourceDestCheck()

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means that checking is disabled. This value must be false for a NAT instance to perform NAT.

Returns:

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means that checking is disabled. This value must be false for a NAT instance to perform NAT.

attribute

public InstanceAttributeName attribute()

The name of the attribute.

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.

See Also:

InstanceAttributeName

attributeAsString

public String attributeAsString()

The name of the attribute.

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.

See Also:

InstanceAttributeName

blockDeviceMappings

public 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 Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

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

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 Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

disableApiTermination

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

ebsOptimized

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

groups

public List<String> groups()

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

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

Returns:

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

instanceId

public String instanceId()

The ID of the instance.

Returns:

The ID of the instance.

instanceInitiatedShutdownBehavior

public 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 AttributeValue instanceType()

Changes the instance type to the specified value. For more information, see Instance Types. 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. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

kernel

public 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 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 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 BlobAttributeValue userData()

Changes the instance's user data to the specified value. If you are using an AWS 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 AWS 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 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.

toBuilder

public ModifyInstanceAttributeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyInstanceAttributeRequest.Builder,ModifyInstanceAttributeRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ModifyInstanceAttributeRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo