com.amazonaws.services.rds.model

Class ModifyEventSubscriptionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.ModifyEventSubscriptionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ModifyEventSubscriptionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ModifyEventSubscription operation.

Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

See Also:

AmazonRDS.modifyEventSubscription(ModifyEventSubscriptionRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyEventSubscriptionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ModifyEventSubscriptionRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Boolean	getEnabled() A Boolean value; set to true to activate the subscription.
List<String>	getEventCategories() A list of event categories for a SourceType that you want to subscribe to.
String	getSnsTopicArn() The Amazon Resource Name (ARN) of the SNS topic created for event notification.
String	getSourceType() The type of source that will be generating the events.
String	getSubscriptionName() The name of the RDS event notification subscription.
int	hashCode()
Boolean	isEnabled() A Boolean value; set to true to activate the subscription.
void	setEnabled(Boolean enabled) A Boolean value; set to true to activate the subscription.
void	setEventCategories(Collection<String> eventCategories) A list of event categories for a SourceType that you want to subscribe to.
void	setSnsTopicArn(String snsTopicArn) The Amazon Resource Name (ARN) of the SNS topic created for event notification.
void	setSourceType(String sourceType) The type of source that will be generating the events.
void	setSubscriptionName(String subscriptionName) The name of the RDS event notification subscription.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ModifyEventSubscriptionRequest	withEnabled(Boolean enabled) A Boolean value; set to true to activate the subscription.
ModifyEventSubscriptionRequest	withEventCategories(Collection<String> eventCategories) A list of event categories for a SourceType that you want to subscribe to.
ModifyEventSubscriptionRequest	withEventCategories(String... eventCategories) A list of event categories for a SourceType that you want to subscribe to.
ModifyEventSubscriptionRequest	withSnsTopicArn(String snsTopicArn) The Amazon Resource Name (ARN) of the SNS topic created for event notification.
ModifyEventSubscriptionRequest	withSourceType(String sourceType) The type of source that will be generating the events.
ModifyEventSubscriptionRequest	withSubscriptionName(String subscriptionName) The name of the RDS event notification subscription.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyEventSubscriptionRequest

public ModifyEventSubscriptionRequest()

Method Detail

getSubscriptionName

public String getSubscriptionName()

The name of the RDS event notification subscription.

Returns:

The name of the RDS event notification subscription.

setSubscriptionName

public void setSubscriptionName(String subscriptionName)

The name of the RDS event notification subscription.

Parameters:

subscriptionName - The name of the RDS event notification subscription.

withSubscriptionName

public ModifyEventSubscriptionRequest withSubscriptionName(String subscriptionName)

The name of the RDS event notification subscription.

Returns a reference to this object so that method calls can be chained together.

Parameters:

subscriptionName - The name of the RDS event notification subscription.

Returns:

A reference to this updated object so that method calls can be chained together.

getSnsTopicArn

public String getSnsTopicArn()

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:

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.

setSnsTopicArn

public void setSnsTopicArn(String 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.

Parameters:

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.

withSnsTopicArn

public ModifyEventSubscriptionRequest withSnsTopicArn(String 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.

Parameters:

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 updated object so that method calls can be chained together.

getSourceType

public String getSourceType()

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:

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

setSourceType

public void setSourceType(String 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

Parameters:

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

withSourceType

public ModifyEventSubscriptionRequest withSourceType(String 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.

Parameters:

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 updated object so that method calls can be chained together.

getEventCategories

public List<String> getEventCategories()

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

setEventCategories

public void setEventCategories(Collection<String> 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.

Parameters:

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.

withEventCategories

public ModifyEventSubscriptionRequest withEventCategories(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setEventCategories(java.util.Collection) or withEventCategories(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

withEventCategories

public ModifyEventSubscriptionRequest withEventCategories(Collection<String> 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

isEnabled

public Boolean isEnabled()

A Boolean value; set to true to activate the subscription.

Returns:

A Boolean value; set to true to activate the subscription.

setEnabled

public void setEnabled(Boolean enabled)

A Boolean value; set to true to activate the subscription.

Parameters:

enabled - A Boolean value; set to true to activate the subscription.

withEnabled

public ModifyEventSubscriptionRequest withEnabled(Boolean enabled)

A Boolean value; set to true to activate the subscription.

Returns a reference to this object so that method calls can be chained together.

Parameters:

enabled - A Boolean value; set to true to activate the subscription.

Returns:

A reference to this updated object so that method calls can be chained together.

getEnabled

public Boolean getEnabled()

A Boolean value; set to true to activate the subscription.

Returns:

A Boolean value; set to true to activate the subscription.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public ModifyEventSubscriptionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()