1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. EventSubscription
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi

aws.rds.EventSubscription

Explore with Pulumi AI

Provides a DB event subscription resource.

Example Usage

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

const _default = new aws.rds.Instance("default", {
    allocatedStorage: 10,
    engine: "mysql",
    engineVersion: "5.6.17",
    instanceClass: aws.rds.InstanceType.T2_Micro,
    dbName: "mydb",
    username: "foo",
    password: "bar",
    dbSubnetGroupName: "my_database_subnet_group",
    parameterGroupName: "default.mysql5.6",
});
const defaultTopic = new aws.sns.Topic("default", {name: "rds-events"});
const defaultEventSubscription = new aws.rds.EventSubscription("default", {
    name: "rds-event-sub",
    snsTopic: defaultTopic.arn,
    sourceType: "db-instance",
    sourceIds: [_default.identifier],
    eventCategories: [
        "availability",
        "deletion",
        "failover",
        "failure",
        "low storage",
        "maintenance",
        "notification",
        "read replica",
        "recovery",
        "restoration",
    ],
});
Copy
import pulumi
import pulumi_aws as aws

default = aws.rds.Instance("default",
    allocated_storage=10,
    engine="mysql",
    engine_version="5.6.17",
    instance_class=aws.rds.InstanceType.T2_MICRO,
    db_name="mydb",
    username="foo",
    password="bar",
    db_subnet_group_name="my_database_subnet_group",
    parameter_group_name="default.mysql5.6")
