software.amazon.awscdk.services.sns.subscriptions.UrlSubscription Maven / Gradle / Ivy
Show all versions of sns-subscriptions Show documentation
package software.amazon.awscdk.services.sns.subscriptions;
/**
* Use a URL as a subscription target.
*
* The message will be POSTed to the given URL.
*
* @see https://docs.aws.amazon.com/sns/latest/dg/sns-http-https-endpoint-as-subscriber.html
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.15.0 (build 585166b)", date = "2020-12-22T12:13:02.075Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.sns.subscriptions.$Module.class, fqn = "@aws-cdk/aws-sns-subscriptions.UrlSubscription")
public class UrlSubscription extends software.amazon.jsii.JsiiObject implements software.amazon.awscdk.services.sns.ITopicSubscription {
protected UrlSubscription(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected UrlSubscription(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* @param url This parameter is required.
* @param props
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public UrlSubscription(final @org.jetbrains.annotations.NotNull java.lang.String url, final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.sns.subscriptions.UrlSubscriptionProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(url, "url is required"), props });
}
/**
* @param url This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public UrlSubscription(final @org.jetbrains.annotations.NotNull java.lang.String url) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(url, "url is required") });
}
/**
* Returns a configuration for a URL to subscribe to an SNS topic.
*
* @param _topic This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.sns.TopicSubscriptionConfig bind(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.sns.ITopic _topic) {
return software.amazon.jsii.Kernel.call(this, "bind", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.sns.TopicSubscriptionConfig.class), new Object[] { java.util.Objects.requireNonNull(_topic, "_topic is required") });
}
/**
* A fluent builder for {@link software.amazon.awscdk.services.sns.subscriptions.UrlSubscription}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param url This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static Builder create(final java.lang.String url) {
return new Builder(url);
}
private final java.lang.String url;
private software.amazon.awscdk.services.sns.subscriptions.UrlSubscriptionProps.Builder props;
private Builder(final java.lang.String url) {
this.url = url;
}
/**
* Queue to be used as dead letter queue.
*
* If not passed no dead letter queue is enabled.
*
* Default: - No dead letter queue enabled.
*
* @return {@code this}
* @param deadLetterQueue Queue to be used as dead letter queue. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder deadLetterQueue(final software.amazon.awscdk.services.sqs.IQueue deadLetterQueue) {
this.props().deadLetterQueue(deadLetterQueue);
return this;
}
/**
* The filter policy.
*
* Default: - all messages are delivered
*
* @return {@code this}
* @param filterPolicy The filter policy. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder filterPolicy(final java.util.Map filterPolicy) {
this.props().filterPolicy(filterPolicy);
return this;
}
/**
* The subscription's protocol.
*
* Default: - Protocol is derived from url
*
* @return {@code this}
* @param protocol The subscription's protocol. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder protocol(final software.amazon.awscdk.services.sns.SubscriptionProtocol protocol) {
this.props().protocol(protocol);
return this;
}
/**
* The message to the queue is the same as it was sent to the topic.
*
* If false, the message will be wrapped in an SNS envelope.
*
* Default: false
*
* @return {@code this}
* @param rawMessageDelivery The message to the queue is the same as it was sent to the topic. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder rawMessageDelivery(final java.lang.Boolean rawMessageDelivery) {
this.props().rawMessageDelivery(rawMessageDelivery);
return this;
}
/**
* @returns a newly built instance of {@link software.amazon.awscdk.services.sns.subscriptions.UrlSubscription}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public software.amazon.awscdk.services.sns.subscriptions.UrlSubscription build() {
return new software.amazon.awscdk.services.sns.subscriptions.UrlSubscription(
this.url,
this.props != null ? this.props.build() : null
);
}
private software.amazon.awscdk.services.sns.subscriptions.UrlSubscriptionProps.Builder props() {
if (this.props == null) {
this.props = new software.amazon.awscdk.services.sns.subscriptions.UrlSubscriptionProps.Builder();
}
return this.props;
}
}
}