ModifyImageAttributeRequest (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ModifyImageAttributeRequest.Builder,ModifyImageAttributeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyImageAttributeRequest
extends Ec2Request
implements ToCopyableBuilder<ModifyImageAttributeRequest.Builder,ModifyImageAttributeRequest>

Contains the parameters for ModifyImageAttribute.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ModifyImageAttributeRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ModifyImageAttributeRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`attribute()` The name of the attribute to modify.
`static ModifyImageAttributeRequest.Builder`	`builder()`
`AttributeValue`	`description()` A new description for the AMI.
`Boolean`	`dryRun()` Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasOrganizationalUnitArns()` For responses, this returns true if the service returned a value for the OrganizationalUnitArns property.
`boolean`	`hasOrganizationArns()` For responses, this returns true if the service returned a value for the OrganizationArns property.
`boolean`	`hasProductCodes()` For responses, this returns true if the service returned a value for the ProductCodes property.
`boolean`	`hasUserGroups()` For responses, this returns true if the service returned a value for the UserGroups property.
`boolean`	`hasUserIds()` For responses, this returns true if the service returned a value for the UserIds property.
`String`	`imageId()` The ID of the AMI.
`AttributeValue`	`imdsSupport()` Set to `v2.0` to indicate that IMDSv2 is specified in the AMI.
`LaunchPermissionModifications`	`launchPermission()` A new launch permission for the AMI.
`OperationType`	`operationType()` The operation type.
`String`	`operationTypeAsString()` The operation type.
`List<String>`	`organizationalUnitArns()` The Amazon Resource Name (ARN) of an organizational unit (OU).
`List<String>`	`organizationArns()` The Amazon Resource Name (ARN) of an organization.
`List<String>`	`productCodes()` Not supported.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModifyImageAttributeRequest.Builder>`	`serializableBuilderClass()`
`ModifyImageAttributeRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`userGroups()` The user groups.
`List<String>`	`userIds()` The Amazon Web Services account IDs.
`String`	`value()` The value of the attribute being modified.

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
  - attribute
```
public final String attribute()
```
    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
  - description
```
public final AttributeValue description()
```
    A new description for the AMI.
    
    Returns:
    
    A new description for the AMI.
  - imageId
```
public final String imageId()
```
    The ID of the AMI.
    
    Returns:
    
    The ID of the AMI.
  - launchPermission
```
public final LaunchPermissionModifications launchPermission()
```
    A new launch permission for the AMI.
    
    Returns:
    
    A new launch permission for the AMI.
  - operationType
```
public final OperationType operationType()
```
    The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
    
    If the service returns an enum value that is not available in the current SDK version, operationType will return OperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationTypeAsString().
    
    Returns:
    
    The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
    
    See Also:
    
    OperationType
  - operationTypeAsString
```
public final String operationTypeAsString()
```
    The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
    
    If the service returns an enum value that is not available in the current SDK version, operationType will return OperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationTypeAsString().
    
    Returns:
    
    The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
    
    See Also:
    
    OperationType
  - hasProductCodes
```
public final boolean hasProductCodes()
```
    For responses, this returns true if the service returned a value for the ProductCodes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - productCodes
```
public final List<String> productCodes()
```
    Not supported.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProductCodes() method.
    
    Returns:
    
    Not supported.
  - hasUserGroups
```
public final boolean hasUserGroups()
```
    For responses, this returns true if the service returned a value for the UserGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - userGroups
```
public final List<String> userGroups()
```
    The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserGroups() method.
    
    Returns:
    
    The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
  - hasUserIds
```
public final boolean hasUserIds()
```
    For responses, this returns true if the service returned a value for the UserIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - userIds
```
public final List<String> userIds()
```
    The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserIds() method.
    
    Returns:
    
    The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
  - value
```
public final String value()
```
    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.
  - dryRun
```
public final Boolean dryRun()
```
    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    
    Returns:
    
    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
  - hasOrganizationArns
```
public final boolean hasOrganizationArns()
```
    For responses, this returns true if the service returned a value for the OrganizationArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - organizationArns
```
public final List<String> organizationArns()
```
    The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrganizationArns() method.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
  - hasOrganizationalUnitArns
```
public final boolean hasOrganizationalUnitArns()
```
    For responses, this returns true if the service returned a value for the OrganizationalUnitArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - organizationalUnitArns
```
public final List<String> organizationalUnitArns()
```
    The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrganizationalUnitArns() method.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
  - imdsSupport
```
public final AttributeValue 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:
    
    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.
  - toBuilder
```
public ModifyImageAttributeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModifyImageAttributeRequest.Builder,ModifyImageAttributeRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static ModifyImageAttributeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModifyImageAttributeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ModifyImageAttributeRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

attribute

description

imageId

launchPermission

operationType

operationTypeAsString

hasProductCodes

productCodes

hasUserGroups

userGroups

hasUserIds

userIds

value

dryRun

hasOrganizationArns

organizationArns

hasOrganizationalUnitArns

organizationalUnitArns

imdsSupport

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields