We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 3, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 3, 2026 by Pulumi
Resource Type definition for AWS::DocDB::EventSubscription
Create EventSubscription Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EventSubscription(name: string, args: EventSubscriptionArgs, opts?: CustomResourceOptions);@overload
def EventSubscription(resource_name: str,
args: EventSubscriptionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def EventSubscription(resource_name: str,
opts: Optional[ResourceOptions] = None,
sns_topic_arn: Optional[str] = None,
enabled: Optional[bool] = None,
event_categories: Optional[Sequence[str]] = None,
source_ids: Optional[Sequence[str]] = None,
source_type: Optional[EventSubscriptionSourceType] = None,
subscription_name: Optional[str] = None)func NewEventSubscription(ctx *Context, name string, args EventSubscriptionArgs, opts ...ResourceOption) (*EventSubscription, error)public EventSubscription(string name, EventSubscriptionArgs args, CustomResourceOptions? opts = null)
public EventSubscription(String name, EventSubscriptionArgs args)
public EventSubscription(String name, EventSubscriptionArgs args, CustomResourceOptions options)
type: aws-native:docdb:EventSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_docdb_event_subscription" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args EventSubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EventSubscriptionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EventSubscriptionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EventSubscriptionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EventSubscriptionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
EventSubscription Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The EventSubscription resource accepts the following input properties:
- Sns
Topic stringArn - 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.
- Enabled bool
- A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
- Event
Categories List<string> - A list of event categories for a SourceType that you want to subscribe to.
- Source
Ids List<string> - The list of identifiers of the event sources for which events are returned
- Source
Type Pulumi.Aws Native. Doc Db. Event Subscription Source Type - The type of source that is generating the events.
- Subscription
Name string - The name of the subscription.
- Sns
Topic stringArn - 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.
- Enabled bool
- A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
- Event
Categories []string - A list of event categories for a SourceType that you want to subscribe to.
- Source
Ids []string - The list of identifiers of the event sources for which events are returned
- Source
Type EventSubscription Source Type - The type of source that is generating the events.
- Subscription
Name string - The name of the subscription.
- sns_
topic_ stringarn - 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.
- enabled bool
- A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
- event_
categories list(string) - A list of event categories for a SourceType that you want to subscribe to.
- source_
ids list(string) - The list of identifiers of the event sources for which events are returned
- source_
type "db-instance" | "db-cluster" | "db-parameter-group" | "db-security-group" | "db-cluster-snapshot" - The type of source that is generating the events.
- subscription_
name string - The name of the subscription.
- sns
Topic StringArn - 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.
- enabled Boolean
- A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
- event
Categories List<String> - A list of event categories for a SourceType that you want to subscribe to.
- source
Ids List<String> - The list of identifiers of the event sources for which events are returned
- source
Type EventSubscription Source Type - The type of source that is generating the events.
- subscription
Name String - The name of the subscription.
- sns
Topic stringArn - 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.
- enabled boolean
- A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
- event
Categories string[] - A list of event categories for a SourceType that you want to subscribe to.
- source
Ids string[] - The list of identifiers of the event sources for which events are returned
- source
Type EventSubscription Source Type - The type of source that is generating the events.
- subscription
Name string - The name of the subscription.
- sns_
topic_ strarn - 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.
- enabled bool
- A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
- event_
categories Sequence[str] - A list of event categories for a SourceType that you want to subscribe to.
- source_
ids Sequence[str] - The list of identifiers of the event sources for which events are returned
- source_
type EventSubscription Source Type - The type of source that is generating the events.
- subscription_
name str - The name of the subscription.
- sns
Topic StringArn - 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.
- enabled Boolean
- A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
- event
Categories List<String> - A list of event categories for a SourceType that you want to subscribe to.
- source
Ids List<String> - The list of identifiers of the event sources for which events are returned
- source
Type "db-instance" | "db-cluster" | "db-parameter-group" | "db-security-group" | "db-cluster-snapshot" - The type of source that is generating the events.
- subscription
Name String - The name of the subscription.
Outputs
All input properties are implicitly available as output properties. Additionally, the EventSubscription resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
EventSubscriptionSourceType, EventSubscriptionSourceTypeArgs
- Db
Instance db-instance- Db
Cluster db-cluster- Db
Parameter Group db-parameter-group- Db
Security Group db-security-group- Db
Cluster Snapshot db-cluster-snapshot
- Event
Subscription Source Type Db Instance db-instance- Event
Subscription Source Type Db Cluster db-cluster- Event
Subscription Source Type Db Parameter Group db-parameter-group- Event
Subscription Source Type Db Security Group db-security-group- Event
Subscription Source Type Db Cluster Snapshot db-cluster-snapshot
- "db-instance"
db-instance- "db-cluster"
db-cluster- "db-parameter-group"
db-parameter-group- "db-security-group"
db-security-group- "db-cluster-snapshot"
db-cluster-snapshot
- Db
Instance db-instance- Db
Cluster db-cluster- Db
Parameter Group db-parameter-group- Db
Security Group db-security-group- Db
Cluster Snapshot db-cluster-snapshot
- Db
Instance db-instance- Db
Cluster db-cluster- Db
Parameter Group db-parameter-group- Db
Security Group db-security-group- Db
Cluster Snapshot db-cluster-snapshot
- DB_INSTANCE
db-instance- DB_CLUSTER
db-cluster- DB_PARAMETER_GROUP
db-parameter-group- DB_SECURITY_GROUP
db-security-group- DB_CLUSTER_SNAPSHOT
db-cluster-snapshot
- "db-instance"
db-instance- "db-cluster"
db-cluster- "db-parameter-group"
db-parameter-group- "db-security-group"
db-security-group- "db-cluster-snapshot"
db-cluster-snapshot
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 3, 2026 by Pulumi