AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateEventSubscription operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Redshift.AmazonRedshiftRequest
      Amazon.Redshift.Model.CreateEventSubscriptionRequest

Namespace: Amazon.Redshift.Model
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z

Syntax

C#
public class CreateEventSubscriptionRequest : AmazonRedshiftRequest
         IAmazonWebServiceRequest

The CreateEventSubscriptionRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Enabled System.Boolean

Gets and sets the property Enabled.

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

Public Property EventCategories System.Collections.Generic.List<System.String>

Gets and sets the property EventCategories.

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

Values: Configuration, Management, Monitoring, Security

Public Property Severity System.String

Gets and sets the property Severity.

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

Values: ERROR, INFO

Public Property SnsTopicArn System.String

Gets and sets the property 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.

Public Property SourceIds System.Collections.Generic.List<System.String>

Gets and sets the property 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

Public Property SourceType System.String

Gets and sets the property 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 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.

Public Property SubscriptionName System.String

Gets and sets the property 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.

Public Property Tags System.Collections.Generic.List<Amazon.Redshift.Model.Tag>

Gets and sets the property Tags.

A list of tag instances.

Examples

This example shows how to create an event subscription.

To create an event subscription


var response = client.CreateEventSubscription(new CreateEventSubscriptionRequest 
{
    SnsTopicArn = "arn:aws:sns:us-west-2:123456789101:my-sns-topic",
    SubscriptionName = "mysubscription"
});


            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms