This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# Amazon EventBridge Pipes
<a name="AWS_Pipes"></a>

**Resource types**
+ [AWS::Pipes::Pipe](aws-resource-pipes-pipe.md)

# AWS::Pipes::Pipe
<a name="aws-resource-pipes-pipe"></a>

Specifies a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

**Note**  
As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see [Generate an CloudFormation template from EventBridge Pipes](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html) in the *Amazon EventBridge User Guide*.

## Syntax
<a name="aws-resource-pipes-pipe-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-pipes-pipe-syntax.json"></a>

```
{
  "Type" : "AWS::Pipes::Pipe",
  "Properties" : {
      "[Description](#cfn-pipes-pipe-description)" : String,
      "[DesiredState](#cfn-pipes-pipe-desiredstate)" : String,
      "[Enrichment](#cfn-pipes-pipe-enrichment)" : String,
      "[EnrichmentParameters](#cfn-pipes-pipe-enrichmentparameters)" : PipeEnrichmentParameters,
      "[KmsKeyIdentifier](#cfn-pipes-pipe-kmskeyidentifier)" : String,
      "[LogConfiguration](#cfn-pipes-pipe-logconfiguration)" : PipeLogConfiguration,
      "[Name](#cfn-pipes-pipe-name)" : String,
      "[RoleArn](#cfn-pipes-pipe-rolearn)" : String,
      "[Source](#cfn-pipes-pipe-source)" : String,
      "[SourceParameters](#cfn-pipes-pipe-sourceparameters)" : PipeSourceParameters,
      "[Tags](#cfn-pipes-pipe-tags)" : {Key: Value, ...},
      "[Target](#cfn-pipes-pipe-target)" : String,
      "[TargetParameters](#cfn-pipes-pipe-targetparameters)" : PipeTargetParameters
    }
}
```

### YAML
<a name="aws-resource-pipes-pipe-syntax.yaml"></a>

```
Type: AWS::Pipes::Pipe
Properties:
  [Description](#cfn-pipes-pipe-description): String
  [DesiredState](#cfn-pipes-pipe-desiredstate): String
  [Enrichment](#cfn-pipes-pipe-enrichment): String
  [EnrichmentParameters](#cfn-pipes-pipe-enrichmentparameters): 
    PipeEnrichmentParameters
  [KmsKeyIdentifier](#cfn-pipes-pipe-kmskeyidentifier): String
  [LogConfiguration](#cfn-pipes-pipe-logconfiguration): 
    PipeLogConfiguration
  [Name](#cfn-pipes-pipe-name): String
  [RoleArn](#cfn-pipes-pipe-rolearn): String
  [Source](#cfn-pipes-pipe-source): String
  [SourceParameters](#cfn-pipes-pipe-sourceparameters): 
    PipeSourceParameters
  [Tags](#cfn-pipes-pipe-tags): 
    Key: Value
  [Target](#cfn-pipes-pipe-target): String
  [TargetParameters](#cfn-pipes-pipe-targetparameters): 
    PipeTargetParameters
```

## Properties
<a name="aws-resource-pipes-pipe-properties"></a>

