Interface CfnBucket.IDefaultRetentionProperty

The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket.

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDefaultRetentionProperty

Syntax (vb)

Public Interface IDefaultRetentionProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3;

var defaultRetentionProperty = new DefaultRetentionProperty {
    Days = 123,
    Mode = "mode",
    Years = 123
};

Synopsis

Properties

Days	The number of days that you want to specify for the default retention period.
Mode	The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.
Years	The number of years that you want to specify for the default retention period.

Properties

Days

The number of days that you want to specify for the default retention period.

virtual Nullable<double> Days { get; }

Property Value

System.Nullable<System.Double>

Remarks

If Object Lock is turned on, you must specify Mode and specify either Days or Years .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-days

Mode

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.

virtual string Mode { get; }

Property Value

System.String

Remarks

If Object Lock is turned on, you must specify Mode and specify either Days or Years .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-mode

Years

The number of years that you want to specify for the default retention period.

virtual Nullable<double> Years { get; }

Property Value

System.Nullable<System.Double>

Remarks

If Object Lock is turned on, you must specify Mode and specify either Days or Years .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html#cfn-s3-bucket-defaultretention-years