Package software.amazon.awssdk.services.databasemigration.model

Class CreateEventSubscriptionRequest

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("software.amazon.awssdk:codegen") public final class CreateEventSubscriptionRequest extends DatabaseMigrationRequest implements ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

  • Method Details

    • subscriptionName

      public final String subscriptionName()

      The name of the DMS event notification subscription. This name must be less than 255 characters.

      Returns:
      The name of the DMS event notification subscription. This name must be less than 255 characters.

    • snsTopicArn

      public final 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 final String sourceType()

      The type of 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 isn't specified, all events are returned.

      Valid values: replication-instance | replication-task

      Returns:
      The type of 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 isn't specified, all events are returned.

      Valid values: replication-instance | replication-task

    • hasEventCategories

      public final boolean hasEventCategories()
      For responses, this returns true if the service returned a value for the EventCategories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • eventCategories

      public final 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 Database Migration Service User Guide.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEventCategories() method.

      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 Database Migration Service User Guide.

    • hasSourceIds

      public final boolean hasSourceIds()
      For responses, this returns true if the service returned a value for the SourceIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • sourceIds

      public final List<String> sourceIds()

      A list of identifiers for which 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSourceIds() method.

      Returns:
      A list of identifiers for which 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 final 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 final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo