Pipe

pipes.services.k8s.aws/v1alpha1

Type	Link
GoDoc	pipes-controller/apis/v1alpha1#Pipe

Metadata

Property	Value
Scope	Namespaced
Kind	`Pipe`
ListKind	`PipeList`
Plural	`pipes`
Singular	`pipe`

An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

Spec

description: string
desiredState: string
enrichment: string
enrichmentParameters: 
  httpParameters: 
    headerParameters: {}
    pathParameterValues:
    - string
    queryStringParameters: {}
  inputTemplate: string
name: string
roleARN: string
source: string
sourceParameters: 
  activeMQBrokerParameters: 
    batchSize: integer
    credentials: 
      basicAuth: string
    maximumBatchingWindowInSeconds: integer
    queueName: string
  dynamoDBStreamParameters: 
    batchSize: integer
    deadLetterConfig: 
      arn: string
    maximumBatchingWindowInSeconds: integer
    maximumRecordAgeInSeconds: integer
    maximumRetryAttempts: integer
    onPartialBatchItemFailure: string
    parallelizationFactor: integer
    startingPosition: string
  filterCriteria: 
    filters:
    - pattern: string
  kinesisStreamParameters: 
    batchSize: integer
    deadLetterConfig: 
      arn: string
    maximumBatchingWindowInSeconds: integer
    maximumRecordAgeInSeconds: integer
    maximumRetryAttempts: integer
    onPartialBatchItemFailure: string
    parallelizationFactor: integer
    startingPosition: string
    startingPositionTimestamp: string
  managedStreamingKafkaParameters: 
    batchSize: integer
    consumerGroupID: string
    credentials: 
      clientCertificateTLSAuth: string
      saslSCRAM512Auth: string
    maximumBatchingWindowInSeconds: integer
    startingPosition: string
    topicName: string
  rabbitMQBrokerParameters: 
    batchSize: integer
    credentials: 
      basicAuth: string
    maximumBatchingWindowInSeconds: integer
    queueName: string
    virtualHost: string
  selfManagedKafkaParameters: 
    additionalBootstrapServers:
    - string
    batchSize: integer
    consumerGroupID: string
    credentials: 
      basicAuth: string
      clientCertificateTLSAuth: string
      saslSCRAM256Auth: string
      saslSCRAM512Auth: string
    maximumBatchingWindowInSeconds: integer
    serverRootCaCertificate: string
    startingPosition: string
    topicName: string
    vpc: 
      securityGroup:
      - string
      subnets:
      - string
  sqsQueueParameters: 
    batchSize: integer
    maximumBatchingWindowInSeconds: integer
tags: {}
target: string
targetParameters: 
  batchJobParameters: 
    arrayProperties: 
      size: integer
    containerOverrides: 
      command:
      - string
      environment:
      - name: string
        value: string
      instanceType: string
      resourceRequirements:
      - type_: string
        value: string
    dependsOn:
    - jobID: string
      type_: string
    jobDefinition: string
    jobName: string
    parameters: {}
    retryStrategy: 
      attempts: integer
  cloudWatchLogsParameters: 
    logStreamName: string
    timestamp: string
  ecsTaskParameters: 
    capacityProviderStrategy:
    - base: integer
      capacityProvider: string
      weight: integer
    enableECSManagedTags: boolean
    enableExecuteCommand: boolean
    group: string
    launchType: string
    networkConfiguration: 
      awsVPCConfiguration: 
        assignPublicIP: string
        securityGroups:
        - string
        subnets:
        - string
    overrides: 
      containerOverrides:
        command:
        - string
        cpu: integer
        environment:
        - name: string
          value: string
        environmentFiles:
        - type_: string
          value: string
        memory: integer
        memoryReservation: integer
        name: string
        resourceRequirements:
        - type_: string
          value: string
      cpu: string
      ephemeralStorage: 
        sizeInGiB: integer
      executionRoleARN: string
      inferenceAcceleratorOverrides:
      - deviceName: string
        deviceType: string
      memory: string
      taskRoleARN: string
    placementConstraints:
    - expression: string
      type_: string
    placementStrategy:
    - field: string
      type_: string
    platformVersion: string
    propagateTags: string
    referenceID: string
    tags:
    - key: string
      value: string
    taskCount: integer
    taskDefinitionARN: string
  eventBridgeEventBusParameters: 
    detailType: string
    endpointID: string
    resources:
    - string
    source: string
    time: string
  httpParameters: 
    headerParameters: {}
    pathParameterValues:
    - string
    queryStringParameters: {}
  inputTemplate: string
  kinesisStreamParameters: 
    partitionKey: string
  lambdaFunctionParameters: 
    invocationType: string
  redshiftDataParameters: 
    database: string
    dbUser: string
    secretManagerARN: string
    sqls:
    - string
    statementName: string
    withEvent: boolean
  sageMakerPipelineParameters: 
    pipelineParameterList:
    - name: string
      value: string
  sqsQueueParameters: 
    messageDeduplicationID: string
    messageGroupID: string
  stepFunctionStateMachineParameters: 
    invocationType: string

