CreateEventSubscriptionRequest (AWS SDK for Java 1.8.9 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.rds.model.CreateEventSubscriptionRequest

All Implemented Interfaces:

Serializable
```
public class CreateEventSubscriptionRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the 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 Also:
AmazonRDS.createEventSubscription(CreateEventSubscriptionRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateEventSubscriptionRequest()

Constructors
Constructor and Description
`CreateEventSubscriptionRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Boolean`	`getEnabled()` A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
`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.
`List<String>`	`getSourceIds()` The list of identifiers of the event sources for which events will be returned.
`String`	`getSourceType()` The type of source that will be generating the events.
`String`	`getSubscriptionName()` The name of the subscription.
`List<Tag>`	`getTags()` A list of tags.
`int`	`hashCode()`
`Boolean`	`isEnabled()` A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
`void`	`setEnabled(Boolean enabled)` A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
`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`	`setSourceIds(Collection<String> sourceIds)` The list of identifiers of the event sources for which events will be returned.
`void`	`setSourceType(String sourceType)` The type of source that will be generating the events.
`void`	`setSubscriptionName(String subscriptionName)` The name of the subscription.
`void`	`setTags(Collection<Tag> tags)` A list of tags.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateEventSubscriptionRequest`	`withEnabled(Boolean enabled)` A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
`CreateEventSubscriptionRequest`	`withEventCategories(Collection<String> eventCategories)` A list of event categories for a SourceType that you want to subscribe to.
`CreateEventSubscriptionRequest`	`withEventCategories(String... eventCategories)` A list of event categories for a SourceType that you want to subscribe to.
`CreateEventSubscriptionRequest`	`withSnsTopicArn(String snsTopicArn)` The Amazon Resource Name (ARN) of the SNS topic created for event notification.
`CreateEventSubscriptionRequest`	`withSourceIds(Collection<String> sourceIds)` The list of identifiers of the event sources for which events will be returned.
`CreateEventSubscriptionRequest`	`withSourceIds(String... sourceIds)` The list of identifiers of the event sources for which events will be returned.
`CreateEventSubscriptionRequest`	`withSourceType(String sourceType)` The type of source that will be generating the events.
`CreateEventSubscriptionRequest`	`withSubscriptionName(String subscriptionName)` The name of the subscription.
`CreateEventSubscriptionRequest`	`withTags(Collection<Tag> tags)` A list of tags.
`CreateEventSubscriptionRequest`	`withTags(Tag... tags)` A list of tags.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateEventSubscriptionRequest
```
public CreateEventSubscriptionRequest()
```
- Method Detail
  - getSubscriptionName
```
public String getSubscriptionName()
```
    The name of the subscription.
    Constraints: The name must be less than 255 characters.
    
    Returns:
    The name of the subscription.
    Constraints: The name must be less than 255 characters.
  - setSubscriptionName
```
public void setSubscriptionName(String subscriptionName)
```
    The name of the subscription.
    Constraints: The name must be less than 255 characters.
    
    Parameters:
    subscriptionName - The name of the subscription.
    Constraints: The name must be less than 255 characters.
  - withSubscriptionName
```
public CreateEventSubscriptionRequest withSubscriptionName(String 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.
    
    Parameters:
    subscriptionName - The name of the subscription.
    Constraints: The name must be less than 255 characters.
    
    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 CreateEventSubscriptionRequest 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 CreateEventSubscriptionRequest 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 CreateEventSubscriptionRequest 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.
    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 CreateEventSubscriptionRequest 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.
  - getSourceIds
```
public List<String> getSourceIds()
```
    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:
    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.
  - setSourceIds
```
public void setSourceIds(Collection<String> 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.
    Parameters:
    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.
  - withSourceIds
```
public CreateEventSubscriptionRequest withSourceIds(String... 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.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    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.
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withSourceIds
```
public CreateEventSubscriptionRequest withSourceIds(Collection<String> 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.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    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.
    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, set to false to create the subscription but not active it.
    
    Returns:
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
    
    Parameters:
    enabled - A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
  - withEnabled
```
public CreateEventSubscriptionRequest withEnabled(Boolean 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.
    
    Parameters:
    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 updated object so that method calls can be chained together.
  - getEnabled
```
public Boolean getEnabled()
```
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
    
    Returns:
    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
  - getTags
```
public List<Tag> getTags()
```
    A list of tags.
    
    Returns:
    A list of tags.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of tags.
    
    Parameters:
    tags - A list of tags.
  - withTags
```
public CreateEventSubscriptionRequest withTags(Tag... tags)
```
    A list of tags.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tags - A list of tags.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withTags
```
public CreateEventSubscriptionRequest withTags(Collection<Tag> tags)
```
    A list of tags.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    tags - A list of tags.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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

Class CreateEventSubscriptionRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateEventSubscriptionRequest

Method Detail

getSubscriptionName

setSubscriptionName

withSubscriptionName

getSnsTopicArn

setSnsTopicArn

withSnsTopicArn

getSourceType

setSourceType

withSourceType

getEventCategories

setEventCategories

withEventCategories

withEventCategories

getSourceIds

setSourceIds

withSourceIds

withSourceIds

isEnabled

setEnabled

withEnabled

getEnabled

getTags

setTags

withTags

withTags

toString

hashCode

equals