com.amazonaws.services.ec2.model.ModifyInstanceAttributeRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.ModifyInstanceAttributeRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ModifyInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* 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.
*
*/
private Boolean sourceDestCheck;
/**
*
* 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
*
*
*/
private String attribute;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList blockDeviceMappings;
/**
*
* 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.
*
*/
private Boolean disableApiTermination;
/**
*
* 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.
*
*/
private Boolean ebsOptimized;
/**
*
* 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.
*
*/
private Boolean enaSupport;
/**
*
* 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.
*
*/
private com.amazonaws.internal.SdkInternalList groups;
/**
*
* The ID of the instance.
*
*/
private String instanceId;
/**
*
* Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the
* operating system command for system shutdown).
*
*/
private String instanceInitiatedShutdownBehavior;
/**
*
* 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.
*
*/
private String instanceType;
/**
*
* 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.
*
*/
private String kernel;
/**
*
* 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.
*
*/
private String ramdisk;
/**
*
* 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.
*
*/
private String sriovNetSupport;
/**
*
* Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool
* or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance
* user data.
*
*/
private String userData;
/**
*
* A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
*
*/
private String value;
/**
*
* Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for
* your instance.
*
*
*/
private Boolean disableApiStop;
/**
* Default constructor for ModifyInstanceAttributeRequest object. Callers should use the setter or fluent setter
* (with...) methods to initialize the object after creating it.
*/
public ModifyInstanceAttributeRequest() {
}
/**
* Constructs a new ModifyInstanceAttributeRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param instanceId
* The ID of the instance.
* @param 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
*
*/
public ModifyInstanceAttributeRequest(String instanceId, String attribute) {
setInstanceId(instanceId);
setAttribute(attribute);
}
/**
* Constructs a new ModifyInstanceAttributeRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param instanceId
* The ID of the instance.
* @param 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
*
*/
public ModifyInstanceAttributeRequest(String instanceId, InstanceAttributeName attribute) {
setInstanceId(instanceId);
setAttribute(attribute.toString());
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setSourceDestCheck(Boolean sourceDestCheck) {
this.sourceDestCheck = 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.
*
*
* @return 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.
*/
public Boolean getSourceDestCheck() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withSourceDestCheck(Boolean sourceDestCheck) {
setSourceDestCheck(sourceDestCheck);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isSourceDestCheck() {
return this.sourceDestCheck;
}
/**
*
* 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
*
*
*
* @param 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
*
* @see InstanceAttributeName
*/
public void setAttribute(String attribute) {
this.attribute = 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
*
*
*
* @return 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 InstanceAttributeName
*/
public String getAttribute() {
return this.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
*
*
*
* @param 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
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceAttributeName
*/
public ModifyInstanceAttributeRequest withAttribute(String attribute) {
setAttribute(attribute);
return this;
}
/**
*
* 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
*
*
*
* @param 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
*
* @see InstanceAttributeName
*/
public void setAttribute(InstanceAttributeName attribute) {
withAttribute(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
*
*
*
* @param 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
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceAttributeName
*/
public ModifyInstanceAttributeRequest withAttribute(InstanceAttributeName attribute) {
this.attribute = attribute.toString();
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getBlockDeviceMappings() {
if (blockDeviceMappings == null) {
blockDeviceMappings = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setBlockDeviceMappings(java.util.Collection blockDeviceMappings) {
if (blockDeviceMappings == null) {
this.blockDeviceMappings = null;
return;
}
this.blockDeviceMappings = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setBlockDeviceMappings(java.util.Collection)} or {@link #withBlockDeviceMappings(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withBlockDeviceMappings(InstanceBlockDeviceMappingSpecification... blockDeviceMappings) {
if (this.blockDeviceMappings == null) {
setBlockDeviceMappings(new com.amazonaws.internal.SdkInternalList(blockDeviceMappings.length));
}
for (InstanceBlockDeviceMappingSpecification ele : blockDeviceMappings) {
this.blockDeviceMappings.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withBlockDeviceMappings(java.util.Collection blockDeviceMappings) {
setBlockDeviceMappings(blockDeviceMappings);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setDisableApiTermination(Boolean disableApiTermination) {
this.disableApiTermination = 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.
*
*
* @return 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.
*/
public Boolean getDisableApiTermination() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withDisableApiTermination(Boolean disableApiTermination) {
setDisableApiTermination(disableApiTermination);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isDisableApiTermination() {
return this.disableApiTermination;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setEbsOptimized(Boolean ebsOptimized) {
this.ebsOptimized = 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.
*
*
* @return 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.
*/
public Boolean getEbsOptimized() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withEbsOptimized(Boolean ebsOptimized) {
setEbsOptimized(ebsOptimized);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isEbsOptimized() {
return this.ebsOptimized;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setEnaSupport(Boolean enaSupport) {
this.enaSupport = 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.
*
*
* @return 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.
*/
public Boolean getEnaSupport() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withEnaSupport(Boolean enaSupport) {
setEnaSupport(enaSupport);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isEnaSupport() {
return this.enaSupport;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getGroups() {
if (groups == null) {
groups = new com.amazonaws.internal.SdkInternalList();
}
return 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.
*
*
* @param 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.
*/
public void setGroups(java.util.Collection groups) {
if (groups == null) {
this.groups = null;
return;
}
this.groups = new com.amazonaws.internal.SdkInternalList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setGroups(java.util.Collection)} or {@link #withGroups(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withGroups(String... groups) {
if (this.groups == null) {
setGroups(new com.amazonaws.internal.SdkInternalList(groups.length));
}
for (String ele : groups) {
this.groups.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withGroups(java.util.Collection groups) {
setGroups(groups);
return this;
}
/**
*
* The ID of the instance.
*
*
* @param instanceId
* The ID of the instance.
*/
public void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
/**
*
* The ID of the instance.
*
*
* @return The ID of the instance.
*/
public String getInstanceId() {
return this.instanceId;
}
/**
*
* The ID of the instance.
*
*
* @param instanceId
* The ID of the instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withInstanceId(String instanceId) {
setInstanceId(instanceId);
return this;
}
/**
*
* Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the
* operating system command for system shutdown).
*
*
* @param instanceInitiatedShutdownBehavior
* Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the
* operating system command for system shutdown).
*/
public void setInstanceInitiatedShutdownBehavior(String instanceInitiatedShutdownBehavior) {
this.instanceInitiatedShutdownBehavior = instanceInitiatedShutdownBehavior;
}
/**
*
* Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the
* operating system command for system shutdown).
*
*
* @return Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the
* operating system command for system shutdown).
*/
public String getInstanceInitiatedShutdownBehavior() {
return this.instanceInitiatedShutdownBehavior;
}
/**
*
* Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the
* operating system command for system shutdown).
*
*
* @param instanceInitiatedShutdownBehavior
* Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the
* operating system command for system shutdown).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withInstanceInitiatedShutdownBehavior(String instanceInitiatedShutdownBehavior) {
setInstanceInitiatedShutdownBehavior(instanceInitiatedShutdownBehavior);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setInstanceType(String instanceType) {
this.instanceType = 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.
*
*
* @return 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.
*/
public String getInstanceType() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withInstanceType(String instanceType) {
setInstanceType(instanceType);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setKernel(String kernel) {
this.kernel = 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.
*
*
* @return 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.
*/
public String getKernel() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withKernel(String kernel) {
setKernel(kernel);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setRamdisk(String ramdisk) {
this.ramdisk = 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.
*
*
* @return 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.
*/
public String getRamdisk() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withRamdisk(String ramdisk) {
setRamdisk(ramdisk);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setSriovNetSupport(String sriovNetSupport) {
this.sriovNetSupport = 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.
*
*
* @return 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.
*/
public String getSriovNetSupport() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withSriovNetSupport(String sriovNetSupport) {
setSriovNetSupport(sriovNetSupport);
return this;
}
/**
*
* Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool
* or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance
* user data.
*
*
* @param userData
* Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on
* the tool or SDK that you're using, the base64-encoding might be performed for you. For more information,
* see Work
* with instance user data.
*/
public void setUserData(String userData) {
this.userData = userData;
}
/**
*
* Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool
* or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance
* user data.
*
*
* @return Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on
* the tool or SDK that you're using, the base64-encoding might be performed for you. For more information,
* see Work
* with instance user data.
*/
public String getUserData() {
return this.userData;
}
/**
*
* Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool
* or SDK that you're using, the base64-encoding might be performed for you. For more information, see Work with instance
* user data.
*
*
* @param userData
* Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on
* the tool or SDK that you're using, the base64-encoding might be performed for you. For more information,
* see Work
* with instance user data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withUserData(String userData) {
setUserData(userData);
return this;
}
/**
*
* A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
*
*
* @param value
* A new value for the attribute. Use only with the kernel, ramdisk,
* userData, disableApiTermination, or
* instanceInitiatedShutdownBehavior attribute.
*/
public void setValue(String value) {
this.value = value;
}
/**
*
* A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
*
*
* @return A new value for the attribute. Use only with the kernel, ramdisk,
* userData, disableApiTermination, or
* instanceInitiatedShutdownBehavior attribute.
*/
public String getValue() {
return this.value;
}
/**
*
* A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
*
*
* @param value
* A new value for the attribute. Use only with the kernel, ramdisk,
* userData, disableApiTermination, or
* instanceInitiatedShutdownBehavior attribute.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withValue(String value) {
setValue(value);
return this;
}
/**
*
* Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for
* your instance.
*
*
*
* @param disableApiStop
* Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection
* for your instance.
*
*/
public void setDisableApiStop(Boolean disableApiStop) {
this.disableApiStop = disableApiStop;
}
/**
*
* Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for
* your instance.
*
*
*
* @return Indicates whether an instance is enabled for stop protection. For more information, see Enable stop
* protection for your instance.
*
*/
public Boolean getDisableApiStop() {
return this.disableApiStop;
}
/**
*
* Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for
* your instance.
*
*
*
* @param disableApiStop
* Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection
* for your instance.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyInstanceAttributeRequest withDisableApiStop(Boolean disableApiStop) {
setDisableApiStop(disableApiStop);
return this;
}
/**
*
* Indicates whether an instance is enabled for stop protection. For more information, see Enable stop protection for
* your instance.
*
*
*
* @return Indicates whether an instance is enabled for stop protection. For more information, see Enable stop
* protection for your instance.
*
*/
public Boolean isDisableApiStop() {
return this.disableApiStop;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new ModifyInstanceAttributeRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSourceDestCheck() != null)
sb.append("SourceDestCheck: ").append(getSourceDestCheck()).append(",");
if (getAttribute() != null)
sb.append("Attribute: ").append(getAttribute()).append(",");
if (getBlockDeviceMappings() != null)
sb.append("BlockDeviceMappings: ").append(getBlockDeviceMappings()).append(",");
if (getDisableApiTermination() != null)
sb.append("DisableApiTermination: ").append(getDisableApiTermination()).append(",");
if (getEbsOptimized() != null)
sb.append("EbsOptimized: ").append(getEbsOptimized()).append(",");
if (getEnaSupport() != null)
sb.append("EnaSupport: ").append(getEnaSupport()).append(",");
if (getGroups() != null)
sb.append("Groups: ").append(getGroups()).append(",");
if (getInstanceId() != null)
sb.append("InstanceId: ").append(getInstanceId()).append(",");
if (getInstanceInitiatedShutdownBehavior() != null)
sb.append("InstanceInitiatedShutdownBehavior: ").append(getInstanceInitiatedShutdownBehavior()).append(",");
if (getInstanceType() != null)
sb.append("InstanceType: ").append(getInstanceType()).append(",");
if (getKernel() != null)
sb.append("Kernel: ").append(getKernel()).append(",");
if (getRamdisk() != null)
sb.append("Ramdisk: ").append(getRamdisk()).append(",");
if (getSriovNetSupport() != null)
sb.append("SriovNetSupport: ").append(getSriovNetSupport()).append(",");
if (getUserData() != null)
sb.append("UserData: ").append(getUserData()).append(",");
if (getValue() != null)
sb.append("Value: ").append(getValue()).append(",");
if (getDisableApiStop() != null)
sb.append("DisableApiStop: ").append(getDisableApiStop());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ModifyInstanceAttributeRequest == false)
return false;
ModifyInstanceAttributeRequest other = (ModifyInstanceAttributeRequest) obj;
if (other.getSourceDestCheck() == null ^ this.getSourceDestCheck() == null)
return false;
if (other.getSourceDestCheck() != null && other.getSourceDestCheck().equals(this.getSourceDestCheck()) == false)
return false;
if (other.getAttribute() == null ^ this.getAttribute() == null)
return false;
if (other.getAttribute() != null && other.getAttribute().equals(this.getAttribute()) == false)
return false;
if (other.getBlockDeviceMappings() == null ^ this.getBlockDeviceMappings() == null)
return false;
if (other.getBlockDeviceMappings() != null && other.getBlockDeviceMappings().equals(this.getBlockDeviceMappings()) == false)
return false;
if (other.getDisableApiTermination() == null ^ this.getDisableApiTermination() == null)
return false;
if (other.getDisableApiTermination() != null && other.getDisableApiTermination().equals(this.getDisableApiTermination()) == false)
return false;
if (other.getEbsOptimized() == null ^ this.getEbsOptimized() == null)
return false;
if (other.getEbsOptimized() != null && other.getEbsOptimized().equals(this.getEbsOptimized()) == false)
return false;
if (other.getEnaSupport() == null ^ this.getEnaSupport() == null)
return false;
if (other.getEnaSupport() != null && other.getEnaSupport().equals(this.getEnaSupport()) == false)
return false;
if (other.getGroups() == null ^ this.getGroups() == null)
return false;
if (other.getGroups() != null && other.getGroups().equals(this.getGroups()) == false)
return false;
if (other.getInstanceId() == null ^ this.getInstanceId() == null)
return false;
if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false)
return false;
if (other.getInstanceInitiatedShutdownBehavior() == null ^ this.getInstanceInitiatedShutdownBehavior() == null)
return false;
if (other.getInstanceInitiatedShutdownBehavior() != null
&& other.getInstanceInitiatedShutdownBehavior().equals(this.getInstanceInitiatedShutdownBehavior()) == false)
return false;
if (other.getInstanceType() == null ^ this.getInstanceType() == null)
return false;
if (other.getInstanceType() != null && other.getInstanceType().equals(this.getInstanceType()) == false)
return false;
if (other.getKernel() == null ^ this.getKernel() == null)
return false;
if (other.getKernel() != null && other.getKernel().equals(this.getKernel()) == false)
return false;
if (other.getRamdisk() == null ^ this.getRamdisk() == null)
return false;
if (other.getRamdisk() != null && other.getRamdisk().equals(this.getRamdisk()) == false)
return false;
if (other.getSriovNetSupport() == null ^ this.getSriovNetSupport() == null)
return false;
if (other.getSriovNetSupport() != null && other.getSriovNetSupport().equals(this.getSriovNetSupport()) == false)
return false;
if (other.getUserData() == null ^ this.getUserData() == null)
return false;
if (other.getUserData() != null && other.getUserData().equals(this.getUserData()) == false)
return false;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
if (other.getDisableApiStop() == null ^ this.getDisableApiStop() == null)
return false;
if (other.getDisableApiStop() != null && other.getDisableApiStop().equals(this.getDisableApiStop()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSourceDestCheck() == null) ? 0 : getSourceDestCheck().hashCode());
hashCode = prime * hashCode + ((getAttribute() == null) ? 0 : getAttribute().hashCode());
hashCode = prime * hashCode + ((getBlockDeviceMappings() == null) ? 0 : getBlockDeviceMappings().hashCode());
hashCode = prime * hashCode + ((getDisableApiTermination() == null) ? 0 : getDisableApiTermination().hashCode());
hashCode = prime * hashCode + ((getEbsOptimized() == null) ? 0 : getEbsOptimized().hashCode());
hashCode = prime * hashCode + ((getEnaSupport() == null) ? 0 : getEnaSupport().hashCode());
hashCode = prime * hashCode + ((getGroups() == null) ? 0 : getGroups().hashCode());
hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode());
hashCode = prime * hashCode + ((getInstanceInitiatedShutdownBehavior() == null) ? 0 : getInstanceInitiatedShutdownBehavior().hashCode());
hashCode = prime * hashCode + ((getInstanceType() == null) ? 0 : getInstanceType().hashCode());
hashCode = prime * hashCode + ((getKernel() == null) ? 0 : getKernel().hashCode());
hashCode = prime * hashCode + ((getRamdisk() == null) ? 0 : getRamdisk().hashCode());
hashCode = prime * hashCode + ((getSriovNetSupport() == null) ? 0 : getSriovNetSupport().hashCode());
hashCode = prime * hashCode + ((getUserData() == null) ? 0 : getUserData().hashCode());
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
hashCode = prime * hashCode + ((getDisableApiStop() == null) ? 0 : getDisableApiStop().hashCode());
return hashCode;
}
@Override
public ModifyInstanceAttributeRequest clone() {
return (ModifyInstanceAttributeRequest) super.clone();
}
}