AWS.Pipes — AWS SDK for JavaScript (original) (raw)

Examples:

Calling the createPipe operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  Source: 'STRING_VALUE', /* required */
  Target: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DesiredState: RUNNING | STOPPED,
  Enrichment: 'STRING_VALUE',
  EnrichmentParameters: {
    HttpParameters: {
      HeaderParameters: {
        '<HeaderKey>': 'STRING_VALUE',
        /* '<HeaderKey>': ... */
      },
      PathParameterValues: [
        'STRING_VALUE',
        /* more items */
      ],
      QueryStringParameters: {
        '<QueryStringKey>': 'STRING_VALUE',
        /* '<QueryStringKey>': ... */
      }
    },
    InputTemplate: 'STRING_VALUE'
  },
  LogConfiguration: {
    Level: OFF | ERROR | INFO | TRACE, /* required */
    CloudwatchLogsLogDestination: {
      LogGroupArn: 'STRING_VALUE' /* required */
    },
    FirehoseLogDestination: {
      DeliveryStreamArn: 'STRING_VALUE' /* required */
    },
    IncludeExecutionData: [
      ALL,
      /* more items */
    ],
    S3LogDestination: {
      BucketName: 'STRING_VALUE', /* required */
      BucketOwner: 'STRING_VALUE', /* required */
      OutputFormat: json | plain | w3c,
      Prefix: 'STRING_VALUE'
    }
  },
  SourceParameters: {
    ActiveMQBrokerParameters: {
      Credentials: { /* required */
        BasicAuth: 'STRING_VALUE'
      },
      QueueName: 'STRING_VALUE', /* required */
      BatchSize: 'NUMBER_VALUE',
      MaximumBatchingWindowInSeconds: 'NUMBER_VALUE'
    },
    DynamoDBStreamParameters: {
      StartingPosition: TRIM_HORIZON | LATEST, /* required */
      BatchSize: 'NUMBER_VALUE',
      DeadLetterConfig: {
        Arn: 'STRING_VALUE'
      },
      MaximumBatchingWindowInSeconds: 'NUMBER_VALUE',
      MaximumRecordAgeInSeconds: 'NUMBER_VALUE',
      MaximumRetryAttempts: 'NUMBER_VALUE',
      OnPartialBatchItemFailure: AUTOMATIC_BISECT,
      ParallelizationFactor: 'NUMBER_VALUE'
    },
    FilterCriteria: {
      Filters: [
        {
          Pattern: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    KinesisStreamParameters: {
      StartingPosition: TRIM_HORIZON | LATEST | AT_TIMESTAMP, /* required */
      BatchSize: 'NUMBER_VALUE',
      DeadLetterConfig: {
        Arn: 'STRING_VALUE'
      },
      MaximumBatchingWindowInSeconds: 'NUMBER_VALUE',
      MaximumRecordAgeInSeconds: 'NUMBER_VALUE',
      MaximumRetryAttempts: 'NUMBER_VALUE',
      OnPartialBatchItemFailure: AUTOMATIC_BISECT,
      ParallelizationFactor: 'NUMBER_VALUE',
      StartingPositionTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
    },
    ManagedStreamingKafkaParameters: {
      TopicName: 'STRING_VALUE', /* required */
      BatchSize: 'NUMBER_VALUE',
      ConsumerGroupID: 'STRING_VALUE',
      Credentials: {
        ClientCertificateTlsAuth: 'STRING_VALUE',
        SaslScram512Auth: 'STRING_VALUE'
      },
      MaximumBatchingWindowInSeconds: 'NUMBER_VALUE',
      StartingPosition: TRIM_HORIZON | LATEST
    },
    RabbitMQBrokerParameters: {
      Credentials: { /* required */
        BasicAuth: 'STRING_VALUE'
      },
      QueueName: 'STRING_VALUE', /* required */
      BatchSize: 'NUMBER_VALUE',
      MaximumBatchingWindowInSeconds: 'NUMBER_VALUE',
      VirtualHost: 'STRING_VALUE'
    },
    SelfManagedKafkaParameters: {
      TopicName: 'STRING_VALUE', /* required */
      AdditionalBootstrapServers: [
        'STRING_VALUE',
        /* more items */
      ],
      BatchSize: 'NUMBER_VALUE',
      ConsumerGroupID: 'STRING_VALUE',
      Credentials: {
        BasicAuth: 'STRING_VALUE',
        ClientCertificateTlsAuth: 'STRING_VALUE',
        SaslScram256Auth: 'STRING_VALUE',
        SaslScram512Auth: 'STRING_VALUE'
      },
      MaximumBatchingWindowInSeconds: 'NUMBER_VALUE',
      ServerRootCaCertificate: 'STRING_VALUE',
      StartingPosition: TRIM_HORIZON | LATEST,
      Vpc: {
        SecurityGroup: [
          'STRING_VALUE',
          /* more items */
        ],
        Subnets: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    SqsQueueParameters: {
      BatchSize: 'NUMBER_VALUE',
      MaximumBatchingWindowInSeconds: 'NUMBER_VALUE'
    }
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  TargetParameters: {
    BatchJobParameters: {
      JobDefinition: 'STRING_VALUE', /* required */
      JobName: 'STRING_VALUE', /* required */
      ArrayProperties: {
        Size: 'NUMBER_VALUE'
      },
      ContainerOverrides: {
        Command: [
          'STRING_VALUE',
          /* more items */
        ],
        Environment: [
          {
            Name: 'STRING_VALUE',
            Value: 'STRING_VALUE'
          },
          /* more items */
        ],
        InstanceType: 'STRING_VALUE',
        ResourceRequirements: [
          {
            Type: GPU | MEMORY | VCPU, /* required */
            Value: 'STRING_VALUE' /* required */
          },
          /* more items */
        ]
      },
      DependsOn: [
        {
          JobId: 'STRING_VALUE',
          Type: N_TO_N | SEQUENTIAL
        },
        /* more items */
      ],
      Parameters: {
        '<String>': 'STRING_VALUE',
        /* '<String>': ... */
      },
      RetryStrategy: {
        Attempts: 'NUMBER_VALUE'
      }
    },
    CloudWatchLogsParameters: {
      LogStreamName: 'STRING_VALUE',
      Timestamp: 'STRING_VALUE'
    },
    EcsTaskParameters: {
      TaskDefinitionArn: 'STRING_VALUE', /* required */
      CapacityProviderStrategy: [
        {
          capacityProvider: 'STRING_VALUE', /* required */
          base: 'NUMBER_VALUE',
          weight: 'NUMBER_VALUE'
        },
        /* more items */
      ],
      EnableECSManagedTags: true || false,
      EnableExecuteCommand: true || false,
      Group: 'STRING_VALUE',
      LaunchType: EC2 | FARGATE | EXTERNAL,
      NetworkConfiguration: {
        awsvpcConfiguration: {
          Subnets: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          AssignPublicIp: ENABLED | DISABLED,
          SecurityGroups: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      Overrides: {
        ContainerOverrides: [
          {
            Command: [
              'STRING_VALUE',
              /* more items */
            ],
            Cpu: 'NUMBER_VALUE',
            Environment: [
              {
                name: 'STRING_VALUE',
                value: 'STRING_VALUE'
              },
              /* more items */
            ],
            EnvironmentFiles: [
              {
                type: s3, /* required */
                value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            Memory: 'NUMBER_VALUE',
            MemoryReservation: 'NUMBER_VALUE',
            Name: 'STRING_VALUE',
            ResourceRequirements: [
              {
                type: GPU | InferenceAccelerator, /* required */
                value: 'STRING_VALUE' /* required */
              },
              /* more items */
            ]
          },
          /* more items */
        ],
        Cpu: 'STRING_VALUE',
        EphemeralStorage: {
          sizeInGiB: 'NUMBER_VALUE' /* required */
        },
        ExecutionRoleArn: 'STRING_VALUE',
        InferenceAcceleratorOverrides: [
          {
            deviceName: 'STRING_VALUE',
            deviceType: 'STRING_VALUE'
          },
          /* more items */
        ],
        Memory: 'STRING_VALUE',
        TaskRoleArn: 'STRING_VALUE'
      },
      PlacementConstraints: [
        {
          expression: 'STRING_VALUE',
          type: distinctInstance | memberOf
        },
        /* more items */
      ],
      PlacementStrategy: [
        {
          field: 'STRING_VALUE',
          type: random | spread | binpack
        },
        /* more items */
      ],
      PlatformVersion: 'STRING_VALUE',
      PropagateTags: TASK_DEFINITION,
      ReferenceId: 'STRING_VALUE',
      Tags: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      TaskCount: 'NUMBER_VALUE'
    },
    EventBridgeEventBusParameters: {
      DetailType: 'STRING_VALUE',
      EndpointId: 'STRING_VALUE',
      Resources: [
        'STRING_VALUE',
        /* more items */
      ],
      Source: 'STRING_VALUE',
      Time: 'STRING_VALUE'
    },
    HttpParameters: {
      HeaderParameters: {
        '<HeaderKey>': 'STRING_VALUE',
        /* '<HeaderKey>': ... */
      },
      PathParameterValues: [
        'STRING_VALUE',
        /* more items */
      ],
      QueryStringParameters: {
        '<QueryStringKey>': 'STRING_VALUE',
        /* '<QueryStringKey>': ... */
      }
    },
    InputTemplate: 'STRING_VALUE',
    KinesisStreamParameters: {
      PartitionKey: 'STRING_VALUE' /* required */
    },
    LambdaFunctionParameters: {
      InvocationType: REQUEST_RESPONSE | FIRE_AND_FORGET
    },
    RedshiftDataParameters: {
      Database: 'STRING_VALUE', /* required */
      Sqls: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      DbUser: 'STRING_VALUE',
      SecretManagerArn: 'STRING_VALUE',
      StatementName: 'STRING_VALUE',
      WithEvent: true || false
    },
    SageMakerPipelineParameters: {
      PipelineParameterList: [
        {
          Name: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    SqsQueueParameters: {
      MessageDeduplicationId: 'STRING_VALUE',
      MessageGroupId: 'STRING_VALUE'
    },
    StepFunctionStateMachineParameters: {
      InvocationType: REQUEST_RESPONSE | FIRE_AND_FORGET
    },
    TimestreamParameters: {
      DimensionMappings: [ /* required */
        {
          DimensionName: 'STRING_VALUE', /* required */
          DimensionValue: 'STRING_VALUE', /* required */
          DimensionValueType: VARCHAR /* required */
        },
        /* more items */
      ],
      TimeValue: 'STRING_VALUE', /* required */
      VersionValue: 'STRING_VALUE', /* required */
      EpochTimeUnit: MILLISECONDS | SECONDS | MICROSECONDS | NANOSECONDS,
      MultiMeasureMappings: [
        {
          MultiMeasureAttributeMappings: [ /* required */
            {
              MeasureValue: 'STRING_VALUE', /* required */
              MeasureValueType: DOUBLE | BIGINT | VARCHAR | BOOLEAN | TIMESTAMP, /* required */
              MultiMeasureAttributeName: 'STRING_VALUE' /* required */
            },
            /* more items */
          ],
          MultiMeasureName: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      SingleMeasureMappings: [
        {
          MeasureName: 'STRING_VALUE', /* required */
          MeasureValue: 'STRING_VALUE', /* required */
          MeasureValueType: DOUBLE | BIGINT | VARCHAR | BOOLEAN | TIMESTAMP /* required */
        },
        /* more items */
      ],
      TimeFieldType: EPOCH | TIMESTAMP_FORMAT,
      TimestampFormat: 'STRING_VALUE'
    }
  }
};
pipes.createPipe(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});