CreateEventSubscriptionRequest (AWS Java SDK :: Services :: AWS Database Migration Service 2.10.56 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest
    - - software.amazon.awssdk.services.databasemigration.model.CreateEventSubscriptionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateEventSubscriptionRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateEventSubscriptionRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateEventSubscriptionRequest.Builder`	`builder()`
`Boolean`	`enabled()` A Boolean value; set to `true` to activate the subscription, or set to `false` to create the subscription but not activate it.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`eventCategories()` A list of event categories for a source type 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 Amazon SNS topic created for event notification.
`List<String>`	`sourceIds()` A list of identifiers for which AWS DMS provides notification events.
`String`	`sourceType()` The type of AWS DMS resource that generates the events.
`String`	`subscriptionName()` The name of the AWS DMS event notification subscription.
`List<Tag>`	`tags()` One or more 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 String subscriptionName()
```
    The name of the AWS DMS event notification subscription. This name must be less than 255 characters.
    
    Returns:
    
    The name of the AWS DMS event notification subscription. This name must be less than 255 characters.
  - snsTopicArn
```
public String snsTopicArn()
```
    The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. 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 created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
  - sourceType
```
public String sourceType()
```
    The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value is not specified, all events are returned.
    
    Valid values: replication-instance | replication-task
    
    Returns:
    
    The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value is not specified, all events are returned.
    
    Valid values: replication-instance | replication-task
  - hasEventCategories
```
public 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 List<String> eventCategories()
```
    A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the AWS Database Migration Service User Guide.
    
    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 source type that you want to subscribe to. For more information, see Working with Events and Notifications in the AWS Database Migration Service User Guide.
  - hasSourceIds
```
public 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 List<String> sourceIds()
```
    A list of identifiers for which AWS DMS provides notification events.
    
    If you don't specify a value, notifications are provided for all sources.
    
    If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
    
    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:
    
    A list of identifiers for which AWS DMS provides notification events.
    
    If you don't specify a value, notifications are provided for all sources.
    
    If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
  - enabled
```
public Boolean enabled()
```
    A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.
    
    Returns:
    
    A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.
  - hasTags
```
public 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 List<Tag> tags()
```
    One or more 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:
    
    One or more 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 DatabaseMigrationRequest
  - 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

Class CreateEventSubscriptionRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

subscriptionName

snsTopicArn

sourceType

hasEventCategories

eventCategories

hasSourceIds

sourceIds

enabled

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields