Class EventSubscription

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var defaultCluster = new Aws.Neptune.Cluster("defaultCluster", new Aws.Neptune.ClusterArgs
    {
        ApplyImmediately = "true",
        BackupRetentionPeriod = 5,
        ClusterIdentifier = "neptune-cluster-demo",
        Engine = "neptune",
        IamDatabaseAuthenticationEnabled = "true",
        PreferredBackupWindow = "07:00-09:00",
        SkipFinalSnapshot = true,
    });
    var example = new Aws.Neptune.ClusterInstance("example", new Aws.Neptune.ClusterInstanceArgs
    {
        ApplyImmediately = "true",
        ClusterIdentifier = defaultCluster.Id,
        Engine = "neptune",
        InstanceClass = "db.r4.large",
    });
    var defaultTopic = new Aws.Sns.Topic("defaultTopic", new Aws.Sns.TopicArgs
    {
    });
    var defaultEventSubscription = new Aws.Neptune.EventSubscription("defaultEventSubscription", new Aws.Neptune.EventSubscriptionArgs
    {
        EventCategories = 
        {
            "maintenance",
            "availability",
            "creation",
            "backup",
            "restoration",
            "recovery",
            "deletion",
            "failover",
            "failure",
            "notification",
            "configuration change",
            "read replica",
        },
        SnsTopicArn = defaultTopic.Arn,
        SourceIds = 
        {
            example.Id,
        },
        SourceType = "db-instance",
        Tags = 
        {
            { "env", "test" },
        },
    });
}

}

Attributes

The following additional atttributes are provided:

• id - The name of the Neptune event notification subscription.
• arn - The Amazon Resource Name of the Neptune event notification subscription.
• customer_aws_id - The AWS customer account associated with the Neptune event notification subscription.

Inheritance

System.Object

Resource

CustomResource

EventSubscription

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Neptune

Assembly: Pulumi.Aws.dll

Syntax

public class EventSubscription : CustomResource

Constructors

EventSubscription(String, EventSubscriptionArgs, CustomResourceOptions)

Create a EventSubscription resource with the given unique name, arguments, and options.

Declaration

public EventSubscription(string name, EventSubscriptionArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EventSubscriptionArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

CustomerAwsId

Declaration

public Output<string> CustomerAwsId { get; }

Property Value

Type	Description
Output<System.String>

Enabled

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

Declaration

public Output<bool?> Enabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

EventCategories

A list of event categories for a source_type that you want to subscribe to. Run aws neptune describe-event-categories to find all the event categories.

Declaration

public Output<ImmutableArray<string>> EventCategories { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NamePrefix

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

Declaration

public Output<string> NamePrefix { get; }

Property Value

Type	Description
Output<System.String>

SnsTopicArn

The ARN of the SNS topic to send events to.

Declaration

public Output<string> SnsTopicArn { get; }

Property Value

Type	Description
Output<System.String>

SourceIds

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.

Declaration

public Output<ImmutableArray<string>> SourceIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

SourceType

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.

Declaration

public Output<string> SourceType { get; }

Property Value

Type	Description
Output<System.String>

Tags

A map of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, EventSubscriptionState, CustomResourceOptions)

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

Declaration

public static EventSubscription Get(string name, Input<string> id, EventSubscriptionState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EventSubscriptionState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
EventSubscription