Package software.amazon.awscdk.services.redshift

Class CfnEventSubscription.Builder

java.lang.Object

software.amazon.awscdk.services.redshift.CfnEventSubscription.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEventSubscription>

Enclosing class:

CfnEventSubscription

@Stability(Stable)
public static final class CfnEventSubscription.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEventSubscription>

A fluent builder for CfnEventSubscription.

Method Summary

Modifier and Type	Method	Description
CfnEventSubscription	build()
static CfnEventSubscription.Builder	create(software.constructs.Construct scope, String id)
CfnEventSubscription.Builder	enabled(Boolean enabled)	A boolean value;
CfnEventSubscription.Builder	enabled(IResolvable enabled)	A boolean value;
CfnEventSubscription.Builder	eventCategories(List<String> eventCategories)	Specifies the Amazon Redshift event categories to be published by the event notification subscription.
CfnEventSubscription.Builder	severity(String severity)	Specifies the Amazon Redshift event severity to be published by the event notification subscription.
CfnEventSubscription.Builder	snsTopicArn(String snsTopicArn)	The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
CfnEventSubscription.Builder	sourceIds(List<String> sourceIds)	A list of one or more identifiers of Amazon Redshift source objects.
CfnEventSubscription.Builder	sourceType(String sourceType)	The type of source that will be generating the events.
CfnEventSubscription.Builder	subscriptionName(String subscriptionName)	The name of the event subscription to be created.
CfnEventSubscription.Builder	tags(List<? extends CfnTag> tags)	A list of tag instances.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnEventSubscription.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnEventSubscription.Builder.

subscriptionName

@Stability(Stable)
public CfnEventSubscription.Builder subscriptionName(String subscriptionName)

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.

Parameters:

subscriptionName - The name of the event subscription to be created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-subscriptionname

enabled

@Stability(Stable)
public CfnEventSubscription.Builder enabled(Boolean enabled)

A boolean value;

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

Parameters:

enabled - A boolean value;. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-enabled

enabled

@Stability(Stable)
public CfnEventSubscription.Builder enabled(IResolvable enabled)

A boolean value;

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

Parameters:

enabled - A boolean value;. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-enabled

eventCategories

@Stability(Stable)
public CfnEventSubscription.Builder eventCategories(List<String> eventCategories)

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

Values: configuration, management, monitoring, security, pending

Parameters:

eventCategories - Specifies the Amazon Redshift event categories to be published by the event notification subscription. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-eventcategories

severity

@Stability(Stable)
public CfnEventSubscription.Builder severity(String severity)

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

Values: ERROR, INFO

Parameters:

severity - Specifies the Amazon Redshift event severity to be published by the event notification subscription. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-severity

snsTopicArn

@Stability(Stable)
public CfnEventSubscription.Builder snsTopicArn(String snsTopicArn)

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.

Parameters:

snsTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-snstopicarn

sourceIds

@Stability(Stable)
public CfnEventSubscription.Builder sourceIds(List<String> sourceIds)

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

Parameters:

sourceIds - A list of one or more identifiers of Amazon Redshift source objects. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-sourceids

sourceType

@Stability(Stable)
public CfnEventSubscription.Builder sourceType(String sourceType)

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.

Parameters:

sourceType - The type of source that will be generating the events. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-sourcetype

tags

@Stability(Stable)
public CfnEventSubscription.Builder tags(List<? extends CfnTag> tags)

A list of tag instances.

Parameters:

tags - A list of tag instances. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html#cfn-redshift-eventsubscription-tags

build

@Stability(Stable)
public CfnEventSubscription build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEventSubscription>

Returns:

a newly built instance of CfnEventSubscription.