`Description`  <a name="cfn-pipes-pipe-description"></a>
A description of the pipe.  
*Required*: No  
*Type*: String  
*Pattern*: `^.*$`  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DesiredState`  <a name="cfn-pipes-pipe-desiredstate"></a>
The state the pipe should be in.  
*Required*: No  
*Type*: String  
*Allowed values*: `RUNNING | STOPPED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Enrichment`  <a name="cfn-pipes-pipe-enrichment"></a>
The ARN of the enrichment resource.  
*Required*: No  
*Type*: String  
*Pattern*: `^$|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$`  
*Minimum*: `0`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnrichmentParameters`  <a name="cfn-pipes-pipe-enrichmentparameters"></a>
The parameters required to set up enrichment on your pipe.  
*Required*: No  
*Type*: [PipeEnrichmentParameters](aws-properties-pipes-pipe-pipeenrichmentparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsKeyIdentifier`  <a name="cfn-pipes-pipe-kmskeyidentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.  
To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.  
To update a pipe that is using a customer managed key to use the default AWS owned key, specify an empty string.  
For more information, see [Managing keys](https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html) in the *AWS Key Management Service Developer Guide*.   
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LogConfiguration`  <a name="cfn-pipes-pipe-logconfiguration"></a>
The logging configuration settings for the pipe.  
*Required*: No  
*Type*: [PipeLogConfiguration](aws-properties-pipes-pipe-pipelogconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-pipes-pipe-name"></a>
The name of the pipe.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\.\-_A-Za-z0-9]+$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RoleArn`  <a name="cfn-pipes-pipe-rolearn"></a>
The ARN of the role that allows the pipe to send data to the target.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z0-9+=,.@\-_/]+$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Source`  <a name="cfn-pipes-pipe-source"></a>
The ARN of the source resource.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^smk://(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]):[0-9]{1,5}|arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceParameters`  <a name="cfn-pipes-pipe-sourceparameters"></a>
The parameters required to set up a source for your pipe.  
*Required*: No  
*Type*: [PipeSourceParameters](aws-properties-pipes-pipe-pipesourceparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-pipes-pipe-tags"></a>
The list of key-value pairs to associate with the pipe.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Target`  <a name="cfn-pipes-pipe-target"></a>
The ARN of the target resource.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetParameters`  <a name="cfn-pipes-pipe-targetparameters"></a>
The parameters required to set up a target for your pipe.  
For more information about pipe target parameters, including how to use dynamic path parameters, see [Target parameters](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) in the *Amazon EventBridge User Guide*.  
*Required*: No  
*Type*: [PipeTargetParameters](aws-properties-pipes-pipe-pipetargetparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-pipes-pipe-return-values"></a>

### Ref
<a name="aws-resource-pipes-pipe-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the name of the pipe that was created by the request.

### Fn::GetAtt
<a name="aws-resource-pipes-pipe-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-pipes-pipe-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the pipe.

`CreationTime`  <a name="CreationTime-fn::getatt"></a>
The time the pipe was created.

`CurrentState`  <a name="CurrentState-fn::getatt"></a>
The state the pipe is in.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
When the pipe was last updated, in [ISO-8601 format](https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).

`StateReason`  <a name="StateReason-fn::getatt"></a>
The reason the pipe is in its current state.

## Examples
<a name="aws-resource-pipes-pipe--examples"></a>



**Topics**
+ [Create a Pipe with an enrichment](#aws-resource-pipes-pipe--examples--Create_a_Pipe_with_an_enrichment)
+ [Create a pipe with an event filter](#aws-resource-pipes-pipe--examples--Create_a_pipe_with_an_event_filter)

### Create a Pipe with an enrichment
<a name="aws-resource-pipes-pipe--examples--Create_a_Pipe_with_an_enrichment"></a>

Create a Pipe with an Amazon SQS source, an API Gateway enrichment, and a Step Functions state machine target.

#### JSON
<a name="aws-resource-pipes-pipe--examples--Create_a_Pipe_with_an_enrichment--json"></a>

```
{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "TestPipe": {
      "Type": "AWS::Pipes::Pipe",
      "Properties": {
        "Name": "PipeCfnExample",
        "RoleArn": "arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role",
        "Source": "arn:aws:sqs:us-east-1:123456789123:pipeDemoSource",
        "Enrichment": "arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets",
        "Target": "arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine"
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-pipes-pipe--examples--Create_a_Pipe_with_an_enrichment--yaml"></a>

```
AWSTemplateFormatVersion: 2010-09-09
Resources:
  TestPipe:
    Type: AWS::Pipes::Pipe
    Properties:
      Name:  PipeCfnExample
      RoleArn: arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role
      Source: arn:aws:sqs:us-east-1:123456789123:pipeDemoSource
      Enrichment: arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets
      Target: arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine
```

### Create a pipe with an event filter
<a name="aws-resource-pipes-pipe--examples--Create_a_pipe_with_an_event_filter"></a>

The following example:
+ Provisions a DynamoDB table and associated data stream to act as the pipe source, and a Amazon SQS queue for the pipe target.
+ Provisions an IAM execution role for the pipe that defines the necessary permissions to access both the source and target. 
+ Creates a pipe that connects the DynamoDB stream source to the Amazon SQS queue target.
+ Within the pipe, defines an event filter with an event pattern that selects events where `eventname` is `INSERT` or `MODIFY`.

**Note**  
Be aware that you will be billed for the AWS resources used if you create a stack from this template.

#### JSON
<a name="aws-resource-pipes-pipe--examples--Create_a_pipe_with_an_event_filter--json"></a>

```
{
  "AWSTemplateFormatVersion": "2010-09-09",

 "Description" : "EventBridge Pipe template example. Provisions a pipe, along with a DynamoDB stream as the pipe source and an SQS queue as the pipe target. Also provisions an execution role that contains the necessary permissions to access both the source and target. Once provisioned, the pipe receives events from the DynamoDB data stream, applies a filter, and sends matching events on to an SQS Queue. You will be billed for the Amazon resources used if you create a stack from this template.",

  "Parameters" : {
    "SourceTableName" : {
      "Type" : "String",
      "Default" : "pipe-example-source",
      "Description" : "Specify the name of the table to provision as the pipe source, or accept the default."
    },
  "TargetQueueName" : {
    "Type" : "String",
    "Default" : "pipe-example-target",
    "Description" : "Specify the name of the queue to provision as the pipe target, or accept the default."
  },
    "PipeName" : {
      "Type" : "String",
      "Default" : "pipe-with-filtering-example",
      "Description" : "Specify the name of the table to provision as the pipe source, or accept the default."
    }
},
  "Resources": {
    "PipeSourceDynamoDBTable": {
      "Type": "AWS::DynamoDB::Table",
      "Properties": {
        "AttributeDefinitions": [{
            "AttributeName": "Album",
            "AttributeType": "S"
          },
          {
            "AttributeName": "Artist",
            "AttributeType": "S"
          }

        ],
        "KeySchema": [{
            "AttributeName": "Album",
            "KeyType": "HASH"

          },
          {
            "AttributeName": "Artist",
            "KeyType": "RANGE"
          }
        ],
        "ProvisionedThroughput": {
          "ReadCapacityUnits": 10,
          "WriteCapacityUnits": 10
        },
        "StreamSpecification": {
          "StreamViewType": "NEW_AND_OLD_IMAGES"
        },
        "TableName": { "Ref" : "SourceTableName" }
      }
    },
    "PipeTargetQueue": {
      "Type": "AWS::SQS::Queue",
      "Properties": {
        "QueueName": { "Ref" : "TargetQueueName" }
      }
    },
    "PipeTutorialPipeRole": {
      "Type": "AWS::IAM::Role",
      "Properties": {
        "AssumeRolePolicyDocument": {
          "Version": "2012-10-17"		 	 	 ,
          "Statement": [{
            "Effect": "Allow",
            "Principal": {
              "Service": "pipes.amazonaws.com"
            },
            "Action": "sts:AssumeRole",
            "Condition": {
              "StringLike": {
                "aws:SourceArn": {
	"Fn::Join": [
		"", 
                [
                  "arn:",
                  { "Ref": "AWS::Partition" },
                  ":pipes:",
                  { "Ref": "AWS::Region" },
                  ":",
                  { "Ref": "AWS::AccountId" },
                  ":pipe/",
                  { "Ref": "PipeName" }
               ]
	]
       },
                "aws:SourceAccount": { "Ref" : "AWS::AccountId" }
              }
            }
          }]
        },
        "Description" : "EventBridge Pipe template example. Execution role that grants the pipe the permissions necessary to send events to the specified pipe.",
        "Path": "/",
        "Policies": [{
            "PolicyName": "SourcePermissions",
            "PolicyDocument": {
              "Version": "2012-10-17"		 	 	 ,
              "Statement": [{
                "Effect": "Allow",
                "Action": [
                  "dynamodb:DescribeStream",
                  "dynamodb:GetRecords",
                  "dynamodb:GetShardIterator",
                  "dynamodb:ListStreams"
                ],
                "Resource": [
                  { "Fn::GetAtt" : [ "PipeSourceDynamoDBTable", "StreamArn" ] }
                ]
              }]
            }
          },
          {
            "PolicyName": "TargetPermissions",
            "PolicyDocument": {
              "Version": "2012-10-17"		 	 	 ,
              "Statement": [{
                "Effect": "Allow",
                "Action": [
                  "sqs:SendMessage"
                ],
                "Resource": [
                  { "Fn::GetAtt" : [ "PipeTargetQueue", "Arn" ] }
                ]
              }]
            }
          }
        ]
      }
  },
    "PipeWithFiltering": {
      "Type": "AWS::Pipes::Pipe",
      "Properties": {
        "Description" : "EventBridge Pipe template example. Pipe that receives events from a DynamoDB stream, applies a filter, and sends matching events on to an SQS Queue.",
        "Name": { "Ref" : "PipeName" },
        "RoleArn": {"Fn::GetAtt" : ["PipeTutorialPipeRole", "Arn"] },
        "Source": { "Fn::GetAtt" : [ "PipeSourceDynamoDBTable", "StreamArn" ] },
        "SourceParameters": {
          "DynamoDBStreamParameters" : {
            "StartingPosition" : "LATEST"
         },
        "FilterCriteria" : {
          "Filters" : [ {
            "Pattern" : "{ \"eventName\": [\"INSERT\", \"MODIFY\"] }"
         }]
        }
        },
        "Target": { "Fn::GetAtt" : [ "PipeTargetQueue", "Arn" ] }
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-pipes-pipe--examples--Create_a_pipe_with_an_event_filter--yaml"></a>

```
AWSTemplateFormatVersion: 2010-09-09
Description: >-
  EventBridge Pipe template example. Provisions a pipe, along with a DynamoDB
  stream as the pipe source and an SQS queue as the pipe target. Also provisions
  an execution role that contains the necessary permissions to access both the
  source and target. Once provisioned, the pipe receives events from the
  DynamoDB data stream, applies a filter, and sends matching events on to an SQS
  Queue. You will be billed for the Amazon resources used if you create a stack
  from this template.
Parameters:
  SourceTableName:
    Type: String
    Default: pipe-example-source
    Description: >-
      Specify the name of the table to provision as the pipe source, or accept
      the default.
  TargetQueueName:
    Type: String
    Default: pipe-example-target
    Description: >-
      Specify the name of the queue to provision as the pipe target, or accept
      the default.
  PipeName:
    Type: String
    Default: pipe-with-filtering-example
    Description: >-
      Specify the name of the table to provision as the pipe source, or accept
      the default.
Resources:
  PipeSourceDynamoDBTable:
    Type: 'AWS::DynamoDB::Table'
    Properties:
      AttributeDefinitions:
        - AttributeName: Album
          AttributeType: S
        - AttributeName: Artist
          AttributeType: S
      KeySchema:
        - AttributeName: Album
          KeyType: HASH
        - AttributeName: Artist
          KeyType: RANGE
      ProvisionedThroughput:
        ReadCapacityUnits: 10
        WriteCapacityUnits: 10
      StreamSpecification:
        StreamViewType: NEW_AND_OLD_IMAGES
      TableName:
        Ref: SourceTableName
  PipeTargetQueue:
    Type: 'AWS::SQS::Queue'
    Properties:
      QueueName:
        Ref: TargetQueueName
  PipeTutorialPipeRole:
    Type: 'AWS::IAM::Role'
    Properties:
      AssumeRolePolicyDocument:
        Version: 2012-10-17
        Statement:
          - Effect: Allow
            Principal:
              Service: pipes.amazonaws.com
            Action: 'sts:AssumeRole'
            Condition:
              StringLike:
                'aws:SourceArn':
                  'Fn::Join':
                    - ''
                    - - 'arn:'
                      - Ref: 'AWS::Partition'
                      - ':pipes:'
                      - Ref: 'AWS::Region'
                      - ':'
                      - Ref: 'AWS::AccountId'
                      - ':pipe/'
                      - Ref: PipeName
                'aws:SourceAccount':
                  Ref: 'AWS::AccountId'
      Description: >-
        EventBridge Pipe template example. Execution role that grants the pipe
        the permissions necessary to send events to the specified pipe.
      Path: /
      Policies:
        - PolicyName: SourcePermissions
          PolicyDocument:
            Version: 2012-10-17
            Statement:
              - Effect: Allow
                Action:
                  - 'dynamodb:DescribeStream'
                  - 'dynamodb:GetRecords'
                  - 'dynamodb:GetShardIterator'
                  - 'dynamodb:ListStreams'
                Resource:
                  - 'Fn::GetAtt':
                      - PipeSourceDynamoDBTable
                      - StreamArn
        - PolicyName: TargetPermissions
          PolicyDocument:
            Version: 2012-10-17
            Statement:
              - Effect: Allow
                Action:
                  - 'sqs:SendMessage'
                Resource:
                  - 'Fn::GetAtt':
                      - PipeTargetQueue
                      - Arn
  PipeWithFiltering:
    Type: 'AWS::Pipes::Pipe'
    Properties:
      Description: >-
        EventBridge Pipe template example. Pipe that receives events from a
        DynamoDB stream, applies a filter, and sends matching events on to an
        SQS Queue.
      Name:
        Ref: PipeName
      RoleArn:
        'Fn::GetAtt':
          - PipeTutorialPipeRole
          - Arn
      Source:
        'Fn::GetAtt':
          - PipeSourceDynamoDBTable
          - StreamArn
      SourceParameters:
        DynamoDBStreamParameters:
          StartingPosition: LATEST
        FilterCriteria:
          Filters:
            - Pattern: '{ "eventName": ["INSERT", "MODIFY"] }'
      Target:
        'Fn::GetAtt':
          - PipeTargetQueue
          - Arn
```

# AWS::Pipes::Pipe AwsVpcConfiguration
<a name="aws-properties-pipes-pipe-awsvpcconfiguration"></a>

This structure specifies 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.

## Syntax
<a name="aws-properties-pipes-pipe-awsvpcconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-awsvpcconfiguration-syntax.json"></a>

```
{
  "[AssignPublicIp](#cfn-pipes-pipe-awsvpcconfiguration-assignpublicip)" : String,
  "[SecurityGroups](#cfn-pipes-pipe-awsvpcconfiguration-securitygroups)" : [ String, ... ],
  "[Subnets](#cfn-pipes-pipe-awsvpcconfiguration-subnets)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-pipes-pipe-awsvpcconfiguration-syntax.yaml"></a>

```
  [AssignPublicIp](#cfn-pipes-pipe-awsvpcconfiguration-assignpublicip): String
  [SecurityGroups](#cfn-pipes-pipe-awsvpcconfiguration-securitygroups): 
    - String
  [Subnets](#cfn-pipes-pipe-awsvpcconfiguration-subnets): 
    - String
```

## Properties
<a name="aws-properties-pipes-pipe-awsvpcconfiguration-properties"></a>

`AssignPublicIp`  <a name="cfn-pipes-pipe-awsvpcconfiguration-assignpublicip"></a>
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`.  
*Required*: No  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecurityGroups`  <a name="cfn-pipes-pipe-awsvpcconfiguration-securitygroups"></a>
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.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1 | 0`  
*Maximum*: `1024 | 5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Subnets`  <a name="cfn-pipes-pipe-awsvpcconfiguration-subnets"></a>
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 0`  
*Maximum*: `1024 | 16`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe BatchArrayProperties
<a name="aws-properties-pipes-pipe-batcharrayproperties"></a>

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.

## Syntax
<a name="aws-properties-pipes-pipe-batcharrayproperties-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-batcharrayproperties-syntax.json"></a>

```
{
  "[Size](#cfn-pipes-pipe-batcharrayproperties-size)" : Integer
}
```

### YAML
<a name="aws-properties-pipes-pipe-batcharrayproperties-syntax.yaml"></a>

```
  [Size](#cfn-pipes-pipe-batcharrayproperties-size): Integer
```

## Properties
<a name="aws-properties-pipes-pipe-batcharrayproperties-properties"></a>

`Size`  <a name="cfn-pipes-pipe-batcharrayproperties-size"></a>
The size of the array, if this is an array batch job.  
*Required*: No  
*Type*: Integer  
*Minimum*: `2`  
*Maximum*: `10000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe BatchContainerOverrides
<a name="aws-properties-pipes-pipe-batchcontaineroverrides"></a>

The overrides that are sent to a container.

## Syntax
<a name="aws-properties-pipes-pipe-batchcontaineroverrides-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-batchcontaineroverrides-syntax.json"></a>

```
{
  "[Command](#cfn-pipes-pipe-batchcontaineroverrides-command)" : [ String, ... ],
  "[Environment](#cfn-pipes-pipe-batchcontaineroverrides-environment)" : [ BatchEnvironmentVariable, ... ],
  "[InstanceType](#cfn-pipes-pipe-batchcontaineroverrides-instancetype)" : String,
  "[ResourceRequirements](#cfn-pipes-pipe-batchcontaineroverrides-resourcerequirements)" : [ BatchResourceRequirement, ... ]
}
```

### YAML
<a name="aws-properties-pipes-pipe-batchcontaineroverrides-syntax.yaml"></a>

```
  [Command](#cfn-pipes-pipe-batchcontaineroverrides-command): 
    - String
  [Environment](#cfn-pipes-pipe-batchcontaineroverrides-environment): 
    - BatchEnvironmentVariable
  [InstanceType](#cfn-pipes-pipe-batchcontaineroverrides-instancetype): String
  [ResourceRequirements](#cfn-pipes-pipe-batchcontaineroverrides-resourcerequirements): 
    - BatchResourceRequirement
```

## Properties
<a name="aws-properties-pipes-pipe-batchcontaineroverrides-properties"></a>

`Command`  <a name="cfn-pipes-pipe-batchcontaineroverrides-command"></a>
The command to send to the container that overrides the default command from the Docker image or the task definition.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Environment`  <a name="cfn-pipes-pipe-batchcontaineroverrides-environment"></a>
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.
*Required*: No  
*Type*: Array of [BatchEnvironmentVariable](aws-properties-pipes-pipe-batchenvironmentvariable.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstanceType`  <a name="cfn-pipes-pipe-batchcontaineroverrides-instancetype"></a>
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.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceRequirements`  <a name="cfn-pipes-pipe-batchcontaineroverrides-resourcerequirements"></a>
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`.  
*Required*: No  
*Type*: Array of [BatchResourceRequirement](aws-properties-pipes-pipe-batchresourcerequirement.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe BatchEnvironmentVariable
<a name="aws-properties-pipes-pipe-batchenvironmentvariable"></a>

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.

**Note**  
Environment variables cannot start with "` AWS Batch `". This naming convention is reserved for variables that AWS Batch sets.

## Syntax
<a name="aws-properties-pipes-pipe-batchenvironmentvariable-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-batchenvironmentvariable-syntax.json"></a>

```
{
  "[Name](#cfn-pipes-pipe-batchenvironmentvariable-name)" : String,
  "[Value](#cfn-pipes-pipe-batchenvironmentvariable-value)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-batchenvironmentvariable-syntax.yaml"></a>

```
  [Name](#cfn-pipes-pipe-batchenvironmentvariable-name): String
  [Value](#cfn-pipes-pipe-batchenvironmentvariable-value): String
```

## Properties
<a name="aws-properties-pipes-pipe-batchenvironmentvariable-properties"></a>

`Name`  <a name="cfn-pipes-pipe-batchenvironmentvariable-name"></a>
The name of the key-value pair. For environment variables, this is the name of the environment variable.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-pipes-pipe-batchenvironmentvariable-value"></a>
The value of the key-value pair. For environment variables, this is the value of the environment variable.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe BatchJobDependency
<a name="aws-properties-pipes-pipe-batchjobdependency"></a>

An object that represents an AWS Batch job dependency.

## Syntax
<a name="aws-properties-pipes-pipe-batchjobdependency-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-batchjobdependency-syntax.json"></a>

```
{
  "[JobId](#cfn-pipes-pipe-batchjobdependency-jobid)" : String,
  "[Type](#cfn-pipes-pipe-batchjobdependency-type)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-batchjobdependency-syntax.yaml"></a>

```
  [JobId](#cfn-pipes-pipe-batchjobdependency-jobid): String
  [Type](#cfn-pipes-pipe-batchjobdependency-type): String
```

## Properties
<a name="aws-properties-pipes-pipe-batchjobdependency-properties"></a>

`JobId`  <a name="cfn-pipes-pipe-batchjobdependency-jobid"></a>
The job ID of the AWS Batch job that's associated with this dependency.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-pipes-pipe-batchjobdependency-type"></a>
The type of the job dependency.  
*Required*: No  
*Type*: String  
*Allowed values*: `N_TO_N | SEQUENTIAL`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe BatchResourceRequirement
<a name="aws-properties-pipes-pipe-batchresourcerequirement"></a>

The type and amount of a resource to assign to a container. The supported resources include `GPU`, `MEMORY`, and `VCPU`.

## Syntax
<a name="aws-properties-pipes-pipe-batchresourcerequirement-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-batchresourcerequirement-syntax.json"></a>

```
{
  "[Type](#cfn-pipes-pipe-batchresourcerequirement-type)" : String,
  "[Value](#cfn-pipes-pipe-batchresourcerequirement-value)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-batchresourcerequirement-syntax.yaml"></a>

```
  [Type](#cfn-pipes-pipe-batchresourcerequirement-type): String
  [Value](#cfn-pipes-pipe-batchresourcerequirement-value): String
```

## Properties
<a name="aws-properties-pipes-pipe-batchresourcerequirement-properties"></a>

`Type`  <a name="cfn-pipes-pipe-batchresourcerequirement-type"></a>
The type of resource to assign to a container. The supported resources include `GPU`, `MEMORY`, and `VCPU`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `GPU | MEMORY | VCPU`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-pipes-pipe-batchresourcerequirement-value"></a>
The quantity of the specified resource to reserve for the container. The values vary based on the `type` specified.    
type="GPU"  
The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.  
GPUs aren't available for jobs that are running on Fargate resources.  
type="MEMORY"  
The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to `Memory` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.docker.com/engine/reference/run/). You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to `Memory` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--memory` option to [docker run](https://docs.docker.com/engine/reference/run/).  
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see [Memory management](https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html) in the *AWS Batch User Guide*.
For jobs that are running on Fargate resources, then `value` is the hard limit (in MiB), and must match one of the supported values and the `VCPU` values must be one of the values supported for that memory value.    
value = 512  
`VCPU` = 0.25  
value = 1024  
`VCPU` = 0.25 or 0.5  
value = 2048  
`VCPU` = 0.25, 0.5, or 1  
value = 3072  
`VCPU` = 0.5, or 1  
value = 4096  
`VCPU` = 0.5, 1, or 2  
value = 5120, 6144, or 7168  
`VCPU` = 1 or 2  
value = 8192  
`VCPU` = 1, 2, 4, or 8  
value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360  
`VCPU` = 2 or 4  
value = 16384  
`VCPU` = 2, 4, or 8  
value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720  
`VCPU` = 4  
value = 20480, 24576, or 28672  
`VCPU` = 4 or 8  
value = 36864, 45056, 53248, or 61440  
`VCPU` = 8  
value = 32768, 40960, 49152, or 57344  
`VCPU` = 8 or 16  
value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880  
`VCPU` = 16  
type="VCPU"  
The number of vCPUs reserved for the container. This parameter maps to `CpuShares` in the [ Create a container](https://docs.docker.com/engine/api/v1.23/#create-a-container) section of the [Docker Remote API](https://docs.docker.com/engine/api/v1.23/) and the `--cpu-shares` option to [docker run](https://docs.docker.com/engine/reference/run/). Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.  
The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see [AWS Fargate quotas](https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate) in the *AWS General Reference*.  
For jobs that are running on Fargate resources, then `value` must match one of the supported values and the `MEMORY` values must be one of the values supported for that `VCPU` value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16    
value = 0.25  
`MEMORY` = 512, 1024, or 2048  
value = 0.5  
`MEMORY` = 1024, 2048, 3072, or 4096  
value = 1  
`MEMORY` = 2048, 3072, 4096, 5120, 6144, 7168, or 8192  
value = 2  
`MEMORY` = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384  
value = 4  
`MEMORY` = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720  
value = 8  
`MEMORY` = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440   
value = 16  
`MEMORY` = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880 
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe BatchRetryStrategy
<a name="aws-properties-pipes-pipe-batchretrystrategy"></a>

The retry strategy that's associated with a job. For more information, see [ Automated job retries](https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) in the *AWS Batch User Guide*.

## Syntax
<a name="aws-properties-pipes-pipe-batchretrystrategy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-batchretrystrategy-syntax.json"></a>

```
{
  "[Attempts](#cfn-pipes-pipe-batchretrystrategy-attempts)" : Integer
}
```

### YAML
<a name="aws-properties-pipes-pipe-batchretrystrategy-syntax.yaml"></a>

```
  [Attempts](#cfn-pipes-pipe-batchretrystrategy-attempts): Integer
```

## Properties
<a name="aws-properties-pipes-pipe-batchretrystrategy-properties"></a>

`Attempts`  <a name="cfn-pipes-pipe-batchretrystrategy-attempts"></a>
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.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe CapacityProviderStrategyItem
<a name="aws-properties-pipes-pipe-capacityproviderstrategyitem"></a>

The details of a capacity provider strategy. To learn more, see [CapacityProviderStrategyItem](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) in the Amazon ECS API Reference.

## Syntax
<a name="aws-properties-pipes-pipe-capacityproviderstrategyitem-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-capacityproviderstrategyitem-syntax.json"></a>

```
{
  "[Base](#cfn-pipes-pipe-capacityproviderstrategyitem-base)" : Integer,
  "[CapacityProvider](#cfn-pipes-pipe-capacityproviderstrategyitem-capacityprovider)" : String,
  "[Weight](#cfn-pipes-pipe-capacityproviderstrategyitem-weight)" : Integer
}
```

### YAML
<a name="aws-properties-pipes-pipe-capacityproviderstrategyitem-syntax.yaml"></a>

```
  [Base](#cfn-pipes-pipe-capacityproviderstrategyitem-base): Integer
  [CapacityProvider](#cfn-pipes-pipe-capacityproviderstrategyitem-capacityprovider): String
  [Weight](#cfn-pipes-pipe-capacityproviderstrategyitem-weight): Integer
```

## Properties
<a name="aws-properties-pipes-pipe-capacityproviderstrategyitem-properties"></a>

`Base`  <a name="cfn-pipes-pipe-capacityproviderstrategyitem-base"></a>
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.   
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `100000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CapacityProvider`  <a name="cfn-pipes-pipe-capacityproviderstrategyitem-capacityprovider"></a>
The short name of the capacity provider.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Weight`  <a name="cfn-pipes-pipe-capacityproviderstrategyitem-weight"></a>
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.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `1000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe CloudwatchLogsLogDestination
<a name="aws-properties-pipes-pipe-cloudwatchlogslogdestination"></a>

Represents the Amazon CloudWatch Logs logging configuration settings for the pipe.

## Syntax
<a name="aws-properties-pipes-pipe-cloudwatchlogslogdestination-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-cloudwatchlogslogdestination-syntax.json"></a>

```
{
  "[LogGroupArn](#cfn-pipes-pipe-cloudwatchlogslogdestination-loggrouparn)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-cloudwatchlogslogdestination-syntax.yaml"></a>

```
  [LogGroupArn](#cfn-pipes-pipe-cloudwatchlogslogdestination-loggrouparn): String
```

## Properties
<a name="aws-properties-pipes-pipe-cloudwatchlogslogdestination-properties"></a>

`LogGroupArn`  <a name="cfn-pipes-pipe-cloudwatchlogslogdestination-loggrouparn"></a>
The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.  
*Required*: No  
*Type*: String  
*Pattern*: `^(^arn:aws([a-z]|\-)*:logs:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):log-group:.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe DeadLetterConfig
<a name="aws-properties-pipes-pipe-deadletterconfig"></a>

A `DeadLetterConfig` object that contains information about a dead-letter queue configuration.

## Syntax
<a name="aws-properties-pipes-pipe-deadletterconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-deadletterconfig-syntax.json"></a>

```
{
  "[Arn](#cfn-pipes-pipe-deadletterconfig-arn)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-deadletterconfig-syntax.yaml"></a>

```
  [Arn](#cfn-pipes-pipe-deadletterconfig-arn): String
```

## Properties
<a name="aws-properties-pipes-pipe-deadletterconfig-properties"></a>

`Arn`  <a name="cfn-pipes-pipe-deadletterconfig-arn"></a>
The ARN of the specified target for the dead-letter queue.   
For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either an Amazon SNS topic or Amazon SQS queue ARN.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe DimensionMapping
<a name="aws-properties-pipes-pipe-dimensionmapping"></a>

Maps source data to a dimension in the target Timestream for LiveAnalytics table.

For more information, see [Amazon Timestream for LiveAnalytics concepts](https://docs.aws.amazon.com/timestream/latest/developerguide/concepts.html)

## Syntax
<a name="aws-properties-pipes-pipe-dimensionmapping-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-dimensionmapping-syntax.json"></a>

```
{
  "[DimensionName](#cfn-pipes-pipe-dimensionmapping-dimensionname)" : String,
  "[DimensionValue](#cfn-pipes-pipe-dimensionmapping-dimensionvalue)" : String,
  "[DimensionValueType](#cfn-pipes-pipe-dimensionmapping-dimensionvaluetype)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-dimensionmapping-syntax.yaml"></a>

```
  [DimensionName](#cfn-pipes-pipe-dimensionmapping-dimensionname): String
  [DimensionValue](#cfn-pipes-pipe-dimensionmapping-dimensionvalue): String
  [DimensionValueType](#cfn-pipes-pipe-dimensionmapping-dimensionvaluetype): String
```

## Properties
<a name="aws-properties-pipes-pipe-dimensionmapping-properties"></a>

`DimensionName`  <a name="cfn-pipes-pipe-dimensionmapping-dimensionname"></a>
The metadata attributes of the time series. For example, the name and Availability Zone of an Amazon EC2 instance or the name of the manufacturer of a wind turbine are dimensions.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DimensionValue`  <a name="cfn-pipes-pipe-dimensionmapping-dimensionvalue"></a>
Dynamic path to the dimension value in the source event.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DimensionValueType`  <a name="cfn-pipes-pipe-dimensionmapping-dimensionvaluetype"></a>
The data type of the dimension for the time-series data.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `VARCHAR`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe EcsContainerOverride
<a name="aws-properties-pipes-pipe-ecscontaineroverride"></a>

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is `{"containerOverrides": [ ] }`. If a non-empty container override is specified, the `name` parameter must be included.

## Syntax
<a name="aws-properties-pipes-pipe-ecscontaineroverride-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-ecscontaineroverride-syntax.json"></a>

```
{
  "[Command](#cfn-pipes-pipe-ecscontaineroverride-command)" : [ String, ... ],
  "[Cpu](#cfn-pipes-pipe-ecscontaineroverride-cpu)" : Integer,
  "[Environment](#cfn-pipes-pipe-ecscontaineroverride-environment)" : [ EcsEnvironmentVariable, ... ],
  "[EnvironmentFiles](#cfn-pipes-pipe-ecscontaineroverride-environmentfiles)" : [ EcsEnvironmentFile, ... ],
  "[Memory](#cfn-pipes-pipe-ecscontaineroverride-memory)" : Integer,
  "[MemoryReservation](#cfn-pipes-pipe-ecscontaineroverride-memoryreservation)" : Integer,
  "[Name](#cfn-pipes-pipe-ecscontaineroverride-name)" : String,
  "[ResourceRequirements](#cfn-pipes-pipe-ecscontaineroverride-resourcerequirements)" : [ EcsResourceRequirement, ... ]
}
```

### YAML
<a name="aws-properties-pipes-pipe-ecscontaineroverride-syntax.yaml"></a>

```
  [Command](#cfn-pipes-pipe-ecscontaineroverride-command): 
    - String
  [Cpu](#cfn-pipes-pipe-ecscontaineroverride-cpu): Integer
  [Environment](#cfn-pipes-pipe-ecscontaineroverride-environment): 
    - EcsEnvironmentVariable
  [EnvironmentFiles](#cfn-pipes-pipe-ecscontaineroverride-environmentfiles): 
    - EcsEnvironmentFile
  [Memory](#cfn-pipes-pipe-ecscontaineroverride-memory): Integer
  [MemoryReservation](#cfn-pipes-pipe-ecscontaineroverride-memoryreservation): Integer
  [Name](#cfn-pipes-pipe-ecscontaineroverride-name): String
  [ResourceRequirements](#cfn-pipes-pipe-ecscontaineroverride-resourcerequirements): 
    - EcsResourceRequirement
```

## Properties
<a name="aws-properties-pipes-pipe-ecscontaineroverride-properties"></a>

`Command`  <a name="cfn-pipes-pipe-ecscontaineroverride-command"></a>
The command 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.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Cpu`  <a name="cfn-pipes-pipe-ecscontaineroverride-cpu"></a>
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.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Environment`  <a name="cfn-pipes-pipe-ecscontaineroverride-environment"></a>
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.  
*Required*: No  
*Type*: Array of [EcsEnvironmentVariable](aws-properties-pipes-pipe-ecsenvironmentvariable.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnvironmentFiles`  <a name="cfn-pipes-pipe-ecscontaineroverride-environmentfiles"></a>
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.  
*Required*: No  
*Type*: Array of [EcsEnvironmentFile](aws-properties-pipes-pipe-ecsenvironmentfile.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Memory`  <a name="cfn-pipes-pipe-ecscontaineroverride-memory"></a>
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.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MemoryReservation`  <a name="cfn-pipes-pipe-ecscontaineroverride-memoryreservation"></a>
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.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-pipes-pipe-ecscontaineroverride-name"></a>
The name of the container that receives the override. This parameter is required if any override is specified.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceRequirements`  <a name="cfn-pipes-pipe-ecscontaineroverride-resourcerequirements"></a>
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.  
*Required*: No  
*Type*: Array of [EcsResourceRequirement](aws-properties-pipes-pipe-ecsresourcerequirement.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe EcsEnvironmentFile
<a name="aws-properties-pipes-pipe-ecsenvironmentfile"></a>

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a `.env` file extension. Each line in an environment file should contain an environment variable in `VARIABLE=VALUE` format. Lines beginning with `#` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.docker.com/compose/env-file/).

If there are environment variables specified using the `environment` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying environment variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*.

This parameter is only supported for tasks hosted on Fargate using the following platform versions:
+ Linux platform version `1.4.0` or later.
+ Windows platform version `1.0.0` or later.

## Syntax
<a name="aws-properties-pipes-pipe-ecsenvironmentfile-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-ecsenvironmentfile-syntax.json"></a>

```
{
  "[Type](#cfn-pipes-pipe-ecsenvironmentfile-type)" : String,
  "[Value](#cfn-pipes-pipe-ecsenvironmentfile-value)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-ecsenvironmentfile-syntax.yaml"></a>

```
  [Type](#cfn-pipes-pipe-ecsenvironmentfile-type): String
  [Value](#cfn-pipes-pipe-ecsenvironmentfile-value): String
```

## Properties
<a name="aws-properties-pipes-pipe-ecsenvironmentfile-properties"></a>

`Type`  <a name="cfn-pipes-pipe-ecsenvironmentfile-type"></a>
The file type to use. The only supported value is `s3`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `s3`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-pipes-pipe-ecsenvironmentfile-value"></a>
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe EcsEnvironmentVariable
<a name="aws-properties-pipes-pipe-ecsenvironmentvariable"></a>

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.

## Syntax
<a name="aws-properties-pipes-pipe-ecsenvironmentvariable-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-ecsenvironmentvariable-syntax.json"></a>

```
{
  "[Name](#cfn-pipes-pipe-ecsenvironmentvariable-name)" : String,
  "[Value](#cfn-pipes-pipe-ecsenvironmentvariable-value)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-ecsenvironmentvariable-syntax.yaml"></a>

```
  [Name](#cfn-pipes-pipe-ecsenvironmentvariable-name): String
  [Value](#cfn-pipes-pipe-ecsenvironmentvariable-value): String
```

## Properties
<a name="aws-properties-pipes-pipe-ecsenvironmentvariable-properties"></a>

`Name`  <a name="cfn-pipes-pipe-ecsenvironmentvariable-name"></a>
The name of the key-value pair. For environment variables, this is the name of the environment variable.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-pipes-pipe-ecsenvironmentvariable-value"></a>
The value of the key-value pair. For environment variables, this is the value of the environment variable.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe EcsEphemeralStorage
<a name="aws-properties-pipes-pipe-ecsephemeralstorage"></a>

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see [Fargate task storage](https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) in the *Amazon ECS User Guide for Fargate*.

**Note**  
This parameter is only supported for tasks hosted on Fargate using Linux platform version `1.4.0` or later. This parameter is not supported for Windows containers on Fargate.

## Syntax
<a name="aws-properties-pipes-pipe-ecsephemeralstorage-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-ecsephemeralstorage-syntax.json"></a>

```
{
  "[SizeInGiB](#cfn-pipes-pipe-ecsephemeralstorage-sizeingib)" : Integer
}
```

### YAML
<a name="aws-properties-pipes-pipe-ecsephemeralstorage-syntax.yaml"></a>

```
  [SizeInGiB](#cfn-pipes-pipe-ecsephemeralstorage-sizeingib): Integer
```

## Properties
<a name="aws-properties-pipes-pipe-ecsephemeralstorage-properties"></a>

`SizeInGiB`  <a name="cfn-pipes-pipe-ecsephemeralstorage-sizeingib"></a>
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.  
*Required*: Yes  
*Type*: Integer  
*Minimum*: `21`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe EcsInferenceAcceleratorOverride
<a name="aws-properties-pipes-pipe-ecsinferenceacceleratoroverride"></a>

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide*.

## Syntax
<a name="aws-properties-pipes-pipe-ecsinferenceacceleratoroverride-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-ecsinferenceacceleratoroverride-syntax.json"></a>

```
{
  "[DeviceName](#cfn-pipes-pipe-ecsinferenceacceleratoroverride-devicename)" : String,
  "[DeviceType](#cfn-pipes-pipe-ecsinferenceacceleratoroverride-devicetype)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-ecsinferenceacceleratoroverride-syntax.yaml"></a>

```
  [DeviceName](#cfn-pipes-pipe-ecsinferenceacceleratoroverride-devicename): String
  [DeviceType](#cfn-pipes-pipe-ecsinferenceacceleratoroverride-devicetype): String
```

## Properties
<a name="aws-properties-pipes-pipe-ecsinferenceacceleratoroverride-properties"></a>

`DeviceName`  <a name="cfn-pipes-pipe-ecsinferenceacceleratoroverride-devicename"></a>
The Elastic Inference accelerator device name to override for the task. This parameter must match a `deviceName` specified in the task definition.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeviceType`  <a name="cfn-pipes-pipe-ecsinferenceacceleratoroverride-devicetype"></a>
The Elastic Inference accelerator type to use.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe EcsResourceRequirement
<a name="aws-properties-pipes-pipe-ecsresourcerequirement"></a>

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see [Working with GPUs on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or [Working with Amazon Elastic Inference on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the *Amazon Elastic Container Service Developer Guide*

## Syntax
<a name="aws-properties-pipes-pipe-ecsresourcerequirement-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-ecsresourcerequirement-syntax.json"></a>

```
{
  "[Type](#cfn-pipes-pipe-ecsresourcerequirement-type)" : String,
  "[Value](#cfn-pipes-pipe-ecsresourcerequirement-value)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-ecsresourcerequirement-syntax.yaml"></a>

```
  [Type](#cfn-pipes-pipe-ecsresourcerequirement-type): String
  [Value](#cfn-pipes-pipe-ecsresourcerequirement-value): String
```

## Properties
<a name="aws-properties-pipes-pipe-ecsresourcerequirement-properties"></a>

`Type`  <a name="cfn-pipes-pipe-ecsresourcerequirement-type"></a>
The type of resource to assign to a container. The supported values are `GPU` or `InferenceAccelerator`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `GPU | InferenceAccelerator`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-pipes-pipe-ecsresourcerequirement-value"></a>
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.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe EcsTaskOverride
<a name="aws-properties-pipes-pipe-ecstaskoverride"></a>

The overrides that are associated with a task.

## Syntax
<a name="aws-properties-pipes-pipe-ecstaskoverride-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-ecstaskoverride-syntax.json"></a>

```
{
  "[ContainerOverrides](#cfn-pipes-pipe-ecstaskoverride-containeroverrides)" : [ EcsContainerOverride, ... ],
  "[Cpu](#cfn-pipes-pipe-ecstaskoverride-cpu)" : String,
  "[EphemeralStorage](#cfn-pipes-pipe-ecstaskoverride-ephemeralstorage)" : EcsEphemeralStorage,
  "[ExecutionRoleArn](#cfn-pipes-pipe-ecstaskoverride-executionrolearn)" : String,
  "[InferenceAcceleratorOverrides](#cfn-pipes-pipe-ecstaskoverride-inferenceacceleratoroverrides)" : [ EcsInferenceAcceleratorOverride, ... ],
  "[Memory](#cfn-pipes-pipe-ecstaskoverride-memory)" : String,
  "[TaskRoleArn](#cfn-pipes-pipe-ecstaskoverride-taskrolearn)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-ecstaskoverride-syntax.yaml"></a>

```
  [ContainerOverrides](#cfn-pipes-pipe-ecstaskoverride-containeroverrides): 
    - EcsContainerOverride
  [Cpu](#cfn-pipes-pipe-ecstaskoverride-cpu): String
  [EphemeralStorage](#cfn-pipes-pipe-ecstaskoverride-ephemeralstorage): 
    EcsEphemeralStorage
  [ExecutionRoleArn](#cfn-pipes-pipe-ecstaskoverride-executionrolearn): String
  [InferenceAcceleratorOverrides](#cfn-pipes-pipe-ecstaskoverride-inferenceacceleratoroverrides): 
    - EcsInferenceAcceleratorOverride
  [Memory](#cfn-pipes-pipe-ecstaskoverride-memory): String
  [TaskRoleArn](#cfn-pipes-pipe-ecstaskoverride-taskrolearn): String
```

## Properties
<a name="aws-properties-pipes-pipe-ecstaskoverride-properties"></a>

`ContainerOverrides`  <a name="cfn-pipes-pipe-ecstaskoverride-containeroverrides"></a>
One or more container overrides that are sent to a task.  
*Required*: No  
*Type*: Array of [EcsContainerOverride](aws-properties-pipes-pipe-ecscontaineroverride.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Cpu`  <a name="cfn-pipes-pipe-ecstaskoverride-cpu"></a>
The cpu override for the task.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EphemeralStorage`  <a name="cfn-pipes-pipe-ecstaskoverride-ephemeralstorage"></a>
The ephemeral storage setting override for the task.  
This parameter is only supported for tasks hosted on Fargate that use the following platform versions:  
+ Linux platform version `1.4.0` or later.
+ Windows platform version `1.0.0` or later.
*Required*: No  
*Type*: [EcsEphemeralStorage](aws-properties-pipes-pipe-ecsephemeralstorage.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExecutionRoleArn`  <a name="cfn-pipes-pipe-ecstaskoverride-executionrolearn"></a>
The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InferenceAcceleratorOverrides`  <a name="cfn-pipes-pipe-ecstaskoverride-inferenceacceleratoroverrides"></a>
The Elastic Inference accelerator override for the task.  
*Required*: No  
*Type*: Array of [EcsInferenceAcceleratorOverride](aws-properties-pipes-pipe-ecsinferenceacceleratoroverride.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Memory`  <a name="cfn-pipes-pipe-ecstaskoverride-memory"></a>
The memory override for the task.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TaskRoleArn`  <a name="cfn-pipes-pipe-ecstaskoverride-taskrolearn"></a>
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. For more information, see [IAM Role for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe Filter
<a name="aws-properties-pipes-pipe-filter"></a>

Filter events using an event pattern. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*.

## Syntax
<a name="aws-properties-pipes-pipe-filter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-filter-syntax.json"></a>

```
{
  "[Pattern](#cfn-pipes-pipe-filter-pattern)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-filter-syntax.yaml"></a>

```
  [Pattern](#cfn-pipes-pipe-filter-pattern): String
```

## Properties
<a name="aws-properties-pipes-pipe-filter-properties"></a>

`Pattern`  <a name="cfn-pipes-pipe-filter-pattern"></a>
The event pattern.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `4096`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe FilterCriteria
<a name="aws-properties-pipes-pipe-filtercriteria"></a>

The collection of event patterns used to filter events.

To remove a filter, specify a `FilterCriteria` object with an empty array of `Filter` objects.

For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*.

## Syntax
<a name="aws-properties-pipes-pipe-filtercriteria-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-filtercriteria-syntax.json"></a>

```
{
  "[Filters](#cfn-pipes-pipe-filtercriteria-filters)" : [ Filter, ... ]
}
```

### YAML
<a name="aws-properties-pipes-pipe-filtercriteria-syntax.yaml"></a>

```
  [Filters](#cfn-pipes-pipe-filtercriteria-filters): 
    - Filter
```

## Properties
<a name="aws-properties-pipes-pipe-filtercriteria-properties"></a>

`Filters`  <a name="cfn-pipes-pipe-filtercriteria-filters"></a>
The event patterns.  
*Required*: No  
*Type*: Array of [Filter](aws-properties-pipes-pipe-filter.md)  
*Minimum*: `0`  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe FirehoseLogDestination
<a name="aws-properties-pipes-pipe-firehoselogdestination"></a>

Represents the Amazon Data Firehose logging configuration settings for the pipe.

## Syntax
<a name="aws-properties-pipes-pipe-firehoselogdestination-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-firehoselogdestination-syntax.json"></a>

```
{
  "[DeliveryStreamArn](#cfn-pipes-pipe-firehoselogdestination-deliverystreamarn)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-firehoselogdestination-syntax.yaml"></a>

```
  [DeliveryStreamArn](#cfn-pipes-pipe-firehoselogdestination-deliverystreamarn): String
```

## Properties
<a name="aws-properties-pipes-pipe-firehoselogdestination-properties"></a>

`DeliveryStreamArn`  <a name="cfn-pipes-pipe-firehoselogdestination-deliverystreamarn"></a>
The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.  
*Required*: No  
*Type*: String  
*Pattern*: `^(^arn:aws([a-z]|\-)*:firehose:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):deliverystream/.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe MQBrokerAccessCredentials
<a name="aws-properties-pipes-pipe-mqbrokeraccesscredentials"></a>

The AWS Secrets Manager secret that stores your broker credentials.

## Syntax
<a name="aws-properties-pipes-pipe-mqbrokeraccesscredentials-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-mqbrokeraccesscredentials-syntax.json"></a>

```
{
  "[BasicAuth](#cfn-pipes-pipe-mqbrokeraccesscredentials-basicauth)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-mqbrokeraccesscredentials-syntax.yaml"></a>

```
  [BasicAuth](#cfn-pipes-pipe-mqbrokeraccesscredentials-basicauth): String
```

## Properties
<a name="aws-properties-pipes-pipe-mqbrokeraccesscredentials-properties"></a>

`BasicAuth`  <a name="cfn-pipes-pipe-mqbrokeraccesscredentials-basicauth"></a>
The ARN of the Secrets Manager secret.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe MSKAccessCredentials
<a name="aws-properties-pipes-pipe-mskaccesscredentials"></a>

The AWS Secrets Manager secret that stores your stream credentials.

## Syntax
<a name="aws-properties-pipes-pipe-mskaccesscredentials-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-mskaccesscredentials-syntax.json"></a>

```
{
  "[ClientCertificateTlsAuth](#cfn-pipes-pipe-mskaccesscredentials-clientcertificatetlsauth)" : String,
  "[SaslScram512Auth](#cfn-pipes-pipe-mskaccesscredentials-saslscram512auth)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-mskaccesscredentials-syntax.yaml"></a>

```
  [ClientCertificateTlsAuth](#cfn-pipes-pipe-mskaccesscredentials-clientcertificatetlsauth): String
  [SaslScram512Auth](#cfn-pipes-pipe-mskaccesscredentials-saslscram512auth): String
```

## Properties
<a name="aws-properties-pipes-pipe-mskaccesscredentials-properties"></a>

`ClientCertificateTlsAuth`  <a name="cfn-pipes-pipe-mskaccesscredentials-clientcertificatetlsauth"></a>
The ARN of the Secrets Manager secret.  
*Required*: No  
*Type*: String  
*Pattern*: `^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SaslScram512Auth`  <a name="cfn-pipes-pipe-mskaccesscredentials-saslscram512auth"></a>
The ARN of the Secrets Manager secret.  
*Required*: No  
*Type*: String  
*Pattern*: `^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe MultiMeasureAttributeMapping
<a name="aws-properties-pipes-pipe-multimeasureattributemapping"></a>

A mapping of a source event data field to a measure in a Timestream for LiveAnalytics record.

## Syntax
<a name="aws-properties-pipes-pipe-multimeasureattributemapping-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-multimeasureattributemapping-syntax.json"></a>

```
{
  "[MeasureValue](#cfn-pipes-pipe-multimeasureattributemapping-measurevalue)" : String,
  "[MeasureValueType](#cfn-pipes-pipe-multimeasureattributemapping-measurevaluetype)" : String,
  "[MultiMeasureAttributeName](#cfn-pipes-pipe-multimeasureattributemapping-multimeasureattributename)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-multimeasureattributemapping-syntax.yaml"></a>

```
  [MeasureValue](#cfn-pipes-pipe-multimeasureattributemapping-measurevalue): String
  [MeasureValueType](#cfn-pipes-pipe-multimeasureattributemapping-measurevaluetype): String
  [MultiMeasureAttributeName](#cfn-pipes-pipe-multimeasureattributemapping-multimeasureattributename): String
```

## Properties
<a name="aws-properties-pipes-pipe-multimeasureattributemapping-properties"></a>

`MeasureValue`  <a name="cfn-pipes-pipe-multimeasureattributemapping-measurevalue"></a>
Dynamic path to the measurement attribute in the source event.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MeasureValueType`  <a name="cfn-pipes-pipe-multimeasureattributemapping-measurevaluetype"></a>
Data type of the measurement attribute in the source event.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `DOUBLE | BIGINT | VARCHAR | BOOLEAN | TIMESTAMP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MultiMeasureAttributeName`  <a name="cfn-pipes-pipe-multimeasureattributemapping-multimeasureattributename"></a>
Target measure name to be used.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe MultiMeasureMapping
<a name="aws-properties-pipes-pipe-multimeasuremapping"></a>

Maps multiple measures from the source event to the same Timestream for LiveAnalytics record.

For more information, see [Amazon Timestream for LiveAnalytics concepts](https://docs.aws.amazon.com/timestream/latest/developerguide/concepts.html)

## Syntax
<a name="aws-properties-pipes-pipe-multimeasuremapping-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-multimeasuremapping-syntax.json"></a>

```
{
  "[MultiMeasureAttributeMappings](#cfn-pipes-pipe-multimeasuremapping-multimeasureattributemappings)" : [ MultiMeasureAttributeMapping, ... ],
  "[MultiMeasureName](#cfn-pipes-pipe-multimeasuremapping-multimeasurename)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-multimeasuremapping-syntax.yaml"></a>

```
  [MultiMeasureAttributeMappings](#cfn-pipes-pipe-multimeasuremapping-multimeasureattributemappings): 
    - MultiMeasureAttributeMapping
  [MultiMeasureName](#cfn-pipes-pipe-multimeasuremapping-multimeasurename): String
```

## Properties
<a name="aws-properties-pipes-pipe-multimeasuremapping-properties"></a>

`MultiMeasureAttributeMappings`  <a name="cfn-pipes-pipe-multimeasuremapping-multimeasureattributemappings"></a>
Mappings that represent multiple source event fields mapped to measures in the same Timestream for LiveAnalytics record.  
*Required*: Yes  
*Type*: Array of [MultiMeasureAttributeMapping](aws-properties-pipes-pipe-multimeasureattributemapping.md)  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MultiMeasureName`  <a name="cfn-pipes-pipe-multimeasuremapping-multimeasurename"></a>
The name of the multiple measurements per record (multi-measure).  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe NetworkConfiguration
<a name="aws-properties-pipes-pipe-networkconfiguration"></a>

This structure specifies the network configuration for an Amazon ECS task.

## Syntax
<a name="aws-properties-pipes-pipe-networkconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-networkconfiguration-syntax.json"></a>

```
{
  "[AwsvpcConfiguration](#cfn-pipes-pipe-networkconfiguration-awsvpcconfiguration)" : AwsVpcConfiguration
}
```

### YAML
<a name="aws-properties-pipes-pipe-networkconfiguration-syntax.yaml"></a>

```
  [AwsvpcConfiguration](#cfn-pipes-pipe-networkconfiguration-awsvpcconfiguration): 
    AwsVpcConfiguration
```

## Properties
<a name="aws-properties-pipes-pipe-networkconfiguration-properties"></a>

`AwsvpcConfiguration`  <a name="cfn-pipes-pipe-networkconfiguration-awsvpcconfiguration"></a>
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.  
*Required*: No  
*Type*: [AwsVpcConfiguration](aws-properties-pipes-pipe-awsvpcconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeEnrichmentHttpParameters
<a name="aws-properties-pipes-pipe-pipeenrichmenthttpparameters"></a>

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

## Syntax
<a name="aws-properties-pipes-pipe-pipeenrichmenthttpparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipeenrichmenthttpparameters-syntax.json"></a>

```
{
  "[HeaderParameters](#cfn-pipes-pipe-pipeenrichmenthttpparameters-headerparameters)" : {Key: Value, ...},
  "[PathParameterValues](#cfn-pipes-pipe-pipeenrichmenthttpparameters-pathparametervalues)" : [ String, ... ],
  "[QueryStringParameters](#cfn-pipes-pipe-pipeenrichmenthttpparameters-querystringparameters)" : {Key: Value, ...}
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipeenrichmenthttpparameters-syntax.yaml"></a>

```
  [HeaderParameters](#cfn-pipes-pipe-pipeenrichmenthttpparameters-headerparameters): 
    Key: Value
  [PathParameterValues](#cfn-pipes-pipe-pipeenrichmenthttpparameters-pathparametervalues): 
    - String
  [QueryStringParameters](#cfn-pipes-pipe-pipeenrichmenthttpparameters-querystringparameters): 
    Key: Value
```

## Properties
<a name="aws-properties-pipes-pipe-pipeenrichmenthttpparameters-properties"></a>

`HeaderParameters`  <a name="cfn-pipes-pipe-pipeenrichmenthttpparameters-headerparameters"></a>
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[!#$%&'*+-.^_`|~0-9a-zA-Z]+|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$`  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PathParameterValues`  <a name="cfn-pipes-pipe-pipeenrichmenthttpparameters-pathparametervalues"></a>
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("\$1").  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueryStringParameters`  <a name="cfn-pipes-pipe-pipeenrichmenthttpparameters-querystringparameters"></a>
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[^\x00-\x1F\x7F]+|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$`  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeEnrichmentParameters
<a name="aws-properties-pipes-pipe-pipeenrichmentparameters"></a>

The parameters required to set up enrichment on your pipe.

## Syntax
<a name="aws-properties-pipes-pipe-pipeenrichmentparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipeenrichmentparameters-syntax.json"></a>

```
{
  "[HttpParameters](#cfn-pipes-pipe-pipeenrichmentparameters-httpparameters)" : PipeEnrichmentHttpParameters,
  "[InputTemplate](#cfn-pipes-pipe-pipeenrichmentparameters-inputtemplate)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipeenrichmentparameters-syntax.yaml"></a>

```
  [HttpParameters](#cfn-pipes-pipe-pipeenrichmentparameters-httpparameters): 
    PipeEnrichmentHttpParameters
  [InputTemplate](#cfn-pipes-pipe-pipeenrichmentparameters-inputtemplate): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipeenrichmentparameters-properties"></a>

`HttpParameters`  <a name="cfn-pipes-pipe-pipeenrichmentparameters-httpparameters"></a>
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.  
*Required*: No  
*Type*: [PipeEnrichmentHttpParameters](aws-properties-pipes-pipe-pipeenrichmenthttpparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InputTemplate`  <a name="cfn-pipes-pipe-pipeenrichmentparameters-inputtemplate"></a>
Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt).  
To remove an input template, specify an empty string.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `8192`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeLogConfiguration
<a name="aws-properties-pipes-pipe-pipelogconfiguration"></a>

Represents the configuration settings for the logs to which this pipe should report events.

## Syntax
<a name="aws-properties-pipes-pipe-pipelogconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipelogconfiguration-syntax.json"></a>

```
{
  "[CloudwatchLogsLogDestination](#cfn-pipes-pipe-pipelogconfiguration-cloudwatchlogslogdestination)" : CloudwatchLogsLogDestination,
  "[FirehoseLogDestination](#cfn-pipes-pipe-pipelogconfiguration-firehoselogdestination)" : FirehoseLogDestination,
  "[IncludeExecutionData](#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata)" : [ String, ... ],
  "[Level](#cfn-pipes-pipe-pipelogconfiguration-level)" : String,
  "[S3LogDestination](#cfn-pipes-pipe-pipelogconfiguration-s3logdestination)" : S3LogDestination
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipelogconfiguration-syntax.yaml"></a>

```
  [CloudwatchLogsLogDestination](#cfn-pipes-pipe-pipelogconfiguration-cloudwatchlogslogdestination): 
    CloudwatchLogsLogDestination
  [FirehoseLogDestination](#cfn-pipes-pipe-pipelogconfiguration-firehoselogdestination): 
    FirehoseLogDestination
  [IncludeExecutionData](#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata): 
    - String
  [Level](#cfn-pipes-pipe-pipelogconfiguration-level): String
  [S3LogDestination](#cfn-pipes-pipe-pipelogconfiguration-s3logdestination): 
    S3LogDestination
```

## Properties
<a name="aws-properties-pipes-pipe-pipelogconfiguration-properties"></a>

`CloudwatchLogsLogDestination`  <a name="cfn-pipes-pipe-pipelogconfiguration-cloudwatchlogslogdestination"></a>
The logging configuration settings for the pipe.  
*Required*: No  
*Type*: [CloudwatchLogsLogDestination](aws-properties-pipes-pipe-cloudwatchlogslogdestination.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FirehoseLogDestination`  <a name="cfn-pipes-pipe-pipelogconfiguration-firehoselogdestination"></a>
The Amazon Data Firehose logging configuration settings for the pipe.  
*Required*: No  
*Type*: [FirehoseLogDestination](aws-properties-pipes-pipe-firehoselogdestination.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IncludeExecutionData`  <a name="cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata"></a>
Whether the execution data (specifically, the `payload`, `awsRequest`, and `awsResponse` fields) is included in the log messages for this pipe.  
This applies to all log destinations for the pipe.  
For more information, see [Including execution data in logs](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data) in the *Amazon EventBridge User Guide*.  
 *Allowed values:* `ALL`   
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Level`  <a name="cfn-pipes-pipe-pipelogconfiguration-level"></a>
The level of logging detail to include. This applies to all log destinations for the pipe.  
*Required*: No  
*Type*: String  
*Allowed values*: `OFF | ERROR | INFO | TRACE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3LogDestination`  <a name="cfn-pipes-pipe-pipelogconfiguration-s3logdestination"></a>
The Amazon S3 logging configuration settings for the pipe.  
*Required*: No  
*Type*: [S3LogDestination](aws-properties-pipes-pipe-s3logdestination.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeSourceActiveMQBrokerParameters
<a name="aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters"></a>

The parameters for using an Active MQ broker as a source.

## Syntax
<a name="aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters-syntax.json"></a>

```
{
  "[BatchSize](#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-batchsize)" : Integer,
  "[Credentials](#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-credentials)" : MQBrokerAccessCredentials,
  "[MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-maximumbatchingwindowinseconds)" : Integer,
  "[QueueName](#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-queuename)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters-syntax.yaml"></a>

```
  [BatchSize](#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-batchsize): Integer
  [Credentials](#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-credentials): 
    MQBrokerAccessCredentials
  [MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-maximumbatchingwindowinseconds): Integer
  [QueueName](#cfn-pipes-pipe-pipesourceactivemqbrokerparameters-queuename): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters-properties"></a>

`BatchSize`  <a name="cfn-pipes-pipe-pipesourceactivemqbrokerparameters-batchsize"></a>
The maximum number of records to include in each batch.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `10000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Credentials`  <a name="cfn-pipes-pipe-pipesourceactivemqbrokerparameters-credentials"></a>
The credentials needed to access the resource.  
*Required*: Yes  
*Type*: [MQBrokerAccessCredentials](aws-properties-pipes-pipe-mqbrokeraccesscredentials.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumBatchingWindowInSeconds`  <a name="cfn-pipes-pipe-pipesourceactivemqbrokerparameters-maximumbatchingwindowinseconds"></a>
The maximum length of a time to wait for events.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueueName`  <a name="cfn-pipes-pipe-pipesourceactivemqbrokerparameters-queuename"></a>
The name of the destination queue to consume.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[\s\S]*$`  
*Minimum*: `1`  
*Maximum*: `1000`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Pipes::Pipe PipeSourceDynamoDBStreamParameters
<a name="aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters"></a>

The parameters for using a DynamoDB stream as a source.

## Syntax
<a name="aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters-syntax.json"></a>

```
{
  "[BatchSize](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-batchsize)" : Integer,
  "[DeadLetterConfig](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-deadletterconfig)" : DeadLetterConfig,
  "[MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumbatchingwindowinseconds)" : Integer,
  "[MaximumRecordAgeInSeconds](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumrecordageinseconds)" : Integer,
  "[MaximumRetryAttempts](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumretryattempts)" : Integer,
  "[OnPartialBatchItemFailure](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-onpartialbatchitemfailure)" : String,
  "[ParallelizationFactor](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-parallelizationfactor)" : Integer,
  "[StartingPosition](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-startingposition)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters-syntax.yaml"></a>

```
  [BatchSize](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-batchsize): Integer
  [DeadLetterConfig](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-deadletterconfig): 
    DeadLetterConfig
  [MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumretryattempts): Integer
  [OnPartialBatchItemFailure](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-onpartialbatchitemfailure): String
  [ParallelizationFactor](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-parallelizationfactor): Integer
  [StartingPosition](#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-startingposition): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters-properties"></a>

`BatchSize`  <a name="cfn-pipes-pipe-pipesourcedynamodbstreamparameters-batchsize"></a>
The maximum number of records to include in each batch.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `10000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeadLetterConfig`  <a name="cfn-pipes-pipe-pipesourcedynamodbstreamparameters-deadletterconfig"></a>
Define the target queue to send dead-letter queue events to.  
*Required*: No  
*Type*: [DeadLetterConfig](aws-properties-pipes-pipe-deadletterconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumBatchingWindowInSeconds`  <a name="cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumbatchingwindowinseconds"></a>
The maximum length of a time to wait for events.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumRecordAgeInSeconds`  <a name="cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumrecordageinseconds"></a>
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.   
*Required*: No  
*Type*: Integer  
*Minimum*: `-1`  
*Maximum*: `604800`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumRetryAttempts`  <a name="cfn-pipes-pipe-pipesourcedynamodbstreamparameters-maximumretryattempts"></a>
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.  
*Required*: No  
*Type*: Integer  
*Minimum*: `-1`  
*Maximum*: `10000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OnPartialBatchItemFailure`  <a name="cfn-pipes-pipe-pipesourcedynamodbstreamparameters-onpartialbatchitemfailure"></a>
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.  
*Required*: No  
*Type*: String  
*Allowed values*: `AUTOMATIC_BISECT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ParallelizationFactor`  <a name="cfn-pipes-pipe-pipesourcedynamodbstreamparameters-parallelizationfactor"></a>
The number of batches to process concurrently from each shard. The default value is 1.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StartingPosition`  <a name="cfn-pipes-pipe-pipesourcedynamodbstreamparameters-startingposition"></a>
(Streams only) The position in a stream from which to start reading.  
*Valid values*: `TRIM_HORIZON | LATEST`  
*Required*: Yes  
*Type*: String  
*Allowed values*: `TRIM_HORIZON | LATEST`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Pipes::Pipe PipeSourceKinesisStreamParameters
<a name="aws-properties-pipes-pipe-pipesourcekinesisstreamparameters"></a>

The parameters for using a Kinesis stream as a source.

## Syntax
<a name="aws-properties-pipes-pipe-pipesourcekinesisstreamparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipesourcekinesisstreamparameters-syntax.json"></a>

```
{
  "[BatchSize](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-batchsize)" : Integer,
  "[DeadLetterConfig](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-deadletterconfig)" : DeadLetterConfig,
  "[MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumbatchingwindowinseconds)" : Integer,
  "[MaximumRecordAgeInSeconds](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumrecordageinseconds)" : Integer,
  "[MaximumRetryAttempts](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumretryattempts)" : Integer,
  "[OnPartialBatchItemFailure](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-onpartialbatchitemfailure)" : String,
  "[ParallelizationFactor](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-parallelizationfactor)" : Integer,
  "[StartingPosition](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingposition)" : String,
  "[StartingPositionTimestamp](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingpositiontimestamp)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipesourcekinesisstreamparameters-syntax.yaml"></a>

```
  [BatchSize](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-batchsize): Integer
  [DeadLetterConfig](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-deadletterconfig): 
    DeadLetterConfig
  [MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumbatchingwindowinseconds): Integer
  [MaximumRecordAgeInSeconds](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumrecordageinseconds): Integer
  [MaximumRetryAttempts](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumretryattempts): Integer
  [OnPartialBatchItemFailure](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-onpartialbatchitemfailure): String
  [ParallelizationFactor](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-parallelizationfactor): Integer
  [StartingPosition](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingposition): String
  [StartingPositionTimestamp](#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingpositiontimestamp): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipesourcekinesisstreamparameters-properties"></a>

`BatchSize`  <a name="cfn-pipes-pipe-pipesourcekinesisstreamparameters-batchsize"></a>
The maximum number of records to include in each batch.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `10000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeadLetterConfig`  <a name="cfn-pipes-pipe-pipesourcekinesisstreamparameters-deadletterconfig"></a>
Define the target queue to send dead-letter queue events to.  
*Required*: No  
*Type*: [DeadLetterConfig](aws-properties-pipes-pipe-deadletterconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumBatchingWindowInSeconds`  <a name="cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumbatchingwindowinseconds"></a>
The maximum length of a time to wait for events.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumRecordAgeInSeconds`  <a name="cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumrecordageinseconds"></a>
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.   
*Required*: No  
*Type*: Integer  
*Minimum*: `-1`  
*Maximum*: `604800`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumRetryAttempts`  <a name="cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumretryattempts"></a>
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.  
*Required*: No  
*Type*: Integer  
*Minimum*: `-1`  
*Maximum*: `10000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OnPartialBatchItemFailure`  <a name="cfn-pipes-pipe-pipesourcekinesisstreamparameters-onpartialbatchitemfailure"></a>
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.  
*Required*: No  
*Type*: String  
*Allowed values*: `AUTOMATIC_BISECT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ParallelizationFactor`  <a name="cfn-pipes-pipe-pipesourcekinesisstreamparameters-parallelizationfactor"></a>
The number of batches to process concurrently from each shard. The default value is 1.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StartingPosition`  <a name="cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingposition"></a>
The position in a stream from which to start reading.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `TRIM_HORIZON | LATEST | AT_TIMESTAMP`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StartingPositionTimestamp`  <a name="cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingpositiontimestamp"></a>
With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading, in Unix time seconds.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Pipes::Pipe PipeSourceManagedStreamingKafkaParameters
<a name="aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters"></a>

The parameters for using an MSK stream as a source.

## Syntax
<a name="aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-syntax.json"></a>

```
{
  "[BatchSize](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-batchsize)" : Integer,
  "[ConsumerGroupID](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-consumergroupid)" : String,
  "[Credentials](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-credentials)" : MSKAccessCredentials,
  "[MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-maximumbatchingwindowinseconds)" : Integer,
  "[StartingPosition](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-startingposition)" : String,
  "[TopicName](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-topicname)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-syntax.yaml"></a>

```
  [BatchSize](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-batchsize): Integer
  [ConsumerGroupID](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-consumergroupid): String
  [Credentials](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-credentials): 
    MSKAccessCredentials
  [MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-maximumbatchingwindowinseconds): Integer
  [StartingPosition](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-startingposition): String
  [TopicName](#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-topicname): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-properties"></a>

`BatchSize`  <a name="cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-batchsize"></a>
The maximum number of records to include in each batch.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `10000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConsumerGroupID`  <a name="cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-consumergroupid"></a>
The name of the destination queue to consume.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-\/*:_+=.@-]*$`  
*Minimum*: `1`  
*Maximum*: `200`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Credentials`  <a name="cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-credentials"></a>
The credentials needed to access the resource.  
*Required*: No  
*Type*: [MSKAccessCredentials](aws-properties-pipes-pipe-mskaccesscredentials.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumBatchingWindowInSeconds`  <a name="cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-maximumbatchingwindowinseconds"></a>
The maximum length of a time to wait for events.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StartingPosition`  <a name="cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-startingposition"></a>
The position in a stream from which to start reading.  
*Required*: No  
*Type*: String  
*Allowed values*: `TRIM_HORIZON | LATEST`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TopicName`  <a name="cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-topicname"></a>
The name of the topic that the pipe will read from.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[^.]([a-zA-Z0-9\-_.]+)$`  
*Minimum*: `1`  
*Maximum*: `249`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Pipes::Pipe PipeSourceParameters
<a name="aws-properties-pipes-pipe-pipesourceparameters"></a>

The parameters required to set up a source for your pipe.

## Syntax
<a name="aws-properties-pipes-pipe-pipesourceparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipesourceparameters-syntax.json"></a>

```
{
  "[ActiveMQBrokerParameters](#cfn-pipes-pipe-pipesourceparameters-activemqbrokerparameters)" : PipeSourceActiveMQBrokerParameters,
  "[DynamoDBStreamParameters](#cfn-pipes-pipe-pipesourceparameters-dynamodbstreamparameters)" : PipeSourceDynamoDBStreamParameters,
  "[FilterCriteria](#cfn-pipes-pipe-pipesourceparameters-filtercriteria)" : FilterCriteria,
  "[KinesisStreamParameters](#cfn-pipes-pipe-pipesourceparameters-kinesisstreamparameters)" : PipeSourceKinesisStreamParameters,
  "[ManagedStreamingKafkaParameters](#cfn-pipes-pipe-pipesourceparameters-managedstreamingkafkaparameters)" : PipeSourceManagedStreamingKafkaParameters,
  "[RabbitMQBrokerParameters](#cfn-pipes-pipe-pipesourceparameters-rabbitmqbrokerparameters)" : PipeSourceRabbitMQBrokerParameters,
  "[SelfManagedKafkaParameters](#cfn-pipes-pipe-pipesourceparameters-selfmanagedkafkaparameters)" : PipeSourceSelfManagedKafkaParameters,
  "[SqsQueueParameters](#cfn-pipes-pipe-pipesourceparameters-sqsqueueparameters)" : PipeSourceSqsQueueParameters
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipesourceparameters-syntax.yaml"></a>

```
  [ActiveMQBrokerParameters](#cfn-pipes-pipe-pipesourceparameters-activemqbrokerparameters): 
    PipeSourceActiveMQBrokerParameters
  [DynamoDBStreamParameters](#cfn-pipes-pipe-pipesourceparameters-dynamodbstreamparameters): 
    PipeSourceDynamoDBStreamParameters
  [FilterCriteria](#cfn-pipes-pipe-pipesourceparameters-filtercriteria): 
    FilterCriteria
  [KinesisStreamParameters](#cfn-pipes-pipe-pipesourceparameters-kinesisstreamparameters): 
    PipeSourceKinesisStreamParameters
  [ManagedStreamingKafkaParameters](#cfn-pipes-pipe-pipesourceparameters-managedstreamingkafkaparameters): 
    PipeSourceManagedStreamingKafkaParameters
  [RabbitMQBrokerParameters](#cfn-pipes-pipe-pipesourceparameters-rabbitmqbrokerparameters): 
    PipeSourceRabbitMQBrokerParameters
  [SelfManagedKafkaParameters](#cfn-pipes-pipe-pipesourceparameters-selfmanagedkafkaparameters): 
    PipeSourceSelfManagedKafkaParameters
  [SqsQueueParameters](#cfn-pipes-pipe-pipesourceparameters-sqsqueueparameters): 
    PipeSourceSqsQueueParameters
```

## Properties
<a name="aws-properties-pipes-pipe-pipesourceparameters-properties"></a>

`ActiveMQBrokerParameters`  <a name="cfn-pipes-pipe-pipesourceparameters-activemqbrokerparameters"></a>
The parameters for using an Active MQ broker as a source.  
*Required*: No  
*Type*: [PipeSourceActiveMQBrokerParameters](aws-properties-pipes-pipe-pipesourceactivemqbrokerparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DynamoDBStreamParameters`  <a name="cfn-pipes-pipe-pipesourceparameters-dynamodbstreamparameters"></a>
The parameters for using a DynamoDB stream as a source.  
*Required*: No  
*Type*: [PipeSourceDynamoDBStreamParameters](aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FilterCriteria`  <a name="cfn-pipes-pipe-pipesourceparameters-filtercriteria"></a>
The collection of event patterns used to filter events.  
To remove a filter, specify a `FilterCriteria` object with an empty array of `Filter` objects.  
For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide*.  
*Required*: No  
*Type*: [FilterCriteria](aws-properties-pipes-pipe-filtercriteria.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KinesisStreamParameters`  <a name="cfn-pipes-pipe-pipesourceparameters-kinesisstreamparameters"></a>
The parameters for using a Kinesis stream as a source.  
*Required*: No  
*Type*: [PipeSourceKinesisStreamParameters](aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ManagedStreamingKafkaParameters`  <a name="cfn-pipes-pipe-pipesourceparameters-managedstreamingkafkaparameters"></a>
The parameters for using an MSK stream as a source.  
*Required*: No  
*Type*: [PipeSourceManagedStreamingKafkaParameters](aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RabbitMQBrokerParameters`  <a name="cfn-pipes-pipe-pipesourceparameters-rabbitmqbrokerparameters"></a>
The parameters for using a Rabbit MQ broker as a source.  
*Required*: No  
*Type*: [PipeSourceRabbitMQBrokerParameters](aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SelfManagedKafkaParameters`  <a name="cfn-pipes-pipe-pipesourceparameters-selfmanagedkafkaparameters"></a>
The parameters for using a self-managed Apache Kafka stream as a source.  
A *self managed* cluster refers to any Apache Kafka cluster not hosted by AWS. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as [Confluent Cloud](https://www.confluent.io/), [CloudKarafka](https://www.cloudkarafka.com/), or [Redpanda](https://redpanda.com/). For more information, see [Apache Kafka streams as a source](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kafka.html) in the *Amazon EventBridge User Guide*.  
*Required*: No  
*Type*: [PipeSourceSelfManagedKafkaParameters](aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SqsQueueParameters`  <a name="cfn-pipes-pipe-pipesourceparameters-sqsqueueparameters"></a>
The parameters for using a Amazon SQS stream as a source.  
*Required*: No  
*Type*: [PipeSourceSqsQueueParameters](aws-properties-pipes-pipe-pipesourcesqsqueueparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeSourceRabbitMQBrokerParameters
<a name="aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters"></a>

The parameters for using a Rabbit MQ broker as a source.

## Syntax
<a name="aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters-syntax.json"></a>

```
{
  "[BatchSize](#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-batchsize)" : Integer,
  "[Credentials](#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-credentials)" : MQBrokerAccessCredentials,
  "[MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-maximumbatchingwindowinseconds)" : Integer,
  "[QueueName](#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-queuename)" : String,
  "[VirtualHost](#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-virtualhost)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters-syntax.yaml"></a>

```
  [BatchSize](#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-batchsize): Integer
  [Credentials](#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-credentials): 
    MQBrokerAccessCredentials
  [MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-maximumbatchingwindowinseconds): Integer
  [QueueName](#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-queuename): String
  [VirtualHost](#cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-virtualhost): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipesourcerabbitmqbrokerparameters-properties"></a>

`BatchSize`  <a name="cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-batchsize"></a>
The maximum number of records to include in each batch.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `10000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Credentials`  <a name="cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-credentials"></a>
The credentials needed to access the resource.  
*Required*: Yes  
*Type*: [MQBrokerAccessCredentials](aws-properties-pipes-pipe-mqbrokeraccesscredentials.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumBatchingWindowInSeconds`  <a name="cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-maximumbatchingwindowinseconds"></a>
The maximum length of a time to wait for events.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueueName`  <a name="cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-queuename"></a>
The name of the destination queue to consume.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[\s\S]*$`  
*Minimum*: `1`  
*Maximum*: `1000`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VirtualHost`  <a name="cfn-pipes-pipe-pipesourcerabbitmqbrokerparameters-virtualhost"></a>
The name of the virtual host associated with the source broker.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-\/*:_+=.@-]*$`  
*Minimum*: `1`  
*Maximum*: `200`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Pipes::Pipe PipeSourceSelfManagedKafkaParameters
<a name="aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters"></a>

The parameters for using a self-managed Apache Kafka stream as a source.

A *self managed* cluster refers to any Apache Kafka cluster not hosted by AWS. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as [Confluent Cloud](https://www.confluent.io/), [CloudKarafka](https://www.cloudkarafka.com/), or [Redpanda](https://redpanda.com/). For more information, see [Apache Kafka streams as a source](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kafka.html) in the *Amazon EventBridge User Guide*.

## Syntax
<a name="aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters-syntax.json"></a>

```
{
  "[AdditionalBootstrapServers](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-additionalbootstrapservers)" : [ String, ... ],
  "[BatchSize](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-batchsize)" : Integer,
  "[ConsumerGroupID](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-consumergroupid)" : String,
  "[Credentials](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-credentials)" : SelfManagedKafkaAccessConfigurationCredentials,
  "[MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-maximumbatchingwindowinseconds)" : Integer,
  "[ServerRootCaCertificate](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-serverrootcacertificate)" : String,
  "[StartingPosition](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-startingposition)" : String,
  "[TopicName](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-topicname)" : String,
  "[Vpc](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-vpc)" : SelfManagedKafkaAccessConfigurationVpc
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters-syntax.yaml"></a>

```
  [AdditionalBootstrapServers](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-additionalbootstrapservers): 
    - String
  [BatchSize](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-batchsize): Integer
  [ConsumerGroupID](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-consumergroupid): String
  [Credentials](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-credentials): 
    SelfManagedKafkaAccessConfigurationCredentials
  [MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-maximumbatchingwindowinseconds): Integer
  [ServerRootCaCertificate](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-serverrootcacertificate): String
  [StartingPosition](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-startingposition): String
  [TopicName](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-topicname): String
  [Vpc](#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-vpc): 
    SelfManagedKafkaAccessConfigurationVpc
```

## Properties
<a name="aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters-properties"></a>

`AdditionalBootstrapServers`  <a name="cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-additionalbootstrapservers"></a>
An array of server URLs.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1 | 0`  
*Maximum*: `300 | 2`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`BatchSize`  <a name="cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-batchsize"></a>
The maximum number of records to include in each batch.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `10000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConsumerGroupID`  <a name="cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-consumergroupid"></a>
The name of the destination queue to consume.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-\/*:_+=.@-]*$`  
*Minimum*: `1`  
*Maximum*: `200`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Credentials`  <a name="cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-credentials"></a>
The credentials needed to access the resource.  
*Required*: No  
*Type*: [SelfManagedKafkaAccessConfigurationCredentials](aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumBatchingWindowInSeconds`  <a name="cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-maximumbatchingwindowinseconds"></a>
The maximum length of a time to wait for events.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerRootCaCertificate`  <a name="cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-serverrootcacertificate"></a>
The ARN of the Secrets Manager secret used for certification.  
*Required*: No  
*Type*: String  
*Pattern*: `^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StartingPosition`  <a name="cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-startingposition"></a>
The position in a stream from which to start reading.  
*Required*: No  
*Type*: String  
*Allowed values*: `TRIM_HORIZON | LATEST`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TopicName`  <a name="cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-topicname"></a>
The name of the topic that the pipe will read from.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[^.]([a-zA-Z0-9\-_.]+)$`  
*Minimum*: `1`  
*Maximum*: `249`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Vpc`  <a name="cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-vpc"></a>
This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.  
*Required*: No  
*Type*: [SelfManagedKafkaAccessConfigurationVpc](aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeSourceSqsQueueParameters
<a name="aws-properties-pipes-pipe-pipesourcesqsqueueparameters"></a>

The parameters for using a Amazon SQS stream as a source.

## Syntax
<a name="aws-properties-pipes-pipe-pipesourcesqsqueueparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipesourcesqsqueueparameters-syntax.json"></a>

```
{
  "[BatchSize](#cfn-pipes-pipe-pipesourcesqsqueueparameters-batchsize)" : Integer,
  "[MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourcesqsqueueparameters-maximumbatchingwindowinseconds)" : Integer
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipesourcesqsqueueparameters-syntax.yaml"></a>

```
  [BatchSize](#cfn-pipes-pipe-pipesourcesqsqueueparameters-batchsize): Integer
  [MaximumBatchingWindowInSeconds](#cfn-pipes-pipe-pipesourcesqsqueueparameters-maximumbatchingwindowinseconds): Integer
```

## Properties
<a name="aws-properties-pipes-pipe-pipesourcesqsqueueparameters-properties"></a>

`BatchSize`  <a name="cfn-pipes-pipe-pipesourcesqsqueueparameters-batchsize"></a>
The maximum number of records to include in each batch.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `10000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumBatchingWindowInSeconds`  <a name="cfn-pipes-pipe-pipesourcesqsqueueparameters-maximumbatchingwindowinseconds"></a>
The maximum length of a time to wait for events.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetBatchJobParameters
<a name="aws-properties-pipes-pipe-pipetargetbatchjobparameters"></a>

The parameters for using an AWS Batch job as a target.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargetbatchjobparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargetbatchjobparameters-syntax.json"></a>

```
{
  "[ArrayProperties](#cfn-pipes-pipe-pipetargetbatchjobparameters-arrayproperties)" : BatchArrayProperties,
  "[ContainerOverrides](#cfn-pipes-pipe-pipetargetbatchjobparameters-containeroverrides)" : BatchContainerOverrides,
  "[DependsOn](#cfn-pipes-pipe-pipetargetbatchjobparameters-dependson)" : [ BatchJobDependency, ... ],
  "[JobDefinition](#cfn-pipes-pipe-pipetargetbatchjobparameters-jobdefinition)" : String,
  "[JobName](#cfn-pipes-pipe-pipetargetbatchjobparameters-jobname)" : String,
  "[Parameters](#cfn-pipes-pipe-pipetargetbatchjobparameters-parameters)" : {Key: Value, ...},
  "[RetryStrategy](#cfn-pipes-pipe-pipetargetbatchjobparameters-retrystrategy)" : BatchRetryStrategy
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargetbatchjobparameters-syntax.yaml"></a>

```
  [ArrayProperties](#cfn-pipes-pipe-pipetargetbatchjobparameters-arrayproperties): 
    BatchArrayProperties
  [ContainerOverrides](#cfn-pipes-pipe-pipetargetbatchjobparameters-containeroverrides): 
    BatchContainerOverrides
  [DependsOn](#cfn-pipes-pipe-pipetargetbatchjobparameters-dependson): 
    - BatchJobDependency
  [JobDefinition](#cfn-pipes-pipe-pipetargetbatchjobparameters-jobdefinition): String
  [JobName](#cfn-pipes-pipe-pipetargetbatchjobparameters-jobname): String
  [Parameters](#cfn-pipes-pipe-pipetargetbatchjobparameters-parameters): 
    Key: Value
  [RetryStrategy](#cfn-pipes-pipe-pipetargetbatchjobparameters-retrystrategy): 
    BatchRetryStrategy
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargetbatchjobparameters-properties"></a>

`ArrayProperties`  <a name="cfn-pipes-pipe-pipetargetbatchjobparameters-arrayproperties"></a>
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.  
*Required*: No  
*Type*: [BatchArrayProperties](aws-properties-pipes-pipe-batcharrayproperties.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ContainerOverrides`  <a name="cfn-pipes-pipe-pipetargetbatchjobparameters-containeroverrides"></a>
The overrides that are sent to a container.  
*Required*: No  
*Type*: [BatchContainerOverrides](aws-properties-pipes-pipe-batchcontaineroverrides.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DependsOn`  <a name="cfn-pipes-pipe-pipetargetbatchjobparameters-dependson"></a>
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.  
*Required*: No  
*Type*: Array of [BatchJobDependency](aws-properties-pipes-pipe-batchjobdependency.md)  
*Minimum*: `0`  
*Maximum*: `20`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`JobDefinition`  <a name="cfn-pipes-pipe-pipetargetbatchjobparameters-jobdefinition"></a>
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.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`JobName`  <a name="cfn-pipes-pipe-pipetargetbatchjobparameters-jobname"></a>
The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (\$1).  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Parameters`  <a name="cfn-pipes-pipe-pipetargetbatchjobparameters-parameters"></a>
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.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetryStrategy`  <a name="cfn-pipes-pipe-pipetargetbatchjobparameters-retrystrategy"></a>
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.  
*Required*: No  
*Type*: [BatchRetryStrategy](aws-properties-pipes-pipe-batchretrystrategy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetCloudWatchLogsParameters
<a name="aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters"></a>

The parameters for using an CloudWatch Logs log stream as a target.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters-syntax.json"></a>

```
{
  "[LogStreamName](#cfn-pipes-pipe-pipetargetcloudwatchlogsparameters-logstreamname)" : String,
  "[Timestamp](#cfn-pipes-pipe-pipetargetcloudwatchlogsparameters-timestamp)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters-syntax.yaml"></a>

```
  [LogStreamName](#cfn-pipes-pipe-pipetargetcloudwatchlogsparameters-logstreamname): String
  [Timestamp](#cfn-pipes-pipe-pipetargetcloudwatchlogsparameters-timestamp): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters-properties"></a>

`LogStreamName`  <a name="cfn-pipes-pipe-pipetargetcloudwatchlogsparameters-logstreamname"></a>
The name of the log stream.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Timestamp`  <a name="cfn-pipes-pipe-pipetargetcloudwatchlogsparameters-timestamp"></a>
A [ dynamic path parameter](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) to a field in the payload containing the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.   
The value cannot be a static timestamp as the provided timestamp would be applied to all events delivered by the Pipe, regardless of when they are actually delivered.  
If no dynamic path parameter is provided, the default value is the time the invocation is processed by the Pipe.  
*Required*: No  
*Type*: String  
*Pattern*: `^\$(\.[\w_-]+(\[(\d+|\*)\])*)*$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetEcsTaskParameters
<a name="aws-properties-pipes-pipe-pipetargetecstaskparameters"></a>

The parameters for using an Amazon ECS task as a target.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargetecstaskparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargetecstaskparameters-syntax.json"></a>

```
{
  "[CapacityProviderStrategy](#cfn-pipes-pipe-pipetargetecstaskparameters-capacityproviderstrategy)" : [ CapacityProviderStrategyItem, ... ],
  "[EnableECSManagedTags](#cfn-pipes-pipe-pipetargetecstaskparameters-enableecsmanagedtags)" : Boolean,
  "[EnableExecuteCommand](#cfn-pipes-pipe-pipetargetecstaskparameters-enableexecutecommand)" : Boolean,
  "[Group](#cfn-pipes-pipe-pipetargetecstaskparameters-group)" : String,
  "[LaunchType](#cfn-pipes-pipe-pipetargetecstaskparameters-launchtype)" : String,
  "[NetworkConfiguration](#cfn-pipes-pipe-pipetargetecstaskparameters-networkconfiguration)" : NetworkConfiguration,
  "[Overrides](#cfn-pipes-pipe-pipetargetecstaskparameters-overrides)" : EcsTaskOverride,
  "[PlacementConstraints](#cfn-pipes-pipe-pipetargetecstaskparameters-placementconstraints)" : [ PlacementConstraint, ... ],
  "[PlacementStrategy](#cfn-pipes-pipe-pipetargetecstaskparameters-placementstrategy)" : [ PlacementStrategy, ... ],
  "[PlatformVersion](#cfn-pipes-pipe-pipetargetecstaskparameters-platformversion)" : String,
  "[PropagateTags](#cfn-pipes-pipe-pipetargetecstaskparameters-propagatetags)" : String,
  "[ReferenceId](#cfn-pipes-pipe-pipetargetecstaskparameters-referenceid)" : String,
  "[Tags](#cfn-pipes-pipe-pipetargetecstaskparameters-tags)" : [ Tag, ... ],
  "[TaskCount](#cfn-pipes-pipe-pipetargetecstaskparameters-taskcount)" : Integer,
  "[TaskDefinitionArn](#cfn-pipes-pipe-pipetargetecstaskparameters-taskdefinitionarn)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargetecstaskparameters-syntax.yaml"></a>

```
  [CapacityProviderStrategy](#cfn-pipes-pipe-pipetargetecstaskparameters-capacityproviderstrategy): 
    - CapacityProviderStrategyItem
  [EnableECSManagedTags](#cfn-pipes-pipe-pipetargetecstaskparameters-enableecsmanagedtags): Boolean
  [EnableExecuteCommand](#cfn-pipes-pipe-pipetargetecstaskparameters-enableexecutecommand): Boolean
  [Group](#cfn-pipes-pipe-pipetargetecstaskparameters-group): String
  [LaunchType](#cfn-pipes-pipe-pipetargetecstaskparameters-launchtype): String
  [NetworkConfiguration](#cfn-pipes-pipe-pipetargetecstaskparameters-networkconfiguration): 
    NetworkConfiguration
  [Overrides](#cfn-pipes-pipe-pipetargetecstaskparameters-overrides): 
    EcsTaskOverride
  [PlacementConstraints](#cfn-pipes-pipe-pipetargetecstaskparameters-placementconstraints): 
    - PlacementConstraint
  [PlacementStrategy](#cfn-pipes-pipe-pipetargetecstaskparameters-placementstrategy): 
    - PlacementStrategy
  [PlatformVersion](#cfn-pipes-pipe-pipetargetecstaskparameters-platformversion): String
  [PropagateTags](#cfn-pipes-pipe-pipetargetecstaskparameters-propagatetags): String
  [ReferenceId](#cfn-pipes-pipe-pipetargetecstaskparameters-referenceid): String
  [Tags](#cfn-pipes-pipe-pipetargetecstaskparameters-tags): 
    - Tag
  [TaskCount](#cfn-pipes-pipe-pipetargetecstaskparameters-taskcount): Integer
  [TaskDefinitionArn](#cfn-pipes-pipe-pipetargetecstaskparameters-taskdefinitionarn): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargetecstaskparameters-properties"></a>

`CapacityProviderStrategy`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-capacityproviderstrategy"></a>
The capacity provider strategy 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.   
*Required*: No  
*Type*: Array of [CapacityProviderStrategyItem](aws-properties-pipes-pipe-capacityproviderstrategyitem.md)  
*Minimum*: `0`  
*Maximum*: `6`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnableECSManagedTags`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-enableecsmanagedtags"></a>
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnableExecuteCommand`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-enableexecutecommand"></a>
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.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Group`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-group"></a>
Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LaunchType`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-launchtype"></a>
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. For more information, see [AWS Fargate on Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) in the *Amazon Elastic Container Service Developer Guide*.  
*Required*: No  
*Type*: String  
*Allowed values*: `EC2 | FARGATE | EXTERNAL`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NetworkConfiguration`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-networkconfiguration"></a>
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.  
*Required*: No  
*Type*: [NetworkConfiguration](aws-properties-pipes-pipe-networkconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Overrides`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-overrides"></a>
The overrides that are associated with a task.  
*Required*: No  
*Type*: [EcsTaskOverride](aws-properties-pipes-pipe-ecstaskoverride.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PlacementConstraints`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-placementconstraints"></a>
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).  
*Required*: No  
*Type*: Array of [PlacementConstraint](aws-properties-pipes-pipe-placementconstraint.md)  
*Minimum*: `0`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PlacementStrategy`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-placementstrategy"></a>
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.   
*Required*: No  
*Type*: [Array](aws-properties-pipes-pipe-placementstrategy.md) of [PlacementStrategy](aws-properties-pipes-pipe-placementstrategy.md)  
*Minimum*: `0`  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PlatformVersion`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-platformversion"></a>
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`. For more information about valid platform versions, see [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PropagateTags`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-propagatetags"></a>
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.   
*Required*: No  
*Type*: String  
*Allowed values*: `TASK_DEFINITION`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReferenceId`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-referenceid"></a>
The reference ID to use for the task.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-tags"></a>
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) in the Amazon ECS API Reference.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-pipes-pipe-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TaskCount`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-taskcount"></a>
The number of tasks to create based on `TaskDefinition`. The default is 1.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TaskDefinitionArn`  <a name="cfn-pipes-pipe-pipetargetecstaskparameters-taskdefinitionarn"></a>
The ARN of the task definition to use if the event target is an Amazon ECS task.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-]+):([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetEventBridgeEventBusParameters
<a name="aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters"></a>

The parameters for using an EventBridge event bus as a target.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters-syntax.json"></a>

```
{
  "[DetailType](#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-detailtype)" : String,
  "[EndpointId](#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-endpointid)" : String,
  "[Resources](#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-resources)" : [ String, ... ],
  "[Source](#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-source)" : String,
  "[Time](#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-time)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters-syntax.yaml"></a>

```
  [DetailType](#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-detailtype): String
  [EndpointId](#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-endpointid): String
  [Resources](#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-resources): 
    - String
  [Source](#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-source): String
  [Time](#cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-time): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters-properties"></a>

`DetailType`  <a name="cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-detailtype"></a>
A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EndpointId`  <a name="cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-endpointid"></a>
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`.  
*Required*: No  
*Type*: String  
*Pattern*: `^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$`  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Resources`  <a name="cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-resources"></a>
AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1 | 0`  
*Maximum*: `1600 | 10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Source`  <a name="cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-source"></a>
The source of the event.  
*Required*: No  
*Type*: String  
*Pattern*: `(?=[/\.\-_A-Za-z0-9]+)((?!aws\.).*)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Time`  <a name="cfn-pipes-pipe-pipetargeteventbridgeeventbusparameters-time"></a>
The time stamp of the event, per [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.txt). If no time stamp is provided, the time stamp of the [PutEvents](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) call is used.  
*Required*: No  
*Type*: String  
*Pattern*: `^\$(\.[\w/_-]+(\[(\d+|\*)\])*)*$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetHttpParameters
<a name="aws-properties-pipes-pipe-pipetargethttpparameters"></a>

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargethttpparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargethttpparameters-syntax.json"></a>

```
{
  "[HeaderParameters](#cfn-pipes-pipe-pipetargethttpparameters-headerparameters)" : {Key: Value, ...},
  "[PathParameterValues](#cfn-pipes-pipe-pipetargethttpparameters-pathparametervalues)" : [ String, ... ],
  "[QueryStringParameters](#cfn-pipes-pipe-pipetargethttpparameters-querystringparameters)" : {Key: Value, ...}
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargethttpparameters-syntax.yaml"></a>

```
  [HeaderParameters](#cfn-pipes-pipe-pipetargethttpparameters-headerparameters): 
    Key: Value
  [PathParameterValues](#cfn-pipes-pipe-pipetargethttpparameters-pathparametervalues): 
    - String
  [QueryStringParameters](#cfn-pipes-pipe-pipetargethttpparameters-querystringparameters): 
    Key: Value
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargethttpparameters-properties"></a>

`HeaderParameters`  <a name="cfn-pipes-pipe-pipetargethttpparameters-headerparameters"></a>
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[!#$%&'*+-.^_`|~0-9a-zA-Z]+|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$`  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PathParameterValues`  <a name="cfn-pipes-pipe-pipetargethttpparameters-pathparametervalues"></a>
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("\$1").  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`QueryStringParameters`  <a name="cfn-pipes-pipe-pipetargethttpparameters-querystringparameters"></a>
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `^[^\x00-\x1F\x7F]+|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$`  
*Minimum*: `0`  
*Maximum*: `512`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetKinesisStreamParameters
<a name="aws-properties-pipes-pipe-pipetargetkinesisstreamparameters"></a>

The parameters for using a Kinesis stream as a target.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargetkinesisstreamparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargetkinesisstreamparameters-syntax.json"></a>

```
{
  "[PartitionKey](#cfn-pipes-pipe-pipetargetkinesisstreamparameters-partitionkey)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargetkinesisstreamparameters-syntax.yaml"></a>

```
  [PartitionKey](#cfn-pipes-pipe-pipetargetkinesisstreamparameters-partitionkey): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargetkinesisstreamparameters-properties"></a>

`PartitionKey`  <a name="cfn-pipes-pipe-pipetargetkinesisstreamparameters-partitionkey"></a>
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.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetLambdaFunctionParameters
<a name="aws-properties-pipes-pipe-pipetargetlambdafunctionparameters"></a>

The parameters for using a Lambda function as a target.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargetlambdafunctionparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargetlambdafunctionparameters-syntax.json"></a>

```
{
  "[InvocationType](#cfn-pipes-pipe-pipetargetlambdafunctionparameters-invocationtype)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargetlambdafunctionparameters-syntax.yaml"></a>

```
  [InvocationType](#cfn-pipes-pipe-pipetargetlambdafunctionparameters-invocationtype): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargetlambdafunctionparameters-properties"></a>

`InvocationType`  <a name="cfn-pipes-pipe-pipetargetlambdafunctionparameters-invocationtype"></a>
Specify whether to invoke the function synchronously or asynchronously.  
+ `REQUEST_RESPONSE` (default) - Invoke synchronously. This corresponds to the `RequestResponse` option in the `InvocationType` parameter for the Lambda [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) API.
+ `FIRE_AND_FORGET` - Invoke asynchronously. This corresponds to the `Event` option in the `InvocationType` parameter for the Lambda [Invoke](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) API.
For more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide*.  
*Required*: No  
*Type*: String  
*Allowed values*: `REQUEST_RESPONSE | FIRE_AND_FORGET`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetParameters
<a name="aws-properties-pipes-pipe-pipetargetparameters"></a>

The parameters required to set up a target for your pipe.

For more information about pipe target parameters, including how to use dynamic path parameters, see [Target parameters](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) in the *Amazon EventBridge User Guide*.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargetparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargetparameters-syntax.json"></a>

```
{
  "[BatchJobParameters](#cfn-pipes-pipe-pipetargetparameters-batchjobparameters)" : PipeTargetBatchJobParameters,
  "[CloudWatchLogsParameters](#cfn-pipes-pipe-pipetargetparameters-cloudwatchlogsparameters)" : PipeTargetCloudWatchLogsParameters,
  "[EcsTaskParameters](#cfn-pipes-pipe-pipetargetparameters-ecstaskparameters)" : PipeTargetEcsTaskParameters,
  "[EventBridgeEventBusParameters](#cfn-pipes-pipe-pipetargetparameters-eventbridgeeventbusparameters)" : PipeTargetEventBridgeEventBusParameters,
  "[HttpParameters](#cfn-pipes-pipe-pipetargetparameters-httpparameters)" : PipeTargetHttpParameters,
  "[InputTemplate](#cfn-pipes-pipe-pipetargetparameters-inputtemplate)" : String,
  "[KinesisStreamParameters](#cfn-pipes-pipe-pipetargetparameters-kinesisstreamparameters)" : PipeTargetKinesisStreamParameters,
  "[LambdaFunctionParameters](#cfn-pipes-pipe-pipetargetparameters-lambdafunctionparameters)" : PipeTargetLambdaFunctionParameters,
  "[RedshiftDataParameters](#cfn-pipes-pipe-pipetargetparameters-redshiftdataparameters)" : PipeTargetRedshiftDataParameters,
  "[SageMakerPipelineParameters](#cfn-pipes-pipe-pipetargetparameters-sagemakerpipelineparameters)" : PipeTargetSageMakerPipelineParameters,
  "[SqsQueueParameters](#cfn-pipes-pipe-pipetargetparameters-sqsqueueparameters)" : PipeTargetSqsQueueParameters,
  "[StepFunctionStateMachineParameters](#cfn-pipes-pipe-pipetargetparameters-stepfunctionstatemachineparameters)" : PipeTargetStateMachineParameters,
  "[TimestreamParameters](#cfn-pipes-pipe-pipetargetparameters-timestreamparameters)" : PipeTargetTimestreamParameters
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargetparameters-syntax.yaml"></a>

```
  [BatchJobParameters](#cfn-pipes-pipe-pipetargetparameters-batchjobparameters): 
    PipeTargetBatchJobParameters
  [CloudWatchLogsParameters](#cfn-pipes-pipe-pipetargetparameters-cloudwatchlogsparameters): 
    PipeTargetCloudWatchLogsParameters
  [EcsTaskParameters](#cfn-pipes-pipe-pipetargetparameters-ecstaskparameters): 
    PipeTargetEcsTaskParameters
  [EventBridgeEventBusParameters](#cfn-pipes-pipe-pipetargetparameters-eventbridgeeventbusparameters): 
    PipeTargetEventBridgeEventBusParameters
  [HttpParameters](#cfn-pipes-pipe-pipetargetparameters-httpparameters): 
    PipeTargetHttpParameters
  [InputTemplate](#cfn-pipes-pipe-pipetargetparameters-inputtemplate): String
  [KinesisStreamParameters](#cfn-pipes-pipe-pipetargetparameters-kinesisstreamparameters): 
    PipeTargetKinesisStreamParameters
  [LambdaFunctionParameters](#cfn-pipes-pipe-pipetargetparameters-lambdafunctionparameters): 
    PipeTargetLambdaFunctionParameters
  [RedshiftDataParameters](#cfn-pipes-pipe-pipetargetparameters-redshiftdataparameters): 
    PipeTargetRedshiftDataParameters
  [SageMakerPipelineParameters](#cfn-pipes-pipe-pipetargetparameters-sagemakerpipelineparameters): 
    PipeTargetSageMakerPipelineParameters
  [SqsQueueParameters](#cfn-pipes-pipe-pipetargetparameters-sqsqueueparameters): 
    PipeTargetSqsQueueParameters
  [StepFunctionStateMachineParameters](#cfn-pipes-pipe-pipetargetparameters-stepfunctionstatemachineparameters): 
    PipeTargetStateMachineParameters
  [TimestreamParameters](#cfn-pipes-pipe-pipetargetparameters-timestreamparameters): 
    PipeTargetTimestreamParameters
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargetparameters-properties"></a>

`BatchJobParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-batchjobparameters"></a>
The parameters for using an AWS Batch job as a target.  
*Required*: No  
*Type*: [PipeTargetBatchJobParameters](aws-properties-pipes-pipe-pipetargetbatchjobparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CloudWatchLogsParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-cloudwatchlogsparameters"></a>
The parameters for using an CloudWatch Logs log stream as a target.  
*Required*: No  
*Type*: [PipeTargetCloudWatchLogsParameters](aws-properties-pipes-pipe-pipetargetcloudwatchlogsparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EcsTaskParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-ecstaskparameters"></a>
The parameters for using an Amazon ECS task as a target.  
*Required*: No  
*Type*: [PipeTargetEcsTaskParameters](aws-properties-pipes-pipe-pipetargetecstaskparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EventBridgeEventBusParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-eventbridgeeventbusparameters"></a>
The parameters for using an EventBridge event bus as a target.  
*Required*: No  
*Type*: [PipeTargetEventBridgeEventBusParameters](aws-properties-pipes-pipe-pipetargeteventbridgeeventbusparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HttpParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-httpparameters"></a>
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.  
*Required*: No  
*Type*: [PipeTargetHttpParameters](aws-properties-pipes-pipe-pipetargethttpparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InputTemplate`  <a name="cfn-pipes-pipe-pipetargetparameters-inputtemplate"></a>
Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see [The JavaScript Object Notation (JSON) Data Interchange Format](http://www.rfc-editor.org/rfc/rfc7159.txt).  
To remove an input template, specify an empty string.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `8192`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KinesisStreamParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-kinesisstreamparameters"></a>
The parameters for using a Kinesis stream as a target.  
*Required*: No  
*Type*: [PipeTargetKinesisStreamParameters](aws-properties-pipes-pipe-pipetargetkinesisstreamparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LambdaFunctionParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-lambdafunctionparameters"></a>
The parameters for using a Lambda function as a target.  
*Required*: No  
*Type*: [PipeTargetLambdaFunctionParameters](aws-properties-pipes-pipe-pipetargetlambdafunctionparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RedshiftDataParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-redshiftdataparameters"></a>
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.  
*Required*: No  
*Type*: [PipeTargetRedshiftDataParameters](aws-properties-pipes-pipe-pipetargetredshiftdataparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SageMakerPipelineParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-sagemakerpipelineparameters"></a>
The parameters for using a SageMaker AI pipeline as a target.  
*Required*: No  
*Type*: [PipeTargetSageMakerPipelineParameters](aws-properties-pipes-pipe-pipetargetsagemakerpipelineparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SqsQueueParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-sqsqueueparameters"></a>
The parameters for using a Amazon SQS stream as a target.  
*Required*: No  
*Type*: [PipeTargetSqsQueueParameters](aws-properties-pipes-pipe-pipetargetsqsqueueparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StepFunctionStateMachineParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-stepfunctionstatemachineparameters"></a>
The parameters for using a Step Functions state machine as a target.  
*Required*: No  
*Type*: [PipeTargetStateMachineParameters](aws-properties-pipes-pipe-pipetargetstatemachineparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimestreamParameters`  <a name="cfn-pipes-pipe-pipetargetparameters-timestreamparameters"></a>
The parameters for using a Timestream for LiveAnalytics table as a target.  
*Required*: No  
*Type*: [PipeTargetTimestreamParameters](aws-properties-pipes-pipe-pipetargettimestreamparameters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetRedshiftDataParameters
<a name="aws-properties-pipes-pipe-pipetargetredshiftdataparameters"></a>

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargetredshiftdataparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargetredshiftdataparameters-syntax.json"></a>

```
{
  "[Database](#cfn-pipes-pipe-pipetargetredshiftdataparameters-database)" : String,
  "[DbUser](#cfn-pipes-pipe-pipetargetredshiftdataparameters-dbuser)" : String,
  "[SecretManagerArn](#cfn-pipes-pipe-pipetargetredshiftdataparameters-secretmanagerarn)" : String,
  "[Sqls](#cfn-pipes-pipe-pipetargetredshiftdataparameters-sqls)" : [ String, ... ],
  "[StatementName](#cfn-pipes-pipe-pipetargetredshiftdataparameters-statementname)" : String,
  "[WithEvent](#cfn-pipes-pipe-pipetargetredshiftdataparameters-withevent)" : Boolean
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargetredshiftdataparameters-syntax.yaml"></a>

```
  [Database](#cfn-pipes-pipe-pipetargetredshiftdataparameters-database): String
  [DbUser](#cfn-pipes-pipe-pipetargetredshiftdataparameters-dbuser): String
  [SecretManagerArn](#cfn-pipes-pipe-pipetargetredshiftdataparameters-secretmanagerarn): String
  [Sqls](#cfn-pipes-pipe-pipetargetredshiftdataparameters-sqls): 
    - String
  [StatementName](#cfn-pipes-pipe-pipetargetredshiftdataparameters-statementname): String
  [WithEvent](#cfn-pipes-pipe-pipetargetredshiftdataparameters-withevent): Boolean
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargetredshiftdataparameters-properties"></a>

`Database`  <a name="cfn-pipes-pipe-pipetargetredshiftdataparameters-database"></a>
The name of the database. Required when authenticating using temporary credentials.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DbUser`  <a name="cfn-pipes-pipe-pipetargetredshiftdataparameters-dbuser"></a>
The database user name. Required when authenticating using temporary credentials.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecretManagerArn`  <a name="cfn-pipes-pipe-pipetargetredshiftdataparameters-secretmanagerarn"></a>
The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets Manager.  
*Required*: No  
*Type*: String  
*Pattern*: `^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Sqls`  <a name="cfn-pipes-pipe-pipetargetredshiftdataparameters-sqls"></a>
The SQL statement text to run.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1 | 1`  
*Maximum*: `100000 | 40`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StatementName`  <a name="cfn-pipes-pipe-pipetargetredshiftdataparameters-statementname"></a>
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `500`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WithEvent`  <a name="cfn-pipes-pipe-pipetargetredshiftdataparameters-withevent"></a>
Indicates whether to send an event back to EventBridge after the SQL statement runs.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetSageMakerPipelineParameters
<a name="aws-properties-pipes-pipe-pipetargetsagemakerpipelineparameters"></a>

The parameters for using a SageMaker AI pipeline as a target.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargetsagemakerpipelineparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargetsagemakerpipelineparameters-syntax.json"></a>

```
{
  "[PipelineParameterList](#cfn-pipes-pipe-pipetargetsagemakerpipelineparameters-pipelineparameterlist)" : [ SageMakerPipelineParameter, ... ]
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargetsagemakerpipelineparameters-syntax.yaml"></a>

```
  [PipelineParameterList](#cfn-pipes-pipe-pipetargetsagemakerpipelineparameters-pipelineparameterlist): 
    - SageMakerPipelineParameter
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargetsagemakerpipelineparameters-properties"></a>

`PipelineParameterList`  <a name="cfn-pipes-pipe-pipetargetsagemakerpipelineparameters-pipelineparameterlist"></a>
List of Parameter names and values for SageMaker AI Model Building Pipeline execution.  
*Required*: No  
*Type*: Array of [SageMakerPipelineParameter](aws-properties-pipes-pipe-sagemakerpipelineparameter.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetSqsQueueParameters
<a name="aws-properties-pipes-pipe-pipetargetsqsqueueparameters"></a>

The parameters for using a Amazon SQS stream as a target.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargetsqsqueueparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargetsqsqueueparameters-syntax.json"></a>

```
{
  "[MessageDeduplicationId](#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagededuplicationid)" : String,
  "[MessageGroupId](#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagegroupid)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargetsqsqueueparameters-syntax.yaml"></a>

```
  [MessageDeduplicationId](#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagededuplicationid): String
  [MessageGroupId](#cfn-pipes-pipe-pipetargetsqsqueueparameters-messagegroupid): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargetsqsqueueparameters-properties"></a>

`MessageDeduplicationId`  <a name="cfn-pipes-pipe-pipetargetsqsqueueparameters-messagededuplicationid"></a>
This parameter applies only to FIFO (first-in-first-out) queues.  
The token used for deduplication of sent messages.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MessageGroupId`  <a name="cfn-pipes-pipe-pipetargetsqsqueueparameters-messagegroupid"></a>
The FIFO message group ID to use as the target.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetStateMachineParameters
<a name="aws-properties-pipes-pipe-pipetargetstatemachineparameters"></a>

The parameters for using a Step Functions state machine as a target.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargetstatemachineparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargetstatemachineparameters-syntax.json"></a>

```
{
  "[InvocationType](#cfn-pipes-pipe-pipetargetstatemachineparameters-invocationtype)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargetstatemachineparameters-syntax.yaml"></a>

```
  [InvocationType](#cfn-pipes-pipe-pipetargetstatemachineparameters-invocationtype): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargetstatemachineparameters-properties"></a>

`InvocationType`  <a name="cfn-pipes-pipe-pipetargetstatemachineparameters-invocationtype"></a>
Specify whether to invoke the Step Functions state machine synchronously or asynchronously.  
+ `REQUEST_RESPONSE` (default) - Invoke synchronously. For more information, see [StartSyncExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html) in the *AWS Step Functions API Reference*.
**Note**  
`REQUEST_RESPONSE` is not supported for `STANDARD` state machine workflows.
+ `FIRE_AND_FORGET` - Invoke asynchronously. For more information, see [StartExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) in the *AWS Step Functions API Reference*.
For more information, see [Invocation types](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation) in the *Amazon EventBridge User Guide*.  
*Required*: No  
*Type*: String  
*Allowed values*: `REQUEST_RESPONSE | FIRE_AND_FORGET`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PipeTargetTimestreamParameters
<a name="aws-properties-pipes-pipe-pipetargettimestreamparameters"></a>

The parameters for using a Timestream for LiveAnalytics table as a target.

## Syntax
<a name="aws-properties-pipes-pipe-pipetargettimestreamparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-pipetargettimestreamparameters-syntax.json"></a>

```
{
  "[DimensionMappings](#cfn-pipes-pipe-pipetargettimestreamparameters-dimensionmappings)" : [ DimensionMapping, ... ],
  "[EpochTimeUnit](#cfn-pipes-pipe-pipetargettimestreamparameters-epochtimeunit)" : String,
  "[MultiMeasureMappings](#cfn-pipes-pipe-pipetargettimestreamparameters-multimeasuremappings)" : [ MultiMeasureMapping, ... ],
  "[SingleMeasureMappings](#cfn-pipes-pipe-pipetargettimestreamparameters-singlemeasuremappings)" : [ SingleMeasureMapping, ... ],
  "[TimeFieldType](#cfn-pipes-pipe-pipetargettimestreamparameters-timefieldtype)" : String,
  "[TimestampFormat](#cfn-pipes-pipe-pipetargettimestreamparameters-timestampformat)" : String,
  "[TimeValue](#cfn-pipes-pipe-pipetargettimestreamparameters-timevalue)" : String,
  "[VersionValue](#cfn-pipes-pipe-pipetargettimestreamparameters-versionvalue)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-pipetargettimestreamparameters-syntax.yaml"></a>

```
  [DimensionMappings](#cfn-pipes-pipe-pipetargettimestreamparameters-dimensionmappings): 
    - DimensionMapping
  [EpochTimeUnit](#cfn-pipes-pipe-pipetargettimestreamparameters-epochtimeunit): String
  [MultiMeasureMappings](#cfn-pipes-pipe-pipetargettimestreamparameters-multimeasuremappings): 
    - MultiMeasureMapping
  [SingleMeasureMappings](#cfn-pipes-pipe-pipetargettimestreamparameters-singlemeasuremappings): 
    - SingleMeasureMapping
  [TimeFieldType](#cfn-pipes-pipe-pipetargettimestreamparameters-timefieldtype): String
  [TimestampFormat](#cfn-pipes-pipe-pipetargettimestreamparameters-timestampformat): String
  [TimeValue](#cfn-pipes-pipe-pipetargettimestreamparameters-timevalue): String
  [VersionValue](#cfn-pipes-pipe-pipetargettimestreamparameters-versionvalue): String
```

## Properties
<a name="aws-properties-pipes-pipe-pipetargettimestreamparameters-properties"></a>

`DimensionMappings`  <a name="cfn-pipes-pipe-pipetargettimestreamparameters-dimensionmappings"></a>
Map source data to dimensions in the target Timestream for LiveAnalytics table.  
For more information, see [Amazon Timestream for LiveAnalytics concepts](https://docs.aws.amazon.com/timestream/latest/developerguide/concepts.html)  
*Required*: Yes  
*Type*: Array of [DimensionMapping](aws-properties-pipes-pipe-dimensionmapping.md)  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EpochTimeUnit`  <a name="cfn-pipes-pipe-pipetargettimestreamparameters-epochtimeunit"></a>
The granularity of the time units used. Default is `MILLISECONDS`.  
Required if `TimeFieldType` is specified as `EPOCH`.  
*Required*: No  
*Type*: String  
*Allowed values*: `MILLISECONDS | SECONDS | MICROSECONDS | NANOSECONDS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MultiMeasureMappings`  <a name="cfn-pipes-pipe-pipetargettimestreamparameters-multimeasuremappings"></a>
Maps multiple measures from the source event to the same record in the specified Timestream for LiveAnalytics table.  
*Required*: No  
*Type*: Array of [MultiMeasureMapping](aws-properties-pipes-pipe-multimeasuremapping.md)  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SingleMeasureMappings`  <a name="cfn-pipes-pipe-pipetargettimestreamparameters-singlemeasuremappings"></a>
Mappings of single source data fields to individual records in the specified Timestream for LiveAnalytics table.  
*Required*: No  
*Type*: Array of [SingleMeasureMapping](aws-properties-pipes-pipe-singlemeasuremapping.md)  
*Minimum*: `0`  
*Maximum*: `8192`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeFieldType`  <a name="cfn-pipes-pipe-pipetargettimestreamparameters-timefieldtype"></a>
The type of time value used.  
The default is `EPOCH`.  
*Required*: No  
*Type*: String  
*Allowed values*: `EPOCH | TIMESTAMP_FORMAT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimestampFormat`  <a name="cfn-pipes-pipe-pipetargettimestreamparameters-timestampformat"></a>
How to format the timestamps. For example, `yyyy-MM-dd'T'HH:mm:ss'Z'`.  
Required if `TimeFieldType` is specified as `TIMESTAMP_FORMAT`.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeValue`  <a name="cfn-pipes-pipe-pipetargettimestreamparameters-timevalue"></a>
Dynamic path to the source data field that represents the time value for your data.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VersionValue`  <a name="cfn-pipes-pipe-pipetargettimestreamparameters-versionvalue"></a>
64 bit version value or source data field that represents the version value for your data.  
Write requests with a higher version number will update the existing measure values of the record and version. In cases where the measure value is the same, the version will still be updated.   
Default value is 1.   
Timestream for LiveAnalytics does not support updating partial measure values in a record.  
Write requests for duplicate data with a higher version number will update the existing measure value and version. In cases where the measure value is the same, `Version` will still be updated. Default value is `1`.  
`Version` must be `1` or greater, or you will receive a `ValidationException` error.
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PlacementConstraint
<a name="aws-properties-pipes-pipe-placementconstraint"></a>

An object representing a constraint on task placement. To learn more, see [Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.

## Syntax
<a name="aws-properties-pipes-pipe-placementconstraint-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-placementconstraint-syntax.json"></a>

```
{
  "[Expression](#cfn-pipes-pipe-placementconstraint-expression)" : String,
  "[Type](#cfn-pipes-pipe-placementconstraint-type)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-placementconstraint-syntax.yaml"></a>

```
  [Expression](#cfn-pipes-pipe-placementconstraint-expression): String
  [Type](#cfn-pipes-pipe-placementconstraint-type): String
```

## Properties
<a name="aws-properties-pipes-pipe-placementconstraint-properties"></a>

`Expression`  <a name="cfn-pipes-pipe-placementconstraint-expression"></a>
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is `distinctInstance`. To learn more, see [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide.   
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `2000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-pipes-pipe-placementconstraint-type"></a>
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.   
*Required*: No  
*Type*: String  
*Allowed values*: `distinctInstance | memberOf`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe PlacementStrategy
<a name="aws-properties-pipes-pipe-placementstrategy"></a>

The task placement strategy for a task or service. To learn more, see [Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the Amazon Elastic Container Service Service Developer Guide.

## Syntax
<a name="aws-properties-pipes-pipe-placementstrategy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-placementstrategy-syntax.json"></a>

```
{
  "[Field](#cfn-pipes-pipe-placementstrategy-field)" : String,
  "[Type](#cfn-pipes-pipe-placementstrategy-type)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-placementstrategy-syntax.yaml"></a>

```
  [Field](#cfn-pipes-pipe-placementstrategy-field): String
  [Type](#cfn-pipes-pipe-placementstrategy-type): String
```

## Properties
<a name="aws-properties-pipes-pipe-placementstrategy-properties"></a>

`Field`  <a name="cfn-pipes-pipe-placementstrategy-field"></a>
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.   
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-pipes-pipe-placementstrategy-type"></a>
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).   
*Required*: No  
*Type*: String  
*Allowed values*: `random | spread | binpack`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe S3LogDestination
<a name="aws-properties-pipes-pipe-s3logdestination"></a>

Represents the Amazon S3 logging configuration settings for the pipe.

## Syntax
<a name="aws-properties-pipes-pipe-s3logdestination-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-s3logdestination-syntax.json"></a>

```
{
  "[BucketName](#cfn-pipes-pipe-s3logdestination-bucketname)" : String,
  "[BucketOwner](#cfn-pipes-pipe-s3logdestination-bucketowner)" : String,
  "[OutputFormat](#cfn-pipes-pipe-s3logdestination-outputformat)" : String,
  "[Prefix](#cfn-pipes-pipe-s3logdestination-prefix)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-s3logdestination-syntax.yaml"></a>

```
  [BucketName](#cfn-pipes-pipe-s3logdestination-bucketname): String
  [BucketOwner](#cfn-pipes-pipe-s3logdestination-bucketowner): String
  [OutputFormat](#cfn-pipes-pipe-s3logdestination-outputformat): String
  [Prefix](#cfn-pipes-pipe-s3logdestination-prefix): String
```

## Properties
<a name="aws-properties-pipes-pipe-s3logdestination-properties"></a>

`BucketName`  <a name="cfn-pipes-pipe-s3logdestination-bucketname"></a>
The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BucketOwner`  <a name="cfn-pipes-pipe-s3logdestination-bucketowner"></a>
The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OutputFormat`  <a name="cfn-pipes-pipe-s3logdestination-outputformat"></a>
The format EventBridge uses for the log records.  
EventBridge currently only supports `json` formatting.  
*Required*: No  
*Type*: String  
*Allowed values*: `json | plain | w3c`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Prefix`  <a name="cfn-pipes-pipe-s3logdestination-prefix"></a>
The prefix text with which to begin Amazon S3 log object names.  
For more information, see [Organizing objects using prefixes](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html) in the *Amazon Simple Storage Service User Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe SageMakerPipelineParameter
<a name="aws-properties-pipes-pipe-sagemakerpipelineparameter"></a>

Name/Value pair of a parameter to start execution of a SageMaker AI Model Building Pipeline.

## Syntax
<a name="aws-properties-pipes-pipe-sagemakerpipelineparameter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-sagemakerpipelineparameter-syntax.json"></a>

```
{
  "[Name](#cfn-pipes-pipe-sagemakerpipelineparameter-name)" : String,
  "[Value](#cfn-pipes-pipe-sagemakerpipelineparameter-value)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-sagemakerpipelineparameter-syntax.yaml"></a>

```
  [Name](#cfn-pipes-pipe-sagemakerpipelineparameter-name): String
  [Value](#cfn-pipes-pipe-sagemakerpipelineparameter-value): String
```

## Properties
<a name="aws-properties-pipes-pipe-sagemakerpipelineparameter-properties"></a>

`Name`  <a name="cfn-pipes-pipe-sagemakerpipelineparameter-name"></a>
Name of parameter to start execution of a SageMaker AI Model Building Pipeline.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-pipes-pipe-sagemakerpipelineparameter-value"></a>
Value of parameter to start execution of a SageMaker AI Model Building Pipeline.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe SelfManagedKafkaAccessConfigurationCredentials
<a name="aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials"></a>

The AWS Secrets Manager secret that stores your stream credentials.

## Syntax
<a name="aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-syntax.json"></a>

```
{
  "[BasicAuth](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-basicauth)" : String,
  "[ClientCertificateTlsAuth](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-clientcertificatetlsauth)" : String,
  "[SaslScram256Auth](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-saslscram256auth)" : String,
  "[SaslScram512Auth](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-saslscram512auth)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-syntax.yaml"></a>

```
  [BasicAuth](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-basicauth): String
  [ClientCertificateTlsAuth](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-clientcertificatetlsauth): String
  [SaslScram256Auth](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-saslscram256auth): String
  [SaslScram512Auth](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-saslscram512auth): String
```

## Properties
<a name="aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-properties"></a>

`BasicAuth`  <a name="cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-basicauth"></a>
The ARN of the Secrets Manager secret.  
*Required*: No  
*Type*: String  
*Pattern*: `^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ClientCertificateTlsAuth`  <a name="cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-clientcertificatetlsauth"></a>
The ARN of the Secrets Manager secret.  
*Required*: No  
*Type*: String  
*Pattern*: `^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SaslScram256Auth`  <a name="cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-saslscram256auth"></a>
The ARN of the Secrets Manager secret.  
*Required*: No  
*Type*: String  
*Pattern*: `^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SaslScram512Auth`  <a name="cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationcredentials-saslscram512auth"></a>
The ARN of the Secrets Manager secret.  
*Required*: No  
*Type*: String  
*Pattern*: `^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)$`  
*Minimum*: `1`  
*Maximum*: `1600`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe SelfManagedKafkaAccessConfigurationVpc
<a name="aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc"></a>

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

## Syntax
<a name="aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-syntax.json"></a>

```
{
  "[SecurityGroup](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-securitygroup)" : [ String, ... ],
  "[Subnets](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-subnets)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-syntax.yaml"></a>

```
  [SecurityGroup](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-securitygroup): 
    - String
  [Subnets](#cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-subnets): 
    - String
```

## Properties
<a name="aws-properties-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-properties"></a>

`SecurityGroup`  <a name="cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-securitygroup"></a>
Specifies the 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.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1 | 0`  
*Maximum*: `1024 | 5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Subnets`  <a name="cfn-pipes-pipe-selfmanagedkafkaaccessconfigurationvpc-subnets"></a>
Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1 | 0`  
*Maximum*: `1024 | 16`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe SingleMeasureMapping
<a name="aws-properties-pipes-pipe-singlemeasuremapping"></a>

Maps a single source data field to a single record in the specified Timestream for LiveAnalytics table.

For more information, see [Amazon Timestream for LiveAnalytics concepts](https://docs.aws.amazon.com/timestream/latest/developerguide/concepts.html)

## Syntax
<a name="aws-properties-pipes-pipe-singlemeasuremapping-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-singlemeasuremapping-syntax.json"></a>

```
{
  "[MeasureName](#cfn-pipes-pipe-singlemeasuremapping-measurename)" : String,
  "[MeasureValue](#cfn-pipes-pipe-singlemeasuremapping-measurevalue)" : String,
  "[MeasureValueType](#cfn-pipes-pipe-singlemeasuremapping-measurevaluetype)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-singlemeasuremapping-syntax.yaml"></a>

```
  [MeasureName](#cfn-pipes-pipe-singlemeasuremapping-measurename): String
  [MeasureValue](#cfn-pipes-pipe-singlemeasuremapping-measurevalue): String
  [MeasureValueType](#cfn-pipes-pipe-singlemeasuremapping-measurevaluetype): String
```

## Properties
<a name="aws-properties-pipes-pipe-singlemeasuremapping-properties"></a>

`MeasureName`  <a name="cfn-pipes-pipe-singlemeasuremapping-measurename"></a>
Target measure name for the measurement attribute in the Timestream table.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MeasureValue`  <a name="cfn-pipes-pipe-singlemeasuremapping-measurevalue"></a>
Dynamic path of the source field to map to the measure in the record.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MeasureValueType`  <a name="cfn-pipes-pipe-singlemeasuremapping-measurevaluetype"></a>
Data type of the source field.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `DOUBLE | BIGINT | VARCHAR | BOOLEAN | TIMESTAMP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Pipes::Pipe Tag
<a name="aws-properties-pipes-pipe-tag"></a>

<a name="aws-properties-pipes-pipe-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::Pipes::Pipe](aws-resource-pipes-pipe.md).

## Syntax
<a name="aws-properties-pipes-pipe-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-pipes-pipe-tag-syntax.json"></a>

```
{
  "[Key](#cfn-pipes-pipe-tag-key)" : String,
  "[Value](#cfn-pipes-pipe-tag-value)" : String
}
```

### YAML
<a name="aws-properties-pipes-pipe-tag-syntax.yaml"></a>

```
  [Key](#cfn-pipes-pipe-tag-key): String
  [Value](#cfn-pipes-pipe-tag-value): String
```

## Properties
<a name="aws-properties-pipes-pipe-tag-properties"></a>

`Key`  <a name="cfn-pipes-pipe-tag-key"></a>
The key of the key-value pair.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-pipes-pipe-tag-value"></a>
The value of the key-value pair.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)