Package software.amazon.awscdk.services.neptune

Interface CfnEventSubscriptionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventSubscriptionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:42.500Z")
@Stability(Stable)
public interface CfnEventSubscriptionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEventSubscription.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.neptune.*;
 CfnEventSubscriptionProps cfnEventSubscriptionProps = CfnEventSubscriptionProps.builder()
         .snsTopicArn("snsTopicArn")
         // the properties below are optional
         .enabled(false)
         .eventCategories(List.of("eventCategories"))
         .sourceIds(List.of("sourceIds"))
         .sourceType("sourceType")
         .subscriptionName("subscriptionName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEventSubscriptionProps.Builder	A builder for CfnEventSubscriptionProps
static final class	CfnEventSubscriptionProps.Jsii$Proxy	An implementation for CfnEventSubscriptionProps

Method Summary

Modifier and Type	Method	Description
static CfnEventSubscriptionProps.Builder	builder()
default Object	getEnabled()	A Boolean value indicating if the subscription is enabled.
default List<String>	getEventCategories()	A list of event categories for a SourceType that you want to subscribe to.
String	getSnsTopicArn()	The topic ARN of the event notification subscription.
default List<String>	getSourceIds()	The list of identifiers of the event sources for which events will be returned.
default String	getSourceType()	The source type for the event notification subscription.
default String	getSubscriptionName()	The name of the subscription.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSnsTopicArn

@Stability(Stable)
@NotNull
String getSnsTopicArn()

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

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

A Boolean value indicating if the subscription is enabled.

True indicates the subscription is enabled.

Returns union: either Boolean or IResolvable

Default: - true

See Also:

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

getEventCategories

@Stability(Stable)
@Nullable
default List<String> getEventCategories()

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

getSourceIds

@Stability(Stable)
@Nullable
default List<String> getSourceIds()

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

getSourceType

@Stability(Stable)
@Nullable
default String getSourceType()

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

getSubscriptionName

@Stability(Stable)
@Nullable
default String getSubscriptionName()

The name of the subscription.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnEventSubscriptionProps.Builder builder()

Returns:

a CfnEventSubscriptionProps.Builder of CfnEventSubscriptionProps