EventSubscription class
Provides a Redshift event subscription resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.redshift.Cluster("default", {
clusterIdentifier: "default",
databaseName: "default",
});
const defaultTopic = new aws.sns.Topic("default", {name: "redshift-events"});
const defaultEventSubscription = new aws.redshift.EventSubscription("default", {
name: "redshift-event-sub",
snsTopicArn: defaultTopic.arn,
sourceType: "cluster",
sourceIds: [_default.id],
severity: "INFO",
eventCategories: [
"configuration",
"management",
"monitoring",
"security",
],
tags: {
Name: "default",
},
});
import pulumi
import pulumi_aws as aws
default = aws.redshift.Cluster("default",
cluster_identifier="default",
database_name="default")
default_topic = aws.sns.Topic("default", name="redshift-events")
default_event_subscription = aws.redshift.EventSubscription("default",
name="redshift-event-sub",
sns_topic_arn=default_topic.arn,
source_type="cluster",
source_ids=[default.id],
severity="INFO",
event_categories=[
"configuration",
"management",
"monitoring",
"security",
],
tags={
"Name": "default",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.RedShift.Cluster("default", new()
{
ClusterIdentifier = "default",
DatabaseName = "default",
});
var defaultTopic = new Aws.Sns.Topic("default", new()
{
Name = "redshift-events",
});
var defaultEventSubscription = new Aws.RedShift.EventSubscription("default", new()
{
Name = "redshift-event-sub",
SnsTopicArn = defaultTopic.Arn,
SourceType = "cluster",
SourceIds = new[]
{
@default.Id,
},
Severity = "INFO",
EventCategories = new[]
{
"configuration",
"management",
"monitoring",
"security",
},
Tags =
{
{ "Name", "default" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/redshift"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_default, err := redshift.NewCluster(ctx, "default", &redshift.ClusterArgs{
ClusterIdentifier: pulumi.String("default"),
DatabaseName: pulumi.String("default"),
})
if err != nil {
return err
}
defaultTopic, err := sns.NewTopic(ctx, "default", &sns.TopicArgs{
Name: pulumi.String("redshift-events"),
})
if err != nil {
return err
}
_, err = redshift.NewEventSubscription(ctx, "default", &redshift.EventSubscriptionArgs{
Name: pulumi.String("redshift-event-sub"),
SnsTopicArn: defaultTopic.Arn,
SourceType: pulumi.String("cluster"),
SourceIds: pulumi.StringArray{
_default.ID().ToIDOutput().ToStringOutput(),
},
Severity: pulumi.String("INFO"),
EventCategories: pulumi.StringArray{
pulumi.String("configuration"),
pulumi.String("management"),
pulumi.String("monitoring"),
pulumi.String("security"),
},
Tags: pulumi.StringMap{
"Name": pulumi.String("default"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_redshift_cluster" "default" {
cluster_identifier = "default"
database_name = "default"
}
resource "aws_sns_topic" "default" {
name = "redshift-events"
}
resource "aws_redshift_eventsubscription" "default" {
name = "redshift-event-sub"
sns_topic_arn = aws_sns_topic.default.arn
source_type = "cluster"
source_ids = [aws_redshift_cluster.default.id]
severity = "INFO"
event_categories = ["configuration", "management", "monitoring", "security"]
tags = {
"Name" = "default"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.Cluster;
import com.pulumi.aws.redshift.ClusterArgs;
import com.pulumi.aws.sns.Topic;
import com.pulumi.aws.sns.TopicArgs;
import com.pulumi.aws.redshift.EventSubscription;
import com.pulumi.aws.redshift.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 default_ = new Cluster("default", ClusterArgs.builder()
.clusterIdentifier("default")
.databaseName("default")
.build());
var defaultTopic = new Topic("defaultTopic", TopicArgs.builder()
.name("redshift-events")
.build());
var defaultEventSubscription = new EventSubscription("defaultEventSubscription", EventSubscriptionArgs.builder()
.name("redshift-event-sub")
.snsTopicArn(defaultTopic.arn())
.sourceType("cluster")
.sourceIds(default_.id())
.severity("INFO")
.eventCategories(
"configuration",
"management",
"monitoring",
"security")
.tags(Map.of("Name", "default"))
.build());
}
}
resources:
default:
type: aws:redshift:Cluster
properties:
clusterIdentifier: default
databaseName: default
defaultTopic:
type: aws:sns:Topic
name: default
properties:
name: redshift-events
defaultEventSubscription:
type: aws:redshift:EventSubscription
name: default
properties:
name: redshift-event-sub
snsTopicArn: ${defaultTopic.arn}
sourceType: cluster
sourceIds:
- ${default.id}
severity: INFO
eventCategories:
- configuration
- management
- monitoring
- security
tags:
Name: default
Import
Using pulumi import, import Redshift Event Subscriptions using the name. For example:
$ pulumi import aws:redshift/eventSubscription:EventSubscription default redshift-event-sub
Constructors
- EventSubscription(String name, {EventSubscriptionArgs? args, CustomResourceOptions? options})
-
Creates a new EventSubscription.
nameThe Pulumi resource name.argsArguments used to configure this EventSubscription. The set of arguments for EventSubscription.optionsResource 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 Redshift event notification subscription
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
customerAwsId
↔ Output<
String> -
The AWS customer account associated with the Redshift event notification subscription
latefinal
-
enabled
↔ Output<
bool?> -
A boolean flag to enable/disable the subscription. Defaults to
true.latefinal -
eventCategories
↔ Output<
List< String> ?> -
A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html or run
aws redshift describe-event-categories.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> -
The name of the Redshift 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
-
severity
↔ Output<
String?> -
The event severity to be published by the notification subscription. Valid options are
INFOorERROR. Default value ofINFO.latefinal -
snsTopicArn
↔ Output<
String> -
The ARN of the SNS topic to send events to.
latefinal
-
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
sourceTypemust also be specified.latefinal -
sourceType
↔ Output<
String?> -
The type of source that will be generating the events. Valid options are
cluster,cluster-parameter-group,cluster-security-group,cluster-snapshot, orscheduled-action. If not set, all sources will be subscribed to.latefinal -
status
↔ Output<
String> -
latefinal
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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
nameandid.