AccountLevelBpaSync (AWS Java SDK :: Services :: Amazon Lightsail 2.21.17 API)

java.lang.Object
- software.amazon.awssdk.services.lightsail.model.AccountLevelBpaSync

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AccountLevelBpaSync.Builder,AccountLevelBpaSync>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AccountLevelBpaSync
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AccountLevelBpaSync.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AccountLevelBpaSync.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`bpaImpactsLightsail()` A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
`static AccountLevelBpaSync.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastSyncedAt()` The timestamp of when the account-level BPA configuration was last synchronized.
`BPAStatusMessage`	`message()` A message that provides a reason for a `Failed` or `Defaulted` synchronization status.
`String`	`messageAsString()` A message that provides a reason for a `Failed` or `Defaulted` synchronization status.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AccountLevelBpaSync.Builder>`	`serializableBuilderClass()`
`AccountLevelBpaSyncStatus`	`status()` The status of the account-level BPA synchronization.
`String`	`statusAsString()` The status of the account-level BPA synchronization.
`AccountLevelBpaSync.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
  - status
```
public final AccountLevelBpaSyncStatus 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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return AccountLevelBpaSyncStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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 or Defaulted . The message parameter provides more information for those statuses.
    See Also:
    
    AccountLevelBpaSyncStatus
  - statusAsString
```
public final String 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 or Defaulted. The message 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 return AccountLevelBpaSyncStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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 or Defaulted . The message parameter provides more information for those statuses.
    See Also:
    
    AccountLevelBpaSyncStatus
  - lastSyncedAt
```
public final Instant 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
```
public final BPAStatusMessage 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.
    If the service returns an enum value that is not available in the current SDK version, message will return BPAStatusMessage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageAsString().
    Returns:
    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.
    See Also:
    
    BPAStatusMessage
  - messageAsString
```
public final String messageAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, message will return BPAStatusMessage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageAsString().
    Returns:
    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.
    See Also:
    
    BPAStatusMessage
  - bpaImpactsLightsail
```
public final Boolean 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
```
public AccountLevelBpaSync.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AccountLevelBpaSync.Builder,AccountLevelBpaSync>
  - builder
```
public static AccountLevelBpaSync.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AccountLevelBpaSync.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

Class AccountLevelBpaSync

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

status

statusAsString

lastSyncedAt

message

messageAsString

bpaImpactsLightsail

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields