Skip to content

Latest commit

 

History

History
67 lines (63 loc) · 8.92 KB

io.md

File metadata and controls

67 lines (63 loc) · 8.92 KB

Inputs

Name Description Type Default Required
application_failure_feedback_role_arn IAM role for failure feedback. string "" no
application_success_feedback_role_arn The IAM role permitted to receive success feedback for this topic. string "" no
application_success_feedback_sample_rate Percentage of success to sample. number 100 no
certificate application Platform principal. See Principal for type of principal required for platform. The value of this attribute when stored into the Terraform state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources. string "" no
content_based_deduplication Boolean indicating whether or not to enable content-based deduplication for FIFO topics. bool false no
create_topic_policy Determines whether an SNS topic policy is created bool true no
data_protection_policy A map of data protection policy statements string null no
default_sender_id A string, such as your business brand, that is displayed as the sender on the receiving device. string "" no
default_sms_type The type of SMS message that you will send by default. Possible values are: Promotional, Transactional. string "Transactional" no
delivery_policy The SNS delivery policy. string null no
delivery_status_iam_role_arn The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. string "" no
delivery_status_success_sampling_rate The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value must be between 0 and 100. number 50 no
display_name The display name for the SNS topic. string "" no
enable_default_topic_policy Specifies whether to enable the default topic policy. Defaults to true bool true no
enable_sms_preference Boolean indicating whether or not to update SNS SMS Preference. bool false no
enable_sns Boolean indicating whether or not to create sns. bool false no
enable_topic Boolean indicating whether or not to create topic. bool false no
enabled Boolean indicating whether or not to create sns module. bool true no
environment Environment (e.g. prod, dev, staging). string "" no
event_delivery_failure_topic_arn SNS Topic triggered when a delivery to any of the platform endpoints associated with your platform application encounters a permanent failure. string "" no
event_endpoint_created_topic_arn SNS Topic triggered when a new platform endpoint is added to your platform application. string "" no
event_endpoint_deleted_topic_arn SNS Topic triggered when an existing platform endpoint is deleted from your platform application. string "" no
event_endpoint_updated_topic_arn SNS Topic triggered when an existing platform endpoint is changed from your platform application. string "" no
failure_feedback_role_arn The IAM role permitted to receive failure feedback for this application. string "" no
fifo_topic Boolean indicating whether or not to create a FIFO (first-in-first-out) topic bool false no
gcm_key Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the Terraform state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources. string "" no
http_failure_feedback_role_arn IAM role for failure feedback. string "" no
http_success_feedback_role_arn The IAM role permitted to receive success feedback for this topic. string "" no
http_success_feedback_sample_rate Percentage of success to sample. number 100 no
key Application Platform credential. See Credential for type of credential required for platform. The value of this attribute when stored into the Terraform state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources. string "" no
kms_master_key_id The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information. string "" no
label_order Label order, e.g. name,application. list(any)
[
"name",
"environment"
]
no
lambda_failure_feedback_role_arn IAM role for failure feedback. string "" no
lambda_success_feedback_role_arn The IAM role permitted to receive success feedback for this topic. string "" no
lambda_success_feedback_sample_rate Percentage of success to sample. number 100 no
managedby ManagedBy, eg 'CloudDrove'. string "hello@clouddrove.com" no
monthly_spend_limit The maximum amount in USD that you are willing to spend each month to send SMS messages. number 1 no
name Name (e.g. app or cluster). string "" no
override_topic_policy_documents List of IAM policy documents that are merged together into the exported document. In merging, statements with non-blank sids will override statements with the same sid list(string) [] no
platform The platform that the app is registered with. See Platform for supported platforms like 'APNS' 'GCM'. string "" no
policy The fully-formed AWS policy as JSON. For more information about building AWS IAM policy documents with Terraform. string "" no
repository Terraform current module repo string "https://github.com/clouddrove/terraform-aws-sns" no
signature_version If SignatureVersion should be 1 (SHA1) or 2 (SHA256). 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. number null no
source_topic_policy_documents List of IAM policy documents that are merged together into the exported document. Statements must have unique sids list(string) [] no
sqs_failure_feedback_role_arn IAM role for failure feedback. string "" no
sqs_success_feedback_role_arn The IAM role permitted to receive success feedback for this topic. string "" no
sqs_success_feedback_sample_rate Percentage of success to sample. number 100 no
subscribers Required configuration for subscibres to SNS topic.
map(object({
protocol = string
# The protocol to use. The possible values for this are: sqs, sms, lambda, application. (http or https are partially supported, see below) (email is an option but is unsupported, see below).
endpoint = string
# The endpoint to send data to, the contents will vary with the protocol. (see below for more information)
endpoint_auto_confirms = bool
# Boolean indicating whether the end point is capable of auto confirming subscription e.g., PagerDuty (default is false)
raw_message_delivery = bool
# Boolean indicating whether or not 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)
filter_policy = string
# JSON String with the filter policy that will be used in the subscription to filter messages seen by the target resource.
delivery_policy = string
# The SNS delivery policy
confirmation_timeout_in_minutes = string
# Integer indicating number of minutes to wait in retying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols.
}))
{} no
success_feedback_role_arn The IAM role permitted to receive success feedback for this application. string "" no
success_feedback_sample_rate The percentage of success to sample (0-100). number 100 no
topic_policy_statements A map of IAM policy statements for custom permission usage any {} no
tracing_config Tracing mode of an Amazon SNS topic. Valid values: PassThrough, Active. string null no
usage_report_s3_bucket The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. string "" no

Outputs

Name Description
arn The ARN of the SNS platform application.
id The ID of the SNS platform application.
topic-arn The ARN of the SNS topic.
topic-id The ID of the SNS topic.