Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Redshift.CreateEventSubscription

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 Amazon Web Services 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 Amazon Web Services account. You must specify a source type if you specify a source ID.

Synopsis

data CreateEventSubscription = CreateEventSubscription' {
- enabled :: Maybe Bool
- eventCategories :: Maybe [Text]
- severity :: Maybe Text
- sourceIds :: Maybe [Text]
- sourceType :: Maybe Text
- tags :: Maybe [Tag]
- subscriptionName :: Text
- snsTopicArn :: Text
}
newCreateEventSubscription :: Text -> Text -> CreateEventSubscription
createEventSubscription_enabled :: Lens' CreateEventSubscription (Maybe Bool)
createEventSubscription_eventCategories :: Lens' CreateEventSubscription (Maybe [Text])
createEventSubscription_severity :: Lens' CreateEventSubscription (Maybe Text)
createEventSubscription_sourceIds :: Lens' CreateEventSubscription (Maybe [Text])
createEventSubscription_sourceType :: Lens' CreateEventSubscription (Maybe Text)
createEventSubscription_tags :: Lens' CreateEventSubscription (Maybe [Tag])
createEventSubscription_subscriptionName :: Lens' CreateEventSubscription Text
createEventSubscription_snsTopicArn :: Lens' CreateEventSubscription Text
data CreateEventSubscriptionResponse = CreateEventSubscriptionResponse' {
- eventSubscription :: Maybe EventSubscription
- httpStatus :: Int
}
newCreateEventSubscriptionResponse :: Int -> CreateEventSubscriptionResponse
createEventSubscriptionResponse_eventSubscription :: Lens' CreateEventSubscriptionResponse (Maybe EventSubscription)
createEventSubscriptionResponse_httpStatus :: Lens' CreateEventSubscriptionResponse Int

Creating a Request

data CreateEventSubscription Source #

See: newCreateEventSubscription smart constructor.

Constructors

CreateEventSubscription'

Fields

enabled :: Maybe Bool
A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
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
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.
tags :: Maybe [Tag]
A list of tag instances.
subscriptionName :: Text
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.
snsTopicArn :: Text
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.

Instances

Instances details

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

newCreateEventSubscription Source #

Arguments

:: Text	`$sel:subscriptionName:CreateEventSubscription'`
-> Text	`CreateEventSubscription`
-> CreateEventSubscription

Create a value of CreateEventSubscription 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:

CreateEventSubscription, createEventSubscription_enabled - A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

CreateEventSubscription, createEventSubscription_eventCategories - Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

CreateEventSubscription, createEventSubscription_severity - Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

$sel:sourceIds:CreateEventSubscription', createEventSubscription_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

CreateEventSubscription, createEventSubscription_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.

CreateEventSubscription, createEventSubscription_tags - A list of tag instances.

$sel:subscriptionName:CreateEventSubscription', createEventSubscription_subscriptionName - 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.

CreateEventSubscription, createEventSubscription_snsTopicArn - 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.

Request Lenses

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

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

createEventSubscription_eventCategories :: Lens' CreateEventSubscription (Maybe [Text]) Source #

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

Values: configuration, management, monitoring, security, pending

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

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

Values: ERROR, INFO

createEventSubscription_sourceIds :: Lens' CreateEventSubscription (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

createEventSubscription_sourceType :: 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 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.

createEventSubscription_tags :: Lens' CreateEventSubscription (Maybe [Tag]) Source #

A list of tag instances.

createEventSubscription_subscriptionName :: 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.

createEventSubscription_snsTopicArn :: 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

data CreateEventSubscriptionResponse Source #

See: newCreateEventSubscriptionResponse smart constructor.

Constructors

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

Instances

Instances details

Generic CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.CreateEventSubscription Associated Types type Rep CreateEventSubscriptionResponse :: Type -> Type # Methods from :: CreateEventSubscriptionResponse -> Rep CreateEventSubscriptionResponse x # to :: Rep CreateEventSubscriptionResponse x -> CreateEventSubscriptionResponse #
Read CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.CreateEventSubscription Methods readsPrec :: Int -> ReadS CreateEventSubscriptionResponse # readList :: ReadS [CreateEventSubscriptionResponse] # readPrec :: ReadPrec CreateEventSubscriptionResponse # readListPrec :: ReadPrec [CreateEventSubscriptionResponse] #
Show CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.CreateEventSubscription Methods showsPrec :: Int -> CreateEventSubscriptionResponse -> ShowS # show :: CreateEventSubscriptionResponse -> String # showList :: [CreateEventSubscriptionResponse] -> ShowS #
NFData CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.CreateEventSubscription Methods rnf :: CreateEventSubscriptionResponse -> () #
Eq CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.CreateEventSubscription Methods (==) :: CreateEventSubscriptionResponse -> CreateEventSubscriptionResponse -> Bool # (/=) :: CreateEventSubscriptionResponse -> CreateEventSubscriptionResponse -> Bool #
type Rep CreateEventSubscriptionResponse Source #
Instance details Defined in Amazonka.Redshift.CreateEventSubscription type Rep CreateEventSubscriptionResponse = D1 ('MetaData "CreateEventSubscriptionResponse" "Amazonka.Redshift.CreateEventSubscription" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "CreateEventSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSubscription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSubscription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateEventSubscriptionResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEventSubscriptionResponse'`
-> CreateEventSubscriptionResponse

Create a value of CreateEventSubscriptionResponse 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:CreateEventSubscriptionResponse', createEventSubscriptionResponse_eventSubscription - Undocumented member.

$sel:httpStatus:CreateEventSubscriptionResponse', createEventSubscriptionResponse_httpStatus - The response's http status code.

Response Lenses

createEventSubscriptionResponse_eventSubscription :: Lens' CreateEventSubscriptionResponse (Maybe EventSubscription) Source #

Undocumented member.

createEventSubscriptionResponse_httpStatus :: Lens' CreateEventSubscriptionResponse Int Source #

The response's http status code.