com.amazonaws.services.ec2.model

Class ModifyImageAttributeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.ModifyImageAttributeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<ModifyImageAttributeRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyImageAttributeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<ModifyImageAttributeRequest>

Contains the parameters for ModifyImageAttribute.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyImageAttributeRequest() Default constructor for ModifyImageAttributeRequest object.
ModifyImageAttributeRequest(String imageId, String attribute) Constructs a new ModifyImageAttributeRequest object.

Method Summary

Modifier and Type	Method and Description
ModifyImageAttributeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAttribute() The name of the attribute to modify.
String	getDescription() A new description for the AMI.
Request<ModifyImageAttributeRequest>	getDryRunRequest() This method is intended for internal use only.
String	getImageId() The ID of the AMI.
String	getImdsSupport() Set to v2.0 to indicate that IMDSv2 is specified in the AMI.
LaunchPermissionModifications	getLaunchPermission() A new launch permission for the AMI.
String	getOperationType() The operation type.
List<String>	getOrganizationalUnitArns() The Amazon Resource Name (ARN) of an organizational unit (OU).
List<String>	getOrganizationArns() The Amazon Resource Name (ARN) of an organization.
List<String>	getProductCodes() Not supported.
List<String>	getUserGroups() The user groups.
List<String>	getUserIds() The Amazon Web Services account IDs.
String	getValue() The value of the attribute being modified.
int	hashCode()
void	setAttribute(String attribute) The name of the attribute to modify.
void	setDescription(String description) A new description for the AMI.
void	setImageId(String imageId) The ID of the AMI.
void	setImdsSupport(String imdsSupport) Set to v2.0 to indicate that IMDSv2 is specified in the AMI.
void	setLaunchPermission(LaunchPermissionModifications launchPermission) A new launch permission for the AMI.
void	setOperationType(OperationType operationType) The operation type.
void	setOperationType(String operationType) The operation type.
void	setOrganizationalUnitArns(Collection<String> organizationalUnitArns) The Amazon Resource Name (ARN) of an organizational unit (OU).
void	setOrganizationArns(Collection<String> organizationArns) The Amazon Resource Name (ARN) of an organization.
void	setProductCodes(Collection<String> productCodes) Not supported.
void	setUserGroups(Collection<String> userGroups) The user groups.
void	setUserIds(Collection<String> userIds) The Amazon Web Services account IDs.
void	setValue(String value) The value of the attribute being modified.
String	toString() Returns a string representation of this object.
ModifyImageAttributeRequest	withAttribute(String attribute) The name of the attribute to modify.
ModifyImageAttributeRequest	withDescription(String description) A new description for the AMI.
ModifyImageAttributeRequest	withImageId(String imageId) The ID of the AMI.
ModifyImageAttributeRequest	withImdsSupport(String imdsSupport) Set to v2.0 to indicate that IMDSv2 is specified in the AMI.
ModifyImageAttributeRequest	withLaunchPermission(LaunchPermissionModifications launchPermission) A new launch permission for the AMI.
ModifyImageAttributeRequest	withOperationType(OperationType operationType) The operation type.
ModifyImageAttributeRequest	withOperationType(String operationType) The operation type.
ModifyImageAttributeRequest	withOrganizationalUnitArns(Collection<String> organizationalUnitArns) The Amazon Resource Name (ARN) of an organizational unit (OU).
ModifyImageAttributeRequest	withOrganizationalUnitArns(String... organizationalUnitArns) The Amazon Resource Name (ARN) of an organizational unit (OU).
ModifyImageAttributeRequest	withOrganizationArns(Collection<String> organizationArns) The Amazon Resource Name (ARN) of an organization.
ModifyImageAttributeRequest	withOrganizationArns(String... organizationArns) The Amazon Resource Name (ARN) of an organization.
ModifyImageAttributeRequest	withProductCodes(Collection<String> productCodes) Not supported.
ModifyImageAttributeRequest	withProductCodes(String... productCodes) Not supported.
ModifyImageAttributeRequest	withUserGroups(Collection<String> userGroups) The user groups.
ModifyImageAttributeRequest	withUserGroups(String... userGroups) The user groups.
ModifyImageAttributeRequest	withUserIds(Collection<String> userIds) The Amazon Web Services account IDs.
ModifyImageAttributeRequest	withUserIds(String... userIds) The Amazon Web Services account IDs.
ModifyImageAttributeRequest	withValue(String value) The value of the attribute being modified.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyImageAttributeRequest

