Class AccessRules

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

Describes the anonymous access permissions for an Amazon Lightsail bucket and its objects.

For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the

Amazon Lightsail Developer Guide.

See Also:

  • Method Details

    • getObject

      public final AccessType getObject()

      Specifies the anonymous access to all objects in a bucket.

      The following options can be specified:

      • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

        If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

      • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

        If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

      If the service returns an enum value that is not available in the current SDK version, getObject will return AccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from getObjectAsString().

      Returns:
      Specifies the anonymous access to all objects in a bucket.

      The following options can be specified:

      • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

        If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

      • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

        If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

      See Also:

    • getObjectAsString

      public final String getObjectAsString()

      Specifies the anonymous access to all objects in a bucket.

      The following options can be specified:

      • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

        If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

      • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

        If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

      If the service returns an enum value that is not available in the current SDK version, getObject will return AccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from getObjectAsString().

      Returns:
      Specifies the anonymous access to all objects in a bucket.

      The following options can be specified:

      • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.

        If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.

      • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.

        If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.

      See Also:

    • allowPublicOverrides

      public final Boolean allowPublicOverrides()

      A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.

      When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.

      Returns:
      A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.

      When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.

    • toBuilder

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

    • builder

      public static AccessRules.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AccessRules.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.