pulumi-aws-kotlin/com.pulumi.aws.rds.kotlin/EventSubscription

EventSubscription

class EventSubscription : KotlinCustomResource

Provides a DB 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.rds.Instance;
import com.pulumi.aws.rds.InstanceArgs;
import com.pulumi.aws.sns.Topic;
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 defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
            .allocatedStorage(10)
            .engine("mysql")
            .engineVersion("5.6.17")
            .instanceClass("db.t2.micro")
            .name("mydb")
            .username("foo")
            .password("bar")
            .dbSubnetGroupName("my_database_subnet_group")
            .parameterGroupName("default.mysql5.6")
            .build());
        var defaultTopic = new Topic("defaultTopic");
        var defaultEventSubscription = new EventSubscription("defaultEventSubscription", EventSubscriptionArgs.builder()
            .snsTopic(defaultTopic.arn())
            .sourceType("db-instance")
            .sourceIds(defaultInstance.id())
            .eventCategories(
                "availability",
                "deletion",
                "failover",
                "failure",
                "low storage",
                "maintenance",
                "notification",
                "read replica",
                "recovery",
                "restoration")
            .build());
    }
}

Import

DB Event Subscriptions can be imported using the name, e.g.,

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

Properties

arn

val arn: Output<String>

The Amazon Resource Name of the RDS event notification subscription

customerAwsId

val customerAwsId: Output<String>

The AWS customer account associated with the RDS event notification subscription

enabled

val enabled: Output<Boolean>?

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

eventCategories

val eventCategories: Output<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.

val id: Output<String>

name

val name: Output<String>

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

namePrefix

val namePrefix: Output<String>

The name of the DB event subscription. Conflicts with name.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

snsTopic

val snsTopic: Output<String>

The SNS topic to send events to.

sourceIds

val sourceIds: Output<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

val sourceType: Output<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 or db-cluster-snapshot. If not set, all sources will be subscribed to.