public class

BucketVersioningConfiguration

extends Object
implements Serializable
java.lang.Object
   ↳ org.mule.module.s3.model.BucketVersioningConfiguration

Summary

Constants
String ENABLED S3 bucket versioning status indicating that versioning is enabled for a bucket.
String OFF S3 bucket versioning status indicating that versioning is off for a bucket.
String SUSPENDED S3 bucket versioning status indicating that versioning is suspended for a bucket.
long serialVersionUID
Fields
private Boolean isMfaDeleteEnabled Indicates if the optional Multi-Factor Authentication Delete control is enabled for this bucket versioning configuration.
private String status The current status of versioning
Public Constructors
BucketVersioningConfiguration()
Creates a new bucket versioning configuration object which defaults to OFF status.
BucketVersioningConfiguration(String status)
Creates a new bucket versioning configuration object with the specified status.
Public Methods
String getStatus()
Returns the current status of versioning for this bucket versioning configuration object, indicating if versioning is enabled or not for a bucket.
Boolean isMfaDeleteEnabled()
Returns true if Multi-Factor Authentication (MFA) Delete is enabled for this bucket versioning configuration, false if it isn't enabled, and null if no information is available about the status of MFADelete.
void setMfaDeleteEnabled(Boolean mfaDeleteEnabled)
Sets the status of Multi-Factor Authentication (MFA) Delete for a bucket.
void setStatus(String status)
Sets the desired status of versioning for this bucket versioning configuration object.
BucketVersioningConfiguration withMfaDeleteEnabled(Boolean mfaDeleteEnabled)
Sets the status of Multi-Factor Authentication (MFA) Delete for a bucket, and returns this object so that additional method calls may be chained together.
BucketVersioningConfiguration withStatus(String status)
Sets the desired status of versioning for this bucket versioning configuration object, and returns this object so that additional method calls may be chained together.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String ENABLED

S3 bucket versioning status indicating that versioning is enabled for a bucket.

Constant Value: "Enabled"

public static final String OFF

S3 bucket versioning status indicating that versioning is off for a bucket. By default, all buckets start off with versioning off. Once you enable versioning for a bucket, you can never set the status back to "Off". You can only suspend versioning on a bucket once you've enabled.

Constant Value: "Off"

public static final String SUSPENDED

S3 bucket versioning status indicating that versioning is suspended for a bucket. Use the "Suspended" status when you want to disable versioning on a bucket that has versioning enabled.

Constant Value: "Suspended"

private static final long serialVersionUID

Constant Value: -789912755033989999 (0xf509aa88d0a61c91)

Fields

private Boolean isMfaDeleteEnabled

Indicates if the optional Multi-Factor Authentication Delete control is enabled for this bucket versioning configuration.

private String status

The current status of versioning

Public Constructors

public BucketVersioningConfiguration ()

Creates a new bucket versioning configuration object which defaults to OFF status.

public BucketVersioningConfiguration (String status)

Creates a new bucket versioning configuration object with the specified status.

Note that once versioning has been enabled for a bucket, its status can only be suspended and can never be set back to off.

Parameters
status The desired bucket versioning status for the new configuration object.
See Also

Public Methods

public String getStatus ()

Returns the current status of versioning for this bucket versioning configuration object, indicating if versioning is enabled or not for a bucket.

Returns
  • The current status of versioning for this bucket versioning configuration.

public Boolean isMfaDeleteEnabled ()

Returns true if Multi-Factor Authentication (MFA) Delete is enabled for this bucket versioning configuration, false if it isn't enabled, and null if no information is available about the status of MFADelete.

When MFA Delete is enabled, object versions can only be permanently deleted when the bucket owner passes in, as part of a delete version request, an MFA token from the hardware token generator associated with their AWS account.

By default, MFA Delete is not enabled.

When enabling or disabling MFA Delete controls, you must also supply an MFA token from the hardware token generator.

Returns
  • True if the Multi-Factor Authentication (MFA) Delete is enabled for this bucket versioning configuration, false if it isn't enabled, and null if no information is present on the status of MFA Delete.

public void setMfaDeleteEnabled (Boolean mfaDeleteEnabled)

Sets the status of Multi-Factor Authentication (MFA) Delete for a bucket. When MFA Delete is enabled, object versions can only be permanently deleted when the bucket owner passes in, as part of a delete version request, an MFA token from the hardware token generator associated with their AWS account.

By default, MFA Delete is not enabled.

When enabling or disabling MFA Delete controls, you must also supply an MFA token from the hardware token generator as part of the request.

Parameters
mfaDeleteEnabled True if the Multi-Factor Authentication (MFA) Delete is being enabled enabled, false if it is being disabled.

public void setStatus (String status)

Sets the desired status of versioning for this bucket versioning configuration object.

Note that once versioning has been enabled for a bucket, its status can only be suspended and can never be set back to off.

Parameters
status The desired status of versioning for this bucket versioning configuration.
See Also

public BucketVersioningConfiguration withMfaDeleteEnabled (Boolean mfaDeleteEnabled)

Sets the status of Multi-Factor Authentication (MFA) Delete for a bucket, and returns this object so that additional method calls may be chained together. When MFA Delete is enabled, object versions can only be permanently deleted when the bucket owner passes in, as part of a delete version request, an MFA token from the hardware token generator associated with their AWS account.

By default, MFA Delete is not enabled.

When enabling or disabling MFA Delete controls, you must also supply an MFA token from the hardware token generator as part of the request.

Parameters
mfaDeleteEnabled True if the Multi-Factor Authentication (MFA) Delete is being enabled enabled, false if it is being disabled.
Returns
  • The updated S3BucketVersioningConfiguration object so that additional method calls may be chained together.

public BucketVersioningConfiguration withStatus (String status)

Sets the desired status of versioning for this bucket versioning configuration object, and returns this object so that additional method calls may be chained together.

Note that once versioning has been enabled for a bucket, its status can only be suspended and can never be set back to off.

Parameters
status The desired status of versioning for this bucket versioning configuration.
Returns
  • The updated S3BucketVersioningConfiguration object so that additional method calls may be chained together.
See Also