Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DLM.Types.EventParameters

Description

Documentation

data EventParameters Source #

Specifies an event that triggers an event-based policy.

See: newEventParameters smart constructor.

Constructors

EventParameters'

Fields

eventType :: EventTypeValues
The type of event. Currently, only snapshot sharing events are supported.
snapshotOwner :: [Text]
The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.
descriptionRegex :: Text
The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.
For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.

Instances

Instances details

Eq EventParameters Source #
Instance details Defined in Amazonka.DLM.Types.EventParameters Methods (==) :: EventParameters -> EventParameters -> Bool # (/=) :: EventParameters -> EventParameters -> Bool #
Read EventParameters Source #
Instance details Defined in Amazonka.DLM.Types.EventParameters Methods readsPrec :: Int -> ReadS EventParameters # readList :: ReadS [EventParameters] # readPrec :: ReadPrec EventParameters # readListPrec :: ReadPrec [EventParameters] #
Show EventParameters Source #
Instance details Defined in Amazonka.DLM.Types.EventParameters Methods showsPrec :: Int -> EventParameters -> ShowS # show :: EventParameters -> String # showList :: [EventParameters] -> ShowS #
Generic EventParameters Source #
Instance details Defined in Amazonka.DLM.Types.EventParameters Associated Types type Rep EventParameters :: Type -> Type # Methods from :: EventParameters -> Rep EventParameters x # to :: Rep EventParameters x -> EventParameters #
NFData EventParameters Source #
Instance details Defined in Amazonka.DLM.Types.EventParameters Methods rnf :: EventParameters -> () #
Hashable EventParameters Source #
Instance details Defined in Amazonka.DLM.Types.EventParameters Methods hashWithSalt :: Int -> EventParameters -> Int # hash :: EventParameters -> Int #
ToJSON EventParameters Source #
Instance details Defined in Amazonka.DLM.Types.EventParameters Methods toJSON :: EventParameters -> Value # toEncoding :: EventParameters -> Encoding # toJSONList :: [EventParameters] -> Value # toEncodingList :: [EventParameters] -> Encoding #
FromJSON EventParameters Source #
Instance details Defined in Amazonka.DLM.Types.EventParameters Methods parseJSON :: Value -> Parser EventParameters # parseJSONList :: Value -> Parser [EventParameters] #
type Rep EventParameters Source #
Instance details Defined in Amazonka.DLM.Types.EventParameters type Rep EventParameters = D1 ('MetaData "EventParameters" "Amazonka.DLM.Types.EventParameters" "libZSservicesZSamazonka-dlmZSamazonka-dlm" 'False) (C1 ('MetaCons "EventParameters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EventTypeValues) :: (S1 ('MetaSel ('Just "snapshotOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "descriptionRegex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newEventParameters Source #

Arguments

:: EventTypeValues	`$sel:eventType:EventParameters'`
-> Text	`$sel:descriptionRegex:EventParameters'`
-> EventParameters

Create a value of EventParameters 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:eventType:EventParameters', eventParameters_eventType - The type of event. Currently, only snapshot sharing events are supported.

$sel:snapshotOwner:EventParameters', eventParameters_snapshotOwner - The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.

$sel:descriptionRegex:EventParameters', eventParameters_descriptionRegex - The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.

For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.

eventParameters_eventType :: Lens' EventParameters EventTypeValues Source #

The type of event. Currently, only snapshot sharing events are supported.

eventParameters_snapshotOwner :: Lens' EventParameters [Text] Source #

The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.

eventParameters_descriptionRegex :: Lens' EventParameters Text Source #

The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.

For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.