Package software.amazon.awscdk.services.s3

Interface CfnBucket.ObjectLockConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.ObjectLockConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.ObjectLockConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Places an Object Lock configuration on the specified bucket.

The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 ObjectLockConfigurationProperty objectLockConfigurationProperty = ObjectLockConfigurationProperty.builder()
         .objectLockEnabled("objectLockEnabled")
         .rule(ObjectLockRuleProperty.builder()
                 .defaultRetention(DefaultRetentionProperty.builder()
                         .days(123)
                         .mode("mode")
                         .years(123)
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucket.ObjectLockConfigurationProperty.Builder	A builder for CfnBucket.ObjectLockConfigurationProperty
static final class	CfnBucket.ObjectLockConfigurationProperty.Jsii$Proxy	An implementation for CfnBucket.ObjectLockConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnBucket.ObjectLockConfigurationProperty.Builder	builder()
default String	getObjectLockEnabled()	Indicates whether this bucket has an Object Lock configuration enabled.
default Object	getRule()	Specifies the Object Lock rule for the specified object.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getObjectLockEnabled

@Stability(Stable)
@Nullable
default String getObjectLockEnabled()

Indicates whether this bucket has an Object Lock configuration enabled.

Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-objectlockenabled

getRule

@Stability(Stable)
@Nullable
default Object getRule()

Specifies the Object Lock rule for the specified object.

Enable this rule when you apply ObjectLockConfiguration to a bucket. If Object Lock is turned on, bucket settings require both Mode and a period of either Days or Years . You cannot specify Days and Years at the same time. For more information, see ObjectLockRule and DefaultRetention .

Returns union: either IResolvable or CfnBucket.ObjectLockRuleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockconfiguration.html#cfn-s3-bucket-objectlockconfiguration-rule

builder

@Stability(Stable)
static CfnBucket.ObjectLockConfigurationProperty.Builder builder()

Returns:

a CfnBucket.ObjectLockConfigurationProperty.Builder of CfnBucket.ObjectLockConfigurationProperty