Class: AWSCDK::S3::CfnBucket::FilterRuleProperty

Inherits:

Jsii::Struct

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

Defined in:

s3/cfn_bucket.rb

Overview

Specifies the Amazon S3 object key name to filter on.

An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as 2023- or engineering/ . Then, you can use FilterRule to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.

See Also:

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

Instance Attribute Summary

• #name ⇒ String readonly

  The object key name prefix or suffix identifying one or more objects to which the filtering rule applies.

• #value ⇒ String readonly

  The value that the filter searches for in object key names.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name:, value:) ⇒ FilterRuleProperty constructor

  A new instance of FilterRuleProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name:, value:) ⇒ FilterRuleProperty

Returns a new instance of FilterRuleProperty.

Parameters:

• name (String) —

  The object key name prefix or suffix identifying one or more objects to which the filtering rule applies.

• value (String) —

  The value that the filter searches for in object key names.

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

def initialize(name:, value:)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
end

Instance Attribute Details

#name ⇒ String (readonly)

The object key name prefix or suffix identifying one or more objects to which the filtering rule applies.

The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide .

Returns:

• (String)

See Also:

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

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

def name
  @name
end

#value ⇒ String (readonly)

The value that the filter searches for in object key names.

Returns:

• (String)

See Also:

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

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

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :name => "name",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "value" => @value,
  })
  result.compact
end