Class CreateEventSubscriptionRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.A list of event categories for a SourceType that you want to subscribe to.The Amazon Resource Name (ARN) of the SNS topic created for event notification.The list of identifiers of the event sources for which events will be returned.The type of source that will be generating the events.The name of the subscription.getTags()
int
hashCode()
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) toString()
Returns a string representation of this object; useful for testing and debugging.withEnabled
(Boolean enabled) A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.withEventCategories
(String... eventCategories) A list of event categories for a SourceType that you want to subscribe to.withEventCategories
(Collection<String> eventCategories) A list of event categories for a SourceType that you want to subscribe to.withSnsTopicArn
(String snsTopicArn) The Amazon Resource Name (ARN) of the SNS topic created for event notification.withSourceIds
(String... sourceIds) The list of identifiers of the event sources for which events will be returned.withSourceIds
(Collection<String> sourceIds) The list of identifiers of the event sources for which events will be returned.withSourceType
(String sourceType) The type of source that will be generating the events.withSubscriptionName
(String subscriptionName) The name of the subscription.NOTE: This method appends the values to the existing list (if any).withTags
(Collection<Tag> tags) Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateEventSubscriptionRequest
public CreateEventSubscriptionRequest()
-
-
Method Details
-
setSubscriptionName
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.
-
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.
-
withSubscriptionName
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnsTopicArn
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.
-
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.
-
withSnsTopicArn
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSourceType
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
-
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
-
withSourceType
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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)
orwithEventCategories(java.util.Collection)
if you want to override the existing values.- 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:
- Returns a reference to this object so that method calls can be chained together.
-
withEventCategories
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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.
NOTE: This method appends the values to the existing list (if any). Use
setSourceIds(java.util.Collection)
orwithSourceIds(java.util.Collection)
if you want to override the existing values.- 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:
- Returns a reference to this object so that method calls can be chained together.
-
withSourceIds
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEnabled
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.
-
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.
-
withEnabled
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
getTags
- Returns:
-
setTags
- Parameters:
tags
-
-
withTags
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-