Network.AWS.DMS.CreateEventSubscription

Creates an AWS DMS event notification subscription.

You can specify the type of source (SourceType ) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds ) that triggers the events, and provide a list of event categories (EventCategories ) for events you want to be notified of. If you specify both the SourceType and SourceIds , such as SourceType = replication-instance and SourceIdentifier = my-replinstance , you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier , you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either SourceType nor SourceIdentifier , you will be notified of events generated from all AWS DMS sources belonging to your customer account.

For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database MIgration Service User Guide.

Creating a Request

createEventSubscription

Arguments

:: Text

cesSubscriptionName

-> Text

cesSNSTopicARN

-> CreateEventSubscription

Creates a value of CreateEventSubscription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cesEnabled - A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.
• cesSourceType - The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance . If this value is not specified, all events are returned. Valid values: replication-instance | migration-task
• cesEventCategories - A list of event categories for a source type that you want to subscribe to. You can see a list of the categories for a given source type by calling the DescribeEventCategories action or in the topic Working with Events and Notifications in the AWS Database Migration Service User Guide.
• cesSourceIds - The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.
• cesTags - A tag to be attached to the event subscription.
• cesSubscriptionName - The name of the DMS event notification subscription. Constraints: The name must be less than 255 characters.
• cesSNSTopicARN - The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

data CreateEventSubscription

See: createEventSubscription smart constructor.

Instances

Eq CreateEventSubscription

Methods

(==) :: CreateEventSubscription -> CreateEventSubscription -> Bool

(/=) :: CreateEventSubscription -> CreateEventSubscription -> Bool

Data CreateEventSubscription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateEventSubscription -> c CreateEventSubscription

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateEventSubscription

toConstr :: CreateEventSubscription -> Constr

dataTypeOf :: CreateEventSubscription -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateEventSubscription)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateEventSubscription)

gmapT :: (forall b. Data b => b -> b) -> CreateEventSubscription -> CreateEventSubscription

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateEventSubscription -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateEventSubscription -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateEventSubscription -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateEventSubscription -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateEventSubscription -> m CreateEventSubscription

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEventSubscription -> m CreateEventSubscription

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEventSubscription -> m CreateEventSubscription

Read CreateEventSubscription

Methods

readsPrec :: Int -> ReadS CreateEventSubscription

readList :: ReadS [CreateEventSubscription]

readPrec :: ReadPrec CreateEventSubscription

readListPrec :: ReadPrec [CreateEventSubscription]

Show CreateEventSubscription

Methods

showsPrec :: Int -> CreateEventSubscription -> ShowS

show :: CreateEventSubscription -> String

showList :: [CreateEventSubscription] -> ShowS

Generic CreateEventSubscription

Associated Types

type Rep CreateEventSubscription :: * -> *

Methods

from :: CreateEventSubscription -> Rep CreateEventSubscription x

to :: Rep CreateEventSubscription x -> CreateEventSubscription

Hashable CreateEventSubscription

Methods

hashWithSalt :: Int -> CreateEventSubscription -> Int

hash :: CreateEventSubscription -> Int

ToJSON CreateEventSubscription

Methods

toJSON :: CreateEventSubscription -> Value

toEncoding :: CreateEventSubscription -> Encoding

toJSONList :: [CreateEventSubscription] -> Value

toEncodingList :: [CreateEventSubscription] -> Encoding

NFData CreateEventSubscription

Methods

rnf :: CreateEventSubscription -> ()

AWSRequest CreateEventSubscription

Associated Types

type Rs CreateEventSubscription :: *

Methods

request :: CreateEventSubscription -> Request CreateEventSubscription

response :: MonadResource m => Logger -> Service -> Proxy * CreateEventSubscription -> ClientResponse -> m (Response CreateEventSubscription)

ToQuery CreateEventSubscription

Methods

toQuery :: CreateEventSubscription -> QueryString

ToPath CreateEventSubscription

Methods

toPath :: CreateEventSubscription -> ByteString

ToHeaders CreateEventSubscription

Methods

toHeaders :: CreateEventSubscription -> [Header]

type Rep CreateEventSubscription

