Class: AWSCDK::S3::CfnBucket::ObjectLockConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::S3::CfnBucket::ObjectLockConfigurationProperty

Defined in:

s3/cfn_bucket.rb

Overview

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 .

See Also:

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

Instance Attribute Summary

• #object_lock_enabled ⇒ String^? readonly

  Indicates whether this bucket has an Object Lock configuration enabled.

• #rule ⇒ AWSCDK::IResolvable, ... readonly

  Specifies the Object Lock rule for the specified object.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(object_lock_enabled: nil, rule: nil) ⇒ ObjectLockConfigurationProperty constructor

  A new instance of ObjectLockConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(object_lock_enabled: nil, rule: nil) ⇒ ObjectLockConfigurationProperty

Returns a new instance of ObjectLockConfigurationProperty.

Parameters:

• object_lock_enabled (String, nil) (defaults to: nil) —

  Indicates whether this bucket has an Object Lock configuration enabled.

• rule (AWSCDK::IResolvable, AWSCDK::S3::CfnBucket::ObjectLockRuleProperty, nil) (defaults to: nil) —

  Specifies the Object Lock rule for the specified object.

# File 's3/cfn_bucket.rb', line 2786

def initialize(object_lock_enabled: nil, rule: nil)
  @object_lock_enabled = object_lock_enabled
  Jsii::Type.check_type(@object_lock_enabled, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "objectLockEnabled") unless @object_lock_enabled.nil?
  @rule = rule.is_a?(Hash) ? ::AWSCDK::S3::CfnBucket::ObjectLockRuleProperty.new(**rule.transform_keys(&:to_sym)) : rule
  Jsii::Type.check_type(@rule, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zMy5DZm5CdWNrZXQuT2JqZWN0TG9ja1J1bGVQcm9wZXJ0eSJ9XX19")), "rule") unless @rule.nil?
end

Instance Attribute Details

#object_lock_enabled ⇒ String^? (readonly)

Indicates whether this bucket has an Object Lock configuration enabled.

Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

Returns:

• (String, nil)

See Also:

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

# File 's3/cfn_bucket.rb', line 2799

def object_lock_enabled
  @object_lock_enabled
end

#rule ⇒ AWSCDK::IResolvable, ... (readonly)

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:

• (AWSCDK::IResolvable, AWSCDK::S3::CfnBucket::ObjectLockRuleProperty, nil)

See Also:

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

# File 's3/cfn_bucket.rb', line 2806

def rule
  @rule
end

Class Method Details

.jsii_properties ⇒ Object

# File 's3/cfn_bucket.rb', line 2808

def self.jsii_properties
  {
    :object_lock_enabled => "objectLockEnabled",
    :rule => "rule",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 's3/cfn_bucket.rb', line 2815

def to_jsii
  result = {}
  result.merge!({
    "objectLockEnabled" => @object_lock_enabled,
    "rule" => @rule,
  })
  result.compact
end