AwsSnsTopicSubscriptionArgs

interface AwsSnsTopicSubscriptionArgs extends Omit<AwsSnsTopicSubscriptionResourceArgs, 'topic' | 'endpoint' | 'protocol'> { confirmationTimeoutInMinutes?: Input<number | undefined>; createLambdaInvokePermission?: boolean; deliveryPolicy?: Input<string | undefined>; endpoint?: Input<string>; endpointAutoConfirms?: Input<boolean | undefined>; filterPolicy?: Input<string | undefined>; filterPolicyScope?: Input<string | undefined>; identity: string; lambdaFunction?: AwsSnsLambdaFunctionReference; protocol?: string; rawMessageDelivery?: Input<boolean | undefined>; redrivePolicy?: Input<string | undefined>; region?: Input<string | undefined>; replayPolicy?: Input<string | undefined>; subscriptionRoleArn?: Input<string | undefined>; topic: Input<string>; }

SNS topic-subscription inputs for AwsSns.

Hierarchy

  • Omit<AwsSnsTopicSubscriptionResourceArgs, "topic" | "endpoint" | "protocol">
  • AwsSnsTopicSubscriptionArgs

Properties

confirmationTimeoutInMinutes: Input<number | undefined>

Inherited from 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.

createLambdaInvokePermission: boolean

Whether to create the required Lambda resource-policy permission. Defaults to true for lambdaFunction.

deliveryPolicy: Input<string | undefined>

Inherited from 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 for more details.

endpoint: Input<string>

Existing externally managed subscription endpoint. Omit when lambdaFunction is set.

endpointAutoConfirms: Input<boolean | undefined>

Inherited from endpointAutoConfirms

Whether the endpoint is capable of auto confirming subscription (e.g., PagerDuty). Default is false.

filterPolicy: Input<string | undefined>

Inherited from 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 for more details.

filterPolicyScope: Input<string | undefined>

Inherited from filterPolicyScope

Whether the filterPolicy applies to MessageAttributes (default) or MessageBody.

identity: string

Inherited from identity

Stable logical-only identity for this subscription.

lambdaFunction: AwsSnsLambdaFunctionReference

Lambda function reference for a managed lambda protocol subscription.

protocol: string

Existing externally managed subscription protocol. Omit when lambdaFunction is set.

rawMessageDelivery: Input<boolean | undefined>

Inherited from 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.

redrivePolicy: Input<string | undefined>

Inherited from redrivePolicy

JSON String with the redrive policy that will be used in the subscription. Refer to the SNS docs for more details.

region: Input<string | undefined>

Inherited from region

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

replayPolicy: Input<string | undefined>

Inherited from replayPolicy

JSON String with the archived message replay policy that will be used in the subscription. Refer to the SNS docs for more details.

subscriptionRoleArn: Input<string | undefined>

Inherited from subscriptionRoleArn

ARN of the IAM role to publish to Kinesis Data Firehose delivery stream. Refer to SNS docs.

topic: Input<string>

Topic ARN or output from a compatible topic reference.