Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.S3.Types.FilterRule

Description

Synopsis

data FilterRule = FilterRule' {
- name :: Maybe FilterRuleName
- value :: Maybe Text
}
newFilterRule :: FilterRule
filterRule_name :: Lens' FilterRule (Maybe FilterRuleName)
filterRule_value :: Lens' FilterRule (Maybe Text)

Documentation

data FilterRule Source #

Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.

See: newFilterRule smart constructor.

Constructors

FilterRule'

Fields

name :: Maybe FilterRuleName
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.
value :: Maybe Text
The value that the filter searches for in object key names.

Instances

Instances details

FromXML FilterRule Source #
Instance details Defined in Amazonka.S3.Types.FilterRule Methods parseXML :: [Node] -> Either String FilterRule #
ToXML FilterRule Source #
Instance details Defined in Amazonka.S3.Types.FilterRule Methods toXML :: FilterRule -> XML #
Generic FilterRule Source #
Instance details Defined in Amazonka.S3.Types.FilterRule Associated Types type Rep FilterRule :: Type -> Type # Methods from :: FilterRule -> Rep FilterRule x # to :: Rep FilterRule x -> FilterRule #
Read FilterRule Source #
Instance details Defined in Amazonka.S3.Types.FilterRule Methods readsPrec :: Int -> ReadS FilterRule # readList :: ReadS [FilterRule] # readPrec :: ReadPrec FilterRule # readListPrec :: ReadPrec [FilterRule] #
Show FilterRule Source #
Instance details Defined in Amazonka.S3.Types.FilterRule Methods showsPrec :: Int -> FilterRule -> ShowS # show :: FilterRule -> String # showList :: [FilterRule] -> ShowS #
NFData FilterRule Source #
Instance details Defined in Amazonka.S3.Types.FilterRule Methods rnf :: FilterRule -> () #
Eq FilterRule Source #
Instance details Defined in Amazonka.S3.Types.FilterRule Methods (==) :: FilterRule -> FilterRule -> Bool # (/=) :: FilterRule -> FilterRule -> Bool #
Hashable FilterRule Source #
Instance details Defined in Amazonka.S3.Types.FilterRule Methods hashWithSalt :: Int -> FilterRule -> Int # hash :: FilterRule -> Int #
type Rep FilterRule Source #
Instance details Defined in Amazonka.S3.Types.FilterRule type Rep FilterRule = D1 ('MetaData "FilterRule" "Amazonka.S3.Types.FilterRule" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "FilterRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FilterRuleName)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newFilterRule :: FilterRule Source #

Create a value of FilterRule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:FilterRule', filterRule_name - 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.

$sel:value:FilterRule', filterRule_value - The value that the filter searches for in object key names.

filterRule_name :: Lens' FilterRule (Maybe FilterRuleName) Source #

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.

filterRule_value :: Lens' FilterRule (Maybe Text) Source #

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