com.amazonaws.services.rds.model.CreateEventSubscriptionRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2014 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.rds.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.rds.AmazonRDS#createEventSubscription(CreateEventSubscriptionRequest) CreateEventSubscription operation}.
*
* Creates an RDS event notification subscription. This action requires a
* topic ARN (Amazon Resource Name) created by either the RDS console,
* the SNS console, or the SNS API. To obtain an ARN with SNS, you must
* create a topic in Amazon SNS and subscribe to the topic. The ARN is
* displayed in the SNS console.
*
*
* You can specify the type of source (SourceType) you want to be
* notified of, provide a list of RDS sources (SourceIds) that triggers
* the events, and provide a list of event categories (EventCategories)
* for events you want to be notified of. For example, you can specify
* SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and
* EventCategories = Availability, Backup.
*
*
* If you specify both the SourceType and SourceIds, such as SourceType =
* db-instance and SourceIdentifier = myDBInstance1, you will be notified
* of all the db-instance events for the specified source. If you specify
* a SourceType but do not specify a SourceIdentifier, you will receive
* notice of the events for that source type for all your RDS sources. If
* you do not specify either the SourceType nor the SourceIdentifier, you
* will be notified of events generated from all RDS sources belonging to
* your customer account.
*
*
* @see com.amazonaws.services.rds.AmazonRDS#createEventSubscription(CreateEventSubscriptionRequest)
*/
public class CreateEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of the subscription. Constraints: The name must be less
* than 255 characters.
*/
private String subscriptionName;
/**
* The Amazon Resource Name (ARN) of the 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 source that will be generating the events. For example, if
* you want to be notified of events generated by a DB instance, you
* would set this parameter to db-instance. if this value is not
* specified, all events are returned.
Valid values: db-instance |
* db-parameter-group | db-security-group | db-snapshot
*/
private String sourceType;
/**
* A list of event categories for a SourceType that you want to subscribe
* to. You can see a list of the categories for a given SourceType in the
* Events
* topic in the Amazon RDS User Guide or by using the
* DescribeEventCategories action.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag eventCategories;
/**
* The list of identifiers of the event sources for which events will be
* 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 cannot end with a hyphen or
* contain two consecutive hyphens. Constraints:
- If SourceIds
* are supplied, SourceType must also be provided.
- If the source
* type is a DB instance, then a
DBInstanceIdentifier must
* be supplied. - If the source type is a DB security group, a
*
DBSecurityGroupName must be supplied. - If the
* source type is a DB parameter group, a
*
DBParameterGroupName must be supplied. - If the
* source type is a DB snapshot, a
DBSnapshotIdentifier must
* be supplied.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag sourceIds;
/**
* A Boolean value; set to true to activate the subscription, set
* to false to create the subscription but not active it.
*/
private Boolean enabled;
/**
* A list of tags.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag tags;
/**
* The name of the subscription. Constraints: The name must be less
* than 255 characters.
*
* @return The name of the subscription.
Constraints: The name must be less
* than 255 characters.
*/
public String getSubscriptionName() {
return subscriptionName;
}
/**
* The name of the subscription.
Constraints: The name must be less
* than 255 characters.
*
* @param subscriptionName The name of the subscription.
Constraints: The name must be less
* than 255 characters.
*/
public void setSubscriptionName(String subscriptionName) {
this.subscriptionName = subscriptionName;
}
/**
* The name of the subscription.
Constraints: The name must be less
* than 255 characters.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param subscriptionName The name of the subscription.
Constraints: The name must be less
* than 255 characters.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateEventSubscriptionRequest withSubscriptionName(String subscriptionName) {
this.subscriptionName = subscriptionName;
return this;
}
/**
* The Amazon Resource Name (ARN) of the 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 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 snsTopicArn;
}
/**
* The Amazon Resource Name (ARN) of the 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 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 SNS topic created for event
* notification. The ARN is created by Amazon SNS when you create a topic
* and subscribe to it.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param snsTopicArn The Amazon Resource Name (ARN) of the SNS topic created for event
* notification. The ARN is created by Amazon SNS when you create a topic
* and subscribe to it.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateEventSubscriptionRequest withSnsTopicArn(String snsTopicArn) {
this.snsTopicArn = snsTopicArn;
return this;
}
/**
* The type of source that will be generating the events. For example, if
* you want to be notified of events generated by a DB instance, you
* would set this parameter to db-instance. if this value is not
* specified, all events are returned.
Valid values: db-instance |
* db-parameter-group | db-security-group | db-snapshot
*
* @return The type of source that will be generating the events. For example, if
* you want to be notified of events generated by a DB instance, you
* would set this parameter to db-instance. if this value is not
* specified, all events are returned.
Valid values: db-instance |
* db-parameter-group | db-security-group | db-snapshot
*/
public String getSourceType() {
return sourceType;
}
/**
* The type of source that will be generating the events. For example, if
* you want to be notified of events generated by a DB instance, you
* would set this parameter to db-instance. if this value is not
* specified, all events are returned.
Valid values: db-instance |
* db-parameter-group | db-security-group | db-snapshot
*
* @param sourceType The type of source that will be generating the events. For example, if
* you want to be notified of events generated by a DB instance, you
* would set this parameter to db-instance. if this value is not
* specified, all events are returned.
Valid values: db-instance |
* db-parameter-group | db-security-group | db-snapshot
*/
public void setSourceType(String sourceType) {
this.sourceType = sourceType;
}
/**
* The type of source that will be generating the events. For example, if
* you want to be notified of events generated by a DB instance, you
* would set this parameter to db-instance. if this value is not
* specified, all events are returned.
Valid values: db-instance |
* db-parameter-group | db-security-group | db-snapshot
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param sourceType The type of source that will be generating the events. For example, if
* you want to be notified of events generated by a DB instance, you
* would set this parameter to db-instance. if this value is not
* specified, all events are returned.
Valid values: db-instance |
* db-parameter-group | db-security-group | db-snapshot
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateEventSubscriptionRequest withSourceType(String sourceType) {
this.sourceType = sourceType;
return this;
}
/**
* A list of event categories for a SourceType that you want to subscribe
* to. You can see a list of the categories for a given SourceType in the
* Events
* topic in the Amazon RDS User Guide or by using the
* DescribeEventCategories action.
*
* @return A list of event categories for a SourceType that you want to subscribe
* to. You can see a list of the categories for a given SourceType in the
* Events
* topic in the Amazon RDS User Guide or by using the
* DescribeEventCategories action.
*/
public java.util.List getEventCategories() {
if (eventCategories == null) {
eventCategories = new com.amazonaws.internal.ListWithAutoConstructFlag();
eventCategories.setAutoConstruct(true);
}
return eventCategories;
}
/**
* A list of event categories for a SourceType that you want to subscribe
* to. You can see a list of the categories for a given SourceType in the
* Events
* topic in the Amazon RDS User Guide or by using the
* DescribeEventCategories action.
*
* @param eventCategories A list of event categories for a SourceType that you want to subscribe
* to. You can see a list of the categories for a given SourceType in the
* Events
* topic in the Amazon RDS User Guide or by using the
* DescribeEventCategories action.
*/
public void setEventCategories(java.util.Collection eventCategories) {
if (eventCategories == null) {
this.eventCategories = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag eventCategoriesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(eventCategories.size());
eventCategoriesCopy.addAll(eventCategories);
this.eventCategories = eventCategoriesCopy;
}
/**
* A list of event categories for a SourceType that you want to subscribe
* to. You can see a list of the categories for a given SourceType in the
* Events
* topic in the Amazon RDS User Guide or by using the
* DescribeEventCategories action.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param eventCategories A list of event categories for a SourceType that you want to subscribe
* to. You can see a list of the categories for a given SourceType in the
* Events
* topic in the Amazon RDS User Guide or by using the
* DescribeEventCategories action.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateEventSubscriptionRequest withEventCategories(String... eventCategories) {
if (getEventCategories() == null) setEventCategories(new java.util.ArrayList(eventCategories.length));
for (String value : eventCategories) {
getEventCategories().add(value);
}
return this;
}
/**
* A list of event categories for a SourceType that you want to subscribe
* to. You can see a list of the categories for a given SourceType in the
* Events
* topic in the Amazon RDS User Guide or by using the
* DescribeEventCategories action.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param eventCategories A list of event categories for a SourceType that you want to subscribe
* to. You can see a list of the categories for a given SourceType in the
* Events
* topic in the Amazon RDS User Guide or by using the
* DescribeEventCategories action.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateEventSubscriptionRequest withEventCategories(java.util.Collection eventCategories) {
if (eventCategories == null) {
this.eventCategories = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag eventCategoriesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(eventCategories.size());
eventCategoriesCopy.addAll(eventCategories);
this.eventCategories = eventCategoriesCopy;
}
return this;
}
/**
* The list of identifiers of the event sources for which events will be
* 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 cannot end with a hyphen or
* contain two consecutive hyphens. Constraints:
- If SourceIds
* are supplied, SourceType must also be provided.
- If the source
* type is a DB instance, then a
DBInstanceIdentifier must
* be supplied. - If the source type is a DB security group, a
*
DBSecurityGroupName must be supplied. - If the
* source type is a DB parameter group, a
*
DBParameterGroupName must be supplied. - If the
* source type is a DB snapshot, a
DBSnapshotIdentifier must
* be supplied.
*
* @return The list of identifiers of the event sources for which events will be
* 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 cannot end with a hyphen or
* contain two consecutive hyphens. Constraints:
- If SourceIds
* are supplied, SourceType must also be provided.
- If the source
* type is a DB instance, then a
DBInstanceIdentifier must
* be supplied. - If the source type is a DB security group, a
*
DBSecurityGroupName must be supplied. - If the
* source type is a DB parameter group, a
*
DBParameterGroupName must be supplied. - If the
* source type is a DB snapshot, a
DBSnapshotIdentifier must
* be supplied.
*/
public java.util.List getSourceIds() {
if (sourceIds == null) {
sourceIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
sourceIds.setAutoConstruct(true);
}
return sourceIds;
}
/**
* The list of identifiers of the event sources for which events will be
* 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 cannot end with a hyphen or
* contain two consecutive hyphens. Constraints:
- If SourceIds
* are supplied, SourceType must also be provided.
- If the source
* type is a DB instance, then a
DBInstanceIdentifier must
* be supplied. - If the source type is a DB security group, a
*
DBSecurityGroupName must be supplied. - If the
* source type is a DB parameter group, a
*
DBParameterGroupName must be supplied. - If the
* source type is a DB snapshot, a
DBSnapshotIdentifier must
* be supplied.
*
* @param sourceIds The list of identifiers of the event sources for which events will be
* 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 cannot end with a hyphen or
* contain two consecutive hyphens. Constraints:
- If SourceIds
* are supplied, SourceType must also be provided.
- If the source
* type is a DB instance, then a
DBInstanceIdentifier must
* be supplied. - If the source type is a DB security group, a
*
DBSecurityGroupName must be supplied. - If the
* source type is a DB parameter group, a
*
DBParameterGroupName must be supplied. - If the
* source type is a DB snapshot, a
DBSnapshotIdentifier must
* be supplied.
*/
public void setSourceIds(java.util.Collection sourceIds) {
if (sourceIds == null) {
this.sourceIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag sourceIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(sourceIds.size());
sourceIdsCopy.addAll(sourceIds);
this.sourceIds = sourceIdsCopy;
}
/**
* The list of identifiers of the event sources for which events will be
* 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 cannot end with a hyphen or
* contain two consecutive hyphens. Constraints:
- If SourceIds
* are supplied, SourceType must also be provided.
- If the source
* type is a DB instance, then a
DBInstanceIdentifier must
* be supplied. - If the source type is a DB security group, a
*
DBSecurityGroupName must be supplied. - If the
* source type is a DB parameter group, a
*
DBParameterGroupName must be supplied. - If the
* source type is a DB snapshot, a
DBSnapshotIdentifier must
* be supplied.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param sourceIds The list of identifiers of the event sources for which events will be
* 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 cannot end with a hyphen or
* contain two consecutive hyphens.
Constraints:
- If SourceIds
* are supplied, SourceType must also be provided.
- If the source
* type is a DB instance, then a
DBInstanceIdentifier must
* be supplied. - If the source type is a DB security group, a
*
DBSecurityGroupName must be supplied. - If the
* source type is a DB parameter group, a
*
DBParameterGroupName must be supplied. - If the
* source type is a DB snapshot, a
DBSnapshotIdentifier must
* be supplied.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateEventSubscriptionRequest withSourceIds(String... sourceIds) {
if (getSourceIds() == null) setSourceIds(new java.util.ArrayList(sourceIds.length));
for (String value : sourceIds) {
getSourceIds().add(value);
}
return this;
}
/**
* The list of identifiers of the event sources for which events will be
* 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 cannot end with a hyphen or
* contain two consecutive hyphens. Constraints:
- If SourceIds
* are supplied, SourceType must also be provided.
- If the source
* type is a DB instance, then a
DBInstanceIdentifier must
* be supplied. - If the source type is a DB security group, a
*
DBSecurityGroupName must be supplied. - If the
* source type is a DB parameter group, a
*
DBParameterGroupName must be supplied. - If the
* source type is a DB snapshot, a
DBSnapshotIdentifier must
* be supplied.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param sourceIds The list of identifiers of the event sources for which events will be
* 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 cannot end with a hyphen or
* contain two consecutive hyphens.
Constraints:
- If SourceIds
* are supplied, SourceType must also be provided.
- If the source
* type is a DB instance, then a
DBInstanceIdentifier must
* be supplied. - If the source type is a DB security group, a
*
DBSecurityGroupName must be supplied. - If the
* source type is a DB parameter group, a
*
DBParameterGroupName must be supplied. - If the
* source type is a DB snapshot, a
DBSnapshotIdentifier must
* be supplied.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateEventSubscriptionRequest withSourceIds(java.util.Collection sourceIds) {
if (sourceIds == null) {
this.sourceIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag sourceIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(sourceIds.size());
sourceIdsCopy.addAll(sourceIds);
this.sourceIds = sourceIdsCopy;
}
return this;
}
/**
* A Boolean value; set to true to activate the subscription, set
* to false to create the subscription but not active it.
*
* @return A Boolean value; set to true to activate the subscription, set
* to false to create the subscription but not active it.
*/
public Boolean isEnabled() {
return enabled;
}
/**
* A Boolean value; set to true to activate the subscription, set
* to false to create the subscription but not active it.
*
* @param enabled A Boolean value; set to true to activate the subscription, set
* to false to create the subscription but not active it.
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
/**
* A Boolean value; set to true to activate the subscription, set
* to false to create the subscription but not active it.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param enabled A Boolean value; set to true to activate the subscription, set
* to false to create the subscription but not active it.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateEventSubscriptionRequest withEnabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
/**
* A Boolean value; set to true to activate the subscription, set
* to false to create the subscription but not active it.
*
* @return A Boolean value; set to true to activate the subscription, set
* to false to create the subscription but not active it.
*/
public Boolean getEnabled() {
return enabled;
}
/**
* A list of tags.
*
* @return A list of tags.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.ListWithAutoConstructFlag();
tags.setAutoConstruct(true);
}
return tags;
}
/**
* A list of tags.
*
* @param tags A list of tags.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag tagsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(tags.size());
tagsCopy.addAll(tags);
this.tags = tagsCopy;
}
/**
* A list of tags.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param tags A list of tags.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateEventSubscriptionRequest withTags(Tag... tags) {
if (getTags() == null) setTags(new java.util.ArrayList(tags.length));
for (Tag value : tags) {
getTags().add(value);
}
return this;
}
/**
* A list of tags.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param tags A list of tags.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateEventSubscriptionRequest withTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag tagsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(tags.size());
tagsCopy.addAll(tags);
this.tags = tagsCopy;
}
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getSubscriptionName() != null) sb.append("SubscriptionName: " + getSubscriptionName() + ",");
if (getSnsTopicArn() != null) sb.append("SnsTopicArn: " + getSnsTopicArn() + ",");
if (getSourceType() != null) sb.append("SourceType: " + getSourceType() + ",");
if (getEventCategories() != null) sb.append("EventCategories: " + getEventCategories() + ",");
if (getSourceIds() != null) sb.append("SourceIds: " + getSourceIds() + ",");
if (isEnabled() != null) sb.append("Enabled: " + isEnabled() + ",");
if (getTags() != null) sb.append("Tags: " + getTags() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSubscriptionName() == null) ? 0 : getSubscriptionName().hashCode());
hashCode = prime * hashCode + ((getSnsTopicArn() == null) ? 0 : getSnsTopicArn().hashCode());
hashCode = prime * hashCode + ((getSourceType() == null) ? 0 : getSourceType().hashCode());
hashCode = prime * hashCode + ((getEventCategories() == null) ? 0 : getEventCategories().hashCode());
hashCode = prime * hashCode + ((getSourceIds() == null) ? 0 : getSourceIds().hashCode());
hashCode = prime * hashCode + ((isEnabled() == null) ? 0 : isEnabled().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof CreateEventSubscriptionRequest == false) return false;
CreateEventSubscriptionRequest other = (CreateEventSubscriptionRequest)obj;
if (other.getSubscriptionName() == null ^ this.getSubscriptionName() == null) return false;
if (other.getSubscriptionName() != null && other.getSubscriptionName().equals(this.getSubscriptionName()) == false) return false;
if (other.getSnsTopicArn() == null ^ this.getSnsTopicArn() == null) return false;
if (other.getSnsTopicArn() != null && other.getSnsTopicArn().equals(this.getSnsTopicArn()) == false) return false;
if (other.getSourceType() == null ^ this.getSourceType() == null) return false;
if (other.getSourceType() != null && other.getSourceType().equals(this.getSourceType()) == false) return false;
if (other.getEventCategories() == null ^ this.getEventCategories() == null) return false;
if (other.getEventCategories() != null && other.getEventCategories().equals(this.getEventCategories()) == false) return false;
if (other.getSourceIds() == null ^ this.getSourceIds() == null) return false;
if (other.getSourceIds() != null && other.getSourceIds().equals(this.getSourceIds()) == false) return false;
if (other.isEnabled() == null ^ this.isEnabled() == null) return false;
if (other.isEnabled() != null && other.isEnabled().equals(this.isEnabled()) == false) return false;
if (other.getTags() == null ^ this.getTags() == null) return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false;
return true;
}
}