CreateEventSubscriptionRequest Class

Container for the parameters to the CreateEventSubscription operation. Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with 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 type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Neptune.AmazonNeptuneRequest
      Amazon.Neptune.Model.CreateEventSubscriptionRequest

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

Syntax

public class CreateEventSubscriptionRequest : AmazonNeptuneRequest
         IAmazonWebServiceRequest

The CreateEventSubscriptionRequest type exposes the following members

Constructors

	Name	Description
	CreateEventSubscriptionRequest()

Properties

Name	Type	Description
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.
EventCategories	System.Collections.Generic.List<System.String>	Gets and sets the property EventCategories. A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.
SnsTopicArn	System.String	Gets and sets the property SnsTopicArn. The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
SourceIds	System.Collections.Generic.List<System.String>	Gets and sets the property SourceIds. The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. Constraints: If SourceIds are supplied, SourceType must also be provided. If the source type is a DB instance, then a `DBInstanceIdentifier` must be supplied. If the source type is a DB security group, a `DBSecurityGroupName` must be supplied. If the source type is a DB parameter group, a `DBParameterGroupName` must be supplied. If the source type is a DB snapshot, a `DBSnapshotIdentifier` must be supplied.
SourceType	System.String	Gets and sets the property SourceType. The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \| `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
SubscriptionName	System.String	Gets and sets the property SubscriptionName. The name of the subscription. Constraints: The name must be less than 255 characters.
Tags	System.Collections.Generic.List<Amazon.Neptune.Model.Tag>	Gets and sets the property Tags. The tags to be applied to the new event subscription.

Examples

This example creates an event notification subscription.

To create an event notification subscription


var response = client.CreateEventSubscription(new CreateEventSubscriptionRequest 
{
    Enabled = true,
    EventCategories = new List<string> {
        "availability"
    },
    SnsTopicArn = "arn:aws:sns:us-east-1:992648334831:MyDemoSNSTopic",
    SourceIds = new List<string> {
        "mymysqlinstance"
    },
    SourceType = "db-instance",
    SubscriptionName = "mymysqleventsubscription"
});

EventSubscription eventSubscription = response.EventSubscription;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5