library
turbot/aws
OverviewPipelines
0
Triggers
0
Variables
GitHub

Subscribe to SNS Topic

Subscribes to a specified AWS SNS topic.

Run the pipeline

To run this pipeline from your terminal:

flowpipe pipeline run aws.pipeline.subscribe_to_sns_topic \
--arg 'region=<string>' \
--arg 'sns_topic_arn=<string>' \
--arg 'protocol=<string>' \
--arg 'endpoint=<string>'

Use this pipeline

To call this pipeline from your pipeline, use a step:

step "pipeline" "step_name" {
pipeline = aws.pipeline.subscribe_to_sns_topic
args = {
region = <string>
sns_topic_arn = <string>
protocol = <string>
endpoint = <string>
}
}

Params

NameTypeRequiredDescriptionDefault
regionstringYesThe name of the Region.-
credstringYesName for credentials to use. If not provided, the default credentials will be used.default
sns_topic_arnstringYesThe Amazon Resource Name (ARN) of the SNS topic to subscribe to.-
protocolstringYesThe protocol to use for the subscription (e.g., email, sms, lambda, etc.).-
endpointstringYesThe endpoint that will receive notifications.-

Outputs

NameDescription
subscription_arnThe ARN of the subscription if it is confirmed, or the string 'pending confirmation' if the subscription requires confirmation.