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.Redshift.ModifyEventSubscription

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Modifies an existing Amazon Redshift event notification subscription.

Synopsis

data ModifyEventSubscription = ModifyEventSubscription' {
- snsTopicArn :: Maybe Text
- enabled :: Maybe Bool
- sourceType :: Maybe Text
- severity :: Maybe Text
- eventCategories :: Maybe [Text]
- sourceIds :: 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_severity :: Lens' ModifyEventSubscription (Maybe Text)
modifyEventSubscription_eventCategories :: Lens' ModifyEventSubscription (Maybe [Text])
modifyEventSubscription_sourceIds :: Lens' ModifyEventSubscription (Maybe [Text])
modifyEventSubscription_subscriptionName :: Lens' ModifyEventSubscription Text
data ModifyEventSubscriptionResponse = ModifyEventSubscriptionResponse' {
- eventSubscription :: Maybe EventSubscription
- httpStatus :: Int
}
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

snsTopicArn :: Maybe Text
The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.
enabled :: Maybe Bool
A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled
sourceType :: Maybe Text
The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
severity :: Maybe Text
Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
eventCategories :: Maybe [Text]
Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security, pending
sourceIds :: Maybe [Text]
A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
subscriptionName :: Text
The name of the modified Amazon Redshift event notification subscription.

Instances

Instances details

Eq ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods (==) :: ModifyEventSubscription -> ModifyEventSubscription -> Bool # (/=) :: ModifyEventSubscription -> ModifyEventSubscription -> Bool #
Read ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods readsPrec :: Int -> ReadS ModifyEventSubscription # readList :: ReadS [ModifyEventSubscription] # readPrec :: ReadPrec ModifyEventSubscription # readListPrec :: ReadPrec [ModifyEventSubscription] #
Show ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods showsPrec :: Int -> ModifyEventSubscription -> ShowS # show :: ModifyEventSubscription -> String # showList :: [ModifyEventSubscription] -> ShowS #
Generic ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Associated Types type Rep ModifyEventSubscription :: Type -> Type # Methods from :: ModifyEventSubscription -> Rep ModifyEventSubscription x # to :: Rep ModifyEventSubscription x -> ModifyEventSubscription #
NFData ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods rnf :: ModifyEventSubscription -> () #
Hashable ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods hashWithSalt :: Int -> ModifyEventSubscription -> Int # hash :: ModifyEventSubscription -> Int #
AWSRequest ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Associated Types type AWSResponse ModifyEventSubscription # Methods request :: ModifyEventSubscription -> Request ModifyEventSubscription # response :: MonadResource m => Logger -> Service -> Proxy ModifyEventSubscription -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyEventSubscription))) #
ToHeaders ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods toHeaders :: ModifyEventSubscription -> [Header] #
ToPath ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods toPath :: ModifyEventSubscription -> ByteString #
ToQuery ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods toQuery :: ModifyEventSubscription -> QueryString #
type Rep ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription type Rep ModifyEventSubscription = D1 ('MetaData "ModifyEventSubscription" "Amazonka.Redshift.ModifyEventSubscription" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" '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 "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eventCategories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "sourceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ModifyEventSubscription Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription type AWSResponse ModifyEventSubscription = ModifyEventSubscriptionResponse

newModifyEventSubscription Source #

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:

$sel:snsTopicArn:ModifyEventSubscription', modifyEventSubscription_snsTopicArn - The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

$sel:enabled:ModifyEventSubscription', modifyEventSubscription_enabled - A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

$sel:sourceType:ModifyEventSubscription', modifyEventSubscription_sourceType - The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.

Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

$sel:severity:ModifyEventSubscription', modifyEventSubscription_severity - Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

$sel:eventCategories:ModifyEventSubscription', modifyEventSubscription_eventCategories - Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

$sel:sourceIds:ModifyEventSubscription', modifyEventSubscription_sourceIds - A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

Example: my-cluster-1, my-cluster-2

Example: my-snapshot-20131010

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

Request Lenses

modifyEventSubscription_snsTopicArn :: Lens' ModifyEventSubscription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

modifyEventSubscription_enabled :: Lens' ModifyEventSubscription (Maybe Bool) Source #

A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

modifyEventSubscription_sourceType :: Lens' ModifyEventSubscription (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 cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.

Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

modifyEventSubscription_severity :: Lens' ModifyEventSubscription (Maybe Text) Source #

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

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

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

modifyEventSubscription_sourceIds :: Lens' ModifyEventSubscription (Maybe [Text]) Source #

A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

Example: my-cluster-1, my-cluster-2

Example: my-snapshot-20131010

modifyEventSubscription_subscriptionName :: Lens' ModifyEventSubscription Text Source #

The name of the modified Amazon Redshift event notification subscription.

Destructuring the Response

data ModifyEventSubscriptionResponse Source #

See: newModifyEventSubscriptionResponse smart constructor.

Constructors

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

Instances

Instances details

Eq ModifyEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods (==) :: ModifyEventSubscriptionResponse -> ModifyEventSubscriptionResponse -> Bool # (/=) :: ModifyEventSubscriptionResponse -> ModifyEventSubscriptionResponse -> Bool #
Read ModifyEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods readsPrec :: Int -> ReadS ModifyEventSubscriptionResponse # readList :: ReadS [ModifyEventSubscriptionResponse] # readPrec :: ReadPrec ModifyEventSubscriptionResponse # readListPrec :: ReadPrec [ModifyEventSubscriptionResponse] #
Show ModifyEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods showsPrec :: Int -> ModifyEventSubscriptionResponse -> ShowS # show :: ModifyEventSubscriptionResponse -> String # showList :: [ModifyEventSubscriptionResponse] -> ShowS #
Generic ModifyEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Associated Types type Rep ModifyEventSubscriptionResponse :: Type -> Type # Methods from :: ModifyEventSubscriptionResponse -> Rep ModifyEventSubscriptionResponse x # to :: Rep ModifyEventSubscriptionResponse x -> ModifyEventSubscriptionResponse #
NFData ModifyEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription Methods rnf :: ModifyEventSubscriptionResponse -> () #
type Rep ModifyEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.ModifyEventSubscription type Rep ModifyEventSubscriptionResponse = D1 ('MetaData "ModifyEventSubscriptionResponse" "Amazonka.Redshift.ModifyEventSubscription" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" '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 #

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

Undocumented member.

modifyEventSubscriptionResponse_httpStatus :: Lens' ModifyEventSubscriptionResponse Int Source #

The response's http status code.