Class ModifyImageAttributeRequest

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("software.amazon.awssdk:codegen") public final class ModifyImageAttributeRequest extends Ec2Request implements ToCopyableBuilder<ModifyImageAttributeRequest.Builder,ModifyImageAttributeRequest>

Contains the parameters for ModifyImageAttribute.

  • Method Details

    • 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:

    • 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:

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

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

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

    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.