ModifyImageAttributeRequest (AWS SDK for Java

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`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`imageId()` The ID of the AMI.
`LaunchPermissionModifications`	`launchPermission()` A new launch permission for the AMI.
`OperationType`	`operationType()` The operation type.
`String`	`operationTypeAsString()` The operation type.
`List<String>`	`productCodes()` One or more DevPay product codes.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModifyImageAttributeRequest.Builder>`	`serializableBuilderClass()`
`ModifyImageAttributeRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`List<String>`	`userGroups()` One or more user groups.
`List<String>`	`userIds()` One or more AWS 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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - attribute
```
public String attribute()
```
    The name of the attribute to modify. The valid values are description, launchPermission , and productCodes.
    
    Returns:
    
    The name of the attribute to modify. The valid values are description, launchPermission, and productCodes.
  - description
```
public AttributeValue description()
```
    A new description for the AMI.
    
    Returns:
    
    A new description for the AMI.
  - imageId
```
public String imageId()
```
    The ID of the AMI.
    
    Returns:
    
    The ID of the AMI.
  - launchPermission
```
public LaunchPermissionModifications launchPermission()
```
    A new launch permission for the AMI.
    
    Returns:
    
    A new launch permission for the AMI.
  - operationType
```
public 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 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
  - productCodes
```
public List<String> productCodes()
```
    One or more DevPay product codes. After you add a product code to an AMI, it can't be removed.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more DevPay product codes. After you add a product code to an AMI, it can't be removed.
  - userGroups
```
public List<String> userGroups()
```
    One or more 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.
    
    Returns:
    
    One or more user groups. This parameter can be used only when the Attribute parameter is launchPermission.
  - userIds
```
public List<String> userIds()
```
    One or more AWS 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.
    
    Returns:
    
    One or more AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
  - value
```
public String value()
```
    The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes.
    
    Returns:
    
    The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes.
  - toBuilder
```
public ModifyImageAttributeRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModifyImageAttributeRequest.Builder,ModifyImageAttributeRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static ModifyImageAttributeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModifyImageAttributeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

productCodes

userGroups

userIds

value

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields