| 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.Neptune.ModifyEventSubscription
Description
Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.
Synopsis
- data ModifyEventSubscription = ModifyEventSubscription' {
- snsTopicArn :: Maybe Text
- enabled :: Maybe Bool
- sourceType :: Maybe Text
- eventCategories :: Maybe [Text]
- subscriptionName :: Text
- newModifyEventSubscription :: Text -> ModifyEventSubscription
- modifyEventSubscription_snsTopicArn :: Lens' ModifyEventSubscription (Maybe Text)
- modifyEventSubscription_enabled :: Lens' ModifyEventSubscription (Maybe Bool)
- modifyEventSubscription_sourceType :: Lens' ModifyEventSubscription (Maybe Text)
- modifyEventSubscription_eventCategories :: Lens' ModifyEventSubscription (Maybe [Text])
- modifyEventSubscription_subscriptionName :: Lens' ModifyEventSubscription Text
- data ModifyEventSubscriptionResponse = ModifyEventSubscriptionResponse' {}
- newModifyEventSubscriptionResponse :: Int -> ModifyEventSubscriptionResponse
- modifyEventSubscriptionResponse_eventSubscription :: Lens' ModifyEventSubscriptionResponse (Maybe EventSubscription)
- modifyEventSubscriptionResponse_httpStatus :: Lens' ModifyEventSubscriptionResponse Int
Creating a Request
data ModifyEventSubscription Source #
See: newModifyEventSubscription smart constructor.
Constructors
| ModifyEventSubscription' | |
Fields
| |
Instances
newModifyEventSubscription Source #
Create a value of ModifyEventSubscription 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:snsTopicArn:ModifyEventSubscription', modifyEventSubscription_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.
$sel:enabled:ModifyEventSubscription', modifyEventSubscription_enabled - A Boolean value; set to true to activate the subscription.
$sel:sourceType:ModifyEventSubscription', modifyEventSubscription_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.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
$sel:eventCategories:ModifyEventSubscription', modifyEventSubscription_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:subscriptionName:ModifyEventSubscription', modifyEventSubscription_subscriptionName - The name of the event notification subscription.
Request Lenses
modifyEventSubscription_snsTopicArn :: Lens' ModifyEventSubscription (Maybe 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.
modifyEventSubscription_enabled :: Lens' ModifyEventSubscription (Maybe Bool) Source #
A Boolean value; set to true to activate the subscription.
modifyEventSubscription_sourceType :: Lens' ModifyEventSubscription (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.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
modifyEventSubscription_eventCategories :: Lens' ModifyEventSubscription (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.
modifyEventSubscription_subscriptionName :: Lens' ModifyEventSubscription Text Source #
The name of the event notification subscription.
Destructuring the Response
data ModifyEventSubscriptionResponse Source #
See: newModifyEventSubscriptionResponse smart constructor.
Constructors
| ModifyEventSubscriptionResponse' | |
Fields
| |
Instances
newModifyEventSubscriptionResponse Source #
Create a value of ModifyEventSubscriptionResponse 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:ModifyEventSubscriptionResponse', modifyEventSubscriptionResponse_eventSubscription - Undocumented member.
$sel:httpStatus:ModifyEventSubscriptionResponse', modifyEventSubscriptionResponse_httpStatus - The response's http status code.
Response Lenses
modifyEventSubscriptionResponse_eventSubscription :: Lens' ModifyEventSubscriptionResponse (Maybe EventSubscription) Source #
Undocumented member.
modifyEventSubscriptionResponse_httpStatus :: Lens' ModifyEventSubscriptionResponse Int Source #
The response's http status code.