Class CfnEventSubscription
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source ( SourceType
) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources ( SourceIds
) that trigger the events, and you can provide a list of event categories ( EventCategories
) for events that 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 Amazon DocumentDB sources. If you do not specify either the SourceType
or the SourceIdentifier
, you are notified of events generated from all Amazon DocumentDB 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.docdb.*; CfnEventSubscription cfnEventSubscription = CfnEventSubscription.Builder.create(this, "MyCfnEventSubscription") .snsTopicArn("snsTopicArn") // the properties below are optional .enabled(false) .eventCategories(List.of("eventCategories")) .sourceIds(List.of("sourceIds")) .sourceType("sourceType") .subscriptionName("subscriptionName") .build();
- See Also:
-
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, CfnEventSubscriptionProps props) -
Method Summary
Modifier and TypeMethodDescriptionA Boolean value;A list of event categories for aSourceType
that you want to subscribe to.The Amazon Resource Name (ARN) of the SNS topic created for event notification.The list of identifiers of the event sources for which events are returned.The type of source that is generating the events.The name of the subscription.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setEnabled
(Boolean value) A Boolean value;void
setEnabled
(IResolvable value) A Boolean value;void
setEventCategories
(List<String> value) A list of event categories for aSourceType
that you want to subscribe to.void
setSnsTopicArn
(String value) The Amazon Resource Name (ARN) of the SNS topic created for event notification.void
setSourceIds
(List<String> value) The list of identifiers of the event sources for which events are returned.void
setSourceType
(String value) The type of source that is generating the events.void
setSubscriptionName
(String value) The name of the 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, @NotNull 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. 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
-
getSnsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event notification. -
setSnsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event notification. -
getEnabled
A Boolean value; -
setEnabled
A Boolean value; -
setEnabled
A Boolean value; -
getEventCategories
A list of event categories for aSourceType
that you want to subscribe to. -
setEventCategories
A list of event categories for aSourceType
that you want to subscribe to. -
getSourceIds
The list of identifiers of the event sources for which events are returned. -
setSourceIds
The list of identifiers of the event sources for which events are returned. -
getSourceType
The type of source that is generating the events. -
setSourceType
The type of source that is generating the events. -
getSubscriptionName
The name of the subscription. -
setSubscriptionName
The name of the subscription.
-