Package software.amazon.awscdk.services.sns

Class CfnSubscriptionProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • protocol

      @Stability(Stable) public CfnSubscriptionProps.Builder protocol(String protocol)
      Sets the value of CfnSubscriptionProps.getProtocol()
      Parameters:
      protocol - The subscription's protocol. This parameter is required. For more information, see the Protocol parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .
      Returns:
      this

    • topicArn

      @Stability(Stable) public CfnSubscriptionProps.Builder topicArn(String topicArn)
      Sets the value of CfnSubscriptionProps.getTopicArn()
      Parameters:
      topicArn - The ARN of the topic to subscribe to. This parameter is required.
      Returns:
      this

    • topicArn

      @Stability(Stable) public CfnSubscriptionProps.Builder topicArn(ITopicRef topicArn)
      Sets the value of CfnSubscriptionProps.getTopicArn()
      Parameters:
      topicArn - The ARN of the topic to subscribe to. This parameter is required.
      Returns:
      this

    • deliveryPolicy

      @Stability(Stable) public CfnSubscriptionProps.Builder deliveryPolicy(Object deliveryPolicy)
      Sets the value of CfnSubscriptionProps.getDeliveryPolicy()
      Parameters:
      deliveryPolicy - The delivery policy JSON assigned to the subscription. Enables the subscriber to define the message delivery retry strategy in the case of an HTTP/S endpoint subscribed to the topic. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon API Reference and Message delivery retries in the Amazon Developer Guide .
      Returns:
      this

    • endpoint

      @Stability(Stable) public CfnSubscriptionProps.Builder endpoint(String endpoint)
      Sets the value of CfnSubscriptionProps.getEndpoint()
      Parameters:
      endpoint - The subscription's endpoint. The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .
      Returns:
      this

    • endpoint

      @Stability(Stable) public CfnSubscriptionProps.Builder endpoint(IDeliveryStreamRef endpoint)
      Sets the value of CfnSubscriptionProps.getEndpoint()
      Parameters:
      endpoint - The subscription's endpoint. The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .
      Returns:
      this

    • endpoint

      @Stability(Stable) public CfnSubscriptionProps.Builder endpoint(IFunctionRef endpoint)
      Sets the value of CfnSubscriptionProps.getEndpoint()
      Parameters:
      endpoint - The subscription's endpoint. The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .
      Returns:
      this

    • endpoint

      @Stability(Stable) public CfnSubscriptionProps.Builder endpoint(IVersionRef endpoint)
      Sets the value of CfnSubscriptionProps.getEndpoint()
      Parameters:
      endpoint - The subscription's endpoint. The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .
      Returns:
      this

    • endpoint

      @Stability(Stable) public CfnSubscriptionProps.Builder endpoint(IQueueRef endpoint)
      Sets the value of CfnSubscriptionProps.getEndpoint()
      Parameters:
      endpoint - The subscription's endpoint. The endpoint value depends on the protocol that you specify. For more information, see the Endpoint parameter of the [Subscribe](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) action in the Amazon API Reference .
      Returns:
      this

    • filterPolicy

      @Stability(Stable) public CfnSubscriptionProps.Builder filterPolicy(Object filterPolicy)
      Sets the value of CfnSubscriptionProps.getFilterPolicy()
      Parameters:
      filterPolicy - The filter policy JSON assigned to the subscription. Enables the subscriber to filter out unwanted messages. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon API Reference and Message filtering in the Amazon Developer Guide .
      Returns:
      this

    • filterPolicyScope

      @Stability(Stable) public CfnSubscriptionProps.Builder filterPolicyScope(String filterPolicyScope)
      Sets the value of CfnSubscriptionProps.getFilterPolicyScope()
      Parameters:
      filterPolicyScope - This attribute lets you choose the filtering scope by using one of the following string value types:.
      • MessageAttributes (default) - The filter is applied on the message attributes.
      • MessageBody - The filter is applied on the message body.

      Null is not a valid value for FilterPolicyScope . To delete a filter policy, delete the FilterPolicy property but keep FilterPolicyScope property as is.

      Returns:
      this

    • rawMessageDelivery

      @Stability(Stable) public CfnSubscriptionProps.Builder rawMessageDelivery(Boolean rawMessageDelivery)
      Sets the value of CfnSubscriptionProps.getRawMessageDelivery()
      Parameters:
      rawMessageDelivery - When set to true , enables raw message delivery. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon API Reference .
      Returns:
      this

    • rawMessageDelivery

      @Stability(Stable) public CfnSubscriptionProps.Builder rawMessageDelivery(IResolvable rawMessageDelivery)
      Sets the value of CfnSubscriptionProps.getRawMessageDelivery()
      Parameters:
      rawMessageDelivery - When set to true , enables raw message delivery. Raw messages don't contain any JSON formatting and can be sent to Amazon SQS and HTTP/S endpoints. For more information, see [GetSubscriptionAttributes](https://docs.aws.amazon.com/sns/latest/api/API_GetSubscriptionAttributes.html) in the Amazon API Reference .
      Returns:
      this

    • redrivePolicy

      @Stability(Stable) public CfnSubscriptionProps.Builder redrivePolicy(Object redrivePolicy)
      Sets the value of CfnSubscriptionProps.getRedrivePolicy()
      Parameters:
      redrivePolicy - When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

      For more information about the redrive policy and dead-letter queues, see Amazon SQS dead-letter queues in the Amazon SQS Developer Guide .

      Returns:
      this

    • region

      @Stability(Stable) public CfnSubscriptionProps.Builder region(String region)
      Sets the value of CfnSubscriptionProps.getRegion()
      Parameters:
      region - For cross-region subscriptions, the region in which the topic resides. If no region is specified, CloudFormation uses the region of the caller as the default.

      If you perform an update operation that only updates the Region property of a AWS::SNS::Subscription resource, that operation will fail unless you are either:

      • Updating the Region from NULL to the caller region.
      • Updating the Region from the caller region to NULL .
      Returns:
      this

    • replayPolicy

      @Stability(Stable) public CfnSubscriptionProps.Builder replayPolicy(Object replayPolicy)
      Sets the value of CfnSubscriptionProps.getReplayPolicy()
      Parameters:
      replayPolicy - Specifies whether Amazon resends the notification to the subscription when a message's attribute changes.
      Returns:
      this

    • subscriptionRoleArn

      @Stability(Stable) public CfnSubscriptionProps.Builder subscriptionRoleArn(String subscriptionRoleArn)
      Sets the value of CfnSubscriptionProps.getSubscriptionRoleArn()
      Parameters:
      subscriptionRoleArn - This property applies only to Amazon Data Firehose delivery stream subscriptions. Specify the ARN of the IAM role that has the following:

      • Permission to write to the Amazon Data Firehose delivery stream
      • Amazon listed as a trusted entity

      Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Amazon Data Firehose delivery streams in the Amazon Developer Guide.

      Returns:
      this

    • subscriptionRoleArn

      @Stability(Stable) public CfnSubscriptionProps.Builder subscriptionRoleArn(IRoleRef subscriptionRoleArn)
      Sets the value of CfnSubscriptionProps.getSubscriptionRoleArn()
      Parameters:
      subscriptionRoleArn - This property applies only to Amazon Data Firehose delivery stream subscriptions. Specify the ARN of the IAM role that has the following:

      • Permission to write to the Amazon Data Firehose delivery stream
      • Amazon listed as a trusted entity

      Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Amazon Data Firehose delivery streams in the Amazon Developer Guide.

      Returns:
      this

    • build

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