com.amazonaws.services.lightsail.model

Class AccountLevelBpaSync

java.lang.Object

com.amazonaws.services.lightsail.model.AccountLevelBpaSync

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AccountLevelBpaSync
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AccountLevelBpaSync()

Method Summary

Modifier and Type	Method and Description
AccountLevelBpaSync	clone()
boolean	equals(Object obj)
Boolean	getBpaImpactsLightsail() A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
Date	getLastSyncedAt() The timestamp of when the account-level BPA configuration was last synchronized.
String	getMessage() A message that provides a reason for a Failed or Defaulted synchronization status.
String	getStatus() The status of the account-level BPA synchronization.
int	hashCode()
Boolean	isBpaImpactsLightsail() A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBpaImpactsLightsail(Boolean bpaImpactsLightsail) A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
void	setLastSyncedAt(Date lastSyncedAt) The timestamp of when the account-level BPA configuration was last synchronized.
void	setMessage(String message) A message that provides a reason for a Failed or Defaulted synchronization status.
void	setStatus(String status) The status of the account-level BPA synchronization.
String	toString() Returns a string representation of this object.
AccountLevelBpaSync	withBpaImpactsLightsail(Boolean bpaImpactsLightsail) A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.
AccountLevelBpaSync	withLastSyncedAt(Date lastSyncedAt) The timestamp of when the account-level BPA configuration was last synchronized.
AccountLevelBpaSync	withMessage(BPAStatusMessage message) A message that provides a reason for a Failed or Defaulted synchronization status.
AccountLevelBpaSync	withMessage(String message) A message that provides a reason for a Failed or Defaulted synchronization status.
AccountLevelBpaSync	withStatus(AccountLevelBpaSyncStatus status) The status of the account-level BPA synchronization.
AccountLevelBpaSync	withStatus(String status) The status of the account-level BPA synchronization.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AccountLevelBpaSync

public AccountLevelBpaSync()

Method Detail

setStatus

public void setStatus(String 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.

Parameters:

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.

See Also:

AccountLevelBpaSyncStatus

getStatus

public String getStatus()

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.

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

withStatus

public AccountLevelBpaSync withStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AccountLevelBpaSyncStatus

withStatus

public AccountLevelBpaSync withStatus(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AccountLevelBpaSyncStatus

setLastSyncedAt

public void setLastSyncedAt(Date 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.

Parameters:

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.

getLastSyncedAt

public Date getLastSyncedAt()

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.

withLastSyncedAt

public AccountLevelBpaSync withLastSyncedAt(Date 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMessage

public void setMessage(String 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.

Parameters:

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.

See Also:

BPAStatusMessage

getMessage

public String getMessage()

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.

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

withMessage

public AccountLevelBpaSync withMessage(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BPAStatusMessage

withMessage

public AccountLevelBpaSync withMessage(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BPAStatusMessage

setBpaImpactsLightsail

public void setBpaImpactsLightsail(Boolean bpaImpactsLightsail)

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

Parameters:

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

getBpaImpactsLightsail

public Boolean getBpaImpactsLightsail()

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.

withBpaImpactsLightsail

public AccountLevelBpaSync withBpaImpactsLightsail(Boolean bpaImpactsLightsail)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isBpaImpactsLightsail

public Boolean isBpaImpactsLightsail()

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AccountLevelBpaSync clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.