Field	Description
description Optional	string A description of the pipe.
desiredState Optional	string The state the pipe should be in.
enrichment Optional	string The ARN of the enrichment resource.
enrichmentParameters Optional	object The parameters required to set up enrichment on your pipe.
enrichmentParameters.httpParameters Optional	object 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.
enrichmentParameters.httpParameters.headerParameters Optional	object
enrichmentParameters.httpParameters.pathParameterValues Optional	array
enrichmentParameters.httpParameters.pathParameterValues.[] Required	string
enrichmentParameters.inputTemplate Optional	string
name Required	string The name of the pipe.
roleARN Required	string The ARN of the role that allows the pipe to send data to the target.
source Required	string The ARN of the source resource.
sourceParameters Optional	object The parameters required to set up a source for your pipe.
sourceParameters.activeMQBrokerParameters Optional	object The parameters for using an Active MQ broker as a source.
sourceParameters.activeMQBrokerParameters.batchSize Optional	integer
sourceParameters.activeMQBrokerParameters.credentials Optional	object The Secrets Manager secret that stores your broker credentials.
sourceParameters.activeMQBrokerParameters.credentials.basicAuth Optional	string // Optional SecretManager ARN which stores the database credentials
sourceParameters.activeMQBrokerParameters.maximumBatchingWindowInSeconds Optional	integer
sourceParameters.activeMQBrokerParameters.queueName Optional	string
sourceParameters.dynamoDBStreamParameters Optional	object The parameters for using a DynamoDB stream as a source.
sourceParameters.dynamoDBStreamParameters.batchSize Optional	integer
sourceParameters.dynamoDBStreamParameters.deadLetterConfig Optional	object A DeadLetterConfig object that contains information about a dead-letter queue configuration.
sourceParameters.dynamoDBStreamParameters.deadLetterConfig.arn Optional	string
sourceParameters.dynamoDBStreamParameters.maximumBatchingWindowInSeconds Optional	integer
sourceParameters.dynamoDBStreamParameters.maximumRecordAgeInSeconds Optional	integer
sourceParameters.dynamoDBStreamParameters.maximumRetryAttempts Optional	integer
sourceParameters.dynamoDBStreamParameters.onPartialBatchItemFailure Optional	string
sourceParameters.dynamoDBStreamParameters.parallelizationFactor Optional	integer
sourceParameters.dynamoDBStreamParameters.startingPosition Optional	string
sourceParameters.filterCriteria Optional	object 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.
sourceParameters.filterCriteria.filters Optional	array
sourceParameters.filterCriteria.filters.[] Required	object 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.
sourceParameters.kinesisStreamParameters Optional	object The parameters for using a Kinesis stream as a source.
sourceParameters.kinesisStreamParameters.batchSize Optional	integer
sourceParameters.kinesisStreamParameters.deadLetterConfig Optional	object A DeadLetterConfig object that contains information about a dead-letter queue configuration.
sourceParameters.kinesisStreamParameters.deadLetterConfig.arn Optional	string
sourceParameters.kinesisStreamParameters.maximumBatchingWindowInSeconds Optional	integer
sourceParameters.kinesisStreamParameters.maximumRecordAgeInSeconds Optional	integer
sourceParameters.kinesisStreamParameters.maximumRetryAttempts Optional	integer
sourceParameters.kinesisStreamParameters.onPartialBatchItemFailure Optional	string
sourceParameters.kinesisStreamParameters.parallelizationFactor Optional	integer
sourceParameters.kinesisStreamParameters.startingPosition Optional	string
sourceParameters.kinesisStreamParameters.startingPositionTimestamp Optional	string
sourceParameters.managedStreamingKafkaParameters Optional	object The parameters for using an MSK stream as a source.
sourceParameters.managedStreamingKafkaParameters.batchSize Optional	integer
sourceParameters.managedStreamingKafkaParameters.consumerGroupID Optional	string
sourceParameters.managedStreamingKafkaParameters.credentials Optional	object The Secrets Manager secret that stores your stream credentials.
sourceParameters.managedStreamingKafkaParameters.credentials.clientCertificateTLSAuth Optional	string // Optional SecretManager ARN which stores the database credentials
sourceParameters.managedStreamingKafkaParameters.credentials.saslSCRAM512Auth Optional	string // Optional SecretManager ARN which stores the database credentials
sourceParameters.managedStreamingKafkaParameters.maximumBatchingWindowInSeconds Optional	integer
sourceParameters.managedStreamingKafkaParameters.startingPosition Optional	string
sourceParameters.managedStreamingKafkaParameters.topicName Optional	string
sourceParameters.rabbitMQBrokerParameters Optional	object The parameters for using a Rabbit MQ broker as a source.
sourceParameters.rabbitMQBrokerParameters.batchSize Optional	integer
sourceParameters.rabbitMQBrokerParameters.credentials Optional	object The Secrets Manager secret that stores your broker credentials.
sourceParameters.rabbitMQBrokerParameters.credentials.basicAuth Optional	string // Optional SecretManager ARN which stores the database credentials
sourceParameters.rabbitMQBrokerParameters.maximumBatchingWindowInSeconds Optional	integer
sourceParameters.rabbitMQBrokerParameters.queueName Optional	string
sourceParameters.rabbitMQBrokerParameters.virtualHost Optional	string
sourceParameters.selfManagedKafkaParameters Optional	object 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 Amazon Web Services. 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.
sourceParameters.selfManagedKafkaParameters.additionalBootstrapServers Optional	array
sourceParameters.selfManagedKafkaParameters.additionalBootstrapServers.[] Required	string
sourceParameters.selfManagedKafkaParameters.consumerGroupID Optional	string
sourceParameters.selfManagedKafkaParameters.credentials Optional	object The Secrets Manager secret that stores your stream credentials.
sourceParameters.selfManagedKafkaParameters.credentials.basicAuth Optional	string // Optional SecretManager ARN which stores the database credentials
sourceParameters.selfManagedKafkaParameters.credentials.clientCertificateTLSAuth Optional	string // Optional SecretManager ARN which stores the database credentials
sourceParameters.selfManagedKafkaParameters.credentials.saslSCRAM256Auth Optional	string // Optional SecretManager ARN which stores the database credentials
sourceParameters.selfManagedKafkaParameters.credentials.saslSCRAM512Auth Optional	string // Optional SecretManager ARN which stores the database credentials
sourceParameters.selfManagedKafkaParameters.maximumBatchingWindowInSeconds Optional	integer
sourceParameters.selfManagedKafkaParameters.serverRootCaCertificate Optional	string // Optional SecretManager ARN which stores the database credentials
sourceParameters.selfManagedKafkaParameters.startingPosition Optional	string
sourceParameters.selfManagedKafkaParameters.topicName Optional	string
sourceParameters.selfManagedKafkaParameters.vpc Optional	object This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
sourceParameters.selfManagedKafkaParameters.vpc.securityGroup Optional	array List of SecurityGroupId.
sourceParameters.selfManagedKafkaParameters.vpc.securityGroup.[] Required	string
sourceParameters.selfManagedKafkaParameters.vpc.subnets.[] Required	string
sourceParameters.sqsQueueParameters.batchSize Optional	integer
sourceParameters.sqsQueueParameters.maximumBatchingWindowInSeconds Optional	integer
tags Optional	object The list of key-value pairs to associate with the pipe.
target Required	string The ARN of the target resource.
targetParameters Optional	object 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.
targetParameters.batchJobParameters Optional	object The parameters for using an Batch job as a target.
targetParameters.batchJobParameters.arrayProperties Optional	object 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 Batch job.
targetParameters.batchJobParameters.arrayProperties.size Optional	integer
targetParameters.batchJobParameters.containerOverrides Optional	object The overrides that are sent to a container.
targetParameters.batchJobParameters.containerOverrides.command Optional	array
targetParameters.batchJobParameters.containerOverrides.command.[] Required	string
targetParameters.batchJobParameters.containerOverrides.environment.[] Required	object 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 “Batch”. This naming convention is reserved for variables that Batch sets. || targetParameters.batchJobParameters.containerOverrides.environment.[].name
Optional | string
| | targetParameters.batchJobParameters.containerOverrides.environment.[].value
Optional | string
| | targetParameters.batchJobParameters.containerOverrides.instanceType
Optional | string
| | targetParameters.batchJobParameters.containerOverrides.resourceRequirements
Optional | array
| | targetParameters.batchJobParameters.containerOverrides.resourceRequirements.[]
Required | object
The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU. || **targetParameters.batchJobParameters.containerOverrides.resourceRequirements.[].type_**
Optional | **string**
| | **targetParameters.batchJobParameters.containerOverrides.resourceRequirements.[].value**
Optional | **string**
| | **targetParameters.batchJobParameters.dependsOn**
Optional | **array**
| | **targetParameters.batchJobParameters.dependsOn.[]**
Required | **object**
An object that represents an Batch job dependency. || **targetParameters.batchJobParameters.dependsOn.[].jobID**
Optional | **string**
| | **targetParameters.batchJobParameters.dependsOn.[].type_**
Optional | **string**
| | **targetParameters.batchJobParameters.jobDefinition**
Optional | **string**
| | **targetParameters.batchJobParameters.jobName**
Optional | **string**
| | **targetParameters.batchJobParameters.parameters**
Optional | **object**
| | **targetParameters.batchJobParameters.retryStrategy**
Optional | **object**
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 Batch User Guide. | | **targetParameters.batchJobParameters.retryStrategy.attempts**
Optional | **integer**
| | **targetParameters.cloudWatchLogsParameters**
Optional | **object**
The parameters for using an CloudWatch Logs log stream as a target. | | **targetParameters.cloudWatchLogsParameters.logStreamName**
Optional | **string**
| | **targetParameters.cloudWatchLogsParameters.timestamp**
Optional | **string**
| | **targetParameters.ecsTaskParameters**
Optional | **object**
The parameters for using an Amazon ECS task as a target. | | **targetParameters.ecsTaskParameters.capacityProviderStrategy**
Optional | **array**
| | **targetParameters.ecsTaskParameters.capacityProviderStrategy.[]**
Required | **object**
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. || **targetParameters.ecsTaskParameters.capacityProviderStrategy.[].base**
Optional | **integer**
| | **targetParameters.ecsTaskParameters.capacityProviderStrategy.[].capacityProvider**
Optional | **string**
| | **targetParameters.ecsTaskParameters.capacityProviderStrategy.[].weight**
Optional | **integer**
| | **targetParameters.ecsTaskParameters.enableECSManagedTags**
Optional | **boolean**
| | **targetParameters.ecsTaskParameters.enableExecuteCommand**
Optional | **boolean**
| | **targetParameters.ecsTaskParameters.group**
Optional | **string**
| | **targetParameters.ecsTaskParameters.launchType**
Optional | **string**
| | **targetParameters.ecsTaskParameters.networkConfiguration**
Optional | **object**
This structure specifies the network configuration for an Amazon ECS task. | | **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration**
Optional | **object**
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. | | **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.assignPublicIP**
Optional | **string**
| | **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.securityGroups**
Optional | **array**
| | **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.securityGroups.[]**
Required | **string**
|| **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.subnets**
Optional | **array**
| | **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.subnets.[]**
Required | **string**
|| **targetParameters.ecsTaskParameters.overrides**
Optional | **object**
The overrides that are associated with a task. | | **targetParameters.ecsTaskParameters.overrides.containerOverrides**
Optional | **array**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[]**
Required | **object**
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. || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].command**
Optional | **array**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].command.[]**
Required | **string**
|| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].cpu**
Optional | **integer**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment**
Optional | **array**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment.[]**
Required | **object**
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. || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment.[].name**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment.[].value**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles**
Optional | **array**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles.[]**
Required | **object**
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. || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles.[].type_**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles.[].value**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].memory**
Optional | **integer**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].memoryReservation**
Optional | **integer**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].name**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements**
Optional | **array**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements.[]**
Required | **object**
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 || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements.[].type_**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements.[].value**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.cpu**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.ephemeralStorage**
Optional | **object**
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.

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. | | **targetParameters.ecsTaskParameters.overrides.ephemeralStorage.sizeInGiB**
Optional | **integer**
| | **targetParameters.ecsTaskParameters.overrides.executionRoleARN**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides**
Optional | **array**
| | **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides.[]**
Required | **object**
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. || **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides.[].deviceName**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides.[].deviceType**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.memory**
Optional | **string**
| | **targetParameters.ecsTaskParameters.overrides.taskRoleARN**
Optional | **string**
| | **targetParameters.ecsTaskParameters.placementConstraints**
Optional | **array**
| | **targetParameters.ecsTaskParameters.placementConstraints.[]**
Required | **object**
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. || **targetParameters.ecsTaskParameters.placementConstraints.[].expression**
Optional | **string**
| | **targetParameters.ecsTaskParameters.placementConstraints.[].type_**
Optional | **string**
| | **targetParameters.ecsTaskParameters.placementStrategy**
Optional | **array**
| | **targetParameters.ecsTaskParameters.placementStrategy.[]**
Required | **object**
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. || **targetParameters.ecsTaskParameters.placementStrategy.[].field**
Optional | **string**
| | **targetParameters.ecsTaskParameters.placementStrategy.[].type_**
Optional | **string**
| | **targetParameters.ecsTaskParameters.platformVersion**
Optional | **string**
| | **targetParameters.ecsTaskParameters.propagateTags**
Optional | **string**
| | **targetParameters.ecsTaskParameters.referenceID**
Optional | **string**
| | **targetParameters.ecsTaskParameters.tags**
Optional | **array**
| | **targetParameters.ecsTaskParameters.tags.[]**
Required | **object**
A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging. || **targetParameters.ecsTaskParameters.tags.[].key**
Optional | **string**
| | **targetParameters.ecsTaskParameters.tags.[].value**
Optional | **string**
| | **targetParameters.ecsTaskParameters.taskCount**
Optional | **integer**
| | **targetParameters.ecsTaskParameters.taskDefinitionARN**
Optional | **string**
| | **targetParameters.eventBridgeEventBusParameters**
Optional | **object**
The parameters for using an EventBridge event bus as a target. | | **targetParameters.eventBridgeEventBusParameters.detailType**
Optional | **string**
| | **targetParameters.eventBridgeEventBusParameters.endpointID**
Optional | **string**
| | **targetParameters.eventBridgeEventBusParameters.resources**
Optional | **array**
| | **targetParameters.eventBridgeEventBusParameters.resources.[]**
Required | **string**
|| **targetParameters.eventBridgeEventBusParameters.source**
Optional | **string**
| | **targetParameters.eventBridgeEventBusParameters.time**
Optional | **string**
| | **targetParameters.httpParameters**
Optional | **object**
These are custom parameter to be used when the target is an API Gateway REST
APIs or EventBridge ApiDestinations. | | **targetParameters.httpParameters.headerParameters**
Optional | **object**
| | **targetParameters.httpParameters.pathParameterValues**
Optional | **array**
| | **targetParameters.httpParameters.pathParameterValues.[]**
Required | **string**
|| **targetParameters.httpParameters.queryStringParameters**
Optional | **object**
| | **targetParameters.inputTemplate**
Optional | **string**
| | **targetParameters.kinesisStreamParameters**
Optional | **object**
The parameters for using a Kinesis stream as a target. | | **targetParameters.kinesisStreamParameters.partitionKey**
Optional | **string**
| | **targetParameters.lambdaFunctionParameters**
Optional | **object**
The parameters for using a Lambda function as a target. | | **targetParameters.lambdaFunctionParameters.invocationType**
Optional | **string**
| | **targetParameters.redshiftDataParameters**
Optional | **object**
These are custom parameters to be used when the target is a Amazon Redshift
cluster to invoke the Amazon Redshift Data API BatchExecuteStatement. | | **targetParameters.redshiftDataParameters.database**
Optional | **string**
// Redshift Database | | **targetParameters.redshiftDataParameters.dbUser**
Optional | **string**
// Database user name | | **targetParameters.redshiftDataParameters.secretManagerARN**
Optional | **string**
// For targets, can either specify an ARN or a jsonpath pointing to the ARN. | | **targetParameters.redshiftDataParameters.sqls**
Optional | **array**
// A list of SQLs. | | **targetParameters.redshiftDataParameters.sqls.[]**
Required | **string**
|| **targetParameters.redshiftDataParameters.statementName**
Optional | **string**
// A name for Redshift DataAPI statement which can be used as filter of//
ListStatement. | | **targetParameters.redshiftDataParameters.withEvent**
Optional | **boolean**
| | **targetParameters.sageMakerPipelineParameters**
Optional | **object**
The parameters for using a SageMaker pipeline as a target. | | **targetParameters.sageMakerPipelineParameters.pipelineParameterList**
Optional | **array**
| | **targetParameters.sageMakerPipelineParameters.pipelineParameterList.[]**
Required | **object**
Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline. || **targetParameters.sageMakerPipelineParameters.pipelineParameterList.[].name**
Optional | **string**
| | **targetParameters.sageMakerPipelineParameters.pipelineParameterList.[].value**
Optional | **string**
| | **targetParameters.sqsQueueParameters**
Optional | **object**
The parameters for using a Amazon SQS stream as a target. | | **targetParameters.sqsQueueParameters.messageDeduplicationID**
Optional | **string**
| | **targetParameters.sqsQueueParameters.messageGroupID**
Optional | **string**
| | **targetParameters.stepFunctionStateMachineParameters**
Optional | **object**
The parameters for using a Step Functions state machine as a target. | | **targetParameters.stepFunctionStateMachineParameters.invocationType**
Optional | **string**
|

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationTime: string
currentState: string
lastModifiedTime: string
stateReason: string

Field	Description
ackResourceMetadata Optional	object All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn Optional	string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
conditions Optional	array All CRs managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[] Required	object Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition
creationTime Optional	string The time the pipe was created.
currentState Optional	string The state the pipe is in.
lastModifiedTime Optional	string When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).
stateReason Optional	string The reason the pipe is in its current state.

Pipe

Metadata#

Spec#

Status#

Metadata

Spec

Status