Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Neptune.CreateEventSubscription

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune 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 Neptune 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 Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.

Synopsis

Creating a Request

data CreateEventSubscription Source #

See: newCreateEventSubscription smart constructor.

Constructors

CreateEventSubscription'

Fields

enabled :: Maybe Bool
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
eventCategories :: Maybe [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 by using the DescribeEventCategories action.
sourceIds :: Maybe [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.
sourceType :: 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
tags :: Maybe [Tag]
The tags to be applied to the new event subscription.
subscriptionName :: Text
The name of the subscription.
Constraints: The name must be less than 255 characters.
snsTopicArn :: 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.

Instances

Instances details

ToHeaders CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods toHeaders :: CreateEventSubscription -> [Header] #
ToPath CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods toPath :: CreateEventSubscription -> ByteString #
ToQuery CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods toQuery :: CreateEventSubscription -> QueryString #
AWSRequest CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Associated Types type AWSResponse CreateEventSubscription # Methods request :: (Service -> Service) -> CreateEventSubscription -> Request CreateEventSubscription # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateEventSubscription -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEventSubscription))) #
Generic CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Associated Types type Rep CreateEventSubscription :: Type -> Type # Methods from :: CreateEventSubscription -> Rep CreateEventSubscription x # to :: Rep CreateEventSubscription x -> CreateEventSubscription #
Read CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods readsPrec :: Int -> ReadS CreateEventSubscription # readList :: ReadS [CreateEventSubscription] # readPrec :: ReadPrec CreateEventSubscription # readListPrec :: ReadPrec [CreateEventSubscription] #
Show CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods showsPrec :: Int -> CreateEventSubscription -> ShowS # show :: CreateEventSubscription -> String # showList :: [CreateEventSubscription] -> ShowS #
NFData CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods rnf :: CreateEventSubscription -> () #
Eq CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods (==) :: CreateEventSubscription -> CreateEventSubscription -> Bool # (/=) :: CreateEventSubscription -> CreateEventSubscription -> Bool #
Hashable CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods hashWithSalt :: Int -> CreateEventSubscription -> Int # hash :: CreateEventSubscription -> Int #
type AWSResponse CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription type AWSResponse CreateEventSubscription = CreateEventSubscriptionResponse
type Rep CreateEventSubscription Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription type Rep CreateEventSubscription = D1 ('MetaData "CreateEventSubscription" "Amazonka.Neptune.CreateEventSubscription" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "CreateEventSubscription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "sourceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateEventSubscription Source #

Arguments

:: Text	`$sel:subscriptionName:CreateEventSubscription'`
-> Text	`CreateEventSubscription`
-> CreateEventSubscription

Create a value of CreateEventSubscription 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:

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

CreateEventSubscription, createEventSubscription_eventCategories - 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 by using the DescribeEventCategories action.

$sel:sourceIds:CreateEventSubscription', createEventSubscription_sourceIds - 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.

CreateEventSubscription, createEventSubscription_sourceType - 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.

$sel:tags:CreateEventSubscription', createEventSubscription_tags - The tags to be applied to the new event subscription.

$sel:subscriptionName:CreateEventSubscription', createEventSubscription_subscriptionName - The name of the subscription.

Constraints: The name must be less than 255 characters.

CreateEventSubscription, createEventSubscription_snsTopicArn - 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.

Request Lenses

createEventSubscription_enabled :: 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.

createEventSubscription_eventCategories :: Lens' CreateEventSubscription (Maybe [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 by using the DescribeEventCategories action.

createEventSubscription_sourceIds :: Lens' CreateEventSubscription (Maybe [Text]) Source #

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.

createEventSubscription_sourceType :: Lens' CreateEventSubscription (Maybe Text) Source #

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.

createEventSubscription_tags :: Lens' CreateEventSubscription (Maybe [Tag]) Source #

The tags to be applied to the new event subscription.

createEventSubscription_subscriptionName :: Lens' CreateEventSubscription Text Source #

The name of the subscription.

Constraints: The name must be less than 255 characters.

createEventSubscription_snsTopicArn :: 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

data CreateEventSubscriptionResponse Source #

See: newCreateEventSubscriptionResponse smart constructor.

Constructors

CreateEventSubscriptionResponse'
Fields eventSubscription :: Maybe EventSubscription httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Associated Types type Rep CreateEventSubscriptionResponse :: Type -> Type # Methods from :: CreateEventSubscriptionResponse -> Rep CreateEventSubscriptionResponse x # to :: Rep CreateEventSubscriptionResponse x -> CreateEventSubscriptionResponse #
Read CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods readsPrec :: Int -> ReadS CreateEventSubscriptionResponse # readList :: ReadS [CreateEventSubscriptionResponse] # readPrec :: ReadPrec CreateEventSubscriptionResponse # readListPrec :: ReadPrec [CreateEventSubscriptionResponse] #
Show CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods showsPrec :: Int -> CreateEventSubscriptionResponse -> ShowS # show :: CreateEventSubscriptionResponse -> String # showList :: [CreateEventSubscriptionResponse] -> ShowS #
NFData CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods rnf :: CreateEventSubscriptionResponse -> () #
Eq CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription Methods (==) :: CreateEventSubscriptionResponse -> CreateEventSubscriptionResponse -> Bool # (/=) :: CreateEventSubscriptionResponse -> CreateEventSubscriptionResponse -> Bool #
type Rep CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Neptune.CreateEventSubscription type Rep CreateEventSubscriptionResponse = D1 ('MetaData "CreateEventSubscriptionResponse" "Amazonka.Neptune.CreateEventSubscription" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "CreateEventSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateEventSubscriptionResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEventSubscriptionResponse'`
-> CreateEventSubscriptionResponse

Create a value of CreateEventSubscriptionResponse 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:eventSubscription:CreateEventSubscriptionResponse', createEventSubscriptionResponse_eventSubscription - Undocumented member.

$sel:httpStatus:CreateEventSubscriptionResponse', createEventSubscriptionResponse_httpStatus - The response's http status code.

Response Lenses

createEventSubscriptionResponse_eventSubscription :: Lens' CreateEventSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

createEventSubscriptionResponse_httpStatus :: Lens' CreateEventSubscriptionResponse Int Source #

The response's http status code.