public class CreateEventSubscriptionRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
enabled
A Boolean value; set to true to activate the subscription, set to
false to create the subscription but not active it.
|
private SdkInternalList<java.lang.String> |
eventCategories
A list of event categories for a SourceType that you want to subscribe
to.
|
private java.lang.String |
snsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event
notification.
|
private SdkInternalList<java.lang.String> |
sourceIds
The list of identifiers of the event sources for which events will be
returned.
|
private java.lang.String |
sourceType
The type of source that will be generating the events.
|
private java.lang.String |
subscriptionName
The name of the subscription.
|
private SdkInternalList<Tag> |
tags |
NOOP
Constructor and Description |
---|
CreateEventSubscriptionRequest() |
Modifier and Type | Method and Description |
---|---|
CreateEventSubscriptionRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getEnabled()
A Boolean value; set to true to activate the subscription, set to
false to create the subscription but not active it.
|
java.util.List<java.lang.String> |
getEventCategories()
A list of event categories for a SourceType that you want to subscribe
to.
|
java.lang.String |
getSnsTopicArn()
The Amazon Resource Name (ARN) of the SNS topic created for event
notification.
|
java.util.List<java.lang.String> |
getSourceIds()
The list of identifiers of the event sources for which events will be
returned.
|
java.lang.String |
getSourceType()
The type of source that will be generating the events.
|
java.lang.String |
getSubscriptionName()
The name of the subscription.
|
java.util.List<Tag> |
getTags() |
int |
hashCode() |
java.lang.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(java.lang.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(java.util.Collection<java.lang.String> eventCategories)
A list of event categories for a SourceType that you want to subscribe
to.
|
void |
setSnsTopicArn(java.lang.String snsTopicArn)
The Amazon Resource Name (ARN) of the SNS topic created for event
notification.
|
void |
setSourceIds(java.util.Collection<java.lang.String> sourceIds)
The list of identifiers of the event sources for which events will be
returned.
|
void |
setSourceType(java.lang.String sourceType)
The type of source that will be generating the events.
|
void |
setSubscriptionName(java.lang.String subscriptionName)
The name of the subscription.
|
void |
setTags(java.util.Collection<Tag> tags) |
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateEventSubscriptionRequest |
withEnabled(java.lang.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(java.util.Collection<java.lang.String> eventCategories)
A list of event categories for a SourceType that you want to subscribe
to.
|
CreateEventSubscriptionRequest |
withEventCategories(java.lang.String... eventCategories)
A list of event categories for a SourceType that you want to subscribe
to.
|
CreateEventSubscriptionRequest |
withSnsTopicArn(java.lang.String snsTopicArn)
The Amazon Resource Name (ARN) of the SNS topic created for event
notification.
|
CreateEventSubscriptionRequest |
withSourceIds(java.util.Collection<java.lang.String> sourceIds)
The list of identifiers of the event sources for which events will be
returned.
|
CreateEventSubscriptionRequest |
withSourceIds(java.lang.String... sourceIds)
The list of identifiers of the event sources for which events will be
returned.
|
CreateEventSubscriptionRequest |
withSourceType(java.lang.String sourceType)
The type of source that will be generating the events.
|
CreateEventSubscriptionRequest |
withSubscriptionName(java.lang.String subscriptionName)
The name of the subscription.
|
CreateEventSubscriptionRequest |
withTags(java.util.Collection<Tag> tags) |
CreateEventSubscriptionRequest |
withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if
any).
|
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
private java.lang.String subscriptionName
The name of the subscription.
Constraints: The name must be less than 255 characters.
private java.lang.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.
private java.lang.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
private SdkInternalList<java.lang.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.
private SdkInternalList<java.lang.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:
DBInstanceIdentifier
must be supplied.DBSecurityGroupName
must be supplied.DBParameterGroupName
must be supplied.DBSnapshotIdentifier
must be supplied.private java.lang.Boolean enabled
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
private SdkInternalList<Tag> tags
public void setSubscriptionName(java.lang.String subscriptionName)
The name of the subscription.
Constraints: The name must be less than 255 characters.
subscriptionName
- The name of the subscription.
Constraints: The name must be less than 255 characters.
public java.lang.String getSubscriptionName()
The name of the subscription.
Constraints: The name must be less than 255 characters.
Constraints: The name must be less than 255 characters.
public CreateEventSubscriptionRequest withSubscriptionName(java.lang.String subscriptionName)
The name of the subscription.
Constraints: The name must be less than 255 characters.
subscriptionName
- The name of the subscription.
Constraints: The name must be less than 255 characters.
public void setSnsTopicArn(java.lang.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.
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 java.lang.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.
public CreateEventSubscriptionRequest withSnsTopicArn(java.lang.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.
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 setSourceType(java.lang.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
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 java.lang.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
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
public CreateEventSubscriptionRequest withSourceType(java.lang.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
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 java.util.List<java.lang.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.
public void setEventCategories(java.util.Collection<java.lang.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.
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 CreateEventSubscriptionRequest withEventCategories(java.lang.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.
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 CreateEventSubscriptionRequest withEventCategories(java.util.Collection<java.lang.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.
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 java.util.List<java.lang.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:
DBInstanceIdentifier
must be supplied.DBSecurityGroupName
must be supplied.DBParameterGroupName
must be supplied.DBSnapshotIdentifier
must be supplied.Constraints:
DBInstanceIdentifier
must be supplied.DBSecurityGroupName
must be supplied.DBParameterGroupName
must be supplied.DBSnapshotIdentifier
must be supplied.public void setSourceIds(java.util.Collection<java.lang.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:
DBInstanceIdentifier
must be supplied.DBSecurityGroupName
must be supplied.DBParameterGroupName
must be supplied.DBSnapshotIdentifier
must be supplied.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:
DBInstanceIdentifier
must be supplied.DBSecurityGroupName
must be supplied.DBParameterGroupName
must be supplied.DBSnapshotIdentifier
must be supplied.public CreateEventSubscriptionRequest withSourceIds(java.lang.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:
DBInstanceIdentifier
must be supplied.DBSecurityGroupName
must be supplied.DBParameterGroupName
must be supplied.DBSnapshotIdentifier
must be supplied.
NOTE: This method appends the values to the existing list (if
any). Use setSourceIds(java.util.Collection)
or
withSourceIds(java.util.Collection)
if you want to override the
existing values.
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:
DBInstanceIdentifier
must be supplied.DBSecurityGroupName
must be supplied.DBParameterGroupName
must be supplied.DBSnapshotIdentifier
must be supplied.public CreateEventSubscriptionRequest withSourceIds(java.util.Collection<java.lang.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:
DBInstanceIdentifier
must be supplied.DBSecurityGroupName
must be supplied.DBParameterGroupName
must be supplied.DBSnapshotIdentifier
must be supplied.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:
DBInstanceIdentifier
must be supplied.DBSecurityGroupName
must be supplied.DBParameterGroupName
must be supplied.DBSnapshotIdentifier
must be supplied.public void setEnabled(java.lang.Boolean enabled)
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
enabled
- A Boolean value; set to true to activate the subscription,
set to false to create the subscription but not active it.public java.lang.Boolean getEnabled()
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
public CreateEventSubscriptionRequest withEnabled(java.lang.Boolean enabled)
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
enabled
- A Boolean value; set to true to activate the subscription,
set to false to create the subscription but not active it.public java.lang.Boolean isEnabled()
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
public java.util.List<Tag> getTags()
public void setTags(java.util.Collection<Tag> tags)
tags
- public CreateEventSubscriptionRequest withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if
any). Use setTags(java.util.Collection)
or
withTags(java.util.Collection)
if you want to override the
existing values.
tags
- public CreateEventSubscriptionRequest withTags(java.util.Collection<Tag> tags)
tags
- public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public CreateEventSubscriptionRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()