software.amazon.awssdk.services.redshift.model

Class CreateEventSubscriptionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshift.model.RedshiftRequest

software.amazon.awssdk.services.redshift.model.CreateEventSubscriptionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateEventSubscriptionRequest
extends RedshiftRequest
implements ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateEventSubscriptionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateEventSubscriptionRequest.Builder	builder()
Boolean	enabled() A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	eventCategories() Specifies the Amazon Redshift event categories to be published by the event notification subscription.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEventSubscriptionRequest.Builder>	serializableBuilderClass()
String	severity() Specifies the Amazon Redshift event severity to be published by the event notification subscription.
String	snsTopicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
List<String>	sourceIds() A list of one or more identifiers of Amazon Redshift source objects.
String	sourceType() The type of source that will be generating the events.
String	subscriptionName() The name of the event subscription to be created.
List<Tag>	tags() A list of tag instances.
CreateEventSubscriptionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

subscriptionName

public 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.

Returns:

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.

snsTopicArn

public 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.

Returns:

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.

sourceType

public 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, and cluster-snapshot.

Returns:

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, and cluster-snapshot.

sourceIds

public 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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

eventCategories

public List<String> eventCategories()

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

Values: configuration, management, monitoring, security

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

Values: configuration, management, monitoring, security

severity

public String severity()

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

Values: ERROR, INFO

Returns:

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

Values: ERROR, INFO

enabled

public Boolean enabled()

A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

Returns:

A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

tags

public List<Tag> tags()

A list of tag instances.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of tag instances.

toBuilder

public CreateEventSubscriptionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

Specified by:

toBuilder in class RedshiftRequest

builder

public static CreateEventSubscriptionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateEventSubscriptionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo