Terraform resource for managing an AWS EventBridge Pipes Pipe.
You can find out more about EventBridge Pipes in the User Guide.
EventBridge Pipes are very configurable, and may require IAM permissions to work correctly. More information on the configuration options and IAM permissions can be found in the User Guide.
data "aws_caller_identity" "main" {}
resource "aws_iam_role" "example" {
assume_role_policy = jsonencode({
Version = "2012-10-17"
Statement = {
Effect = "Allow"
Action = "sts:AssumeRole"
Principal = {
Service = "pipes.amazonaws.com"
}
Condition = {
StringEquals = {
"aws:SourceAccount" = data.aws_caller_identity.main.account_id
}
}
}
})
}
resource "aws_iam_role_policy" "source" {
role = aws_iam_role.example.id
policy = jsonencode({
Version = "2012-10-17"
Statement = [
{
Effect = "Allow"
Action = [
"sqs:DeleteMessage",
"sqs:GetQueueAttributes",
"sqs:ReceiveMessage",
],
Resource = [
aws_sqs_queue.source.arn,
]
},
]
})
}
resource "aws_sqs_queue" "source" {}
resource "aws_iam_role_policy" "target" {
role = aws_iam_role.example.id
policy = jsonencode({
Version = "2012-10-17"
Statement = [
{
Effect = "Allow"
Action = [
"sqs:SendMessage",
],
Resource = [
aws_sqs_queue.target.arn,
]
},
]
})
}
resource "aws_sqs_queue" "target" {}
resource "aws_pipes_pipe" "example" {
depends_on = [aws_iam_role_policy.source, aws_iam_role_policy.target]
name = "example-pipe"
role_arn = aws_iam_role.example.arn
source = aws_sqs_queue.source.arn
target = aws_sqs_queue.target.arn
}
resource "aws_pipes_pipe" "example" {
name = "example-pipe"
role_arn = aws_iam_role.example.arn
source = aws_sqs_queue.source.arn
target = aws_sqs_queue.target.arn
enrichment = aws_cloudwatch_event_api_destination.example.arn
enrichment_parameters {
http_parameters {
path_parameter_values = ["example-path-param"]
header_parameters = {
"example-header" = "example-value"
"second-example-header" = "second-example-value"
}
query_string_parameters = {
"example-query-string" = "example-value"
"second-example-query-string" = "second-example-value"
}
}
}
}
resource "aws_pipes_pipe" "example" {
name = "example-pipe"
role_arn = aws_iam_role.example.arn
source = aws_sqs_queue.source.arn
target = aws_sqs_queue.target.arn
source_parameters {
filter_criteria {
filter {
pattern = jsonencode({
source = ["event-source"]
})
}
}
}
}
resource "aws_pipes_pipe" "example" {
name = "example-pipe"
role_arn = aws_iam_role.example.arn
source = aws_sqs_queue.source.arn
target = aws_sqs_queue.target.arn
source_parameters {
sqs_queue_parameters {
batch_size = 1
maximum_batching_window_in_seconds = 2
}
}
target_parameters {
sqs_queue {
message_deduplication_id = "example-dedupe"
message_group_id = "example-group"
}
}
}
The following arguments are required:
role_arn
- (Required) ARN of the role that allows the pipe to send data to the target.source
- (Required) Source resource of the pipe. This field typically requires an ARN (Amazon Resource Name). However, when using a self-managed Kafka cluster, you should use a different format. Instead of an ARN, use 'smk://' followed by the bootstrap server's address.target
- (Required) Target resource of the pipe (typically an ARN).The following arguments are optional:
description
- (Optional) A description of the pipe. At most 512 characters.desired_state
- (Optional) The state the pipe should be in. One of: RUNNING
, STOPPED
.enrichment
- (Optional) Enrichment resource of the pipe (typically an ARN). Read more about enrichment in the User Guide.enrichment_parameters
- (Optional) Parameters to configure enrichment for your pipe. Detailed below.name
- (Optional) Name of the pipe. If omitted, Terraform will assign a random, unique name. Conflicts with name_prefix
.name_prefix
- (Optional) Creates a unique name beginning with the specified prefix. Conflicts with name
.source_parameters
- (Optional) Parameters to configure a source for the pipe. Detailed below.target_parameters
- (Optional) Parameters to configure a target for your pipe. Detailed below.tags
- (Optional) Key-value mapping of resource tags. If configured with a provider default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.You can find out more about EventBridge Pipes Enrichment in the User Guide.
input_template
- (Optional) Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. Maximum length of 8192 characters.http_parameters
- (Optional) Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination. If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence. Detailed below.header_parameters
- (Optional) Key-value mapping of the headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.path_parameter_values
- (Optional) The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").query_string_parameters
- (Optional) Key-value mapping of the query strings that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.You can find out more about EventBridge Pipes Sources in the User Guide.
activemq_broker_parameters
- (Optional) The parameters for using an Active MQ broker as a source. Detailed below.dynamodb_stream_parameters
- (Optional) The parameters for using a DynamoDB stream as a source. Detailed below.filter_criteria
- (Optional) The collection of event patterns used to filter events. Detailed below.kinesis_stream_parameters
- (Optional) The parameters for using a Kinesis stream as a source. Detailed below.managed_streaming_kafka_parameters
- (Optional) The parameters for using an MSK stream as a source. Detailed below.rabbitmq_broker_parameters
- (Optional) The parameters for using a Rabbit MQ broker as a source. Detailed below.self_managed_kafka_parameters
- (Optional) The parameters for using a self-managed Apache Kafka stream as a source. Detailed below.sqs_queue_parameters
- (Optional) The parameters for using a Amazon SQS stream as a source. Detailed below.filter
- (Optional) An array of up to 5 event patterns. Detailed below.pattern
- (Required) The event pattern. At most 4096 characters.batch_size
- (Optional) The maximum number of records to include in each batch. Maximum value of 10000.credentials
- (Required) The credentials needed to access the resource. Detailed below.maximum_batching_window_in_seconds
- (Optional) The maximum length of a time to wait for events. Maximum value of 300.queue_name
- (Required) The name of the destination queue to consume. Maximum length of 1000.basic_auth
- (Required) The ARN of the Secrets Manager secret containing the basic auth credentials.batch_size
- (Optional) The maximum number of records to include in each batch. Maximum value of 10000.dead_letter_config
- (Optional) Define the target queue to send dead-letter queue events to. Detailed below.maximum_batching_window_in_seconds
- (Optional) The maximum length of a time to wait for events. Maximum value of 300.maximum_record_age_in_seconds
- (Optional) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records. Maximum value of 604,800.maximum_retry_attempts
- (Optional) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source. Maximum value of 10,000.on_partial_batch_item_failure
- (Optional) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch. Valid values: AUTOMATIC_BISECT.parallelization_factor
- (Optional)The number of batches to process concurrently from each shard. The default value is 1. Maximum value of 10.starting_position
- (Optional) The position in a stream from which to start reading. Valid values: TRIM_HORIZON, LATEST.arn
- (Optional) The ARN of the Amazon SQS queue specified as the target for the dead-letter queue.batch_size
- (Optional) The maximum number of records to include in each batch. Maximum value of 10000.dead_letter_config
- (Optional) Define the target queue to send dead-letter queue events to. Detailed below.maximum_batching_window_in_seconds
- (Optional) The maximum length of a time to wait for events. Maximum value of 300.maximum_record_age_in_seconds
- (Optional) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records. Maximum value of 604,800.maximum_retry_attempts
- (Optional) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source. Maximum value of 10,000.on_partial_batch_item_failure
- (Optional) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch. Valid values: AUTOMATIC_BISECT.parallelization_factor
- (Optional)The number of batches to process concurrently from each shard. The default value is 1. Maximum value of 10.starting_position
- (Required) The position in a stream from which to start reading. Valid values: TRIM_HORIZON, LATEST, AT_TIMESTAMP.starting_position_timestamp
- (Optional) With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.arn
- (Optional) The ARN of the Amazon SQS queue specified as the target for the dead-letter queue.batch_size
- (Optional) The maximum number of records to include in each batch. Maximum value of 10000.consumer_group_id
- (Optional) The name of the destination queue to consume. Maximum value of 200.credentials
- (Optional) The credentials needed to access the resource. Detailed below.maximum_batching_window_in_seconds
- (Optional) The maximum length of a time to wait for events. Maximum value of 300.starting_position
- (Optional) The position in a stream from which to start reading. Valid values: TRIM_HORIZON, LATEST.topic_name
- (Required) The name of the topic that the pipe will read from. Maximum length of 249.client_certificate_tls_auth
- (Optional) The ARN of the Secrets Manager secret containing the credentials.sasl_scram_512_auth
- (Optional) The ARN of the Secrets Manager secret containing the credentials.batch_size
- (Optional) The maximum number of records to include in each batch. Maximum value of 10000.credentials
- (Required) The credentials needed to access the resource. Detailed below.maximum_batching_window_in_seconds
- (Optional) The maximum length of a time to wait for events. Maximum value of 300.queue_name
- (Required) The name of the destination queue to consume. Maximum length of 1000.virtual_host
- (Optional) The name of the virtual host associated with the source broker. Maximum length of 200.basic_auth
- (Required) The ARN of the Secrets Manager secret containing the credentials.additional_bootstrap_servers
- (Optional) An array of server URLs. Maximum number of 2 items, each of maximum length 300.batch_size
- (Optional) The maximum number of records to include in each batch. Maximum value of 10000.consumer_group_id
- (Optional) The name of the destination queue to consume. Maximum value of 200.credentials
- (Optional) The credentials needed to access the resource. Detailed below.maximum_batching_window_in_seconds
- (Optional) The maximum length of a time to wait for events. Maximum value of 300.server_root_ca_certificate
- (Optional) The ARN of the Secrets Manager secret used for certification.starting_position
- (Optional) The position in a stream from which to start reading. Valid values: TRIM_HORIZON, LATEST.topic_name
- (Required) The name of the topic that the pipe will read from. Maximum length of 249.vpc
- (Optional) This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used. Detailed below.basic_auth
- (Optional) The ARN of the Secrets Manager secret containing the credentials.client_certificate_tls_auth
- (Optional) The ARN of the Secrets Manager secret containing the credentials.sasl_scram_256_auth
- (Optional) The ARN of the Secrets Manager secret containing the credentials.sasl_scram_512_auth
- (Optional) The ARN of the Secrets Manager secret containing the credentials.security_groups
- (Optional) List of security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.subnets
- (Optional) List of the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.batch_size
- (Optional) The maximum number of records to include in each batch. Maximum value of 10000.maximum_batching_window_in_seconds
- (Optional) The maximum length of a time to wait for events. Maximum value of 300.You can find out more about EventBridge Pipes Targets in the User Guide.
batch_job_parameters
- (Optional) The parameters for using an AWS Batch job as a target. Detailed below.cloudwatch_logs_parameters
- (Optional) The parameters for using an CloudWatch Logs log stream as a target. Detailed below.ecs_task_parameters
- (Optional) The parameters for using an Amazon ECS task as a target. Detailed below.eventbridge_event_bus_parameters
- (Optional) The parameters for using an EventBridge event bus as a target. Detailed below.http_parameters
- (Optional) These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. Detailed below.input_template
- (Optional) Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. Maximum length of 8192 characters.kinesis_stream_parameters
- (Optional) The parameters for using a Kinesis stream as a source. Detailed below.lambda_function_parameters
- (Optional) The parameters for using a Lambda function as a target. Detailed below.redshift_data_parameters
- (Optional) These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement. Detailed below.sagemaker_pipeline_parameters
- (Optional) The parameters for using a SageMaker pipeline as a target. Detailed below.sqs_queue_parameters
- (Optional) The parameters for using a Amazon SQS stream as a target. Detailed below.step_function_state_machine_parameters
- (Optional) The parameters for using a Step Functions state machine as a target. Detailed below.array_properties
- (Optional) The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job. Detailed below.container_overrides
- (Optional) The overrides that are sent to a container. Detailed below.depends_on
- (Optional) A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin. Detailed below.job_definition
- (Required) The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.job_name
- (Required) The name of the job. It can be up to 128 letters long.parameters
- (Optional) Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition. Detailed below.retry_strategy
- (Optional) The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition. Detailed below.size
- (Optional) The size of the array, if this is an array batch job. Minimum value of 2. Maximum value of 10,000.command
- (Optional) List of commands to send to the container that overrides the default command from the Docker image or the task definition.environment
- (Optional) The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. Environment variables cannot start with " AWS Batch ". This naming convention is reserved for variables that AWS Batch sets. Detailed below.instance_type
- (Optional) The instance type to use for a multi-node parallel job. This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.resource_requirement
- (Optional) The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU. Detailed below.name
- (Optional) The name of the key-value pair. For environment variables, this is the name of the environment variable.value
- (Optional) The value of the key-value pair. For environment variables, this is the value of the environment variable.type
- (Optional) The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.value
- (Optional) The quantity of the specified resource to reserve for the container. The values vary based on the type specified.job_id
- (Optional) The job ID of the AWS Batch job that's associated with this dependency.type
- (Optional) The type of the job dependency. Valid Values: N_TO_N, SEQUENTIAL.attempts
- (Optional) The number of times to move a job to the RUNNABLE status. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value. Maximum value of 10.log_stream_name
- (Optional) The name of the log stream.timestamp
- (Optional) The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. This is the JSON path to the field in the event e.g. $.detail.timestampcapacity_provider_strategy
- (Optional) List of capacity provider strategies to use for the task. If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used. Detailed below.enable_ecs_managed_tags
- (Optional) Specifies whether to enable Amazon ECS managed tags for the task. Valid values: true, false.enable_execute_command
- (Optional) Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task. Valid values: true, false.group
- (Optional) Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.launch_type
- (Optional) Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. Valid Values: EC2, FARGATE, EXTERNALnetwork_configuration
- (Optional) Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks. If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails. Detailed below.overrides
- (Optional) The overrides that are associated with a task. Detailed below.placement_constraint
- (Optional) An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime). Detailed below.placement_strategy
- (Optional) The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task. Detailed below.platform_version
- (Optional) Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0. This structure is used only if LaunchType is FARGATE.propagate_tags
- (Optional) Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action. Valid Values: TASK_DEFINITIONreference_id
- (Optional) The reference ID to use for the task. Maximum length of 1,024.tags
- (Optional) Key-value map of tags that you apply to the task to help you categorize and organize them.task_count
- (Optional) The number of tasks to create based on TaskDefinition. The default is 1.task_definition_arn
- (Optional) The ARN of the task definition to use if the event target is an Amazon ECS task.base
- (Optional) The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used. Maximum value of 100,000.capacity_provider
- (Optional) The short name of the capacity provider. Maximum value of 255.weight
- (Optional) The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. Maximum value of 1,000.aws_vpc_configuration
- (Optional) Use this structure to specify the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode. Detailed below.assign_public_ip
- (Optional) Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE. Valid Values: ENABLED, DISABLED.security_groups
- (Optional) Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.subnets
- (Optional) Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.container_override
- (Optional) One or more container overrides that are sent to a task. Detailed below.cpu
- (Optional) The cpu override for the task.ephemeral_storage
- (Optional) The ephemeral storage setting override for the task. Detailed below.execution_role_arn
- (Optional) The Amazon Resource Name (ARN) of the task execution IAM role override for the task.inference_accelerator_override
- (Optional) List of Elastic Inference accelerator overrides for the task. Detailed below.memory
- (Optional) The memory override for the task.task_role_arn
- (Optional) The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.command
- (Optional) List of commands to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.cpu
- (Optional) The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.environment
- (Optional) The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name. Detailed below.environment_file
- (Optional) A list of files containing the environment variables to pass to a container, instead of the value from the container definition. Detailed below.memory
- (Optional) The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.memory_reservation
- (Optional) The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.name
- (Optional) The name of the container that receives the override. This parameter is required if any override is specified.resource_requirement
- (Optional) The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU. Detailed below.name
- (Optional) The name of the key-value pair. For environment variables, this is the name of the environment variable.value
- (Optional) The value of the key-value pair. For environment variables, this is the value of the environment variable.type
- (Optional) The file type to use. The only supported value is s3.value
- (Optional) The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.type
- (Optional) The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.value
- (Optional) The value for the specified resource type. If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.size_in_gib
- (Required) The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.device_name
- (Optional) The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.device_type
- (Optional) The Elastic Inference accelerator type to use.expression
- (Optional) A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. Maximum length of 2,000.type
- (Optional) The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. Valid Values: distinctInstance, memberOf.field
- (Optional) The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used. Maximum length of 255.type
- (Optional) The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task). Valid Values: random, spread, binpack.detail_type
- (Optional) A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.endpoint_id
- (Optional) The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.resources
- (Optional) List of AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.source
- (Optional) The source of the event. Maximum length of 256.time
- (Optional) The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used. This is the JSON path to the field in the event e.g. $.detail.timestampheader_parameters
- (Optional) Key-value mapping of the headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination. Detailed below.path_parameter_values
- (Optional) The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").query_string_parameters
- (Optional) Key-value mapping of the query strings that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination. Detailed below.partition_key
- (Required) Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.invocation_type
- (Optional) Specify whether to invoke the function synchronously or asynchronously. Valid Values: REQUEST_RESPONSE, FIRE_AND_FORGET.database
- (Required) The name of the database. Required when authenticating using temporary credentials.db_user
- (Optional) The database user name. Required when authenticating using temporary credentials.secret_manager_arn
- (Optional) The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets Manager.sqls
- (Optional) List of SQL statements text to run, each of maximum length of 100,000.statement_name
- (Optional) The name of the SQL statement. You can name the SQL statement when you create it to identify the query.with_event
- (Optional) Indicates whether to send an event back to EventBridge after the SQL statement runs.pipeline_parameter
- (Optional) List of Parameter names and values for SageMaker Model Building Pipeline execution. Detailed below.name
- (Optional) Name of parameter to start execution of a SageMaker Model Building Pipeline. Maximum length of 256.value
- (Optional) Value of parameter to start execution of a SageMaker Model Building Pipeline. Maximum length of 1024.message_deduplication_id
- (Optional) This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of sent messages.message_group_id
- (Optional) The FIFO message group ID to use as the target.invocation_type
- (Optional) Specify whether to invoke the function synchronously or asynchronously. Valid Values: REQUEST_RESPONSE, FIRE_AND_FORGET.This resource exports the following attributes in addition to the arguments above:
arn
- ARN of this pipe.id
- Same as name
.tags_all
- Map of tags assigned to the resource, including those inherited from the provider default_tags
configuration block.create
- (Default 30m
)update
- (Default 30m
)delete
- (Default 30m
)In Terraform v1.5.0 and later, use an import
block to import pipes using the name
. For example:
import {
to = aws_pipes_pipe.example
id = "my-pipe"
}
Using terraform import
, import pipes using the name
. For example:
% terraform import aws_pipes_pipe.example my-pipe