software.amazon.awscdk.services.redshift

Class CfnEventSubscription

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.redshift.CfnEventSubscription

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.849Z")
public class CfnEventSubscription
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Redshift::EventSubscription`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshift.*;
 CfnEventSubscription cfnEventSubscription = CfnEventSubscription.Builder.create(this, "MyCfnEventSubscription")
         .subscriptionName("subscriptionName")
         // the properties below are optional
         .enabled(false)
         .eventCategories(List.of("eventCategories"))
         .severity("severity")
         .snsTopicArn("snsTopicArn")
         .sourceIds(List.of("sourceIds"))
         .sourceType("sourceType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEventSubscription.Builder A fluent builder for CfnEventSubscription.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEventSubscription(Construct scope, java.lang.String id, CfnEventSubscriptionProps props) Create a new `AWS::Redshift::EventSubscription`.
protected	CfnEventSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEventSubscription(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrCustomerAwsId() The AWS account associated with the Amazon Redshift event notification subscription.
java.lang.String	getAttrCustSubscriptionId() The name of the Amazon Redshift event notification subscription.
java.util.List<java.lang.String>	getAttrEventCategoriesList() The list of Amazon Redshift event categories specified in the event notification subscription.
java.util.List<java.lang.String>	getAttrSourceIdsList() A list of the sources that publish events to the Amazon Redshift event notification subscription.
java.lang.String	getAttrStatus() The status of the Amazon Redshift event notification subscription.
java.lang.String	getAttrSubscriptionCreationTime() The date and time the Amazon Redshift event notification subscription was created.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getEnabled() A boolean value;
java.util.List<java.lang.String>	getEventCategories() Specifies the Amazon Redshift event categories to be published by the event notification subscription.
java.lang.String	getSeverity() Specifies the Amazon Redshift event severity to be published by the event notification subscription.
java.lang.String	getSnsTopicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
java.util.List<java.lang.String>	getSourceIds() A list of one or more identifiers of Amazon Redshift source objects.
java.lang.String	getSourceType() The type of source that will be generating the events.
java.lang.String	getSubscriptionName() The name of the event subscription to be created.
TagManager	getTags() A list of tag instances.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setEnabled(java.lang.Boolean value) A boolean value;
void	setEnabled(IResolvable value) A boolean value;
void	setEventCategories(java.util.List<java.lang.String> value) Specifies the Amazon Redshift event categories to be published by the event notification subscription.
void	setSeverity(java.lang.String value) Specifies the Amazon Redshift event severity to be published by the event notification subscription.
void	setSnsTopicArn(java.lang.String value) The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
void	setSourceIds(java.util.List<java.lang.String> value) A list of one or more identifiers of Amazon Redshift source objects.
void	setSourceType(java.lang.String value) The type of source that will be generating the events.
void	setSubscriptionName(java.lang.String value) The name of the event subscription to be created.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEventSubscription

protected CfnEventSubscription(software.amazon.jsii.JsiiObjectRef objRef)

CfnEventSubscription

protected CfnEventSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEventSubscription

public CfnEventSubscription(Construct scope,
                            java.lang.String id,
                            CfnEventSubscriptionProps props)

Create a new `AWS::Redshift::EventSubscription`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCustomerAwsId

public java.lang.String getAttrCustomerAwsId()

The AWS account associated with the Amazon Redshift event notification subscription.

getAttrCustSubscriptionId

public java.lang.String getAttrCustSubscriptionId()

The name of the Amazon Redshift event notification subscription.

getAttrEventCategoriesList

public java.util.List<java.lang.String> getAttrEventCategoriesList()

The list of Amazon Redshift event categories specified in the event notification subscription.

Values: Configuration, Management, Monitoring, Security, Pending

getAttrSourceIdsList

public java.util.List<java.lang.String> getAttrSourceIdsList()

A list of the sources that publish events to the Amazon Redshift event notification subscription.

getAttrStatus

public java.lang.String getAttrStatus()

The status of the Amazon Redshift event notification subscription.

Constraints:

• Can be one of the following: active | no-permission | topic-not-exist
• The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

getAttrSubscriptionCreationTime

public java.lang.String getAttrSubscriptionCreationTime()

The date and time the Amazon Redshift event notification subscription was created.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

A list of tag instances.

getSubscriptionName

public java.lang.String getSubscriptionName()

The name of the event subscription to be created.

Constraints:

• Cannot be null, empty, or blank.
• Must contain from 1 to 255 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

setSubscriptionName

public void setSubscriptionName(java.lang.String value)

The name of the event subscription to be created.

Constraints:

• Cannot be null, empty, or blank.
• Must contain from 1 to 255 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

getEnabled

public java.lang.Object getEnabled()

A boolean value;

set to true to activate the subscription, and set to false to create the subscription but not activate it.

setEnabled

public void setEnabled(java.lang.Boolean value)

A boolean value;

set to true to activate the subscription, and set to false to create the subscription but not activate it.

setEnabled

public void setEnabled(IResolvable value)

A boolean value;

set to true to activate the subscription, and set to false to create the subscription but not activate it.

getEventCategories

public java.util.List<java.lang.String> getEventCategories()

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

setEventCategories

public void setEventCategories(java.util.List<java.lang.String> value)

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

getSeverity

public java.lang.String getSeverity()

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

setSeverity

public void setSeverity(java.lang.String value)

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

getSnsTopicArn

public java.lang.String getSnsTopicArn()

The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.

The ARN is created by Amazon SNS when you create a topic and subscribe to it.

setSnsTopicArn

public void setSnsTopicArn(java.lang.String value)

The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.

The ARN is created by Amazon SNS when you create a topic and subscribe to it.

getSourceIds

public java.util.List<java.lang.String> getSourceIds()

A list of one or more identifiers of Amazon Redshift source objects.

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

setSourceIds

public void setSourceIds(java.util.List<java.lang.String> value)

A list of one or more identifiers of Amazon Redshift source objects.

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

getSourceType

public java.lang.String getSourceType()

The type of source that will be generating the events.

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.

setSourceType

public void setSourceType(java.lang.String value)

The type of source that will be generating the events.

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.