type Rep CreateEventSubscription = D1 (MetaData "CreateEventSubscription" "Network.AWS.DMS.CreateEventSubscription" "amazonka-dms-1.5.0-K6vSYoWLw2X8OYk9sVbLk5" False) (C1 (MetaCons "CreateEventSubscription'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cesEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_cesSourceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cesEventCategories") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cesSourceIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_cesTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag])))) ((:*:) (S1 (MetaSel (Just Symbol "_cesSubscriptionName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cesSNSTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs CreateEventSubscription

type Rs CreateEventSubscription = CreateEventSubscriptionResponse

Request Lenses

cesEnabled :: Lens' CreateEventSubscription (Maybe Bool)

A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.

cesSourceType :: Lens' CreateEventSubscription (Maybe Text)

The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance . If this value is not specified, all events are returned. Valid values: replication-instance | migration-task

cesEventCategories :: Lens' CreateEventSubscription [Text]

A list of event categories for a source type that you want to subscribe to. You can see a list of the categories for a given source type by calling the DescribeEventCategories action or in the topic Working with Events and Notifications in the AWS Database Migration Service User Guide.

cesSourceIds :: Lens' CreateEventSubscription [Text]

The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

cesTags :: Lens' CreateEventSubscription [Tag]

A tag to be attached to the event subscription.

cesSubscriptionName :: Lens' CreateEventSubscription Text

The name of the DMS event notification subscription. Constraints: The name must be less than 255 characters.

cesSNSTopicARN :: Lens' CreateEventSubscription Text

The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Destructuring the Response

createEventSubscriptionResponse

Arguments

:: Int

cesrsResponseStatus

-> CreateEventSubscriptionResponse

Creates a value of CreateEventSubscriptionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cesrsEventSubscription - The event subscription that was created.
• cesrsResponseStatus - -- | The response status code.

data CreateEventSubscriptionResponse

See: createEventSubscriptionResponse smart constructor.

Instances

Eq CreateEventSubscriptionResponse

Methods

(==) :: CreateEventSubscriptionResponse -> CreateEventSubscriptionResponse -> Bool

(/=) :: CreateEventSubscriptionResponse -> CreateEventSubscriptionResponse -> Bool

Data CreateEventSubscriptionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateEventSubscriptionResponse -> c CreateEventSubscriptionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateEventSubscriptionResponse

toConstr :: CreateEventSubscriptionResponse -> Constr

dataTypeOf :: CreateEventSubscriptionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateEventSubscriptionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateEventSubscriptionResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateEventSubscriptionResponse -> CreateEventSubscriptionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateEventSubscriptionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateEventSubscriptionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateEventSubscriptionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateEventSubscriptionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateEventSubscriptionResponse -> m CreateEventSubscriptionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEventSubscriptionResponse -> m CreateEventSubscriptionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEventSubscriptionResponse -> m CreateEventSubscriptionResponse

Read CreateEventSubscriptionResponse

Methods

readsPrec :: Int -> ReadS CreateEventSubscriptionResponse

readList :: ReadS [CreateEventSubscriptionResponse]

readPrec :: ReadPrec CreateEventSubscriptionResponse

readListPrec :: ReadPrec [CreateEventSubscriptionResponse]

Show CreateEventSubscriptionResponse

Methods

showsPrec :: Int -> CreateEventSubscriptionResponse -> ShowS

show :: CreateEventSubscriptionResponse -> String

showList :: [CreateEventSubscriptionResponse] -> ShowS

Generic CreateEventSubscriptionResponse

Associated Types

type Rep CreateEventSubscriptionResponse :: * -> *

Methods

from :: CreateEventSubscriptionResponse -> Rep CreateEventSubscriptionResponse x

to :: Rep CreateEventSubscriptionResponse x -> CreateEventSubscriptionResponse

NFData CreateEventSubscriptionResponse

Methods

rnf :: CreateEventSubscriptionResponse -> ()

type Rep CreateEventSubscriptionResponse

type Rep CreateEventSubscriptionResponse = D1 (MetaData "CreateEventSubscriptionResponse" "Network.AWS.DMS.CreateEventSubscription" "amazonka-dms-1.5.0-K6vSYoWLw2X8OYk9sVbLk5" False) (C1 (MetaCons "CreateEventSubscriptionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cesrsEventSubscription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EventSubscription))) (S1 (MetaSel (Just Symbol "_cesrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

cesrsEventSubscription :: Lens' CreateEventSubscriptionResponse (Maybe EventSubscription)

The event subscription that was created.

cesrsResponseStatus :: Lens' CreateEventSubscriptionResponse Int

• - | The response status code.