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.DocumentDB.Types.EventSubscription

Description

Synopsis

data EventSubscription = EventSubscription' {
- status :: Maybe Text
- customerAwsId :: Maybe Text
- custSubscriptionId :: Maybe Text
- snsTopicArn :: Maybe Text
- eventSubscriptionArn :: Maybe Text
- enabled :: Maybe Bool
- sourceType :: Maybe Text
- subscriptionCreationTime :: Maybe Text
- eventCategoriesList :: Maybe [Text]
- sourceIdsList :: Maybe [Text]
}
newEventSubscription :: EventSubscription
eventSubscription_status :: Lens' EventSubscription (Maybe Text)
eventSubscription_customerAwsId :: Lens' EventSubscription (Maybe Text)
eventSubscription_custSubscriptionId :: Lens' EventSubscription (Maybe Text)
eventSubscription_snsTopicArn :: Lens' EventSubscription (Maybe Text)
eventSubscription_eventSubscriptionArn :: Lens' EventSubscription (Maybe Text)
eventSubscription_enabled :: Lens' EventSubscription (Maybe Bool)
eventSubscription_sourceType :: Lens' EventSubscription (Maybe Text)
eventSubscription_subscriptionCreationTime :: Lens' EventSubscription (Maybe Text)
eventSubscription_eventCategoriesList :: Lens' EventSubscription (Maybe [Text])
eventSubscription_sourceIdsList :: Lens' EventSubscription (Maybe [Text])

Documentation

data EventSubscription Source #

Detailed information about an event to which you have subscribed.

See: newEventSubscription smart constructor.

Constructors

EventSubscription'

Fields

status :: Maybe Text
The status of the Amazon DocumentDB event notification subscription.
Constraints:
Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist
The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.
customerAwsId :: Maybe Text
The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.
custSubscriptionId :: Maybe Text
The Amazon DocumentDB event notification subscription ID.
snsTopicArn :: Maybe Text
The topic ARN of the Amazon DocumentDB event notification subscription.
eventSubscriptionArn :: Maybe Text
The Amazon Resource Name (ARN) for the event subscription.
enabled :: Maybe Bool
A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.
sourceType :: Maybe Text
The source type for the Amazon DocumentDB event notification subscription.
subscriptionCreationTime :: Maybe Text
The time at which the Amazon DocumentDB event notification subscription was created.
eventCategoriesList :: Maybe [Text]
A list of event categories for the Amazon DocumentDB event notification subscription.
sourceIdsList :: Maybe [Text]
A list of source IDs for the Amazon DocumentDB event notification subscription.

Instances

Instances details

Eq EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods (==) :: EventSubscription -> EventSubscription -> Bool # (/=) :: EventSubscription -> EventSubscription -> Bool #
Read EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods readsPrec :: Int -> ReadS EventSubscription # readList :: ReadS [EventSubscription] # readPrec :: ReadPrec EventSubscription # readListPrec :: ReadPrec [EventSubscription] #
Show EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods showsPrec :: Int -> EventSubscription -> ShowS # show :: EventSubscription -> String # showList :: [EventSubscription] -> ShowS #
Generic EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Associated Types type Rep EventSubscription :: Type -> Type # Methods from :: EventSubscription -> Rep EventSubscription x # to :: Rep EventSubscription x -> EventSubscription #
NFData EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods rnf :: EventSubscription -> () #
Hashable EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods hashWithSalt :: Int -> EventSubscription -> Int # hash :: EventSubscription -> Int #
FromXML EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription Methods parseXML :: [Node] -> Either String EventSubscription #
type Rep EventSubscription Source #
Instance details Defined in Amazonka.DocumentDB.Types.EventSubscription type Rep EventSubscription = D1 ('MetaData "EventSubscription" "Amazonka.DocumentDB.Types.EventSubscription" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "EventSubscription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "customerAwsId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "custSubscriptionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eventSubscriptionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "subscriptionCreationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "eventCategoriesList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "sourceIdsList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newEventSubscription :: EventSubscription Source #

Create a value of EventSubscription 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:status:EventSubscription', eventSubscription_status - The status of the Amazon DocumentDB event notification subscription.

Constraints:

Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

$sel:customerAwsId:EventSubscription', eventSubscription_customerAwsId - The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

$sel:custSubscriptionId:EventSubscription', eventSubscription_custSubscriptionId - The Amazon DocumentDB event notification subscription ID.

$sel:snsTopicArn:EventSubscription', eventSubscription_snsTopicArn - The topic ARN of the Amazon DocumentDB event notification subscription.

$sel:eventSubscriptionArn:EventSubscription', eventSubscription_eventSubscriptionArn - The Amazon Resource Name (ARN) for the event subscription.

$sel:enabled:EventSubscription', eventSubscription_enabled - A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

$sel:sourceType:EventSubscription', eventSubscription_sourceType - The source type for the Amazon DocumentDB event notification subscription.

$sel:subscriptionCreationTime:EventSubscription', eventSubscription_subscriptionCreationTime - The time at which the Amazon DocumentDB event notification subscription was created.

$sel:eventCategoriesList:EventSubscription', eventSubscription_eventCategoriesList - A list of event categories for the Amazon DocumentDB event notification subscription.

$sel:sourceIdsList:EventSubscription', eventSubscription_sourceIdsList - A list of source IDs for the Amazon DocumentDB event notification subscription.

eventSubscription_status :: Lens' EventSubscription (Maybe Text) Source #

The status of the Amazon DocumentDB event notification subscription.

Constraints:

Can be one of the following: creating, modifying, deleting, active, no-permission, topic-not-exist

The no-permission status indicates that Amazon DocumentDB no longer has permission to post to the SNS topic. The topic-not-exist status indicates that the topic was deleted after the subscription was created.

eventSubscription_customerAwsId :: Lens' EventSubscription (Maybe Text) Source #

The Amazon Web Services customer account that is associated with the Amazon DocumentDB event notification subscription.

eventSubscription_custSubscriptionId :: Lens' EventSubscription (Maybe Text) Source #

The Amazon DocumentDB event notification subscription ID.

eventSubscription_snsTopicArn :: Lens' EventSubscription (Maybe Text) Source #

The topic ARN of the Amazon DocumentDB event notification subscription.

eventSubscription_eventSubscriptionArn :: Lens' EventSubscription (Maybe Text) Source #

The Amazon Resource Name (ARN) for the event subscription.

eventSubscription_enabled :: Lens' EventSubscription (Maybe Bool) Source #

A Boolean value indicating whether the subscription is enabled. A value of true indicates that the subscription is enabled.

eventSubscription_sourceType :: Lens' EventSubscription (Maybe Text) Source #

The source type for the Amazon DocumentDB event notification subscription.

eventSubscription_subscriptionCreationTime :: Lens' EventSubscription (Maybe Text) Source #

The time at which the Amazon DocumentDB event notification subscription was created.

eventSubscription_eventCategoriesList :: Lens' EventSubscription (Maybe [Text]) Source #

A list of event categories for the Amazon DocumentDB event notification subscription.

eventSubscription_sourceIdsList :: Lens' EventSubscription (Maybe [Text]) Source #

A list of source IDs for the Amazon DocumentDB event notification subscription.