Package software.amazon.awssdk.services.docdb.model

Interface CreateEventSubscriptionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>, DocDbRequest.Builder, SdkBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateEventSubscriptionRequest
public static interface CreateEventSubscriptionRequest.Builder extends DocDbRequest.Builder, SdkPojo, CopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

  • Method Details

    • subscriptionName

      CreateEventSubscriptionRequest.Builder subscriptionName(String subscriptionName)

      The name of the subscription.

      Constraints: The name must be fewer than 255 characters.

      Parameters:
      subscriptionName - The name of the subscription.

      Constraints: The name must be fewer 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. Amazon SNS creates the ARN when you create a topic and subscribe to it.

      Parameters:
      snsTopicArn - The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN 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 an 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-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 an 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-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.

      Parameters:
      eventCategories - A list of event categories for a SourceType that you want to subscribe to.
      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.

      Parameters:
      eventCategories - A list of event categories for a SourceType that you want to subscribe to.
      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 provided, SourceType must also be provided.

      • If the source type is an instance, a DBInstanceIdentifier must be provided.

      • If the source type is a security group, a DBSecurityGroupName must be provided.

      • If the source type is a parameter group, a DBParameterGroupName must be provided.

      • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

      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 provided, SourceType must also be provided.

      • If the source type is an instance, a DBInstanceIdentifier must be provided.

      • If the source type is a security group, a DBSecurityGroupName must be provided.

      • If the source type is a parameter group, a DBParameterGroupName must be provided.

      • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

      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 provided, SourceType must also be provided.

      • If the source type is an instance, a DBInstanceIdentifier must be provided.

      • If the source type is a security group, a DBSecurityGroupName must be provided.

      • If the source type is a parameter group, a DBParameterGroupName must be provided.

      • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

      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 provided, SourceType must also be provided.

      • If the source type is an instance, a DBInstanceIdentifier must be provided.

      • If the source type is a security group, a DBSecurityGroupName must be provided.

      • If the source type is a parameter group, a DBParameterGroupName must be provided.

      • If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

      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 assigned to the event subscription.

      Parameters:
      tags - The tags to be assigned to the 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 assigned to the event subscription.

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

    • tags

      CreateEventSubscriptionRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags to be assigned to the event subscription.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateEventSubscriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateEventSubscriptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.