Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. docdb
  5. EventSubscription
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.docdb.EventSubscription

Explore with Pulumi AI

aws logo
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

    Provides a DocumentDB event subscription resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.docdb.Cluster("example", {
    clusterIdentifier: "example",
    availabilityZones: [
        available.names[0],
        available.names[1],
        available.names[2],
    ],
    masterUsername: "foo",
    masterPassword: "mustbeeightcharaters",
    skipFinalSnapshot: true,
});
const exampleTopic = new aws.sns.Topic("example", {name: "example-events"});
const exampleEventSubscription = new aws.docdb.EventSubscription("example", {
    name: "example",
    enabled: true,
    eventCategories: [
        "creation",
        "failure",
    ],
    sourceType: "db-cluster",
    sourceIds: [example.id],
    snsTopicArn: exampleTopic.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.docdb.Cluster("example",
    cluster_identifier="example",
    availability_zones=[
        available["names"][0],
        available["names"][1],
        available["names"][2],
    ],
    master_username="foo",
    master_password="mustbeeightcharaters",
    skip_final_snapshot=True)
example_topic = aws.sns.Topic("example", name="example-events")
example_event_subscription = aws.docdb.EventSubscription("example",
    name="example",
    enabled=True,
    event_categories=[
        "creation",
        "failure",
    ],
    source_type="db-cluster",
    source_ids=[example.id],
    sns_topic_arn=example_topic.arn)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/docdb"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := docdb.NewCluster(ctx, "example", &docdb.ClusterArgs{
			ClusterIdentifier: pulumi.String("example"),
			AvailabilityZones: pulumi.StringArray{
				available.Names[0],
				available.Names[1],
				available.Names[2],
			},
			MasterUsername:    pulumi.String("foo"),
			MasterPassword:    pulumi.String("mustbeeightcharaters"),
			SkipFinalSnapshot: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleTopic, err := sns.NewTopic(ctx, "example", &sns.TopicArgs{
			Name: pulumi.String("example-events"),
		})
		if err != nil {
			return err
		}
		_, err = docdb.NewEventSubscription(ctx, "example", &docdb.EventSubscriptionArgs{
			Name:    pulumi.String("example"),
			Enabled: pulumi.Bool(true),
			EventCategories: pulumi.StringArray{
				pulumi.String("creation"),
				pulumi.String("failure"),
			},
			SourceType: pulumi.String("db-cluster"),
			SourceIds: pulumi.StringArray{
				example.ID(),
			},
			SnsTopicArn: exampleTopic.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DocDB.Cluster("example", new()
    {
        ClusterIdentifier = "example",
        AvailabilityZones = new[]
        {
            available.Names[0],
            available.Names[1],
            available.Names[2],
        },
        MasterUsername = "foo",
        MasterPassword = "mustbeeightcharaters",
        SkipFinalSnapshot = true,
    });

    var exampleTopic = new Aws.Sns.Topic("example", new()
    {
        Name = "example-events",
    });

    var exampleEventSubscription = new Aws.DocDB.EventSubscription("example", new()
    {
        Name = "example",
        Enabled = true,
        EventCategories = new[]
        {
            "creation",
            "failure",
        },
        SourceType = "db-cluster",
        SourceIds = new[]
        {
            example.Id,
        },
        SnsTopicArn = exampleTopic.Arn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.docdb.Cluster;
import com.pulumi.aws.docdb.ClusterArgs;
import com.pulumi.aws.sns.Topic;
import com.pulumi.aws.sns.TopicArgs;
import com.pulumi.aws.docdb.EventSubscription;
import com.pulumi.aws.docdb.EventSubscriptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Cluster("example", ClusterArgs.builder()
            .clusterIdentifier("example")
            .availabilityZones(            
                available.names()[0],
                available.names()[1],
                available.names()[2])
            .masterUsername("foo")
            .masterPassword("mustbeeightcharaters")
            .skipFinalSnapshot(true)
            .build());

        var exampleTopic = new Topic("exampleTopic", TopicArgs.builder()
            .name("example-events")
            .build());

        var exampleEventSubscription = new EventSubscription("exampleEventSubscription", EventSubscriptionArgs.builder()
            .name("example")
            .enabled(true)
            .eventCategories(            
                "creation",
                "failure")
            .sourceType("db-cluster")
            .sourceIds(example.id())
            .snsTopicArn(exampleTopic.arn())
            .build());

    }
}

    resources:
  example:
    type: aws:docdb:Cluster
    properties:
      clusterIdentifier: example
      availabilityZones:
        - ${available.names[0]}
        - ${available.names[1]}
        - ${available.names[2]}
      masterUsername: foo
      masterPassword: mustbeeightcharaters
      skipFinalSnapshot: true
  exampleTopic:
    type: aws:sns:Topic
    name: example
    properties:
      name: example-events
  exampleEventSubscription:
    type: aws:docdb:EventSubscription
    name: example
    properties:
      name: example
      enabled: true
      eventCategories:
        - creation
        - failure
      sourceType: db-cluster
      sourceIds:
        - ${example.id}
      snsTopicArn: ${exampleTopic.arn}

    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,
                      name: Optional[str] = None,
                      name_prefix: Optional[str] = None,
                      source_ids: Optional[Sequence[str]] = None,
                      source_type: Optional[str] = None,
                      tags: Optional[Mapping[str, 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:docdb:EventSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsEventSubscriptionResource = new Aws.DocDB.EventSubscription("awsEventSubscriptionResource", new()
{
    SnsTopicArn = "string",
    Enabled = false,
    EventCategories = new[]
    {
        "string",
    },
    Name = "string",
    NamePrefix = "string",
    SourceIds = new[]
    {
        "string",
    },
    SourceType = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := docdb.NewEventSubscription(ctx, "awsEventSubscriptionResource", &docdb.EventSubscriptionArgs{
	SnsTopicArn: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	EventCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:       pulumi.String("string"),
	NamePrefix: pulumi.String("string"),
	SourceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SourceType: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var awsEventSubscriptionResource = new EventSubscription("awsEventSubscriptionResource", EventSubscriptionArgs.builder()
    .snsTopicArn("string")
    .enabled(false)
    .eventCategories("string")
    .name("string")
    .namePrefix("string")
    .sourceIds("string")
    .sourceType("string")
    .tags(Map.of("string", "string"))
    .build());

    aws_event_subscription_resource = aws.docdb.EventSubscription("awsEventSubscriptionResource",
    sns_topic_arn="string",
    enabled=False,
    event_categories=["string"],
    name="string",
    name_prefix="string",
    source_ids=["string"],
    source_type="string",
    tags={
        "string": "string",
    })

    const awsEventSubscriptionResource = new aws.docdb.EventSubscription("awsEventSubscriptionResource", {
    snsTopicArn: "string",
    enabled: false,
    eventCategories: ["string"],
    name: "string",
    namePrefix: "string",
    sourceIds: ["string"],
    sourceType: "string",
    tags: {
        string: "string",
    },
});

    type: aws:docdb:EventSubscription
properties:
    enabled: false
    eventCategories:
        - string
    name: string
    namePrefix: string
    snsTopicArn: string
    sourceIds:
        - string
    sourceType: string
    tags:
        string: string

    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
    Enabled bool
    A boolean flag to enable/disable the subscription. Defaults to true.
    EventCategories List<string>
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    Name string
    The name of the DocumentDB event subscription. By default generated by this provider.
    NamePrefix string
    The name of the DocumentDB event subscription. Conflicts with name.
    SourceIds List<string>
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    SourceType string
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    SnsTopicArn string
    Enabled bool
    A boolean flag to enable/disable the subscription. Defaults to true.
    EventCategories []string
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    Name string
    The name of the DocumentDB event subscription. By default generated by this provider.
    NamePrefix string
    The name of the DocumentDB event subscription. Conflicts with name.
    SourceIds []string
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    SourceType string
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    snsTopicArn String
    enabled Boolean
    A boolean flag to enable/disable the subscription. Defaults to true.
    eventCategories List<String>
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    name String
    The name of the DocumentDB event subscription. By default generated by this provider.
    namePrefix String
    The name of the DocumentDB event subscription. Conflicts with name.
    sourceIds List<String>
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    sourceType String
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    snsTopicArn string
    enabled boolean
    A boolean flag to enable/disable the subscription. Defaults to true.
    eventCategories string[]
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    name string
    The name of the DocumentDB event subscription. By default generated by this provider.
    namePrefix string
    The name of the DocumentDB event subscription. Conflicts with name.
    sourceIds string[]
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    sourceType string
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    sns_topic_arn str
    enabled bool
    A boolean flag to enable/disable the subscription. Defaults to true.
    event_categories Sequence[str]
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    name str
    The name of the DocumentDB event subscription. By default generated by this provider.
    name_prefix str
    The name of the DocumentDB event subscription. Conflicts with name.
    source_ids Sequence[str]
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    source_type str
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    snsTopicArn String
    enabled Boolean
    A boolean flag to enable/disable the subscription. Defaults to true.
    eventCategories List<String>
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    name String
    The name of the DocumentDB event subscription. By default generated by this provider.
    namePrefix String
    The name of the DocumentDB event subscription. Conflicts with name.
    sourceIds List<String>
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    sourceType String
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EventSubscription resource produces the following output properties:

    Arn string
    The Amazon Resource Name of the DocumentDB event notification subscription
    CustomerAwsId string
    The AWS customer account associated with the DocumentDB event notification subscription
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name of the DocumentDB event notification subscription
    CustomerAwsId string
    The AWS customer account associated with the DocumentDB event notification subscription
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name of the DocumentDB event notification subscription
    customerAwsId String
    The AWS customer account associated with the DocumentDB event notification subscription
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name of the DocumentDB event notification subscription
    customerAwsId string
    The AWS customer account associated with the DocumentDB event notification subscription
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name of the DocumentDB event notification subscription
    customer_aws_id str
    The AWS customer account associated with the DocumentDB event notification subscription
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name of the DocumentDB event notification subscription
    customerAwsId String
    The AWS customer account associated with the DocumentDB event notification subscription
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing EventSubscription Resource

    Get an existing EventSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EventSubscriptionState, opts?: CustomResourceOptions): EventSubscription
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        customer_aws_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        event_categories: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        sns_topic_arn: Optional[str] = None,
        source_ids: Optional[Sequence[str]] = None,
        source_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> EventSubscription
    func GetEventSubscription(ctx *Context, name string, id IDInput, state *EventSubscriptionState, opts ...ResourceOption) (*EventSubscription, error)
    public static EventSubscription Get(string name, Input<string> id, EventSubscriptionState? state, CustomResourceOptions? opts = null)
    public static EventSubscription get(String name, Output<String> id, EventSubscriptionState state, CustomResourceOptions options)
    resources:  _:    type: aws:docdb:EventSubscription    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The Amazon Resource Name of the DocumentDB event notification subscription
    CustomerAwsId string
    The AWS customer account associated with the DocumentDB event notification subscription
    Enabled bool
    A boolean flag to enable/disable the subscription. Defaults to true.
    EventCategories List<string>
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    Name string
    The name of the DocumentDB event subscription. By default generated by this provider.
    NamePrefix string
    The name of the DocumentDB event subscription. Conflicts with name.
    SnsTopicArn string
    SourceIds List<string>
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    SourceType string
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Amazon Resource Name of the DocumentDB event notification subscription
    CustomerAwsId string
    The AWS customer account associated with the DocumentDB event notification subscription
    Enabled bool
    A boolean flag to enable/disable the subscription. Defaults to true.
    EventCategories []string
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    Name string
    The name of the DocumentDB event subscription. By default generated by this provider.
    NamePrefix string
    The name of the DocumentDB event subscription. Conflicts with name.
    SnsTopicArn string
    SourceIds []string
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    SourceType string
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name of the DocumentDB event notification subscription
    customerAwsId String
    The AWS customer account associated with the DocumentDB event notification subscription
    enabled Boolean
    A boolean flag to enable/disable the subscription. Defaults to true.
    eventCategories List<String>
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    name String
    The name of the DocumentDB event subscription. By default generated by this provider.
    namePrefix String
    The name of the DocumentDB event subscription. Conflicts with name.
    snsTopicArn String
    sourceIds List<String>
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    sourceType String
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Amazon Resource Name of the DocumentDB event notification subscription
    customerAwsId string
    The AWS customer account associated with the DocumentDB event notification subscription
    enabled boolean
    A boolean flag to enable/disable the subscription. Defaults to true.
    eventCategories string[]
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    name string
    The name of the DocumentDB event subscription. By default generated by this provider.
    namePrefix string
    The name of the DocumentDB event subscription. Conflicts with name.
    snsTopicArn string
    sourceIds string[]
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    sourceType string
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Amazon Resource Name of the DocumentDB event notification subscription
    customer_aws_id str
    The AWS customer account associated with the DocumentDB event notification subscription
    enabled bool
    A boolean flag to enable/disable the subscription. Defaults to true.
    event_categories Sequence[str]
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    name str
    The name of the DocumentDB event subscription. By default generated by this provider.
    name_prefix str
    The name of the DocumentDB event subscription. Conflicts with name.
    sns_topic_arn str
    source_ids Sequence[str]
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    source_type str
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Amazon Resource Name of the DocumentDB event notification subscription
    customerAwsId String
    The AWS customer account associated with the DocumentDB event notification subscription
    enabled Boolean
    A boolean flag to enable/disable the subscription. Defaults to true.
    eventCategories List<String>
    A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Event.html or run aws docdb describe-event-categories.
    name String
    The name of the DocumentDB event subscription. By default generated by this provider.
    namePrefix String
    The name of the DocumentDB event subscription. Conflicts with name.
    snsTopicArn String
    sourceIds List<String>
    A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
    sourceType String
    The type of source that will be generating the events. Valid options are db-instance, db-cluster, db-parameter-group, db-security-group, db-cluster-snapshot. If not set, all sources will be subscribed to.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import DocumentDB Event Subscriptions using the name. For example:

    $ pulumi import aws:docdb/eventSubscription:EventSubscription example event-sub

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
    pulumi/pulumi-aws