Interface CfnEventSubscriptionProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnEventSubscriptionProps.Jsii$Proxy
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.docdb.*; 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") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnEventSubscriptionProps
static final class
An implementation forCfnEventSubscriptionProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
A 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.default String
The type of source that is generating the events.default String
The name of the subscription.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getSnsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event notification.Amazon SNS creates the ARN when you create a topic and subscribe to it.
- See Also:
-
getEnabled
A Boolean value;set to
true
to activate the subscription, set tofalse
to create the subscription but not active it.- See Also:
-
getEventCategories
A list of event categories for aSourceType
that you want to subscribe to.- See Also:
-
getSourceIds
The list of identifiers of the event sources for which events are 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 can't end with a hyphen or contain two consecutive hyphens.
Constraints:
- If
SourceIds
are provided,SourceType
must also be provided. - If the source type is an instance, a
DBInstanceIdentifier
must be provided. - If the source type is a security group, a
DBSecurityGroupName
must be provided. - If the source type is a parameter group, a
DBParameterGroupName
must be provided. - If the source type is a snapshot, a
DBSnapshotIdentifier
must be provided.
- See Also:
- If
-
getSourceType
The type of source that is generating the events.For example, if you want to be notified of events generated by an instance, you would set this parameter to
db-instance
. If this value is not specified, all events are returned.Valid values:
db-instance
,db-cluster
,db-parameter-group
,db-security-group
,db-cluster-snapshot
- See Also:
-
getSubscriptionName
The name of the subscription.Constraints: The name must be fewer than 255 characters.
- See Also:
-
builder
- Returns:
- a
CfnEventSubscriptionProps.Builder
ofCfnEventSubscriptionProps
-