Create Pipeline

opensearchingestion_create_pipeline

R Documentation

Creates an OpenSearch Ingestion pipeline

Description

Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.

Usage

opensearchingestion_create_pipeline(PipelineName, MinUnits, MaxUnits,
  PipelineConfigurationBody, LogPublishingOptions, VpcOptions,
  BufferOptions, EncryptionAtRestOptions, Tags)

Arguments

PipelineName

[required] The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

MinUnits

[required] The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

MaxUnits

[required] The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

PipelineConfigurationBody

[required] The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with ⁠\\n⁠.

LogPublishingOptions

Key-value pairs to configure log publishing.

VpcOptions

Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

BufferOptions

Key-value pairs to configure persistent buffering for the pipeline.

EncryptionAtRestOptions

Key-value pairs to configure encryption for data that is written to a persistent buffer.

Tags

List of tags to add to the pipeline upon creation.

Value

A list with the following syntax:

list(
  Pipeline = list(
    PipelineName = "string",
    PipelineArn = "string",
    MinUnits = 123,
    MaxUnits = 123,
    Status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"STARTING"|"START_FAILED"|"STOPPING"|"STOPPED",
    StatusReason = list(
      Description = "string"
    ),
    PipelineConfigurationBody = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedAt = as.POSIXct(
      "2015-01-01"
    ),
    IngestEndpointUrls = list(
      "string"
    ),
    LogPublishingOptions = list(
      IsLoggingEnabled = TRUE|FALSE,
      CloudWatchLogDestination = list(
        LogGroup = "string"
      )
    ),
    VpcEndpoints = list(
      list(
        VpcEndpointId = "string",
        VpcId = "string",
        VpcOptions = list(
          SubnetIds = list(
            "string"
          ),
          SecurityGroupIds = list(
            "string"
          )
        )
      )
    ),
    BufferOptions = list(
      PersistentBufferEnabled = TRUE|FALSE
    ),
    EncryptionAtRestOptions = list(
      KmsKeyArn = "string"
    ),
    ServiceVpcEndpoints = list(
      list(
        ServiceName = "OPENSEARCH_SERVERLESS",
        VpcEndpointId = "string"
      )
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$create_pipeline(
  PipelineName = "string",
  MinUnits = 123,
  MaxUnits = 123,
  PipelineConfigurationBody = "string",
  LogPublishingOptions = list(
    IsLoggingEnabled = TRUE|FALSE,
    CloudWatchLogDestination = list(
      LogGroup = "string"
    )
  ),
  VpcOptions = list(
    SubnetIds = list(
      "string"
    ),
    SecurityGroupIds = list(
      "string"
    )
  ),
  BufferOptions = list(
    PersistentBufferEnabled = TRUE|FALSE
  ),
  EncryptionAtRestOptions = list(
    KmsKeyArn = "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)