Package software.amazon.awssdk.services.imagebuilder.model

Class LaunchPermissionConfiguration

java.lang.Object
software.amazon.awssdk.services.imagebuilder.model.LaunchPermissionConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LaunchPermissionConfiguration.Builder,LaunchPermissionConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class LaunchPermissionConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LaunchPermissionConfiguration.Builder,LaunchPermissionConfiguration>

Describes the configuration for a launch permission. The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all. See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute.

See Also:

  • Method Details

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

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

    • 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 name of the group.

      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 name of the group.

    • 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 ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.

      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 ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.

    • 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 ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see Organizations terminology and concepts.

      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 ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see Organizations terminology and concepts.

    • toBuilder

      public LaunchPermissionConfiguration.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<LaunchPermissionConfiguration.Builder,LaunchPermissionConfiguration>
      Returns:
      a builder for type T

    • builder

      public static LaunchPermissionConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LaunchPermissionConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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