Class CfnEventSubscription

Creates an event notification subscription.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnEventSubscription
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Neptune
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEventSubscription : CfnResource, IInspectable
Syntax (vb)
Public Class CfnEventSubscription
    Inherits CfnResource
    Implements IInspectable
Remarks

This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-eventsubscription.html

CloudformationResource: AWS::Neptune::EventSubscription

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Neptune;

var cfnEventSubscription = new CfnEventSubscription(this, "MyCfnEventSubscription", new CfnEventSubscriptionProps {
    Enabled = false,
    EventCategories = new [] { "eventCategories" },
    SnsTopicArn = "snsTopicArn",
    SourceIds = new [] { "sourceIds" },
    SourceType = "sourceType"
});

Synopsis

Constructors

CfnEventSubscription(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnEventSubscription(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnEventSubscription(Construct, String, ICfnEventSubscriptionProps)

Properties

AttrId
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
Enabled

A Boolean value indicating if the subscription is enabled.
EventCategories
SnsTopicArn

The topic ARN of the event notification subscription.
SourceIds
SourceType

The source type for the event notification subscription.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnEventSubscription(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnEventSubscription(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnEventSubscription(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnEventSubscription(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnEventSubscription(Construct, String, ICfnEventSubscriptionProps)

public CfnEventSubscription(Construct scope, string id, ICfnEventSubscriptionProps props = null)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnEventSubscriptionProps

Resource properties.

Properties

AttrId

public virtual string AttrId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Enabled

A Boolean value indicating if the subscription is enabled.

public virtual object Enabled { get; set; }
Property Value

System.Object

EventCategories

public virtual string[] EventCategories { get; set; }
Property Value

System.String[]

SnsTopicArn

The topic ARN of the event notification subscription.

public virtual string SnsTopicArn { get; set; }
Property Value

System.String

SourceIds

public virtual string[] SourceIds { get; set; }
Property Value

System.String[]

SourceType

The source type for the event notification subscription.

public virtual string SourceType { get; set; }
Property Value

System.String

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements