Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   *
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.s3.model;
 
Represents the versioning configuration for a bucket.

A bucket's versioning configuration can be in one of three possible states:

By default, new buckets are in the off state. Once versioning is enabled for a bucket the status can never be reverted to off.

In addition to enabling versioning, a bucket's versioning configuration can also enable Multi-Factor Authentication (MFA) Delete, which restricts the ability to permanently delete a version of an object. When MFA Delete is enabled, only requests from the bucket owner which include an MFA token generated by the hardware authentication device associated with the bucket owner's AWS account can permanently delete an object version. For more information on AWS Multi-Factor Authentication see http://aws.amazon.com/mfa/

The versioning configuration of a bucket has different implications for each operation performed on that bucket or for objects within that bucket. For instance, when versioning is enabled, a PutObject operation creates a unique object version-id for the object being uploaded. The PutObject API guarantees that, if versioning is enabled for a bucket at the time of the request, the new object can only be permanently deleted using the DeleteVersion operation. It can never be overwritten. Additionally, PutObject guarantees that, if versioning is enabled for a bucket the request, no other object will be overwritten by that request. Refer to the documentation sections for each API for information on how versioning status affects the semantics of that particular API.

S3 is eventually consistent. It may take time for the versioning status of a bucket to be propagated throughout the system.

 
 public class BucketVersioningConfiguration {

    
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.
 
     public static final String OFF = "Off";

    
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.
 
     public static final String SUSPENDED = "Suspended";

    
S3 bucket versioning status indicating that versioning is enabled for a bucket.
 
     public static final String ENABLED = "Enabled";
   
    
    
The current status of versioning
 
     private String status;

    
Indicates if the optional Multi-Factor Authentication Delete control is enabled for this bucket versioning configuration.
 
     private Boolean isMfaDeleteEnabled = null;

    
    
Creates a new bucket versioning configuration object which defaults to OFF status.
        setStatus();
    }

    
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:
ENABLED
SUSPENDED
    public BucketVersioningConfiguration(String status) {
        setStatus(status);
    }

    
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.
See also:
OFF
ENABLED
SUSPENDED
    public String getStatus() {
        return ;
    }

    
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:
ENABLED
SUSPENDED
    public void setStatus(String status) {
        this. = 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:
ENABLED
SUSPENDED
        setStatus(status);
        return this;
    }

    
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 Boolean isMfaDeleteEnabled() {
        return ;
    }

    
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 setMfaDeleteEnabled(Boolean mfaDeleteEnabled) {
         = 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 withMfaDeleteEnabled(Boolean mfaDeleteEnabled) {
        setMfaDeleteEnabled(mfaDeleteEnabled);
        return this;
    }
    
New to GrepCode? Check out our FAQ X