default_topic = aws.sns.Topic("default", name="rds-events")
default_event_subscription = aws.rds.EventSubscription("default",
    name="rds-event-sub",
    sns_topic=default_topic.arn,
    source_type="db-instance",
    source_ids=[default.identifier],
    event_categories=[
        "availability",
        "deletion",
        "failover",
        "failure",
        "low storage",
        "maintenance",
        "notification",
        "read replica",
        "recovery",
        "restoration",
    ])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := rds.NewInstance(ctx, "default", &rds.InstanceArgs{
			AllocatedStorage:   pulumi.Int(10),
			Engine:             pulumi.String("mysql"),
			EngineVersion:      pulumi.String("5.6.17"),
			InstanceClass:      pulumi.String(rds.InstanceType_T2_Micro),
			DbName:             pulumi.String("mydb"),
			Username:           pulumi.String("foo"),
			Password:           pulumi.String("bar"),
			DbSubnetGroupName:  pulumi.String("my_database_subnet_group"),
			ParameterGroupName: pulumi.String("default.mysql5.6"),
		})
		if err != nil {
			return err
		}
		defaultTopic, err := sns.NewTopic(ctx, "default", &sns.TopicArgs{
			Name: pulumi.String("rds-events"),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewEventSubscription(ctx, "default", &rds.EventSubscriptionArgs{
			Name:       pulumi.String("rds-event-sub"),
			SnsTopic:   defaultTopic.Arn,
			SourceType: pulumi.String("db-instance"),
			SourceIds: pulumi.StringArray{
				_default.Identifier,
			},
			EventCategories: pulumi.StringArray{
				pulumi.String("availability"),
				pulumi.String("deletion"),
				pulumi.String("failover"),
				pulumi.String("failure"),
				pulumi.String("low storage"),
				pulumi.String("maintenance"),
				pulumi.String("notification"),
				pulumi.String("read replica"),
				pulumi.String("recovery"),
				pulumi.String("restoration"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.Rds.Instance("default", new()
    {
        AllocatedStorage = 10,
        Engine = "mysql",
        EngineVersion = "5.6.17",
        InstanceClass = Aws.Rds.InstanceType.T2_Micro,
        DbName = "mydb",
        Username = "foo",
        Password = "bar",
        DbSubnetGroupName = "my_database_subnet_group",
        ParameterGroupName = "default.mysql5.6",
    });

    var defaultTopic = new Aws.Sns.Topic("default", new()
    {
        Name = "rds-events",
    });

    var defaultEventSubscription = new Aws.Rds.EventSubscription("default", new()
    {
        Name = "rds-event-sub",
        SnsTopic = defaultTopic.Arn,
        SourceType = "db-instance",
        SourceIds = new[]
        {
            @default.Identifier,
        },
        EventCategories = new[]
        {
            "availability",
            "deletion",
            "failover",
            "failure",
            "low storage",
            "maintenance",
            "notification",
            "read replica",
            "recovery",
            "restoration",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Instance;
import com.pulumi.aws.rds.InstanceArgs;
import com.pulumi.aws.sns.Topic;
import com.pulumi.aws.sns.TopicArgs;
import com.pulumi.aws.rds.EventSubscription;
import com.pulumi.aws.rds.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 default_ = new Instance("default", InstanceArgs.builder()
            .allocatedStorage(10)
            .engine("mysql")
            .engineVersion("5.6.17")
            .instanceClass("db.t2.micro")
            .dbName("mydb")
            .username("foo")
            .password("bar")
            .dbSubnetGroupName("my_database_subnet_group")
            .parameterGroupName("default.mysql5.6")
            .build());

        var defaultTopic = new Topic("defaultTopic", TopicArgs.builder()
            .name("rds-events")
            .build());

        var defaultEventSubscription = new EventSubscription("defaultEventSubscription", EventSubscriptionArgs.builder()
            .name("rds-event-sub")
            .snsTopic(defaultTopic.arn())
            .sourceType("db-instance")
            .sourceIds(default_.identifier())
            .eventCategories(            
                "availability",
                "deletion",
                "failover",
                "failure",
                "low storage",
                "maintenance",
                "notification",
                "read replica",
                "recovery",
                "restoration")
            .build());

    }
}
Copy
resources:
  default:
    type: aws:rds:Instance
    properties:
      allocatedStorage: 10
      engine: mysql
      engineVersion: 5.6.17
      instanceClass: db.t2.micro
      dbName: mydb
      username: foo
      password: bar
      dbSubnetGroupName: my_database_subnet_group
      parameterGroupName: default.mysql5.6
  defaultTopic:
    type: aws:sns:Topic
    name: default
    properties:
      name: rds-events
  defaultEventSubscription:
    type: aws:rds:EventSubscription
    name: default
    properties:
      name: rds-event-sub
      snsTopic: ${defaultTopic.arn}
      sourceType: db-instance
      sourceIds:
        - ${default.identifier}
      eventCategories:
        - availability
        - deletion
        - failover
        - failure
        - low storage
        - maintenance
        - notification
        - read replica
        - recovery
        - restoration
Copy

Create EventSubscription Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EventSubscription(name: string, args: EventSubscriptionArgs, opts?: CustomResourceOptions);
@overload
def EventSubscription(resource_name: str,
                      args: EventSubscriptionArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def EventSubscription(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      sns_topic: Optional[str] = None,
                      enabled: Optional[bool] = None,
                      event_categories: Optional[Sequence[str]] = None,
                      name: Optional[str] = None,
                      name_prefix: Optional[str] = None,
                      source_ids: Optional[Sequence[str]] = None,
                      source_type: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
func NewEventSubscription(ctx *Context, name string, args EventSubscriptionArgs, opts ...ResourceOption) (*EventSubscription, error)
public EventSubscription(string name, EventSubscriptionArgs args, CustomResourceOptions? opts = null)
public EventSubscription(String name, EventSubscriptionArgs args)
public EventSubscription(String name, EventSubscriptionArgs args, CustomResourceOptions options)
type: aws:rds:EventSubscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EventSubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EventSubscriptionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EventSubscriptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EventSubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EventSubscriptionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleeventSubscriptionResourceResourceFromRdseventSubscription = new Aws.Rds.EventSubscription("exampleeventSubscriptionResourceResourceFromRdseventSubscription", new()
{
    SnsTopic = "string",
    Enabled = false,
    EventCategories = new[]
    {
        "string",
    },
    Name = "string",
    NamePrefix = "string",
    SourceIds = new[]
    {
        "string",
    },
    SourceType = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := rds.NewEventSubscription(ctx, "exampleeventSubscriptionResourceResourceFromRdseventSubscription", &rds.EventSubscriptionArgs{
	SnsTopic: pulumi.String("string"),
	Enabled:  pulumi.Bool(false),
	EventCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:       pulumi.String("string"),
	NamePrefix: pulumi.String("string"),
	SourceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SourceType: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampleeventSubscriptionResourceResourceFromRdseventSubscription = new EventSubscription("exampleeventSubscriptionResourceResourceFromRdseventSubscription", EventSubscriptionArgs.builder()
    .snsTopic("string")
    .enabled(false)
    .eventCategories("string")
    .name("string")
    .namePrefix("string")
    .sourceIds("string")
    .sourceType("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
exampleevent_subscription_resource_resource_from_rdsevent_subscription = aws.rds.EventSubscription("exampleeventSubscriptionResourceResourceFromRdseventSubscription",
    sns_topic="string",
    enabled=False,
    event_categories=["string"],
    name="string",
    name_prefix="string",
    source_ids=["string"],
    source_type="string",
    tags={
        "string": "string",
    })
Copy
const exampleeventSubscriptionResourceResourceFromRdseventSubscription = new aws.rds.EventSubscription("exampleeventSubscriptionResourceResourceFromRdseventSubscription", {
    snsTopic: "string",
    enabled: false,
    eventCategories: ["string"],
    name: "string",
    namePrefix: "string",
    sourceIds: ["string"],
    sourceType: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:rds:EventSubscription
properties:
    enabled: false
    eventCategories:
        - string
    name: string
    namePrefix: string
    snsTopic: string
    sourceIds:
        - string
    sourceType: string
    tags:
        string: string
Copy

EventSubscription Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EventSubscription resource accepts the following input properties:

SnsTopic This property is required. string
The SNS topic to send events to.
Enabled bool
A boolean flag to enable/disable the subscription. Defaults to true.
EventCategories List<string>
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
Name Changes to this property will trigger replacement. string
The name of the DB event subscription. By default generated by this provider.
NamePrefix Changes to this property will trigger replacement. string
The name of the DB event subscription. Conflicts with name.
SourceIds 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 string
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
Tags Dictionary<string, string>
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.
SnsTopic This property is required. string
The SNS topic to send events to.
Enabled bool
A boolean flag to enable/disable the subscription. Defaults to true.
EventCategories []string
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
Name Changes to this property will trigger replacement. string
The name of the DB event subscription. By default generated by this provider.
NamePrefix Changes to this property will trigger replacement. string
The name of the DB event subscription. Conflicts with name.
SourceIds []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 string
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
Tags map[string]string
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.
snsTopic This property is required. String
The SNS topic to send events to.
enabled Boolean
A boolean flag to enable/disable the subscription. Defaults to true.
eventCategories List<String>
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
name Changes to this property will trigger replacement. String
The name of the DB event subscription. By default generated by this provider.
namePrefix Changes to this property will trigger replacement. String
The name of the DB event subscription. Conflicts with name.
sourceIds 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 String
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
tags Map<String,String>
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.
snsTopic This property is required. string
The SNS topic to send events to.
enabled boolean
A boolean flag to enable/disable the subscription. Defaults to true.
eventCategories string[]
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
name Changes to this property will trigger replacement. string
The name of the DB event subscription. By default generated by this provider.
namePrefix Changes to this property will trigger replacement. string
The name of the DB event subscription. Conflicts with name.
sourceIds 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 string
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
tags {[key: string]: string}
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.
sns_topic This property is required. str
The SNS topic to send events to.
enabled bool
A boolean flag to enable/disable the subscription. Defaults to true.
event_categories Sequence[str]
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
name Changes to this property will trigger replacement. str
The name of the DB event subscription. By default generated by this provider.
name_prefix Changes to this property will trigger replacement. str
The name of the DB event subscription. Conflicts with name.
source_ids Sequence[str]
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.
source_type str
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
tags Mapping[str, str]
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.
snsTopic This property is required. String
The SNS topic to send events to.
enabled Boolean
A boolean flag to enable/disable the subscription. Defaults to true.
eventCategories List<String>
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
name Changes to this property will trigger replacement. String
The name of the DB event subscription. By default generated by this provider.
namePrefix Changes to this property will trigger replacement. String
The name of the DB event subscription. Conflicts with name.
sourceIds 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 String
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
tags Map<String>
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the EventSubscription resource produces the following output properties:

Arn string
The Amazon Resource Name of the RDS event notification subscription
CustomerAwsId string
The AWS customer account associated with the RDS event notification subscription
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The Amazon Resource Name of the RDS event notification subscription
CustomerAwsId string
The AWS customer account associated with the RDS event notification subscription
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name of the RDS event notification subscription
customerAwsId String
The AWS customer account associated with the RDS event notification subscription
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The Amazon Resource Name of the RDS event notification subscription
customerAwsId string
The AWS customer account associated with the RDS event notification subscription
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The Amazon Resource Name of the RDS event notification subscription
customer_aws_id str
The AWS customer account associated with the RDS event notification subscription
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name of the RDS event notification subscription
customerAwsId String
The AWS customer account associated with the RDS event notification subscription
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing EventSubscription Resource

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

public static get(name: string, id: Input<ID>, state?: EventSubscriptionState, opts?: CustomResourceOptions): EventSubscription
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        customer_aws_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        event_categories: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        sns_topic: Optional[str] = None,
        source_ids: Optional[Sequence[str]] = None,
        source_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> EventSubscription
func GetEventSubscription(ctx *Context, name string, id IDInput, state *EventSubscriptionState, opts ...ResourceOption) (*EventSubscription, error)
public static EventSubscription Get(string name, Input<string> id, EventSubscriptionState? state, CustomResourceOptions? opts = null)
public static EventSubscription get(String name, Output<String> id, EventSubscriptionState state, CustomResourceOptions options)
resources:  _:    type: aws:rds:EventSubscription    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
The Amazon Resource Name of the RDS event notification subscription
CustomerAwsId string
The AWS customer account associated with the RDS event notification subscription
Enabled bool
A boolean flag to enable/disable the subscription. Defaults to true.
EventCategories List<string>
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
Name Changes to this property will trigger replacement. string
The name of the DB event subscription. By default generated by this provider.
NamePrefix Changes to this property will trigger replacement. string
The name of the DB event subscription. Conflicts with name.
SnsTopic string
The SNS topic to send events to.
SourceIds 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 string
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
Tags Dictionary<string, string>
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 Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The Amazon Resource Name of the RDS event notification subscription
CustomerAwsId string
The AWS customer account associated with the RDS event notification subscription
Enabled bool
A boolean flag to enable/disable the subscription. Defaults to true.
EventCategories []string
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
Name Changes to this property will trigger replacement. string
The name of the DB event subscription. By default generated by this provider.
NamePrefix Changes to this property will trigger replacement. string
The name of the DB event subscription. Conflicts with name.
SnsTopic string
The SNS topic to send events to.
SourceIds []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 string
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
Tags map[string]string
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 map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name of the RDS event notification subscription
customerAwsId String
The AWS customer account associated with the RDS event notification subscription
enabled Boolean
A boolean flag to enable/disable the subscription. Defaults to true.
eventCategories List<String>
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
name Changes to this property will trigger replacement. String
The name of the DB event subscription. By default generated by this provider.
namePrefix Changes to this property will trigger replacement. String
The name of the DB event subscription. Conflicts with name.
snsTopic String
The SNS topic to send events to.
sourceIds 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 String
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
tags Map<String,String>
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 Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The Amazon Resource Name of the RDS event notification subscription
customerAwsId string
The AWS customer account associated with the RDS event notification subscription
enabled boolean
A boolean flag to enable/disable the subscription. Defaults to true.
eventCategories string[]
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
name Changes to this property will trigger replacement. string
The name of the DB event subscription. By default generated by this provider.
namePrefix Changes to this property will trigger replacement. string
The name of the DB event subscription. Conflicts with name.
snsTopic string
The SNS topic to send events to.
sourceIds 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 string
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
tags {[key: string]: string}
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 {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The Amazon Resource Name of the RDS event notification subscription
customer_aws_id str
The AWS customer account associated with the RDS event notification subscription
enabled bool
A boolean flag to enable/disable the subscription. Defaults to true.
event_categories Sequence[str]
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
name Changes to this property will trigger replacement. str
The name of the DB event subscription. By default generated by this provider.
name_prefix Changes to this property will trigger replacement. str
The name of the DB event subscription. Conflicts with name.
sns_topic str
The SNS topic to send events to.
source_ids Sequence[str]
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.
source_type str
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
tags Mapping[str, str]
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.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name of the RDS event notification subscription
customerAwsId String
The AWS customer account associated with the RDS event notification subscription
enabled Boolean
A boolean flag to enable/disable the subscription. Defaults to true.
eventCategories List<String>
A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.
name Changes to this property will trigger replacement. String
The name of the DB event subscription. By default generated by this provider.
namePrefix Changes to this property will trigger replacement. String
The name of the DB event subscription. Conflicts with name.
snsTopic String
The SNS topic to send events to.
sourceIds 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 String
The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster, db-cluster-snapshot, or db-proxy. If not set, all sources will be subscribed to.
tags Map<String>
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 Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Import

Using pulumi import, import DB Event Subscriptions using the name. For example:

$ pulumi import aws:rds/eventSubscription:EventSubscription default rds-event-sub
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.