com.pulumi.aws.sns.TopicSubscriptionArgs Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.sns;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class TopicSubscriptionArgs extends com.pulumi.resources.ResourceArgs {
public static final TopicSubscriptionArgs Empty = new TopicSubscriptionArgs();
/**
* Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is `1`.
*
*/
@Import(name="confirmationTimeoutInMinutes")
private @Nullable Output confirmationTimeoutInMinutes;
/**
* @return Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is `1`.
*
*/
public Optional> confirmationTimeoutInMinutes() {
return Optional.ofNullable(this.confirmationTimeoutInMinutes);
}
/**
* JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/DeliveryPolicies.html) for more details.
*
*/
@Import(name="deliveryPolicy")
private @Nullable Output deliveryPolicy;
/**
* @return JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/DeliveryPolicies.html) for more details.
*
*/
public Optional> deliveryPolicy() {
return Optional.ofNullable(this.deliveryPolicy);
}
/**
* Endpoint to send data to. The contents vary with the protocol. See details below.
*
*/
@Import(name="endpoint", required=true)
private Output endpoint;
/**
* @return Endpoint to send data to. The contents vary with the protocol. See details below.
*
*/
public Output endpoint() {
return this.endpoint;
}
/**
* Whether the endpoint is capable of [auto confirming subscription](http://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.html#SendMessageToHttp.prepare) (e.g., PagerDuty). Default is `false`.
*
*/
@Import(name="endpointAutoConfirms")
private @Nullable Output endpointAutoConfirms;
/**
* @return Whether the endpoint is capable of [auto confirming subscription](http://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.html#SendMessageToHttp.prepare) (e.g., PagerDuty). Default is `false`.
*
*/
public Optional> endpointAutoConfirms() {
return Optional.ofNullable(this.endpointAutoConfirms);
}
/**
* JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html) for more details.
*
*/
@Import(name="filterPolicy")
private @Nullable Output filterPolicy;
/**
* @return JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html) for more details.
*
*/
public Optional> filterPolicy() {
return Optional.ofNullable(this.filterPolicy);
}
/**
* Whether the `filter_policy` applies to `MessageAttributes` (default) or `MessageBody`.
*
*/
@Import(name="filterPolicyScope")
private @Nullable Output filterPolicyScope;
/**
* @return Whether the `filter_policy` applies to `MessageAttributes` (default) or `MessageBody`.
*
*/
public Optional> filterPolicyScope() {
return Optional.ofNullable(this.filterPolicyScope);
}
/**
* Protocol to use. Valid values are: `sqs`, `sms`, `lambda`, `firehose`, and `application`. Protocols `email`, `email-json`, `http` and `https` are also valid but partially supported. See details below.
*
*/
@Import(name="protocol", required=true)
private Output protocol;
/**
* @return Protocol to use. Valid values are: `sqs`, `sms`, `lambda`, `firehose`, and `application`. Protocols `email`, `email-json`, `http` and `https` are also valid but partially supported. See details below.
*
*/
public Output protocol() {
return this.protocol;
}
/**
* Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is `false`.
*
*/
@Import(name="rawMessageDelivery")
private @Nullable Output rawMessageDelivery;
/**
* @return Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is `false`.
*
*/
public Optional> rawMessageDelivery() {
return Optional.ofNullable(this.rawMessageDelivery);
}
/**
* JSON String with the redrive policy that will be used in the subscription. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/sns-dead-letter-queues.html#how-messages-moved-into-dead-letter-queue) for more details.
*
*/
@Import(name="redrivePolicy")
private @Nullable Output redrivePolicy;
/**
* @return JSON String with the redrive policy that will be used in the subscription. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/sns-dead-letter-queues.html#how-messages-moved-into-dead-letter-queue) for more details.
*
*/
public Optional> redrivePolicy() {
return Optional.ofNullable(this.redrivePolicy);
}
/**
* JSON String with the archived message replay policy that will be used in the subscription. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/message-archiving-and-replay-subscriber.html) for more details.
*
*/
@Import(name="replayPolicy")
private @Nullable Output replayPolicy;
/**
* @return JSON String with the archived message replay policy that will be used in the subscription. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/message-archiving-and-replay-subscriber.html) for more details.
*
*/
public Optional> replayPolicy() {
return Optional.ofNullable(this.replayPolicy);
}
/**
* ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html).
*
*/
@Import(name="subscriptionRoleArn")
private @Nullable Output subscriptionRoleArn;
/**
* @return ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html).
*
*/
public Optional> subscriptionRoleArn() {
return Optional.ofNullable(this.subscriptionRoleArn);
}
/**
* ARN of the SNS topic to subscribe to.
*
* The following arguments are optional:
*
*/
@Import(name="topic", required=true)
private Output topic;
/**
* @return ARN of the SNS topic to subscribe to.
*
* The following arguments are optional:
*
*/
public Output topic() {
return this.topic;
}
private TopicSubscriptionArgs() {}
private TopicSubscriptionArgs(TopicSubscriptionArgs $) {
this.confirmationTimeoutInMinutes = $.confirmationTimeoutInMinutes;
this.deliveryPolicy = $.deliveryPolicy;
this.endpoint = $.endpoint;
this.endpointAutoConfirms = $.endpointAutoConfirms;
this.filterPolicy = $.filterPolicy;
this.filterPolicyScope = $.filterPolicyScope;
this.protocol = $.protocol;
this.rawMessageDelivery = $.rawMessageDelivery;
this.redrivePolicy = $.redrivePolicy;
this.replayPolicy = $.replayPolicy;
this.subscriptionRoleArn = $.subscriptionRoleArn;
this.topic = $.topic;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(TopicSubscriptionArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private TopicSubscriptionArgs $;
public Builder() {
$ = new TopicSubscriptionArgs();
}
public Builder(TopicSubscriptionArgs defaults) {
$ = new TopicSubscriptionArgs(Objects.requireNonNull(defaults));
}
/**
* @param confirmationTimeoutInMinutes Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is `1`.
*
* @return builder
*
*/
public Builder confirmationTimeoutInMinutes(@Nullable Output confirmationTimeoutInMinutes) {
$.confirmationTimeoutInMinutes = confirmationTimeoutInMinutes;
return this;
}
/**
* @param confirmationTimeoutInMinutes Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is `1`.
*
* @return builder
*
*/
public Builder confirmationTimeoutInMinutes(Integer confirmationTimeoutInMinutes) {
return confirmationTimeoutInMinutes(Output.of(confirmationTimeoutInMinutes));
}
/**
* @param deliveryPolicy JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/DeliveryPolicies.html) for more details.
*
* @return builder
*
*/
public Builder deliveryPolicy(@Nullable Output deliveryPolicy) {
$.deliveryPolicy = deliveryPolicy;
return this;
}
/**
* @param deliveryPolicy JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/DeliveryPolicies.html) for more details.
*
* @return builder
*
*/
public Builder deliveryPolicy(String deliveryPolicy) {
return deliveryPolicy(Output.of(deliveryPolicy));
}
/**
* @param endpoint Endpoint to send data to. The contents vary with the protocol. See details below.
*
* @return builder
*
*/
public Builder endpoint(Output endpoint) {
$.endpoint = endpoint;
return this;
}
/**
* @param endpoint Endpoint to send data to. The contents vary with the protocol. See details below.
*
* @return builder
*
*/
public Builder endpoint(String endpoint) {
return endpoint(Output.of(endpoint));
}
/**
* @param endpointAutoConfirms Whether the endpoint is capable of [auto confirming subscription](http://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.html#SendMessageToHttp.prepare) (e.g., PagerDuty). Default is `false`.
*
* @return builder
*
*/
public Builder endpointAutoConfirms(@Nullable Output endpointAutoConfirms) {
$.endpointAutoConfirms = endpointAutoConfirms;
return this;
}
/**
* @param endpointAutoConfirms Whether the endpoint is capable of [auto confirming subscription](http://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.html#SendMessageToHttp.prepare) (e.g., PagerDuty). Default is `false`.
*
* @return builder
*
*/
public Builder endpointAutoConfirms(Boolean endpointAutoConfirms) {
return endpointAutoConfirms(Output.of(endpointAutoConfirms));
}
/**
* @param filterPolicy JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html) for more details.
*
* @return builder
*
*/
public Builder filterPolicy(@Nullable Output filterPolicy) {
$.filterPolicy = filterPolicy;
return this;
}
/**
* @param filterPolicy JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/message-filtering.html) for more details.
*
* @return builder
*
*/
public Builder filterPolicy(String filterPolicy) {
return filterPolicy(Output.of(filterPolicy));
}
/**
* @param filterPolicyScope Whether the `filter_policy` applies to `MessageAttributes` (default) or `MessageBody`.
*
* @return builder
*
*/
public Builder filterPolicyScope(@Nullable Output filterPolicyScope) {
$.filterPolicyScope = filterPolicyScope;
return this;
}
/**
* @param filterPolicyScope Whether the `filter_policy` applies to `MessageAttributes` (default) or `MessageBody`.
*
* @return builder
*
*/
public Builder filterPolicyScope(String filterPolicyScope) {
return filterPolicyScope(Output.of(filterPolicyScope));
}
/**
* @param protocol Protocol to use. Valid values are: `sqs`, `sms`, `lambda`, `firehose`, and `application`. Protocols `email`, `email-json`, `http` and `https` are also valid but partially supported. See details below.
*
* @return builder
*
*/
public Builder protocol(Output protocol) {
$.protocol = protocol;
return this;
}
/**
* @param protocol Protocol to use. Valid values are: `sqs`, `sms`, `lambda`, `firehose`, and `application`. Protocols `email`, `email-json`, `http` and `https` are also valid but partially supported. See details below.
*
* @return builder
*
*/
public Builder protocol(String protocol) {
return protocol(Output.of(protocol));
}
/**
* @param rawMessageDelivery Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is `false`.
*
* @return builder
*
*/
public Builder rawMessageDelivery(@Nullable Output rawMessageDelivery) {
$.rawMessageDelivery = rawMessageDelivery;
return this;
}
/**
* @param rawMessageDelivery Whether to enable raw message delivery (the original message is directly passed, not wrapped in JSON with the original message in the message property). Default is `false`.
*
* @return builder
*
*/
public Builder rawMessageDelivery(Boolean rawMessageDelivery) {
return rawMessageDelivery(Output.of(rawMessageDelivery));
}
/**
* @param redrivePolicy JSON String with the redrive policy that will be used in the subscription. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/sns-dead-letter-queues.html#how-messages-moved-into-dead-letter-queue) for more details.
*
* @return builder
*
*/
public Builder redrivePolicy(@Nullable Output redrivePolicy) {
$.redrivePolicy = redrivePolicy;
return this;
}
/**
* @param redrivePolicy JSON String with the redrive policy that will be used in the subscription. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/sns-dead-letter-queues.html#how-messages-moved-into-dead-letter-queue) for more details.
*
* @return builder
*
*/
public Builder redrivePolicy(String redrivePolicy) {
return redrivePolicy(Output.of(redrivePolicy));
}
/**
* @param replayPolicy JSON String with the archived message replay policy that will be used in the subscription. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/message-archiving-and-replay-subscriber.html) for more details.
*
* @return builder
*
*/
public Builder replayPolicy(@Nullable Output replayPolicy) {
$.replayPolicy = replayPolicy;
return this;
}
/**
* @param replayPolicy JSON String with the archived message replay policy that will be used in the subscription. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/message-archiving-and-replay-subscriber.html) for more details.
*
* @return builder
*
*/
public Builder replayPolicy(String replayPolicy) {
return replayPolicy(Output.of(replayPolicy));
}
/**
* @param subscriptionRoleArn ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html).
*
* @return builder
*
*/
public Builder subscriptionRoleArn(@Nullable Output subscriptionRoleArn) {
$.subscriptionRoleArn = subscriptionRoleArn;
return this;
}
/**
* @param subscriptionRoleArn ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html).
*
* @return builder
*
*/
public Builder subscriptionRoleArn(String subscriptionRoleArn) {
return subscriptionRoleArn(Output.of(subscriptionRoleArn));
}
/**
* @param topic ARN of the SNS topic to subscribe to.
*
* The following arguments are optional:
*
* @return builder
*
*/
public Builder topic(Output topic) {
$.topic = topic;
return this;
}
/**
* @param topic ARN of the SNS topic to subscribe to.
*
* The following arguments are optional:
*
* @return builder
*
*/
public Builder topic(String topic) {
return topic(Output.of(topic));
}
public TopicSubscriptionArgs build() {
if ($.endpoint == null) {
throw new MissingRequiredPropertyException("TopicSubscriptionArgs", "endpoint");
}
if ($.protocol == null) {
throw new MissingRequiredPropertyException("TopicSubscriptionArgs", "protocol");
}
if ($.topic == null) {
throw new MissingRequiredPropertyException("TopicSubscriptionArgs", "topic");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy