GradientEdge CDK Utils
    Preparing search index...

    Interface SubscriptionProps

    interface SubscriptionProps {
        contentBasedDeduplication?: boolean;
        displayName?: string;
        enforceSSL?: boolean;
        fifo?: boolean;
        fifoThroughputScope?: FifoThroughputScope;
        loggingConfigs?: LoggingConfig[];
        masterKey?: IKey;
        messageRetentionPeriodInDays?: number;
        signatureVersion?: string;
        topicName?: string;
        tracingConfig?: TracingConfig;
    }

    Hierarchy

    • TopicProps
      • SubscriptionProps
    Index

    Properties

    contentBasedDeduplication? displayName? enforceSSL? fifo? fifoThroughputScope? loggingConfigs? masterKey? messageRetentionPeriodInDays? signatureVersion? topicName? tracingConfig?

    Properties

    contentBasedDeduplication?: boolean

    Enables content-based deduplication for FIFO topics.

    None
    displayName?: string

    A developer-defined string that can be used to identify this SNS topic.

    The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.

    None
    enforceSSL?: boolean

    Adds a statement to enforce encryption of data in transit when publishing to the topic.

    https://docs.aws.amazon.com/sns/latest/dg/sns-security-best-practices.html#enforce-encryption-data-in-transit.

    false
    fifo?: boolean

    Set to true to create a FIFO topic.

    None
    fifoThroughputScope?: FifoThroughputScope

    Specifies the throughput quota and deduplication behavior to apply for the FIFO topic.

    You can only set this property when fifo is true.

    undefined - SNS default setting is FifoThroughputScope.TOPIC
    loggingConfigs?: LoggingConfig[]

    The list of delivery status logging configurations for the topic.

    https://docs.aws.amazon.com/sns/latest/dg/sns-topic-attributes.html.

    None
    masterKey?: IKey

    A KMS Key, either managed by this CDK app, or imported.

    None
    messageRetentionPeriodInDays?: number

    The number of days Amazon SNS retains messages.

    It can only be set for FIFO topics.

    https://docs.aws.amazon.com/sns/latest/dg/fifo-message-archiving-replay.html

    - do not archive messages
    signatureVersion?: string

    The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.

    https://docs.aws.amazon.com/sns/latest/dg/sns-verify-signature-of-message.html.

    1
    topicName?: string

    A name for the topic.

    If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the topic name. For more information, see Name Type.

    Generated name
    tracingConfig?: TracingConfig

    Tracing mode of an Amazon SNS topic.

    https://docs.aws.amazon.com/sns/latest/dg/sns-active-tracing.html

    TracingConfig.PASS_THROUGH

    Settings

    Member Visibility

    On This Page

    Properties