@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateEventSubscriptionRequest() |
Modifier and Type | Method and Description |
---|---|
CreateEventSubscriptionRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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 are returned.
|
String |
getSourceType()
The type of source that is generating the events.
|
String |
getSubscriptionName()
The name of the subscription.
|
List<Tag> |
getTags()
The tags to be applied to the new event subscription.
|
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 are returned.
|
void |
setSourceType(String sourceType)
The type of source that is generating the events.
|
void |
setSubscriptionName(String subscriptionName)
The name of the subscription.
|
void |
setTags(Collection<Tag> tags)
The tags to be applied to the new event subscription.
|
String |
toString()
Returns a string representation of this object.
|
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 are returned.
|
CreateEventSubscriptionRequest |
withSourceIds(String... sourceIds)
The list of identifiers of the event sources for which events are returned.
|
CreateEventSubscriptionRequest |
withSourceType(String sourceType)
The type of source that is generating the events.
|
CreateEventSubscriptionRequest |
withSubscriptionName(String subscriptionName)
The name of the subscription.
|
CreateEventSubscriptionRequest |
withTags(Collection<Tag> tags)
The tags to be applied to the new event subscription.
|
CreateEventSubscriptionRequest |
withTags(Tag... tags)
The tags to be applied to the new event subscription.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setSubscriptionName(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 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(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(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 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(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(String sourceType)
The type of source that is 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-cluster
| db-parameter-group
|
db-security-group
| db-snapshot
| db-cluster-snapshot
sourceType
- The type of source that is 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-cluster
| db-parameter-group
|
db-security-group
| db-snapshot
| db-cluster-snapshot
public String getSourceType()
The type of source that is 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-cluster
| db-parameter-group
|
db-security-group
| db-snapshot
| db-cluster-snapshot
Valid values: db-instance
| db-cluster
| db-parameter-group
|
db-security-group
| db-snapshot
| db-cluster-snapshot
public CreateEventSubscriptionRequest withSourceType(String sourceType)
The type of source that is 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-cluster
| db-parameter-group
|
db-security-group
| db-snapshot
| db-cluster-snapshot
sourceType
- The type of source that is 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-cluster
| db-parameter-group
|
db-security-group
| db-snapshot
| db-cluster-snapshot
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 by using the DescribeEventCategories action.
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 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 by using the DescribeEventCategories action.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 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 by using the DescribeEventCategories action.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 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 by using the DescribeEventCategories action.public List<String> getSourceIds()
The list of identifiers of the event sources for which events are 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 can't 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.
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(Collection<String> sourceIds)
The list of identifiers of the event sources for which events are 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 can't 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.
sourceIds
- The list of identifiers of the event sources for which events are 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 can't 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 CreateEventSubscriptionRequest withSourceIds(String... sourceIds)
The list of identifiers of the event sources for which events are 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 can't 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)
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 are 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 can't 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 CreateEventSubscriptionRequest withSourceIds(Collection<String> sourceIds)
The list of identifiers of the event sources for which events are 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 can't 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.
sourceIds
- The list of identifiers of the event sources for which events are 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 can't 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 setEnabled(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 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(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 Boolean isEnabled()
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
public List<Tag> getTags()
The tags to be applied to the new event subscription.
public void setTags(Collection<Tag> tags)
The tags to be applied to the new event subscription.
tags
- The tags to be applied to the new event subscription.public CreateEventSubscriptionRequest withTags(Tag... tags)
The tags to be applied to the new event subscription.
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
- The tags to be applied to the new event subscription.public CreateEventSubscriptionRequest withTags(Collection<Tag> tags)
The tags to be applied to the new event subscription.
tags
- The tags to be applied to the new event subscription.public String toString()
toString
in class Object
Object.toString()
public CreateEventSubscriptionRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()