software.amazon.awscdk.services.rds

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.rds.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.425Z")
 @Stability(value=Stable)
public class CfnEventSubscription
extends CfnResource
implements IInspectable

A CloudFormation `AWS::RDS::EventSubscription`.

The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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.rds.*;
 CfnEventSubscription cfnEventSubscription = CfnEventSubscription.Builder.create(this, "MyCfnEventSubscription")
         .snsTopicArn("snsTopicArn")
         // the properties below are optional
         .enabled(false)
         .eventCategories(List.of("eventCategories"))
         .sourceIds(List.of("sourceIds"))
         .sourceType("sourceType")
         .subscriptionName("subscriptionName")
         .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::RDS::EventSubscription`.
protected	CfnEventSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEventSubscription(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getEnabled() A value that indicates whether to activate the subscription.
List<String>	getEventCategories() A list of event categories for a particular source type ( `SourceType` ) that you want to subscribe to.
String	getSnsTopicArn() The Amazon Resource Name (ARN) of the SNS topic created for event notification.
List<String>	getSourceIds() The list of identifiers of the event sources for which events are returned.
String	getSourceType() The type of source that is generating the events.
String	getSubscriptionName() `AWS::RDS::EventSubscription.SubscriptionName`.
TagManager	getTags() `AWS::RDS::EventSubscription.Tags`.
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 value that indicates whether to activate the subscription.
void	setEnabled(IResolvable value) A value that indicates whether to activate the subscription.
void	setEventCategories(List<String> value) A list of event categories for a particular source type ( `SourceType` ) that you want to subscribe to.
void	setSnsTopicArn(String value) The Amazon Resource Name (ARN) of the SNS topic created for event notification.
void	setSourceIds(List<String> value) The list of identifiers of the event sources for which events are returned.
void	setSourceType(String value) The type of source that is generating the events.
void	setSubscriptionName(String value) `AWS::RDS::EventSubscription.SubscriptionName`.

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::RDS::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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

`AWS::RDS::EventSubscription.Tags`.

getSnsTopicArn

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

The Amazon Resource Name (ARN) of the SNS topic created for event notification.

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

setSnsTopicArn

@Stability(value=Stable)
public void setSnsTopicArn(@NotNull
                                                    String value)

The Amazon Resource Name (ARN) of the SNS topic created for event notification.

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

getEnabled

@Stability(value=Stable)
 @Nullable
public Object getEnabled()

A value that indicates whether to activate the subscription.

If the event notification subscription isn't activated, the subscription is created but not active.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                Boolean value)

A value that indicates whether to activate the subscription.

If the event notification subscription isn't activated, the subscription is created but not active.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                IResolvable value)

A value that indicates whether to activate the subscription.

If the event notification subscription isn't activated, the subscription is created but not active.

getEventCategories

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

A list of event categories for a particular source type ( `SourceType` ) that you want to subscribe to.

You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

setEventCategories

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

A list of event categories for a particular source type ( `SourceType` ) that you want to subscribe to.

You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

getSourceIds

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

The list of identifiers of the event sources for which events are returned.

If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

• If a SourceIds value is supplied, SourceType must also be provided.
• If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
• If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
• If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
• If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
• If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
• If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

setSourceIds

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

The list of identifiers of the event sources for which events are returned.

If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.

Constraints:

• If a SourceIds value is supplied, SourceType must also be provided.
• If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
• If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
• If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
• If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
• If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
• If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

getSourceType

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

The type of source that is generating the events.

For example, if you want to be notified of events generated by a DB instance, set this parameter to db-instance . If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

setSourceType

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

The type of source that is generating the events.

For example, if you want to be notified of events generated by a DB instance, set this parameter to db-instance . If this value isn't specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

getSubscriptionName

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

`AWS::RDS::EventSubscription.SubscriptionName`.

setSubscriptionName

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

`AWS::RDS::EventSubscription.SubscriptionName`.