1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. docdb
  6. EventSubscription

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.74.1
published on Monday, Aug 3, 2026 by Pulumi
aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.74.1
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:

    SnsTopicArn string
    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.
    EventCategories List<string>
    A list of event categories for a SourceType that you want to subscribe to.
    SourceIds List<string>
    The list of identifiers of the event sources for which events are returned
    SourceType Pulumi.AwsNative.DocDb.EventSubscriptionSourceType
    The type of source that is generating the events.
    SubscriptionName string
    The name of the subscription.
    SnsTopicArn string
    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.
    EventCategories []string
    A list of event categories for a SourceType that you want to subscribe to.
    SourceIds []string
    The list of identifiers of the event sources for which events are returned
    SourceType EventSubscriptionSourceType
    The type of source that is generating the events.
    SubscriptionName string
    The name of the subscription.
    sns_topic_arn string
    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.
    snsTopicArn String
    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.
    eventCategories List<String>
    A list of event categories for a SourceType that you want to subscribe to.
    sourceIds List<String>
    The list of identifiers of the event sources for which events are returned
    sourceType EventSubscriptionSourceType
    The type of source that is generating the events.
    subscriptionName String
    The name of the subscription.
    snsTopicArn string
    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.
    eventCategories string[]
    A list of event categories for a SourceType that you want to subscribe to.
    sourceIds string[]
    The list of identifiers of the event sources for which events are returned
    sourceType EventSubscriptionSourceType
    The type of source that is generating the events.
    subscriptionName string
    The name of the subscription.
    sns_topic_arn str
    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 EventSubscriptionSourceType
    The type of source that is generating the events.
    subscription_name str
    The name of the subscription.
    snsTopicArn String
    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.
    eventCategories List<String>
    A list of event categories for a SourceType that you want to subscribe to.
    sourceIds List<String>
    The list of identifiers of the event sources for which events are returned
    sourceType "db-instance" | "db-cluster" | "db-parameter-group" | "db-security-group" | "db-cluster-snapshot"
    The type of source that is generating the events.
    subscriptionName 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

    DbInstance
    db-instance
    DbCluster
    db-cluster
    DbParameterGroup
    db-parameter-group
    DbSecurityGroup
    db-security-group
    DbClusterSnapshot
    db-cluster-snapshot
    EventSubscriptionSourceTypeDbInstance
    db-instance
    EventSubscriptionSourceTypeDbCluster
    db-cluster
    EventSubscriptionSourceTypeDbParameterGroup
    db-parameter-group
    EventSubscriptionSourceTypeDbSecurityGroup
    db-security-group
    EventSubscriptionSourceTypeDbClusterSnapshot
    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
    DbInstance
    db-instance
    DbCluster
    db-cluster
    DbParameterGroup
    db-parameter-group
    DbSecurityGroup
    db-security-group
    DbClusterSnapshot
    db-cluster-snapshot
    DbInstance
    db-instance
    DbCluster
    db-cluster
    DbParameterGroup
    db-parameter-group
    DbSecurityGroup
    db-security-group
    DbClusterSnapshot
    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
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.74.1
    published on Monday, Aug 3, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial