Class CfnEventSubscription
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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.
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.*; CfnEventSubscription cfnEventSubscription = CfnEventSubscription.Builder.create(this, "MyCfnEventSubscription") .enabled(false) .eventCategories(List.of("eventCategories")) .snsTopicArn("snsTopicArn") .sourceIds(List.of("sourceIds")) .sourceType("sourceType") .build();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnEventSubscription
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnEventSubscription
(software.amazon.jsii.JsiiObjectRef objRef) CfnEventSubscription
(software.constructs.Construct scope, String id) CfnEventSubscription
(software.constructs.Construct scope, String id, CfnEventSubscriptionProps props) -
Method Summary
Modifier and TypeMethodDescriptionA Boolean value indicating if the subscription is enabled.The topic ARN of the event notification subscription.The source type for the event notification subscription.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setEnabled
(Boolean value) A Boolean value indicating if the subscription is enabled.void
setEnabled
(IResolvable value) A Boolean value indicating if the subscription is enabled.void
setEventCategories
(List<String> value) void
setSnsTopicArn
(String value) The topic ARN of the event notification subscription.void
setSourceIds
(List<String> value) void
setSourceType
(String value) The source type for the event notification subscription.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnEventSubscription
protected CfnEventSubscription(software.amazon.jsii.JsiiObjectRef objRef) -
CfnEventSubscription
protected CfnEventSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnEventSubscription
@Stability(Stable) public CfnEventSubscription(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnEventSubscriptionProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties.
-
CfnEventSubscription
@Stability(Stable) public CfnEventSubscription(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getEnabled
A Boolean value indicating if the subscription is enabled. -
setEnabled
A Boolean value indicating if the subscription is enabled. -
setEnabled
A Boolean value indicating if the subscription is enabled. -
getEventCategories
-
setEventCategories
-
getSnsTopicArn
The topic ARN of the event notification subscription. -
setSnsTopicArn
The topic ARN of the event notification subscription. -
getSourceIds
-
setSourceIds
-
getSourceType
The source type for the event notification subscription. -
setSourceType
The source type for the event notification subscription.
-