amazonka-rds-1.4.5: Amazon Relational Database Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.RDS.CreateEventSubscription

Contents

Description

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 will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will 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 will be notified of events generated from all RDS sources belonging to your customer account.

Synopsis

Creating a Request

createEventSubscription Source #

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 will be 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 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. 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 Source #

See: createEventSubscription smart constructor.

Instances

Eq CreateEventSubscription Source # 
Data CreateEventSubscription Source # 

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 Source # 
Show CreateEventSubscription Source # 
Generic CreateEventSubscription Source # 
Hashable CreateEventSubscription Source # 
NFData CreateEventSubscription Source # 

Methods

rnf :: CreateEventSubscription -> () #

AWSRequest CreateEventSubscription Source # 
ToPath CreateEventSubscription Source # 
ToHeaders CreateEventSubscription Source # 
ToQuery CreateEventSubscription Source # 
type Rep CreateEventSubscription Source # 
type Rep CreateEventSubscription = D1 (MetaData "CreateEventSubscription" "Network.AWS.RDS.CreateEventSubscription" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" 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 Source # 

Request Lenses

cesEnabled :: Lens' CreateEventSubscription (Maybe Bool) Source #

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) Source #

The type of source that will be 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] Source #

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] Source #

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. 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] Source #

Undocumented member.

cesSubscriptionName :: Lens' CreateEventSubscription Text Source #

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

cesSNSTopicARN :: Lens' CreateEventSubscription Text Source #

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 Source #

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:

data CreateEventSubscriptionResponse Source #

See: createEventSubscriptionResponse smart constructor.

Instances

Eq CreateEventSubscriptionResponse Source # 
Data CreateEventSubscriptionResponse Source # 

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 Source # 
Show CreateEventSubscriptionResponse Source # 
Generic CreateEventSubscriptionResponse Source # 
NFData CreateEventSubscriptionResponse Source # 
type Rep CreateEventSubscriptionResponse Source # 
type Rep CreateEventSubscriptionResponse = D1 (MetaData "CreateEventSubscriptionResponse" "Network.AWS.RDS.CreateEventSubscription" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "CreateEventSubscriptionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cesrsEventSubscription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EventSubscription))) (S1 (MetaSel (Just Symbol "_cesrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses