/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.databasemigrationservice.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateEventSubscriptionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** ** The name of the DMS event notification subscription. This name must be less than 255 characters. *
*/ private String subscriptionName; /** ** 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. *
*/ private String snsTopicArn; /** *
* 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
*
* 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. *
*/ private java.util.List* 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. *
*/ private java.util.List
* A Boolean value; set to true
to activate the subscription, or set to false
to create
* the subscription but not activate it.
*
* One or more tags to be assigned to the event subscription. *
*/ private java.util.List* The name of the DMS event notification subscription. This name must be less than 255 characters. *
* * @param subscriptionName * The name of the DMS event notification subscription. This name must be less than 255 characters. */ public void setSubscriptionName(String subscriptionName) { this.subscriptionName = subscriptionName; } /** ** The name of the DMS event notification subscription. This name must be less than 255 characters. *
* * @return The name of the DMS event notification subscription. This name must be less than 255 characters. */ public String getSubscriptionName() { return this.subscriptionName; } /** ** The name of the DMS event notification subscription. This name must be less than 255 characters. *
* * @param subscriptionName * The name of the DMS event notification subscription. This name must be less than 255 characters. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateEventSubscriptionRequest withSubscriptionName(String subscriptionName) { setSubscriptionName(subscriptionName); return this; } /** ** 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. *
* * @param 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. */ public void setSnsTopicArn(String snsTopicArn) { this.snsTopicArn = 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. *
* * @return 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. */ public String getSnsTopicArn() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateEventSubscriptionRequest withSnsTopicArn(String snsTopicArn) { setSnsTopicArn(snsTopicArn); return this; } /** *
* 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
*
replication-instance
. If this
* value isn't specified, all events are returned.
*
* Valid values: replication-instance
| replication-task
*/
public void setSourceType(String sourceType) {
this.sourceType = 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
*
replication-instance
. If this
* value isn't specified, all events are returned.
*
* Valid values: replication-instance
| replication-task
*/
public String getSourceType() {
return this.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
*
replication-instance
. If this
* value isn't specified, all events are returned.
*
* Valid values: replication-instance
| replication-task
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventSubscriptionRequest withSourceType(String sourceType) {
setSourceType(sourceType);
return this;
}
/**
*
* 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. *
* * @return 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. */ public java.util.List* 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. *
* * @param 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. */ public void setEventCategories(java.util.Collection* 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. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setEventCategories(java.util.Collection)} or {@link #withEventCategories(java.util.Collection)} if you * want to override the existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateEventSubscriptionRequest withEventCategories(String... eventCategories) { if (this.eventCategories == null) { setEventCategories(new java.util.ArrayList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateEventSubscriptionRequest withEventCategories(java.util.Collection* 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. *
* * @return 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.
*/
public java.util.List
* 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.
*
* 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.
*/
public void setSourceIds(java.util.Collection
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSourceIds(java.util.Collection)} or {@link #withSourceIds(java.util.Collection)} if you want to
* override the existing values.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventSubscriptionRequest withSourceIds(String... sourceIds) {
if (this.sourceIds == null) {
setSourceIds(new java.util.ArrayList
* 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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventSubscriptionRequest withSourceIds(java.util.Collection
* A Boolean value; set to
* A Boolean value; set to
* A Boolean value; set to
* A Boolean value; set to
* One or more tags to be assigned to the event subscription.
*
* One or more tags to be assigned to the event subscription.
*
* One or more tags to be assigned to the event subscription.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
* One or more tags to be assigned to the event subscription.
* true
to activate the subscription, or set to false
to create
* the subscription but not activate it.
* true
to activate the subscription, or set to false
to
* create the subscription but not activate it.
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
/**
* true
to activate the subscription, or set to false
to create
* the subscription but not activate it.
* true
to activate the subscription, or set to false
to
* create the subscription but not activate it.
*/
public Boolean getEnabled() {
return this.enabled;
}
/**
* true
to activate the subscription, or set to false
to create
* the subscription but not activate it.
* true
to activate the subscription, or set to false
to
* create the subscription but not activate it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventSubscriptionRequest withEnabled(Boolean enabled) {
setEnabled(enabled);
return this;
}
/**
* true
to activate the subscription, or set to false
to create
* the subscription but not activate it.
* true
to activate the subscription, or set to false
to
* create the subscription but not activate it.
*/
public Boolean isEnabled() {
return this.enabled;
}
/**
*