Package software.amazon.awssdk.services.lightsail.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AccessRules.Builder

Method Summary

Modifier and Type	Method	Description
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.
static AccessRules.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
AccessType	getObject()	Specifies the anonymous access to all objects in a bucket.
String	getObjectAsString()	Specifies the anonymous access to all objects in a bucket.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AccessRules.Builder>	serializableBuilderClass()
AccessRules.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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:

AccessType

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:

AccessType

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

Specified by:

toBuilder in interface ToCopyableBuilder<AccessRules.Builder,AccessRules>

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)

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo