aws_sns
Sends messages to an AWS SNS topic.
Introduced in version 3.36.0.
-
Common
-
Advanced
# Common config fields, showing default values
output:
label: ""
aws_sns:
topic_arn: "" # No default (required)
message_group_id: "" # No default (optional)
message_deduplication_id: "" # No default (optional)
max_in_flight: 64
metadata:
exclude_prefixes: []
# All config fields, showing default values
output:
label: ""
aws_sns:
topic_arn: "" # No default (required)
message_group_id: "" # No default (optional)
message_deduplication_id: "" # No default (optional)
max_in_flight: 64
metadata:
exclude_prefixes: []
timeout: 5s
region: ""
endpoint: ""
credentials:
profile: ""
id: ""
secret: ""
token: ""
from_ec2_role: false
role: ""
role_external_id: ""
Credentials
By default Redpanda Connect will use a shared credentials file when connecting to AWS services. It’s also possible to set them explicitly at the component level, allowing you to transfer data across accounts. You can find out more in Amazon Web Services.
Performance
This output benefits from sending multiple messages in flight in parallel for improved performance. You can tune the max number of in flight messages (or message batches) with the field max_in_flight
.
Fields
message_group_id
An optional group ID to set for messages. This field supports interpolation functions.
Type: string
Requires version 3.60.0 or newer
message_deduplication_id
An optional deduplication ID to set for messages. This field supports interpolation functions.
Type: string
Requires version 3.60.0 or newer
max_in_flight
The maximum number of messages to have in flight at a given time. Increase this to improve throughput.
Type: int
Default: 64
metadata
Specify criteria for which metadata values are sent as headers.
Type: object
Requires version 3.60.0 or newer
metadata.exclude_prefixes
Provide a list of explicit metadata key prefixes to be excluded when adding metadata to sent messages.
Type: array
Default: []
timeout
The maximum period to wait on an upload before abandoning it and reattempting.
Type: string
Default: "5s"
credentials
Optional manual configuration of AWS credentials to use. More information can be found in Amazon Web Services.
Type: object
credentials.secret
The secret for the credentials being used.
This field contains sensitive information that usually shouldn’t be added to a config directly, read our secrets page for more info. |
Type: string
Default: ""
credentials.token
The token for the credentials being used, required when using short term credentials.
Type: string
Default: ""
credentials.from_ec2_role
Use the credentials of a host EC2 machine configured to assume an IAM role associated with the instance.
Type: bool
Default: false
Requires version 4.2.0 or newer