software.amazon.awssdk.services.docdb.model

Class CreateEventSubscriptionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.docdb.model.DocDbRequest

software.amazon.awssdk.services.docdb.model.CreateEventSubscriptionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

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

Represents the input to CreateEventSubscription.

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, set to false to create the subscription but not active it.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	eventCategories() A list of event categories for a SourceType that you want to subscribe to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEventCategories() Returns true if the EventCategories property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasSourceIds() Returns true if the SourceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEventSubscriptionRequest.Builder>	serializableBuilderClass()
String	snsTopicArn() The Amazon Resource Name (ARN) of the SNS topic created for event notification.
List<String>	sourceIds() The list of identifiers of the event sources for which events are returned.
String	sourceType() The type of source that is generating the events.
String	subscriptionName() The name of the subscription.
List<Tag>	tags() The tags to be assigned to the event subscription.
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 final String subscriptionName()

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

Returns:

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

snsTopicArn

public final String snsTopicArn()

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

Returns:

The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.

sourceType

public final String sourceType()

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

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

Returns:

The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance. If this value is not specified, all events are returned.

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

hasEventCategories

public final boolean hasEventCategories()

Returns true if the EventCategories property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

eventCategories

public final List<String> eventCategories()

A list of event categories for a SourceType that you want to subscribe to.

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

You can use hasEventCategories() to see if a value was sent in this field.

Returns:

A list of event categories for a SourceType that you want to subscribe to.

hasSourceIds

public final boolean hasSourceIds()

Returns true if the SourceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

sourceIds

public final List<String> sourceIds()

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 SourceIds are provided, SourceType must also be provided.

• If the source type is an instance, a DBInstanceIdentifier must be provided.

• If the source type is a security group, a DBSecurityGroupName must be provided.

• If the source type is a parameter group, a DBParameterGroupName must be provided.

• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

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

You can use hasSourceIds() to see if a value was sent in this field.

Returns:

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 SourceIds are provided, SourceType must also be provided.

• If the source type is an instance, a DBInstanceIdentifier must be provided.

• If the source type is a security group, a DBSecurityGroupName must be provided.

• If the source type is a parameter group, a DBParameterGroupName must be provided.

• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

enabled

public final Boolean enabled()

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

Returns:

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

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

The tags to be assigned to the event subscription.

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

You can use hasTags() to see if a value was sent in this field.

Returns:

The tags to be assigned to the event subscription.

toBuilder

public CreateEventSubscriptionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

Specified by:

toBuilder in class DocDbRequest

builder

public static CreateEventSubscriptionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo