Package software.amazon.awscdk.services.docdb

Class CfnEventSubscriptionProps.Builder

java.lang.Object
software.amazon.awscdk.services.docdb.CfnEventSubscriptionProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnEventSubscriptionProps>
Enclosing interface:
CfnEventSubscriptionProps
@Stability(Stable) public static final class CfnEventSubscriptionProps.Builder extends Object implements software.amazon.jsii.Builder<CfnEventSubscriptionProps>
A builder for CfnEventSubscriptionProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • snsTopicArn

      @Stability(Stable) public CfnEventSubscriptionProps.Builder snsTopicArn(String snsTopicArn)
      Sets the value of CfnEventSubscriptionProps.getSnsTopicArn()
      Parameters:
      snsTopicArn - The Amazon Resource Name (ARN) of the SNS topic created for event notification. This parameter is required. Amazon SNS creates the ARN when you create a topic and subscribe to it.
      Returns:
      this

    • enabled

      @Stability(Stable) public CfnEventSubscriptionProps.Builder enabled(Boolean enabled)
      Sets the value of CfnEventSubscriptionProps.getEnabled()
      Parameters:
      enabled - A Boolean value;. set to true to activate the subscription, set to false to create the subscription but not active it.
      Returns:
      this

    • enabled

      @Stability(Stable) public CfnEventSubscriptionProps.Builder enabled(IResolvable enabled)
      Sets the value of CfnEventSubscriptionProps.getEnabled()
      Parameters:
      enabled - A Boolean value;. set to true to activate the subscription, set to false to create the subscription but not active it.
      Returns:
      this

    • eventCategories

      @Stability(Stable) public CfnEventSubscriptionProps.Builder eventCategories(List<String> eventCategories)
      Sets the value of CfnEventSubscriptionProps.getEventCategories()
      Parameters:
      eventCategories - A list of event categories for a SourceType that you want to subscribe to.
      Returns:
      this

    • sourceIds

      @Stability(Stable) public CfnEventSubscriptionProps.Builder sourceIds(List<String> sourceIds)
      Sets the value of CfnEventSubscriptionProps.getSourceIds()
      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:
      this

    • sourceType

      @Stability(Stable) public CfnEventSubscriptionProps.Builder sourceType(String sourceType)
      Sets the value of CfnEventSubscriptionProps.getSourceType()
      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:
      this

    • subscriptionName

      @Stability(Stable) public CfnEventSubscriptionProps.Builder subscriptionName(String subscriptionName)
      Sets the value of CfnEventSubscriptionProps.getSubscriptionName()
      Parameters:
      subscriptionName - The name of the subscription. Constraints: The name must be fewer than 255 characters.
      Returns:
      this

    • build

      @Stability(Stable) public CfnEventSubscriptionProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnEventSubscriptionProps>
      Returns:
      a new instance of CfnEventSubscriptionProps
      Throws:
      NullPointerException - if any required attribute was not provided