amazonka-redshift-1.6.1: Amazon Redshift SDK.

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

Network.AWS.Redshift.CreateEventSubscription

Contents

Description

Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.

Synopsis

Creating a Request

createEventSubscription Source #

Creates a value of CreateEventSubscription with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cesEnabled - A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
  • cesSourceType - 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 AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
  • cesSeverity - Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO
  • cesEventCategories - Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: Configuration, Management, Monitoring, Security
  • cesSourceIds - 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
  • cesTags - A list of tag instances.
  • cesSubscriptionName - The name of the event subscription to be created. Constraints: * Cannot be null, empty, or blank. * Must contain from 1 to 255 alphanumeric characters or hyphens. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens.
  • cesSNSTopicARN - The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

data CreateEventSubscription Source #

See: createEventSubscription smart constructor.

Instances
Eq CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Data CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateEventSubscription -> c CreateEventSubscription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateEventSubscription #

toConstr :: CreateEventSubscription -> Constr #

dataTypeOf :: CreateEventSubscription -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateEventSubscription) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateEventSubscription) #

gmapT :: (forall b. Data b => b -> b) -> CreateEventSubscription -> CreateEventSubscription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateEventSubscription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateEventSubscription -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateEventSubscription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateEventSubscription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateEventSubscription -> m CreateEventSubscription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEventSubscription -> m CreateEventSubscription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEventSubscription -> m CreateEventSubscription #

Read CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Show CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Generic CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Associated Types

type Rep CreateEventSubscription :: Type -> Type #

Hashable CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

AWSRequest CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Associated Types

type Rs CreateEventSubscription :: Type #

ToHeaders CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

ToPath CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

ToQuery CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

NFData CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Methods

rnf :: CreateEventSubscription -> () #

type Rep CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

type Rep CreateEventSubscription = D1 (MetaData "CreateEventSubscription" "Network.AWS.Redshift.CreateEventSubscription" "amazonka-redshift-1.6.1-5k9dueihUQf2a2gxNGkSPi" False) (C1 (MetaCons "CreateEventSubscription'" PrefixI True) (((S1 (MetaSel (Just "_cesEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_cesSourceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cesSeverity") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cesEventCategories") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 (MetaSel (Just "_cesSourceIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_cesTags") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 (MetaSel (Just "_cesSubscriptionName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cesSNSTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs CreateEventSubscription Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Request Lenses

cesEnabled :: Lens' CreateEventSubscription (Maybe Bool) Source #

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

cesSourceType :: Lens' CreateEventSubscription (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 AWS account. You must specify a source type in order to specify source IDs. Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

cesSeverity :: Lens' CreateEventSubscription (Maybe Text) Source #

Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO

cesEventCategories :: Lens' CreateEventSubscription [Text] Source #

Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: Configuration, Management, Monitoring, Security

cesSourceIds :: Lens' CreateEventSubscription [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

cesTags :: Lens' CreateEventSubscription [Tag] Source #

A list of tag instances.

cesSubscriptionName :: Lens' CreateEventSubscription Text Source #

The name of the event subscription to be created. Constraints: * Cannot be null, empty, or blank. * Must contain from 1 to 255 alphanumeric characters or hyphens. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens.

cesSNSTopicARN :: Lens' CreateEventSubscription Text Source #

The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Destructuring the Response

createEventSubscriptionResponse Source #

Creates a value of CreateEventSubscriptionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data CreateEventSubscriptionResponse Source #

See: createEventSubscriptionResponse smart constructor.

Instances
Eq CreateEventSubscriptionResponse Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Data CreateEventSubscriptionResponse Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateEventSubscriptionResponse -> c CreateEventSubscriptionResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateEventSubscriptionResponse #

toConstr :: CreateEventSubscriptionResponse -> Constr #

dataTypeOf :: CreateEventSubscriptionResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateEventSubscriptionResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateEventSubscriptionResponse) #

gmapT :: (forall b. Data b => b -> b) -> CreateEventSubscriptionResponse -> CreateEventSubscriptionResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateEventSubscriptionResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateEventSubscriptionResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateEventSubscriptionResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateEventSubscriptionResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateEventSubscriptionResponse -> m CreateEventSubscriptionResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEventSubscriptionResponse -> m CreateEventSubscriptionResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateEventSubscriptionResponse -> m CreateEventSubscriptionResponse #

Read CreateEventSubscriptionResponse Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Show CreateEventSubscriptionResponse Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Generic CreateEventSubscriptionResponse Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

Associated Types

type Rep CreateEventSubscriptionResponse :: Type -> Type #

NFData CreateEventSubscriptionResponse Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

type Rep CreateEventSubscriptionResponse Source # 
Instance details

Defined in Network.AWS.Redshift.CreateEventSubscription

type Rep CreateEventSubscriptionResponse = D1 (MetaData "CreateEventSubscriptionResponse" "Network.AWS.Redshift.CreateEventSubscription" "amazonka-redshift-1.6.1-5k9dueihUQf2a2gxNGkSPi" False) (C1 (MetaCons "CreateEventSubscriptionResponse'" PrefixI True) (S1 (MetaSel (Just "_cesrsEventSubscription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 (MetaSel (Just "_cesrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses