CfnEventSubscriptionProps

class aws_cdk.aws_neptune.CfnEventSubscriptionProps(*, sns_topic_arn, enabled=None, event_categories=None, source_ids=None, source_type=None, subscription_name=None, tags=None)

Bases: object

Properties for defining a CfnEventSubscription.

Parameters:

  • sns_topic_arn (str) – The topic ARN of the event notification subscription.

  • enabled (Union[bool, IResolvable, None]) – A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled. Default: - true

  • event_categories (Optional[Sequence[str]]) – 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.

  • source_ids (Optional[Sequence[str]]) – 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.

  • source_type (Optional[str]) – The source type for the event notification subscription.

  • subscription_name (Optional[str]) – The name of the subscription.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_neptune as neptune

cfn_event_subscription_props = neptune.CfnEventSubscriptionProps(
    sns_topic_arn="snsTopicArn",

    # the properties below are optional
    enabled=False,
    event_categories=["eventCategories"],
    source_ids=["sourceIds"],
    source_type="sourceType",
    subscription_name="subscriptionName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

enabled

A Boolean value indicating if the subscription is enabled.

True indicates the subscription is enabled.

Default:

  • true

See:

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

event_categories

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:

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

sns_topic_arn

The topic ARN of the event notification subscription.

See:

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

source_ids

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:

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

source_type

The source type for the event notification subscription.

See:

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

subscription_name

The name of the subscription.

See:

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

tags

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

See:

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