Class AccountLevelBpaSync
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AccountLevelBpaSync.Builder,
AccountLevelBpaSync>
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 Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.static AccountLevelBpaSync.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
The timestamp of when the account-level BPA configuration was last synchronized.final BPAStatusMessage
message()
A message that provides a reason for aFailed
orDefaulted
synchronization status.final String
A message that provides a reason for aFailed
orDefaulted
synchronization status.static Class
<? extends AccountLevelBpaSync.Builder> status()
The status of the account-level BPA synchronization.final String
The status of the account-level BPA synchronization.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
orDefaulted
. Themessage
parameter provides more information for those statuses.If the service returns an enum value that is not available in the current SDK version,
status
will returnAccountLevelBpaSyncStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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
orDefaulted
. Themessage
parameter provides more information for those statuses. -
- See Also:
-
-
statusAsString
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
orDefaulted
. Themessage
parameter provides more information for those statuses.If the service returns an enum value that is not available in the current SDK version,
status
will returnAccountLevelBpaSyncStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- 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
orDefaulted
. Themessage
parameter provides more information for those statuses. -
- See Also:
-
-
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.
- Returns:
- 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
A message that provides a reason for a
Failed
orDefaulted
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.
If the service returns an enum value that is not available in the current SDK version,
message
will returnBPAStatusMessage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageAsString()
.- Returns:
- A message that provides a reason for a
Failed
orDefaulted
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.
-
- See Also:
-
-
messageAsString
A message that provides a reason for a
Failed
orDefaulted
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.
If the service returns an enum value that is not available in the current SDK version,
message
will returnBPAStatusMessage.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageAsString()
.- Returns:
- A message that provides a reason for a
Failed
orDefaulted
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.
-
- See Also:
-
-
bpaImpactsLightsail
A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
- Returns:
- A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
-
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 interfaceToCopyableBuilder<AccountLevelBpaSync.Builder,
AccountLevelBpaSync> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-