Package com.pulumi.aws.dms

Class EventSubscription

  • public class EventSubscription
extends com.pulumi.resources.CustomResource
    Provides a DMS (Data Migration Service) 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.dms.EventSubscription;
 import com.pulumi.aws.dms.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 EventSubscription("example", EventSubscriptionArgs.builder()
             .enabled(true)
             .eventCategories(            
                 "creation",
                 "failure")
             .name("my-favorite-event-subscription")
             .snsTopicArn(exampleAwsSnsTopic.arn())
             .sourceIds(exampleAwsDmsReplicationTask.replicationTaskId())
             .sourceType("replication-task")
             .tags(Map.of("Name", "example"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import event subscriptions using the `name`. For example: ```sh $ pulumi import aws:dms/eventSubscription:EventSubscription test my-awesome-event-subscription ```

    • 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.util.Optional<java.lang.Boolean>> enabled()  
      com.pulumi.core.Output<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> 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.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 DMS Event Subscription.

      • enabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enabled()
        Returns:
        Whether the event subscription should be enabled.

      • eventCategories

        public com.pulumi.core.Output<java.util.List<java.lang.String>> eventCategories()
        Returns:
        List of event categories to listen for, see `DescribeEventCategories` for a canonical list.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of event subscription.

      • 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()
        Returns:
        SNS topic ARN to send events on.

      • sourceIds

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> sourceIds()
        Returns:
        IDs of sources to listen to. If you don't specify a value, notifications are provided for all sources.

      • sourceType

        public com.pulumi.core.Output<java.lang.String> sourceType()
        Returns:
        Type of source for events. Valid values: `replication-instance` or `replication-task`

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of resource 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.