Package com.pulumi.aws.docdb

Class EventSubscription

  • public class EventSubscription
extends com.pulumi.resources.CustomResource
    Provides a DB event subscription resource. ## Example Usage ```java package generated_program; import java.util.*; import java.io.*; import java.nio.*; import com.pulumi.*; 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 DocDB Event Subscriptions can be imported using the `name`, e.g., ```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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      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> 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, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn

      • 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:
        The Amazon Resource Name of the DocDB event notification subscription

      • customerAwsId

        public com.pulumi.core.Output<java.lang.String> customerAwsId()
        Returns:
        The AWS customer account associated with the DocDB 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()

      • namePrefix

        public com.pulumi.core.Output<java.lang.String> namePrefix()
        Returns:
        The name of the DocDB event subscription. Conflicts with `name`.

      • 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 source_type 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 `default_tags` 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 [`default_tags` configuration block](https://www.terraform.io/docs/providers/aws/index.html#default_tags-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.