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

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

Creating a Request

data ModifyEventSubscription Source #

See: newModifyEventSubscription smart constructor.

Constructors

ModifyEventSubscription' 

Fields

  • snsTopicArn :: Maybe 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.

  • enabled :: Maybe Bool

    A Boolean value; set to true to activate the subscription.

  • 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-parameter-group | db-security-group | db-snapshot

  • 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.

  • subscriptionName :: Text

    The name of the event notification subscription.

Instances

Instances details
Eq ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Read ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Show ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Generic ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Associated Types

type Rep ModifyEventSubscription :: Type -> Type #

NFData ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Methods

rnf :: ModifyEventSubscription -> () #

Hashable ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

AWSRequest ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

ToHeaders ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

ToPath ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

ToQuery ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

type Rep ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

type Rep ModifyEventSubscription = D1 ('MetaData "ModifyEventSubscription" "Amazonka.Neptune.ModifyEventSubscription" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "ModifyEventSubscription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

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

Instances details
Eq ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Read ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Show ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Generic ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

Associated Types

type Rep ModifyEventSubscriptionResponse :: Type -> Type #

NFData ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

type Rep ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Neptune.ModifyEventSubscription

type Rep ModifyEventSubscriptionResponse = D1 ('MetaData "ModifyEventSubscriptionResponse" "Amazonka.Neptune.ModifyEventSubscription" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "ModifyEventSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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