Network.AWS.RDS.CreateEventSubscription

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.

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, set to false to create the subscription but not active it.
• cesSourceType - The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot
• cesEventCategories - A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
• cesSourceIds - The list of identifiers of the event sources for which events are 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 can't end with a hyphen or contain two consecutive hyphens. Constraints: * If SourceIds are supplied, SourceType must also be provided. * If the source type is a DB instance, then a DBInstanceIdentifier must be supplied. * If the source type is a DB security group, a DBSecurityGroupName must be supplied. * If the source type is a DB parameter group, a DBParameterGroupName must be supplied. * If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
• cesTags - Undocumented member.
• cesSubscriptionName - The name of the subscription. Constraints: The name must be less than 255 characters.
• cesSNSTopicARN - The Amazon Resource Name (ARN) of the 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

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

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

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

Data CreateEventSubscription

Defined in Network.AWS.RDS.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

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

readsPrec :: Int -> ReadS CreateEventSubscription

readList :: ReadS [CreateEventSubscription]

readPrec :: ReadPrec CreateEventSubscription

readListPrec :: ReadPrec [CreateEventSubscription]

Show CreateEventSubscription

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

showsPrec :: Int -> CreateEventSubscription -> ShowS

show :: CreateEventSubscription -> String

showList :: [CreateEventSubscription] -> ShowS

Generic CreateEventSubscription

Defined in Network.AWS.RDS.CreateEventSubscription

Associated Types

type Rep CreateEventSubscription :: Type -> Type

Methods

from :: CreateEventSubscription -> Rep CreateEventSubscription x

to :: Rep CreateEventSubscription x -> CreateEventSubscription

Hashable CreateEventSubscription

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

hashWithSalt :: Int -> CreateEventSubscription -> Int

hash :: CreateEventSubscription -> Int

AWSRequest CreateEventSubscription

Defined in Network.AWS.RDS.CreateEventSubscription

Associated Types

type Rs CreateEventSubscription :: Type

Methods

request :: CreateEventSubscription -> Request CreateEventSubscription

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

ToHeaders CreateEventSubscription

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

toHeaders :: CreateEventSubscription -> [Header]

ToPath CreateEventSubscription

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

toPath :: CreateEventSubscription -> ByteString

ToQuery CreateEventSubscription

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

toQuery :: CreateEventSubscription -> QueryString

NFData CreateEventSubscription

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

rnf :: CreateEventSubscription -> ()

type Rep CreateEventSubscription

Defined in Network.AWS.RDS.CreateEventSubscription

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

type Rs CreateEventSubscription

Defined in Network.AWS.RDS.CreateEventSubscription

type Rs CreateEventSubscription = CreateEventSubscriptionResponse

Request Lenses

cesEnabled :: Lens' CreateEventSubscription (Maybe Bool)

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

cesSourceType :: Lens' CreateEventSubscription (Maybe Text)

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

cesEventCategories :: Lens' CreateEventSubscription [Text]

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

cesSourceIds :: Lens' CreateEventSubscription [Text]

The list of identifiers of the event sources for which events are 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 can't end with a hyphen or contain two consecutive hyphens. Constraints: * If SourceIds are supplied, SourceType must also be provided. * If the source type is a DB instance, then a DBInstanceIdentifier must be supplied. * If the source type is a DB security group, a DBSecurityGroupName must be supplied. * If the source type is a DB parameter group, a DBParameterGroupName must be supplied. * If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

cesTags :: Lens' CreateEventSubscription [Tag]

Undocumented member.

cesSubscriptionName :: Lens' CreateEventSubscription Text

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

cesSNSTopicARN :: Lens' CreateEventSubscription Text

The Amazon Resource Name (ARN) of the 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 - Undocumented member.
• cesrsResponseStatus - -- | The response status code.

data CreateEventSubscriptionResponse

See: createEventSubscriptionResponse smart constructor.

Instances

Eq CreateEventSubscriptionResponse

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

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

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

Data CreateEventSubscriptionResponse

Defined in Network.AWS.RDS.CreateEventSubscription

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

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

readsPrec :: Int -> ReadS CreateEventSubscriptionResponse

readList :: ReadS [CreateEventSubscriptionResponse]

readPrec :: ReadPrec CreateEventSubscriptionResponse

readListPrec :: ReadPrec [CreateEventSubscriptionResponse]

Show CreateEventSubscriptionResponse

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

showsPrec :: Int -> CreateEventSubscriptionResponse -> ShowS

show :: CreateEventSubscriptionResponse -> String

showList :: [CreateEventSubscriptionResponse] -> ShowS

Generic CreateEventSubscriptionResponse

Defined in Network.AWS.RDS.CreateEventSubscription

Associated Types

type Rep CreateEventSubscriptionResponse :: Type -> Type

Methods

from :: CreateEventSubscriptionResponse -> Rep CreateEventSubscriptionResponse x

to :: Rep CreateEventSubscriptionResponse x -> CreateEventSubscriptionResponse

NFData CreateEventSubscriptionResponse

Defined in Network.AWS.RDS.CreateEventSubscription

Methods

rnf :: CreateEventSubscriptionResponse -> ()

type Rep CreateEventSubscriptionResponse

Defined in Network.AWS.RDS.CreateEventSubscription

type Rep CreateEventSubscriptionResponse = D1 (MetaData "CreateEventSubscriptionResponse" "Network.AWS.RDS.CreateEventSubscription" "amazonka-rds-1.6.1-GvYb6r2di9RGFKQcoJXq1A" False) (C1 (MetaCons "CreateEventSubscriptionResponse'" PrefixI True) (S1 (MetaSel (Just "_cesrsEventSubscription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 (MetaSel (Just "_cesrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

cesrsEventSubscription :: Lens' CreateEventSubscriptionResponse (Maybe EventSubscription)

Undocumented member.

cesrsResponseStatus :: Lens' CreateEventSubscriptionResponse Int

• - | The response status code.