Package com.pulumi.aws.docdb

Class EventSubscription

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.CustomResource

com.pulumi.aws.docdb.EventSubscription

public class EventSubscription
extends com.pulumi.resources.CustomResource

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.sns.TopicArgs;
 import com.pulumi.aws.docdb.EventSubscription;
 import com.pulumi.aws.docdb.EventSubscriptionArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 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());
 
     }
 }
 
 

## Import Using `pulumi import`, import DocumentDB Event Subscriptions using the `name`. For example: ```sh $ pulumi import aws:docdb/eventSubscription:EventSubscription example event-sub ```

Nested Class Summary

Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

com.pulumi.resources.CustomResource.CustomResourceInternal

Nested classes/interfaces inherited from class com.pulumi.resources.Resource

com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

Field Summary

Fields inherited from class com.pulumi.resources.Resource

childResources, remote

Constructor Summary

Constructors

Constructor	Description
EventSubscription(java.lang.String name)
EventSubscription(java.lang.String name, EventSubscriptionArgs args)
EventSubscription(java.lang.String name, EventSubscriptionArgs args, com.pulumi.resources.CustomResourceOptions options)

Method Summary

Modifier and Type	Method	Description
com.pulumi.core.Output<java.lang.String>	arn()
com.pulumi.core.Output<java.lang.String>	customerAwsId()
com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>>	enabled()
com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>>	eventCategories()
static EventSubscription	get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, EventSubscriptionState state, com.pulumi.resources.CustomResourceOptions options)	Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
com.pulumi.core.Output<java.lang.String>	name()
com.pulumi.core.Output<java.lang.String>	namePrefix()
com.pulumi.core.Output<java.lang.String>	region()
com.pulumi.core.Output<java.lang.String>	snsTopicArn()
com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>>	sourceIds()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>	sourceType()
com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>	tags()
com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>	tagsAll()

Methods inherited from class com.pulumi.resources.CustomResource

getId, id, idFuture

Methods inherited from class com.pulumi.resources.Resource

getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventSubscription

public EventSubscription(java.lang.String name)

Parameters:

name - The _unique_ name of the resulting resource.

EventSubscription

public EventSubscription(java.lang.String name,
                         EventSubscriptionArgs args)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

EventSubscription

public EventSubscription(java.lang.String name,
                         EventSubscriptionArgs args,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

options - A bag of options that control this resource's behavior.

Method Detail

arn

public com.pulumi.core.Output<java.lang.String> arn()

Returns:

ARN of the DocumentDB event notification subscription

customerAwsId

public com.pulumi.core.Output<java.lang.String> customerAwsId()

Returns:

The AWS customer account associated with the DocumentDB event notification subscription

enabled

public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enabled()

Returns:

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

eventCategories

public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> eventCategories()

Returns:

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

public com.pulumi.core.Output<java.lang.String> name()

Returns:

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

namePrefix

public com.pulumi.core.Output<java.lang.String> namePrefix()

Returns:

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

region

public com.pulumi.core.Output<java.lang.String> region()

Returns:

Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

snsTopicArn

public com.pulumi.core.Output<java.lang.String> snsTopicArn()

sourceIds

public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> sourceIds()

Returns:

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 sourceType must also be specified.

sourceType

public com.pulumi.core.Output<java.util.Optional<java.lang.String>> sourceType()

Returns:

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

public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()

Returns:

A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll

public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()

Returns:

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

get

public static EventSubscription get(java.lang.String name,
                                    com.pulumi.core.Output<java.lang.String> id,
                                    @Nullable
                                    EventSubscriptionState state,
                                    @Nullable
                                    com.pulumi.resources.CustomResourceOptions options)

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

Parameters:

name - The _unique_ name of the resulting resource.

id - The _unique_ provider ID of the resource to lookup.

state -

options - Optional settings to control the behavior of the CustomResource.