Package software.amazon.awssdk.services.rds.model

Interface CreateEventSubscriptionRequest.Builder

    • Method Detail

      • subscriptionName

        CreateEventSubscriptionRequest.Builder subscriptionName​(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.

      • snsTopicArn

        CreateEventSubscriptionRequest.Builder snsTopicArn​(String snsTopicArn)

        The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.

        RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.

        Parameters:
        snsTopicArn - The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.

        RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceType

        CreateEventSubscriptionRequest.Builder sourceType​(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 set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

        Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment

        Parameters:
        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 set this parameter to db-instance. For RDS Proxy events, specify db-proxy. If this value isn't specified, all events are returned.

        Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventCategories

        CreateEventSubscriptionRequest.Builder eventCategories​(Collection<String> eventCategories)

        A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

        Parameters:
        eventCategories - A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • eventCategories

        CreateEventSubscriptionRequest.Builder eventCategories​(String... eventCategories)

        A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

        Parameters:
        eventCategories - A list of event categories for a particular source type (SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceIds

        CreateEventSubscriptionRequest.Builder sourceIds​(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, a DBInstanceIdentifier value must be supplied.

        • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

        • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

        • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

        • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

        • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

        • If the source type is an RDS Proxy, a DBProxyName value must be supplied.

        Parameters:
        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, a DBInstanceIdentifier value must be supplied.

        • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

        • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

        • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

        • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

        • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

        • If the source type is an RDS Proxy, a DBProxyName value must be supplied.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceIds

        CreateEventSubscriptionRequest.Builder sourceIds​(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, a DBInstanceIdentifier value must be supplied.

        • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

        • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

        • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

        • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

        • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

        • If the source type is an RDS Proxy, a DBProxyName value must be supplied.

        Parameters:
        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, a DBInstanceIdentifier value must be supplied.

        • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.

        • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.

        • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.

        • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.

        • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

        • If the source type is an RDS Proxy, a DBProxyName value must be supplied.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enabled

        CreateEventSubscriptionRequest.Builder enabled​(Boolean enabled)

        Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

        Parameters:
        enabled - Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateEventSubscriptionRequest.Builder tags​(Collection<Tag> tags)
        Sets the value of the Tags property for this object.
        Parameters:
        tags - The new value for the Tags property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateEventSubscriptionRequest.Builder tags​(Tag... tags)
        Sets the value of the Tags property for this object.
        Parameters:
        tags - The new value for the Tags property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.