AWS::OSIS::Pipeline

OSIS Pipeline

An OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.

Properties

11 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`MaxUnits`	`integer`	Required
`MinUnits`	`integer`	Required
`PipelineConfigurationBody`	`string`	Required
`PipelineName`	`string`	RequiredCreate-only
`BufferOptions`	`BufferOptions`
`EncryptionAtRestOptions`	`EncryptionAtRestOptions`
`LogPublishingOptions`	`LogPublishingOptions`
`PipelineRoleArn`	`string`
`ResourcePolicy`	`ResourcePolicy`
`Tags`	`Array<Tag>`
`VpcOptions`	`VpcOptions`	Write-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`IngestEndpointUrls`	`Array<string>`	A list of endpoints that can be used for ingesting data into a pipeline
`PipelineArn`	`string`	The Amazon Resource Name (ARN) of the pipeline.
`VpcEndpoints`	`Array<VpcEndpoint>`	The VPC interface endpoints that have access to the pipeline.
`VpcEndpointService`	`string`	The VPC endpoint service name for the pipeline.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::OSIS::Pipeline

Resources:
  MyResource:
    Type: AWS::OSIS::Pipeline
    Properties:
      MaxUnits: 1
      MinUnits: 1
      PipelineConfigurationBody: "value"
      PipelineName: "my-pipelinename"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

osis:CreatePipelineosis:GetPipelineosis:TagResourceosis:ListTagsForResourceosis:GetResourcePolicyosis:PutResourcePolicyiam:PassRoleiam:CreateServiceLinkedRole

read

osis:GetPipelineosis:ListTagsForResourceosis:GetResourcePolicy

update

osis:UpdatePipelineosis:GetPipelineosis:ListTagsForResourceosis:TagResourceosis:UntagResourceosis:GetResourcePolicyosis:PutResourcePolicyosis:DeleteResourcePolicy

delete

osis:DeletePipelineosis:GetPipelinelogs:GetLogDeliverylogs:DeleteLogDeliverylogs:ListLogDeliveries

list

osis:ListPipelines

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceOSIS

Properties15

Required4

TaggingSupported

Primary IDPipelineArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

PipelineName

External Links

AWS Documentation