amazonka-redshift-2.0: Amazon Redshift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Redshift.ModifyEventSubscription

Description

Modifies an existing Amazon Redshift event notification subscription.

Synopsis

Creating a Request

data ModifyEventSubscription Source #

See: newModifyEventSubscription smart constructor.

Constructors

ModifyEventSubscription' 

Fields

  • enabled :: Maybe Bool

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

  • eventCategories :: Maybe [Text]

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

    Values: configuration, management, monitoring, security, pending

  • severity :: Maybe Text

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

    Values: ERROR, INFO

  • snsTopicArn :: Maybe Text

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

  • 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

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

  • subscriptionName :: Text

    The name of the modified Amazon Redshift event notification subscription.

Instances

Instances details
ToHeaders ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

ToPath ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

ToQuery ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

AWSRequest ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

Generic ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

Associated Types

type Rep ModifyEventSubscription :: Type -> Type #

Read ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

Show ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

NFData ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

Methods

rnf :: ModifyEventSubscription -> () #

Eq ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

Hashable ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

type AWSResponse ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

type Rep ModifyEventSubscription Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

type Rep ModifyEventSubscription = D1 ('MetaData "ModifyEventSubscription" "Amazonka.Redshift.ModifyEventSubscription" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" '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 "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "snsTopicArn") '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 "subscriptionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

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:

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

ModifyEventSubscription, modifyEventSubscription_eventCategories - Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

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

Values: ERROR, INFO

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

$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

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:subscriptionName:ModifyEventSubscription', modifyEventSubscription_subscriptionName - The name of the modified Amazon Redshift event notification subscription.

Request Lenses

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

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

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_severity :: Lens' ModifyEventSubscription (Maybe Text) Source #

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

Values: ERROR, INFO

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_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_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_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

Instances

Instances details
Generic ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

Associated Types

type Rep ModifyEventSubscriptionResponse :: Type -> Type #

Read ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

Show ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

NFData ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

Eq ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

type Rep ModifyEventSubscriptionResponse Source # 
Instance details

Defined in Amazonka.Redshift.ModifyEventSubscription

type Rep ModifyEventSubscriptionResponse = D1 ('MetaData "ModifyEventSubscriptionResponse" "Amazonka.Redshift.ModifyEventSubscription" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" '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