Class CfnEventSubscription
A CloudFormation AWS::Redshift::EventSubscription
.
Inherited Members
Namespace: Amazon.CDK.AWS.Redshift
Assembly: Amazon.CDK.AWS.Redshift.dll
Syntax (csharp)
public class CfnEventSubscription : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEventSubscription
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
CloudformationResource: AWS::Redshift::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.Redshift;
var cfnEventSubscription = new CfnEventSubscription(this, "MyCfnEventSubscription", new CfnEventSubscriptionProps {
SubscriptionName = "subscriptionName",
// the properties below are optional
Enabled = false,
EventCategories = new [] { "eventCategories" },
Severity = "severity",
SnsTopicArn = "snsTopicArn",
SourceIds = new [] { "sourceIds" },
SourceType = "sourceType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnEventSubscription(Construct, String, ICfnEventSubscriptionProps) | Create a new |
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 |
Properties
AttrCustomerAwsId | The AWS account associated with the Amazon Redshift event notification subscription. |
AttrCustSubscriptionId | The name of the Amazon Redshift event notification subscription. |
AttrEventCategoriesList | The list of Amazon Redshift event categories specified in the event notification subscription. |
AttrSourceIdsList | A list of the sources that publish events to the Amazon Redshift event notification subscription. |
AttrStatus | The status of the Amazon Redshift event notification subscription. |
AttrSubscriptionCreationTime | The date and time the Amazon Redshift event notification subscription was created. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Enabled | A boolean value; |
EventCategories | Specifies the Amazon Redshift event categories to be published by the event notification subscription. |
Severity | Specifies the Amazon Redshift event severity to be published by the event notification subscription. |
SnsTopicArn | The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. |
SourceIds | A list of one or more identifiers of Amazon Redshift source objects. |
SourceType | The type of source that will be generating the events. |
SubscriptionName | The name of the event subscription to be created. |
Tags | A list of tag instances. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEventSubscription(Construct, String, ICfnEventSubscriptionProps)
Create a new AWS::Redshift::EventSubscription
.
public CfnEventSubscription(Construct scope, string id, ICfnEventSubscriptionProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEventSubscriptionProps
- resource properties.
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
Properties
AttrCustomerAwsId
The AWS account associated with the Amazon Redshift event notification subscription.
public virtual string AttrCustomerAwsId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CustomerAwsId
AttrCustSubscriptionId
The name of the Amazon Redshift event notification subscription.
public virtual string AttrCustSubscriptionId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CustSubscriptionId
AttrEventCategoriesList
The list of Amazon Redshift event categories specified in the event notification subscription.
public virtual string[] AttrEventCategoriesList { get; }
Property Value
System.String[]
Remarks
Values: Configuration, Management, Monitoring, Security, Pending
CloudformationAttribute: EventCategoriesList
AttrSourceIdsList
A list of the sources that publish events to the Amazon Redshift event notification subscription.
public virtual string[] AttrSourceIdsList { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: SourceIdsList
AttrStatus
The status of the Amazon Redshift event notification subscription.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
Constraints:
CloudformationAttribute: Status
AttrSubscriptionCreationTime
The date and time the Amazon Redshift event notification subscription was created.
public virtual string AttrSubscriptionCreationTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SubscriptionCreationTime
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;
public virtual object Enabled { get; set; }
Property Value
System.Object
Remarks
set to true
to activate the subscription, and set to false
to create the subscription but not activate it.
EventCategories
Specifies the Amazon Redshift event categories to be published by the event notification subscription.
public virtual string[] EventCategories { get; set; }
Property Value
System.String[]
Remarks
Values: configuration, management, monitoring, security, pending
Severity
Specifies the Amazon Redshift event severity to be published by the event notification subscription.
public virtual string Severity { get; set; }
Property Value
System.String
Remarks
SnsTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
public virtual string SnsTopicArn { get; set; }
Property Value
System.String
Remarks
The ARN is created by Amazon SNS when you create a topic and subscribe to it.
SourceIds
A list of one or more identifiers of Amazon Redshift source objects.
public virtual string[] SourceIds { get; set; }
Property Value
System.String[]
Remarks
All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
SourceType
The type of source that will be generating the events.
public virtual string SourceType { get; set; }
Property Value
System.String
Remarks
For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account . You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
SubscriptionName
The name of the event subscription to be created.
public virtual string SubscriptionName { get; set; }
Property Value
System.String
Remarks
Tags
A list of tag instances.
public virtual TagManager Tags { get; }
Property Value
Remarks
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>