Amazonka.DocumentDB.ModifyEventSubscription

Modifies an existing Amazon DocumentDB event notification subscription.

Creating a Request

data ModifyEventSubscription

Represents the input to ModifyEventSubscription.

See: newModifyEventSubscription smart constructor.

Constructors

ModifyEventSubscription'

Fields

• enabled :: Maybe Bool

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

• eventCategories :: Maybe [Text]

  A list of event categories for a SourceType that you want to subscribe to.

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

• sourceType :: Maybe Text

  The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, 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

• subscriptionName :: Text

  The name of the Amazon DocumentDB event notification subscription.

Instances

ToHeaders ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

toHeaders :: ModifyEventSubscription -> [Header]

ToPath ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

toPath :: ModifyEventSubscription -> ByteString

ToQuery ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

toQuery :: ModifyEventSubscription -> QueryString

AWSRequest ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Associated Types

type AWSResponse ModifyEventSubscription

Methods

request :: (Service -> Service) -> ModifyEventSubscription -> Request ModifyEventSubscription

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyEventSubscription -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyEventSubscription)))

Generic ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Associated Types

type Rep ModifyEventSubscription :: Type -> Type

Methods

from :: ModifyEventSubscription -> Rep ModifyEventSubscription x

to :: Rep ModifyEventSubscription x -> ModifyEventSubscription

Read ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

readsPrec :: Int -> ReadS ModifyEventSubscription

readList :: ReadS [ModifyEventSubscription]

readPrec :: ReadPrec ModifyEventSubscription

readListPrec :: ReadPrec [ModifyEventSubscription]

Show ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

showsPrec :: Int -> ModifyEventSubscription -> ShowS

show :: ModifyEventSubscription -> String

showList :: [ModifyEventSubscription] -> ShowS

NFData ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

rnf :: ModifyEventSubscription -> ()

Eq ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

(==) :: ModifyEventSubscription -> ModifyEventSubscription -> Bool

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

Hashable ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

hashWithSalt :: Int -> ModifyEventSubscription -> Int

hash :: ModifyEventSubscription -> Int

type AWSResponse ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

type AWSResponse ModifyEventSubscription = ModifyEventSubscriptionResponse

type Rep ModifyEventSubscription

Defined in Amazonka.DocumentDB.ModifyEventSubscription

type Rep ModifyEventSubscription = D1 ('MetaData "ModifyEventSubscription" "Amazonka.DocumentDB.ModifyEventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "ModifyEventSubscription'" '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 "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newModifyEventSubscription

Arguments

:: Text

$sel:subscriptionName:ModifyEventSubscription'

-> ModifyEventSubscription

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:

ModifyEventSubscription, modifyEventSubscription_enabled - A Boolean value; set to true to activate the subscription.

ModifyEventSubscription, modifyEventSubscription_eventCategories - A list of event categories for a SourceType that you want to subscribe to.

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.

ModifyEventSubscription, modifyEventSubscription_sourceType - The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, 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

$sel:subscriptionName:ModifyEventSubscription', modifyEventSubscription_subscriptionName - The name of the Amazon DocumentDB event notification subscription.

Request Lenses

modifyEventSubscription_enabled :: Lens' ModifyEventSubscription (Maybe Bool)

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

modifyEventSubscription_eventCategories :: Lens' ModifyEventSubscription (Maybe [Text])

A list of event categories for a SourceType that you want to subscribe to.

modifyEventSubscription_snsTopicArn :: Lens' ModifyEventSubscription (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.

modifyEventSubscription_sourceType :: Lens' ModifyEventSubscription (Maybe Text)

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, 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

modifyEventSubscription_subscriptionName :: Lens' ModifyEventSubscription Text

The name of the Amazon DocumentDB event notification subscription.

Destructuring the Response

data ModifyEventSubscriptionResponse

See: newModifyEventSubscriptionResponse smart constructor.

Constructors

ModifyEventSubscriptionResponse'

Fields

• eventSubscription :: Maybe EventSubscription
• httpStatus :: Int

  The response's http status code.

Instances

Generic ModifyEventSubscriptionResponse

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Associated Types

type Rep ModifyEventSubscriptionResponse :: Type -> Type

Methods

from :: ModifyEventSubscriptionResponse -> Rep ModifyEventSubscriptionResponse x

to :: Rep ModifyEventSubscriptionResponse x -> ModifyEventSubscriptionResponse

Read ModifyEventSubscriptionResponse

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

readsPrec :: Int -> ReadS ModifyEventSubscriptionResponse

readList :: ReadS [ModifyEventSubscriptionResponse]

readPrec :: ReadPrec ModifyEventSubscriptionResponse

readListPrec :: ReadPrec [ModifyEventSubscriptionResponse]

Show ModifyEventSubscriptionResponse

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

showsPrec :: Int -> ModifyEventSubscriptionResponse -> ShowS

show :: ModifyEventSubscriptionResponse -> String

showList :: [ModifyEventSubscriptionResponse] -> ShowS

NFData ModifyEventSubscriptionResponse

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

rnf :: ModifyEventSubscriptionResponse -> ()

Eq ModifyEventSubscriptionResponse

Defined in Amazonka.DocumentDB.ModifyEventSubscription

Methods

(==) :: ModifyEventSubscriptionResponse -> ModifyEventSubscriptionResponse -> Bool

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

type Rep ModifyEventSubscriptionResponse

Defined in Amazonka.DocumentDB.ModifyEventSubscription

type Rep ModifyEventSubscriptionResponse = D1 ('MetaData "ModifyEventSubscriptionResponse" "Amazonka.DocumentDB.ModifyEventSubscription" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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

Arguments

:: Int

$sel:httpStatus:ModifyEventSubscriptionResponse'

-> ModifyEventSubscriptionResponse

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)

Undocumented member.

modifyEventSubscriptionResponse_httpStatus :: Lens' ModifyEventSubscriptionResponse Int

The response's http status code.