software.amazon.awscdk.services.redshift

Class CfnEventSubscription

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.redshift.CfnEventSubscription

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.540Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEventSubscription(software.constructs.Construct scope, 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
String	getAttrCustomerAwsId() The AWS account associated with the Amazon Redshift event notification subscription.
String	getAttrCustSubscriptionId() The name of the Amazon Redshift event notification subscription.
List<String>	getAttrEventCategoriesList() The list of Amazon Redshift event categories specified in the event notification subscription.
List<String>	getAttrSourceIdsList() A list of the sources that publish events to the Amazon Redshift event notification subscription.
String	getAttrStatus() The status of the Amazon Redshift event notification subscription.
String	getAttrSubscriptionCreationTime() The date and time the Amazon Redshift event notification subscription was created.
protected Map<String,Object>	getCfnProperties()
Object	getEnabled() A boolean value;
List<String>	getEventCategories() Specifies the Amazon Redshift event categories to be published by the event notification subscription.
String	getSeverity() Specifies the Amazon Redshift event severity to be published by the event notification subscription.
String	getSnsTopicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
List<String>	getSourceIds() A list of one or more identifiers of Amazon Redshift source objects.
String	getSourceType() The type of source that will be generating the events.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEnabled(Boolean value) A boolean value;
void	setEnabled(IResolvable value) A boolean value;
void	setEventCategories(List<String> value) Specifies the Amazon Redshift event categories to be published by the event notification subscription.
void	setSeverity(String value) Specifies the Amazon Redshift event severity to be published by the event notification subscription.
void	setSnsTopicArn(String value) The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
void	setSourceIds(List<String> value) A list of one or more identifiers of Amazon Redshift source objects.
void	setSourceType(String value) The type of source that will be generating the events.
void	setSubscriptionName(String value) The name of the event subscription to be created.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnEventSubscription(@NotNull
                                                     software.constructs.Construct scope,
                                                     @NotNull
                                                     String id,
                                                     @NotNull
                                                     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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCustomerAwsId

@Stability(value=Stable)
 @NotNull
public String getAttrCustomerAwsId()

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

getAttrCustSubscriptionId

@Stability(value=Stable)
 @NotNull
public String getAttrCustSubscriptionId()

The name of the Amazon Redshift event notification subscription.

getAttrEventCategoriesList

@Stability(value=Stable)
 @NotNull
public List<String> getAttrEventCategoriesList()

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

Values: Configuration, Management, Monitoring, Security, Pending

getAttrSourceIdsList

@Stability(value=Stable)
 @NotNull
public List<String> getAttrSourceIdsList()

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

getAttrStatus

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public String getAttrSubscriptionCreationTime()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

A list of tag instances.

getSubscriptionName

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setSubscriptionName(@NotNull
                                                         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

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                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

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                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

@Stability(value=Stable)
 @Nullable
public List<String> getEventCategories()

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

Values: configuration, management, monitoring, security, pending

setEventCategories

@Stability(value=Stable)
public void setEventCategories(@Nullable
                                                        List<String> value)

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

Values: configuration, management, monitoring, security, pending

getSeverity

@Stability(value=Stable)
 @Nullable
public String getSeverity()

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

Values: ERROR, INFO

setSeverity

@Stability(value=Stable)
public void setSeverity(@Nullable
                                                 String value)

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

Values: ERROR, INFO

getSnsTopicArn

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setSnsTopicArn(@Nullable
                                                    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

@Stability(value=Stable)
 @Nullable
public List<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

@Stability(value=Stable)
public void setSourceIds(@Nullable
                                                  List<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

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setSourceType(@Nullable
                                                   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.