Class CreateEventSubscriptionRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.rds.model.CreateEventSubscriptionRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class CreateEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

See Also:
  • Constructor Details

    • CreateEventSubscriptionRequest

      public CreateEventSubscriptionRequest()
  • Method Details

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

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

    • withSubscriptionName

      public CreateEventSubscriptionRequest withSubscriptionName(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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • 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.
    • 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.

      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

      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

    • 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

    • 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

      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

      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.

      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.

      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

      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.

      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

      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.

      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.

      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

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

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

      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

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

      public List<Tag> getTags()
      Returns:
    • setTags

      public void setTags(Collection<Tag> tags)
      Parameters:
      tags -
    • withTags

      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.

      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

      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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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: