Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Lightsail.Types.AccountLevelBpaSync

Description

Documentation

data AccountLevelBpaSync Source #

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access (BPA) feature for your Lightsail buckets.

The account-level BPA feature of Amazon S3 provides centralized controls to limit public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and object permissions that are configured. Lightsail buckets take into account the Amazon S3 account-level BPA configuration when allowing or denying public access. To do this, Lightsail periodically fetches the account-level BPA configuration from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

See: newAccountLevelBpaSync smart constructor.

Constructors

AccountLevelBpaSync'

Fields

bpaImpactsLightsail :: Maybe Bool
A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
lastSyncedAt :: Maybe POSIX
The timestamp of when the account-level BPA configuration was last synchronized. This value is null when the account-level BPA configuration has not been synchronized.
message :: Maybe BPAStatusMessage
A message that provides a reason for a Failed or Defaulted synchronization status.
The following messages are possible:
- SYNC_ON_HOLD - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.
- DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to active until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
- DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
- Unknown - The reason that synchronization failed is unknown. Contact Amazon Web Services Support for more information.
status :: Maybe AccountLevelBpaSyncStatus
The status of the account-level BPA synchronization.
The following statuses are possible:
- InSync - Account-level BPA is synchronized. The Amazon S3 account-level BPA configuration applies to your Lightsail buckets.
- NeverSynced - Synchronization has not yet happened. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
- Failed - Synchronization failed. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
- Defaulted - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to active.
You might need to complete further actions if the status is Failed or Defaulted. The message parameter provides more information for those statuses.

Instances

Instances details

FromJSON AccountLevelBpaSync Source #
Instance details Defined in Amazonka.Lightsail.Types.AccountLevelBpaSync Methods parseJSON :: Value -> Parser AccountLevelBpaSync # parseJSONList :: Value -> Parser [AccountLevelBpaSync] #
Generic AccountLevelBpaSync Source #
Instance details Defined in Amazonka.Lightsail.Types.AccountLevelBpaSync Associated Types type Rep AccountLevelBpaSync :: Type -> Type # Methods from :: AccountLevelBpaSync -> Rep AccountLevelBpaSync x # to :: Rep AccountLevelBpaSync x -> AccountLevelBpaSync #
Read AccountLevelBpaSync Source #
Instance details Defined in Amazonka.Lightsail.Types.AccountLevelBpaSync Methods readsPrec :: Int -> ReadS AccountLevelBpaSync # readList :: ReadS [AccountLevelBpaSync] # readPrec :: ReadPrec AccountLevelBpaSync # readListPrec :: ReadPrec [AccountLevelBpaSync] #
Show AccountLevelBpaSync Source #
Instance details Defined in Amazonka.Lightsail.Types.AccountLevelBpaSync Methods showsPrec :: Int -> AccountLevelBpaSync -> ShowS # show :: AccountLevelBpaSync -> String # showList :: [AccountLevelBpaSync] -> ShowS #
NFData AccountLevelBpaSync Source #
Instance details Defined in Amazonka.Lightsail.Types.AccountLevelBpaSync Methods rnf :: AccountLevelBpaSync -> () #
Eq AccountLevelBpaSync Source #
Instance details Defined in Amazonka.Lightsail.Types.AccountLevelBpaSync Methods (==) :: AccountLevelBpaSync -> AccountLevelBpaSync -> Bool # (/=) :: AccountLevelBpaSync -> AccountLevelBpaSync -> Bool #
Hashable AccountLevelBpaSync Source #
Instance details Defined in Amazonka.Lightsail.Types.AccountLevelBpaSync Methods hashWithSalt :: Int -> AccountLevelBpaSync -> Int # hash :: AccountLevelBpaSync -> Int #
type Rep AccountLevelBpaSync Source #
Instance details Defined in Amazonka.Lightsail.Types.AccountLevelBpaSync type Rep AccountLevelBpaSync = D1 ('MetaData "AccountLevelBpaSync" "Amazonka.Lightsail.Types.AccountLevelBpaSync" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "AccountLevelBpaSync'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bpaImpactsLightsail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "lastSyncedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BPAStatusMessage)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccountLevelBpaSyncStatus)))))

newAccountLevelBpaSync :: AccountLevelBpaSync Source #

Create a value of AccountLevelBpaSync 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:bpaImpactsLightsail:AccountLevelBpaSync', accountLevelBpaSync_bpaImpactsLightsail - A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.

$sel:lastSyncedAt:AccountLevelBpaSync', accountLevelBpaSync_lastSyncedAt - The timestamp of when the account-level BPA configuration was last synchronized. This value is null when the account-level BPA configuration has not been synchronized.

$sel:message:AccountLevelBpaSync', accountLevelBpaSync_message - A message that provides a reason for a Failed or Defaulted synchronization status.

The following messages are possible:

SYNC_ON_HOLD - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.
DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to active until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
Unknown - The reason that synchronization failed is unknown. Contact Amazon Web Services Support for more information.

$sel:status:AccountLevelBpaSync', accountLevelBpaSync_status - The status of the account-level BPA synchronization.

The following statuses are possible:

InSync - Account-level BPA is synchronized. The Amazon S3 account-level BPA configuration applies to your Lightsail buckets.
NeverSynced - Synchronization has not yet happened. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
Failed - Synchronization failed. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
Defaulted - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to active.

You might need to complete further actions if the status is Failed or Defaulted. The message parameter provides more information for those statuses.

accountLevelBpaSync_bpaImpactsLightsail :: Lens' AccountLevelBpaSync (Maybe Bool) Source #

A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.

accountLevelBpaSync_lastSyncedAt :: Lens' AccountLevelBpaSync (Maybe UTCTime) Source #

The timestamp of when the account-level BPA configuration was last synchronized. This value is null when the account-level BPA configuration has not been synchronized.

accountLevelBpaSync_message :: Lens' AccountLevelBpaSync (Maybe BPAStatusMessage) Source #

A message that provides a reason for a Failed or Defaulted synchronization status.

The following messages are possible:

SYNC_ON_HOLD - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.
DEFAULTED_FOR_SLR_MISSING - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to active until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
DEFAULTED_FOR_SLR_MISSING_ON_HOLD - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see Using Service-Linked Roles for Amazon Lightsail in the Amazon Lightsail Developer Guide.
Unknown - The reason that synchronization failed is unknown. Contact Amazon Web Services Support for more information.

accountLevelBpaSync_status :: Lens' AccountLevelBpaSync (Maybe AccountLevelBpaSyncStatus) Source #

The status of the account-level BPA synchronization.

The following statuses are possible:

InSync - Account-level BPA is synchronized. The Amazon S3 account-level BPA configuration applies to your Lightsail buckets.
NeverSynced - Synchronization has not yet happened. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
Failed - Synchronization failed. The Amazon S3 account-level BPA configuration does not apply to your Lightsail buckets.
Defaulted - Synchronization failed and account-level BPA for your Lightsail buckets is defaulted to active.

You might need to complete further actions if the status is Failed or Defaulted. The message parameter provides more information for those statuses.