Amazonka.Lightsail.Types.AccessRules

Documentation

data 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: newAccessRules smart constructor.

Constructors

AccessRules'

Fields

• allowPublicOverrides :: Maybe Bool

  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.

• getObject :: Maybe AccessType

  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.

Instances

FromJSON AccessRules

Defined in Amazonka.Lightsail.Types.AccessRules

Methods

parseJSON :: Value -> Parser AccessRules

parseJSONList :: Value -> Parser [AccessRules]

ToJSON AccessRules

Defined in Amazonka.Lightsail.Types.AccessRules

Methods

toJSON :: AccessRules -> Value

toEncoding :: AccessRules -> Encoding

toJSONList :: [AccessRules] -> Value

toEncodingList :: [AccessRules] -> Encoding

Generic AccessRules

Defined in Amazonka.Lightsail.Types.AccessRules

Associated Types

type Rep AccessRules :: Type -> Type

Methods

from :: AccessRules -> Rep AccessRules x

to :: Rep AccessRules x -> AccessRules

Read AccessRules

Defined in Amazonka.Lightsail.Types.AccessRules

Methods

readsPrec :: Int -> ReadS AccessRules

readList :: ReadS [AccessRules]

readPrec :: ReadPrec AccessRules

readListPrec :: ReadPrec [AccessRules]

Show AccessRules

Defined in Amazonka.Lightsail.Types.AccessRules

Methods

showsPrec :: Int -> AccessRules -> ShowS

show :: AccessRules -> String

showList :: [AccessRules] -> ShowS

NFData AccessRules

Defined in Amazonka.Lightsail.Types.AccessRules

Methods

rnf :: AccessRules -> ()

Eq AccessRules

Defined in Amazonka.Lightsail.Types.AccessRules

Methods

(==) :: AccessRules -> AccessRules -> Bool

(/=) :: AccessRules -> AccessRules -> Bool

Hashable AccessRules

Defined in Amazonka.Lightsail.Types.AccessRules

Methods

hashWithSalt :: Int -> AccessRules -> Int

hash :: AccessRules -> Int

type Rep AccessRules

Defined in Amazonka.Lightsail.Types.AccessRules

type Rep AccessRules = D1 ('MetaData "AccessRules" "Amazonka.Lightsail.Types.AccessRules" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "AccessRules'" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowPublicOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "getObject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessType))))

newAccessRules :: AccessRules

Create a value of AccessRules with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allowPublicOverrides:AccessRules', accessRules_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.

$sel:getObject:AccessRules', accessRules_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.

accessRules_allowPublicOverrides :: Lens' AccessRules (Maybe Bool)

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.

accessRules_getObject :: Lens' AccessRules (Maybe AccessType)

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.