public ModifyImageAttributeRequest()

Default constructor for ModifyImageAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.

ModifyImageAttributeRequest

public ModifyImageAttributeRequest(String imageId,
                                   String attribute)

Constructs a new ModifyImageAttributeRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

imageId - The ID of the AMI.

attribute - The name of the attribute to modify.

Valid values: description | imdsSupport | launchPermission

Method Detail

setAttribute

public void setAttribute(String attribute)

The name of the attribute to modify.

Valid values: description | imdsSupport | launchPermission

Parameters:

attribute - The name of the attribute to modify.

Valid values: description | imdsSupport | launchPermission

getAttribute

public String getAttribute()

The name of the attribute to modify.

Valid values: description | imdsSupport | launchPermission

Returns:

The name of the attribute to modify.

Valid values: description | imdsSupport | launchPermission

withAttribute

public ModifyImageAttributeRequest withAttribute(String attribute)

The name of the attribute to modify.

Valid values: description | imdsSupport | launchPermission

Parameters:

attribute - The name of the attribute to modify.

Valid values: description | imdsSupport | launchPermission

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

A new description for the AMI.

Parameters:

description - A new description for the AMI.

getDescription

public String getDescription()

A new description for the AMI.

Returns:

A new description for the AMI.

withDescription

public ModifyImageAttributeRequest withDescription(String description)

A new description for the AMI.

Parameters:

description - A new description for the AMI.

Returns:

Returns a reference to this object so that method calls can be chained together.

setImageId

public void setImageId(String imageId)

The ID of the AMI.

Parameters:

imageId - The ID of the AMI.

getImageId

public String getImageId()

The ID of the AMI.

Returns:

The ID of the AMI.

withImageId

public ModifyImageAttributeRequest withImageId(String imageId)

The ID of the AMI.

Parameters:

imageId - The ID of the AMI.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLaunchPermission

public void setLaunchPermission(LaunchPermissionModifications launchPermission)

A new launch permission for the AMI.

Parameters:

launchPermission - A new launch permission for the AMI.

getLaunchPermission

public LaunchPermissionModifications getLaunchPermission()

A new launch permission for the AMI.

Returns:

A new launch permission for the AMI.

withLaunchPermission

public ModifyImageAttributeRequest withLaunchPermission(LaunchPermissionModifications launchPermission)

A new launch permission for the AMI.

Parameters:

launchPermission - A new launch permission for the AMI.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOperationType

public void setOperationType(String operationType)

The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

operationType - The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

See Also:

OperationType

getOperationType

public String getOperationType()

The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

See Also:

OperationType

withOperationType

public ModifyImageAttributeRequest withOperationType(String operationType)

The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

operationType - The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OperationType

setOperationType

public void setOperationType(OperationType operationType)

The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

operationType - The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

See Also:

OperationType

withOperationType

public ModifyImageAttributeRequest withOperationType(OperationType operationType)

The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

operationType - The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OperationType

getProductCodes

public List<String> getProductCodes()

Not supported.

Returns:

Not supported.

setProductCodes

public void setProductCodes(Collection<String> productCodes)

Not supported.

Parameters:

productCodes - Not supported.

withProductCodes

public ModifyImageAttributeRequest withProductCodes(String... productCodes)

Not supported.

NOTE: This method appends the values to the existing list (if any). Use setProductCodes(java.util.Collection) or withProductCodes(java.util.Collection) if you want to override the existing values.

Parameters:

productCodes - Not supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

withProductCodes

public ModifyImageAttributeRequest withProductCodes(Collection<String> productCodes)

Not supported.

Parameters:

productCodes - Not supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

getUserGroups

public List<String> getUserGroups()

The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

setUserGroups

public void setUserGroups(Collection<String> userGroups)

The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

userGroups - The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

withUserGroups

public ModifyImageAttributeRequest withUserGroups(String... userGroups)

The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

NOTE: This method appends the values to the existing list (if any). Use setUserGroups(java.util.Collection) or withUserGroups(java.util.Collection) if you want to override the existing values.

Parameters:

userGroups - The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

Returns a reference to this object so that method calls can be chained together.

withUserGroups

public ModifyImageAttributeRequest withUserGroups(Collection<String> userGroups)

The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

userGroups - The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

Returns a reference to this object so that method calls can be chained together.

getUserIds

public List<String> getUserIds()

The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

setUserIds

public void setUserIds(Collection<String> userIds)

The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

userIds - The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

withUserIds

public ModifyImageAttributeRequest withUserIds(String... userIds)

The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

NOTE: This method appends the values to the existing list (if any). Use setUserIds(java.util.Collection) or withUserIds(java.util.Collection) if you want to override the existing values.

Parameters:

userIds - The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

Returns a reference to this object so that method calls can be chained together.

withUserIds

public ModifyImageAttributeRequest withUserIds(Collection<String> userIds)

The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

userIds - The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

Returns a reference to this object so that method calls can be chained together.

setValue

public void setValue(String value)

The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.

Parameters:

value - The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.

getValue

public String getValue()

The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.

Returns:

The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.

withValue

public ModifyImageAttributeRequest withValue(String value)

The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.

Parameters:

value - The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.

Returns:

Returns a reference to this object so that method calls can be chained together.

getOrganizationArns

public List<String> getOrganizationArns()

The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

setOrganizationArns

public void setOrganizationArns(Collection<String> organizationArns)

The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

organizationArns - The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

withOrganizationArns

public ModifyImageAttributeRequest withOrganizationArns(String... organizationArns)

The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

NOTE: This method appends the values to the existing list (if any). Use setOrganizationArns(java.util.Collection) or withOrganizationArns(java.util.Collection) if you want to override the existing values.

Parameters:

organizationArns - The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

Returns a reference to this object so that method calls can be chained together.

withOrganizationArns

public ModifyImageAttributeRequest withOrganizationArns(Collection<String> organizationArns)

The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

organizationArns - The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

Returns a reference to this object so that method calls can be chained together.

getOrganizationalUnitArns

public List<String> getOrganizationalUnitArns()

The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

setOrganizationalUnitArns

public void setOrganizationalUnitArns(Collection<String> organizationalUnitArns)

The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

organizationalUnitArns - The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

withOrganizationalUnitArns

public ModifyImageAttributeRequest withOrganizationalUnitArns(String... organizationalUnitArns)

The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

NOTE: This method appends the values to the existing list (if any). Use setOrganizationalUnitArns(java.util.Collection) or withOrganizationalUnitArns(java.util.Collection) if you want to override the existing values.

Parameters:

organizationalUnitArns - The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

Returns a reference to this object so that method calls can be chained together.

withOrganizationalUnitArns

public ModifyImageAttributeRequest withOrganizationalUnitArns(Collection<String> organizationalUnitArns)

The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

Parameters:

organizationalUnitArns - The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

Returns a reference to this object so that method calls can be chained together.

setImdsSupport

public void setImdsSupport(String imdsSupport)

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.

Parameters:

imdsSupport - Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.

getImdsSupport

public String getImdsSupport()

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.

Returns:

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.

withImdsSupport

public ModifyImageAttributeRequest withImdsSupport(String imdsSupport)

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.

Parameters:

imdsSupport - Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDryRunRequest

public Request<ModifyImageAttributeRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<ModifyImageAttributeRequest>

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ModifyImageAttributeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()