interface CfnEventSubscriptionProps

Language	Type name
.NET	Amazon.CDK.AWS.Neptune.CfnEventSubscriptionProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsneptune#CfnEventSubscriptionProps
Java	software.amazon.awscdk.services.neptune.CfnEventSubscriptionProps
Python	aws_cdk.aws_neptune.CfnEventSubscriptionProps
TypeScript	aws-cdk-lib » aws_neptune » CfnEventSubscriptionProps

Properties for defining a CfnEventSubscription.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_neptune as neptune } from 'aws-cdk-lib';
const cfnEventSubscriptionProps: neptune.CfnEventSubscriptionProps = {
  snsTopicArn: 'snsTopicArn',

  // the properties below are optional
  enabled: false,
  eventCategories: ['eventCategories'],
  sourceIds: ['sourceIds'],
  sourceType: 'sourceType',
  subscriptionName: 'subscriptionName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
snsTopicArn	string	The topic ARN of the event notification subscription.
enabled?	boolean | IResolvable	A Boolean value indicating if the subscription is enabled.
eventCategories?	string[]	A list of event categories for a SourceType that you want to subscribe to.
sourceIds?	string[]	The list of identifiers of the event sources for which events will be returned.
sourceType?	string	The source type for the event notification subscription.
subscriptionName?	string	The name of the subscription.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

snsTopicArn

Type: string

The topic ARN of the event notification subscription.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-snstopicarn

---

enabled?

Type: boolean | IResolvable (optional, default: true)

A Boolean value indicating if the subscription is enabled.

True indicates the subscription is enabled.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-enabled

---

eventCategories?

Type: string[] (optional)

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 in the Events topic in the Amazon Neptune User Guide or by using the DescribeEventCategories action.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-eventcategories

---

sourceIds?

Type: string[] (optional)

The list of identifiers of the event sources for which events will be 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 cannot end with a hyphen or contain two consecutive hyphens.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-sourceids

---

sourceType?

Type: string (optional)

The source type for the event notification subscription.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-sourcetype

---

subscriptionName?

Type: string (optional)

The name of the subscription.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-subscriptionname

---

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html#cfn-neptune-eventsubscription-tags