software.amazon.awscdk.services.sns

Enum SubscriptionProtocol

java.lang.Object

java.lang.Enum<SubscriptionProtocol>

software.amazon.awscdk.services.sns.SubscriptionProtocol

All Implemented Interfaces:

Serializable, Comparable<SubscriptionProtocol>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.244Z")
 @Stability(value=Stable)
public enum SubscriptionProtocol
extends Enum<SubscriptionProtocol>

The type of subscription, controlling the type of the endpoint parameter.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 import aws.cdk.lib.aws.kinesisfirehose.DeliveryStream;
 DeliveryStream stream;
 Topic topic = new Topic(this, "Topic");
 Subscription.Builder.create(this, "Subscription")
         .topic(topic)
         .endpoint(stream.getDeliveryStreamArn())
         .protocol(SubscriptionProtocol.FIREHOSE)
         .subscriptionRoleArn("SAMPLE_ARN")
         .build();
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLICATION JSON-encoded notifications are sent to a mobile app endpoint.
EMAIL Notifications are sent via email.
EMAIL_JSON Notifications are JSON-encoded and sent via mail.
FIREHOSE Notifications put records into a firehose delivery stream.
HTTP JSON-encoded message is POSTED to an HTTP url.
HTTPS JSON-encoded message is POSTed to an HTTPS url.
LAMBDA Notifications trigger a Lambda function.
SMS Notification is delivered by SMS.
SQS Notifications are enqueued into an SQS queue.

Method Summary

Modifier and Type	Method and Description
static SubscriptionProtocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static SubscriptionProtocol[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HTTP

@Stability(value=Stable)
public static final SubscriptionProtocol HTTP

JSON-encoded message is POSTED to an HTTP url.

HTTPS

@Stability(value=Stable)
public static final SubscriptionProtocol HTTPS

JSON-encoded message is POSTed to an HTTPS url.

EMAIL

@Stability(value=Stable)
public static final SubscriptionProtocol EMAIL

Notifications are sent via email.

EMAIL_JSON

@Stability(value=Stable)
public static final SubscriptionProtocol EMAIL_JSON

Notifications are JSON-encoded and sent via mail.

SMS

@Stability(value=Stable)
public static final SubscriptionProtocol SMS

Notification is delivered by SMS.

SQS

@Stability(value=Stable)
public static final SubscriptionProtocol SQS

Notifications are enqueued into an SQS queue.

APPLICATION

@Stability(value=Stable)
public static final SubscriptionProtocol APPLICATION

JSON-encoded notifications are sent to a mobile app endpoint.

LAMBDA

@Stability(value=Stable)
public static final SubscriptionProtocol LAMBDA

Notifications trigger a Lambda function.

FIREHOSE

@Stability(value=Stable)
public static final SubscriptionProtocol FIREHOSE

Notifications put records into a firehose delivery stream.

Method Detail

values

public static SubscriptionProtocol[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SubscriptionProtocol c : SubscriptionProtocol.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SubscriptionProtocol valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null