Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-osis-pipeline.json
Parent schema serverless-framework-configuration
Type: object

An OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-osis.git

Properties

MaxUnits integer required

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

min=1max=24
MinUnits integer required

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

min=1max=24
PipelineConfigurationBody string | Aws_CF_FunctionString required

The Data Prepper pipeline configuration in YAML format.

PipelineName string | Aws_CF_FunctionString required

Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.

LogPublishingOptions object

Key-value pairs to configure log publishing.

2 nested properties
IsLoggingEnabled boolean

Whether logs should be published.

CloudWatchLogDestination object

The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.

1 nested properties
LogGroup string | Aws_CF_FunctionString
Tags Tag[]

An array of key-value pairs to apply to this resource.

uniqueItems=true
VpcOptions object

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

2 nested properties
SecurityGroupIds string[]

A list of security groups associated with the VPC endpoint.

SubnetIds string[]

A list of subnet IDs associated with the VPC endpoint.

Definitions

LogPublishingOptions object

Key-value pairs to configure log publishing.

IsLoggingEnabled boolean

Whether logs should be published.

CloudWatchLogDestination object

The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.

1 nested properties
LogGroup string | Aws_CF_FunctionString
Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

VpcOptions object

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

SecurityGroupIds string[]

A list of security groups associated with the VPC endpoint.

SubnetIds string[]

A list of subnet IDs associated with the VPC endpoint.

VpcEndpoint object

An OpenSearch Ingestion Service-managed VPC endpoint that will access one or more pipelines.

VpcEndpointId string | Aws_CF_FunctionString

The unique identifier of the endpoint.

VpcId string | Aws_CF_FunctionString

The ID for your VPC. AWS Privatelink generates this value when you create a VPC.

VpcOptions object

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

2 nested properties
SecurityGroupIds string[]

A list of security groups associated with the VPC endpoint.

SubnetIds string[]

A list of subnet IDs associated with the VPC endpoint.