Package software.amazon.awssdk.services.neptune.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. 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.

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

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

        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 SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType 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 by using the DescribeEventCategories action.
        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 SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType 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 by using the DescribeEventCategories action.
        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, 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 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.

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

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

      • enabled

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

      • tags

        CreateEventSubscriptionRequest.Builder tags​(Collection<Tag> tags)

        The tags to be applied to the new event subscription.

        Parameters:
        tags - The tags to be applied to the new event subscription.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateEventSubscriptionRequest.Builder tags​(Tag... tags)

        The tags to be applied to the new event subscription.

        Parameters:
        tags - The tags to be applied to the new event subscription.
        Returns:
        Returns a reference to this object so that method calls can be chained together.