EventSubscription class

Provides a DMS (Data Migration Service) event subscription resource.

Example Usage

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

const example = new aws.dms.EventSubscription("example", {
    enabled: true,
    eventCategories: [
        "creation",
        "failure",
    ],
    name: "my-favorite-event-subscription",
    snsTopicArn: exampleAwsSnsTopic.arn,
    sourceIds: [exampleAwsDmsReplicationTask.replicationTaskId],
    sourceType: "replication-task",
    tags: {
        Name: "example",
    },
});

import pulumi
import pulumi_aws as aws

example = aws.dms.EventSubscription("example",
    enabled=True,
    event_categories=[
        "creation",
        "failure",
    ],
    name="my-favorite-event-subscription",
    sns_topic_arn=example_aws_sns_topic["arn"],
    source_ids=[example_aws_dms_replication_task["replicationTaskId"]],
    source_type="replication-task",
    tags={
        "Name": "example",
    })

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

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Dms.EventSubscription("example", new()
    {
        Enabled = true,
        EventCategories = new[]
        {
            "creation",
            "failure",
        },
        Name = "my-favorite-event-subscription",
        SnsTopicArn = exampleAwsSnsTopic.Arn,
        SourceIds = new[]
        {
            exampleAwsDmsReplicationTask.ReplicationTaskId,
        },
        SourceType = "replication-task",
        Tags =
        {
            { "Name", "example" },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/dms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dms.NewEventSubscription(ctx, "example", &dms.EventSubscriptionArgs{
			Enabled: pulumi.Bool(true),
			EventCategories: pulumi.StringArray{
				pulumi.String("creation"),
				pulumi.String("failure"),
			},
			Name:        pulumi.String("my-favorite-event-subscription"),
			SnsTopicArn: pulumi.Any(exampleAwsSnsTopic.Arn),
			SourceIds: pulumi.StringArray{
				exampleAwsDmsReplicationTask.ReplicationTaskId,
			},
			SourceType: pulumi.String("replication-task"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_dms_eventsubscription" "example" {
  enabled          = true
  event_categories = ["creation", "failure"]
  name             = "my-favorite-event-subscription"
  sns_topic_arn    = exampleAwsSnsTopic.arn
  source_ids       = [exampleAwsDmsReplicationTask.replicationTaskId]
  source_type      = "replication-task"
  tags = {
    "Name" = "example"
  }
}

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());

    }
}

resources:
  example:
    type: aws:dms:EventSubscription
    properties:
      enabled: true
      eventCategories:
        - creation
        - failure
      name: my-favorite-event-subscription
      snsTopicArn: ${exampleAwsSnsTopic.arn}
      sourceIds:
        - ${exampleAwsDmsReplicationTask.replicationTaskId}
      sourceType: replication-task
      tags:
        Name: example

Import

Using pulumi import, import event subscriptions using the name. For example:

$ pulumi import aws:dms/eventSubscription:EventSubscription test my-awesome-event-subscription

Constructors

EventSubscription(String name, {EventSubscriptionArgs? args, CustomResourceOptions? options})
Creates a new EventSubscription. name The Pulumi resource name. args Arguments used to configure this EventSubscription. The set of arguments for EventSubscription. options Resource options controlling this resource's behavior.
EventSubscription.reference(String urn)
Creates a typed reference to an existing EventSubscription resource.

Properties

arn ↔ Output<String>
ARN of the DMS Event Subscription.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
enabled ↔ Output<bool?>
Whether the event subscription should be enabled.
latefinal
eventCategories ↔ Output<List<String>>
List of event categories to listen for, see DescribeEventCategories for a canonical list.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
Name of event subscription.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
snsTopicArn ↔ Output<String>
SNS topic arn to send events on.
latefinal
sourceIds ↔ Output<List<String>?>
Ids of sources to listen to. If you don't specify a value, notifications are provided for all sources.
latefinal
sourceType ↔ Output<String>
Type of source for events. Valid values: replication-instance or replication-task
latefinal
tags ↔ Output<Map<String, String>?>
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.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {EventSubscriptionState? state, CustomResourceOptions? options}) → EventSubscription
Gets an existing EventSubscription resource's state with the given name and id.