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

Class ModifyInstanceAttributeRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ec2.model.ModifyInstanceAttributeRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ModifyInstanceAttributeRequest.Builder,ModifyInstanceAttributeRequest>

@Generated("software.amazon.awssdk:codegen")
public class ModifyInstanceAttributeRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<ModifyInstanceAttributeRequest.Builder,ModifyInstanceAttributeRequest>

Contains the parameters for ModifyInstanceAttribute.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyInstanceAttributeRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	attribute()	The name of the attribute.
List<InstanceBlockDeviceMappingSpecification>	blockDeviceMappings()	Modifies the DeleteOnTermination attribute for volumes that are currently attached.
static ModifyInstanceAttributeRequest.Builder	builder()
Boolean	disableApiTermination()	If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
Boolean	ebsOptimized()	Specifies whether the instance is optimized for EBS I/O.
Boolean	enaSupport()	Set to true to enable enhanced networking with ENA for the instance.
boolean	equals(Object obj)
List<String>	groups()	[EC2-VPC] Changes the security groups of the instance.
int	hashCode()
String	instanceId()	The ID of the instance.
String	instanceInitiatedShutdownBehavior()	Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
String	instanceType()	Changes the instance type to the specified value.
String	kernel()	Changes the instance's kernel to the specified value.
String	ramdisk()	Changes the instance's RAM disk to the specified value.
static Class<? extends ModifyInstanceAttributeRequest.Builder>	serializableBuilderClass()
Boolean	sourceDestCheck()	Specifies whether source/destination checking is enabled.
String	sriovNetSupport()	Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
ModifyInstanceAttributeRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

sourceDestCheck

public Boolean sourceDestCheck()

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means 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 checking is disabled. This value must be false for a NAT instance to perform NAT.

attribute

public String attribute()

The name of the attribute.

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.

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 Boolean 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 paramater 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 paramater for Spot Instances.

ebsOptimized

public Boolean ebsOptimized()

Specifies whether the instance is optimized for 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 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 Boolean 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.

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 String 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 String 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 String 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 String 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 String 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 String 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()

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>

Returns:

a builder for type T

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()

Overrides:

toString in class Object