pulumi-aws-kotlin/com.pulumi.aws.docdb.kotlin/EventSubscription

EventSubscription

class EventSubscription : KotlinCustomResource

Provides a DocumentDB event subscription resource.

Example Usage

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.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 exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
            .clusterIdentifier("example")
            .availabilityZones(
                data.aws_availability_zones().available().names()[0],
                data.aws_availability_zones().available().names()[1],
                data.aws_availability_zones().available().names()[2])
            .masterUsername("foo")
            .masterPassword("mustbeeightcharaters")
            .skipFinalSnapshot(true)
            .build());
        var exampleTopic = new Topic("exampleTopic");
        var exampleEventSubscription = new EventSubscription("exampleEventSubscription", EventSubscriptionArgs.builder()
            .enabled(true)
            .eventCategories(
                "creation",
                "failure")
            .sourceType("db-cluster")
            .sourceIds(exampleCluster.id())
            .snsTopicArn(exampleTopic.arn())
            .build());
    }
}

Import

DocumentDB Event Subscriptions can be imported using the name, e.g.,

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

Properties

arn

val arn: Output<String>

The Amazon Resource Name of the DocumentDB event notification subscription

customerAwsId

val customerAwsId: Output<String>

The AWS customer account associated with the DocumentDB event notification subscription

enabled

val enabled: Output<Boolean>?

A boolean flag to enable/disable the subscription. Defaults to true.

eventCategories

val eventCategories: Output<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.

val id: Output<String>

name

val name: Output<String>

The name of the DocumentDB event subscription. By default generated by this provider.

namePrefix

val namePrefix: Output<String>

The name of the DocumentDB event subscription. Conflicts with name.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

snsTopicArn

val snsTopicArn: Output<String>

sourceIds

val sourceIds: Output<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

val sourceType: Output<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.