Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. osis
  5. Pipeline

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.osis.Pipeline

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    An OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.

    Create Pipeline Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Pipeline(name: string, args: PipelineArgs, opts?: CustomResourceOptions);
    @overload
def Pipeline(resource_name: str,
             args: PipelineArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Pipeline(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             max_units: Optional[int] = None,
             min_units: Optional[int] = None,
             pipeline_configuration_body: Optional[str] = None,
             buffer_options: Optional[PipelineBufferOptionsArgs] = None,
             encryption_at_rest_options: Optional[PipelineEncryptionAtRestOptionsArgs] = None,
             log_publishing_options: Optional[PipelineLogPublishingOptionsArgs] = None,
             pipeline_name: Optional[str] = None,
             tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
             vpc_options: Optional[PipelineVpcOptionsArgs] = None)
    func NewPipeline(ctx *Context, name string, args PipelineArgs, opts ...ResourceOption) (*Pipeline, error)
    public Pipeline(string name, PipelineArgs args, CustomResourceOptions? opts = null)
    public Pipeline(String name, PipelineArgs args)
public Pipeline(String name, PipelineArgs args, CustomResourceOptions options)

    type: aws-native:osis:Pipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Pipeline Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Pipeline resource accepts the following input properties:

    MaxUnits int
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    MinUnits int
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    PipelineConfigurationBody string
    The Data Prepper pipeline configuration.
    BufferOptions Pulumi.AwsNative.Osis.Inputs.PipelineBufferOptions
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    EncryptionAtRestOptions Pulumi.AwsNative.Osis.Inputs.PipelineEncryptionAtRestOptions
    Options to control how OpenSearch encrypts buffer data.
    LogPublishingOptions Pulumi.AwsNative.Osis.Inputs.PipelineLogPublishingOptions
    Key-value pairs that represent log publishing settings.
    PipelineName string
    Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    VpcOptions Pulumi.AwsNative.Osis.Inputs.PipelineVpcOptions
    Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
    MaxUnits int
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    MinUnits int
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    PipelineConfigurationBody string
    The Data Prepper pipeline configuration.
    BufferOptions PipelineBufferOptionsArgs
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    EncryptionAtRestOptions PipelineEncryptionAtRestOptionsArgs
    Options to control how OpenSearch encrypts buffer data.
    LogPublishingOptions PipelineLogPublishingOptionsArgs
    Key-value pairs that represent log publishing settings.
    PipelineName string
    Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    VpcOptions PipelineVpcOptionsArgs
    Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
    maxUnits Integer
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    minUnits Integer
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    pipelineConfigurationBody String
    The Data Prepper pipeline configuration.
    bufferOptions PipelineBufferOptions
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    encryptionAtRestOptions PipelineEncryptionAtRestOptions
    Options to control how OpenSearch encrypts buffer data.
    logPublishingOptions PipelineLogPublishingOptions
    Key-value pairs that represent log publishing settings.
    pipelineName String
    Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    vpcOptions PipelineVpcOptions
    Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
    maxUnits number
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    minUnits number
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    pipelineConfigurationBody string
    The Data Prepper pipeline configuration.
    bufferOptions PipelineBufferOptions
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    encryptionAtRestOptions PipelineEncryptionAtRestOptions
    Options to control how OpenSearch encrypts buffer data.
    logPublishingOptions PipelineLogPublishingOptions
    Key-value pairs that represent log publishing settings.
    pipelineName string
    Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    vpcOptions PipelineVpcOptions
    Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
    max_units int
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    min_units int
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    pipeline_configuration_body str
    The Data Prepper pipeline configuration.
    buffer_options PipelineBufferOptionsArgs
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    encryption_at_rest_options PipelineEncryptionAtRestOptionsArgs
    Options to control how OpenSearch encrypts buffer data.
    log_publishing_options PipelineLogPublishingOptionsArgs
    Key-value pairs that represent log publishing settings.
    pipeline_name str
    Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    vpc_options PipelineVpcOptionsArgs
    Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
    maxUnits Number
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    minUnits Number
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    pipelineConfigurationBody String
    The Data Prepper pipeline configuration.
    bufferOptions Property Map
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    encryptionAtRestOptions Property Map
    Options to control how OpenSearch encrypts buffer data.
    logPublishingOptions Property Map
    Key-value pairs that represent log publishing settings.
    pipelineName String
    Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    vpcOptions Property Map
    Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Pipeline resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IngestEndpointUrls List<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.
    VpcEndpointService string
    The VPC endpoint service name for the pipeline.
    VpcEndpoints List<Pulumi.AwsNative.Osis.Outputs.PipelineVpcEndpoint>
    The VPC interface endpoints that have access to the pipeline.
    Id string
    The provider-assigned unique ID for this managed resource.
    IngestEndpointUrls []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.
    VpcEndpointService string
    The VPC endpoint service name for the pipeline.
    VpcEndpoints []PipelineVpcEndpoint
    The VPC interface endpoints that have access to the pipeline.
    id String
    The provider-assigned unique ID for this managed resource.
    ingestEndpointUrls List<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.
    vpcEndpointService String
    The VPC endpoint service name for the pipeline.
    vpcEndpoints List<PipelineVpcEndpoint>
    The VPC interface endpoints that have access to the pipeline.
    id string
    The provider-assigned unique ID for this managed resource.
    ingestEndpointUrls 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.
    vpcEndpointService string
    The VPC endpoint service name for the pipeline.
    vpcEndpoints PipelineVpcEndpoint[]
    The VPC interface endpoints that have access to the pipeline.
    id str
    The provider-assigned unique ID for this managed resource.
    ingest_endpoint_urls Sequence[str]
    A list of endpoints that can be used for ingesting data into a pipeline
    pipeline_arn str
    The Amazon Resource Name (ARN) of the pipeline.
    vpc_endpoint_service str
    The VPC endpoint service name for the pipeline.
    vpc_endpoints Sequence[PipelineVpcEndpoint]
    The VPC interface endpoints that have access to the pipeline.
    id String
    The provider-assigned unique ID for this managed resource.
    ingestEndpointUrls List<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.
    vpcEndpointService String
    The VPC endpoint service name for the pipeline.
    vpcEndpoints List<Property Map>
    The VPC interface endpoints that have access to the pipeline.

    Supporting Types

    PipelineBufferOptions, PipelineBufferOptionsArgs

    PersistentBufferEnabled bool
    Whether persistent buffering should be enabled.
    PersistentBufferEnabled bool
    Whether persistent buffering should be enabled.
    persistentBufferEnabled Boolean
    Whether persistent buffering should be enabled.
    persistentBufferEnabled boolean
    Whether persistent buffering should be enabled.
    persistent_buffer_enabled bool
    Whether persistent buffering should be enabled.
    persistentBufferEnabled Boolean
    Whether persistent buffering should be enabled.

    PipelineEncryptionAtRestOptions, PipelineEncryptionAtRestOptionsArgs

    KmsKeyArn string
    The KMS key to use for encrypting data. By default an AWS owned key is used
    KmsKeyArn string
    The KMS key to use for encrypting data. By default an AWS owned key is used
    kmsKeyArn String
    The KMS key to use for encrypting data. By default an AWS owned key is used
    kmsKeyArn string
    The KMS key to use for encrypting data. By default an AWS owned key is used
    kms_key_arn str
    The KMS key to use for encrypting data. By default an AWS owned key is used
    kmsKeyArn String
    The KMS key to use for encrypting data. By default an AWS owned key is used

    PipelineLogPublishingOptions, PipelineLogPublishingOptionsArgs

    CloudWatchLogDestination Pulumi.AwsNative.Osis.Inputs.PipelineLogPublishingOptionsCloudWatchLogDestinationProperties
    The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
    IsLoggingEnabled bool
    Whether logs should be published.
    CloudWatchLogDestination PipelineLogPublishingOptionsCloudWatchLogDestinationProperties
    The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
    IsLoggingEnabled bool
    Whether logs should be published.
    cloudWatchLogDestination PipelineLogPublishingOptionsCloudWatchLogDestinationProperties
    The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
    isLoggingEnabled Boolean
    Whether logs should be published.
    cloudWatchLogDestination PipelineLogPublishingOptionsCloudWatchLogDestinationProperties
    The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
    isLoggingEnabled boolean
    Whether logs should be published.
    cloud_watch_log_destination PipelineLogPublishingOptionsCloudWatchLogDestinationProperties
    The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
    is_logging_enabled bool
    Whether logs should be published.
    cloudWatchLogDestination Property Map
    The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
    isLoggingEnabled Boolean
    Whether logs should be published.

    PipelineLogPublishingOptionsCloudWatchLogDestinationProperties, PipelineLogPublishingOptionsCloudWatchLogDestinationPropertiesArgs

    LogGroup string
    LogGroup string
    logGroup String
    logGroup string
    logGroup String

    PipelineVpcEndpoint, PipelineVpcEndpointArgs

    VpcEndpointId string
    The unique identifier of the endpoint.
    VpcId string
    The ID for your VPC. AWS Privatelink generates this value when you create a VPC.
    VpcOptions Pulumi.AwsNative.Osis.Inputs.PipelineVpcOptions
    Information about the VPC, including associated subnets and security groups.
    VpcEndpointId string
    The unique identifier of the endpoint.
    VpcId string
    The ID for your VPC. AWS Privatelink generates this value when you create a VPC.
    VpcOptions PipelineVpcOptions
    Information about the VPC, including associated subnets and security groups.
    vpcEndpointId String
    The unique identifier of the endpoint.
    vpcId String
    The ID for your VPC. AWS Privatelink generates this value when you create a VPC.
    vpcOptions PipelineVpcOptions
    Information about the VPC, including associated subnets and security groups.
    vpcEndpointId string
    The unique identifier of the endpoint.
    vpcId string
    The ID for your VPC. AWS Privatelink generates this value when you create a VPC.
    vpcOptions PipelineVpcOptions
    Information about the VPC, including associated subnets and security groups.
    vpc_endpoint_id str
    The unique identifier of the endpoint.
    vpc_id str
    The ID for your VPC. AWS Privatelink generates this value when you create a VPC.
    vpc_options PipelineVpcOptions
    Information about the VPC, including associated subnets and security groups.
    vpcEndpointId String
    The unique identifier of the endpoint.
    vpcId String
    The ID for your VPC. AWS Privatelink generates this value when you create a VPC.
    vpcOptions Property Map
    Information about the VPC, including associated subnets and security groups.

    PipelineVpcOptions, PipelineVpcOptionsArgs

    SubnetIds List<string>
    A list of subnet IDs associated with the VPC endpoint.
    SecurityGroupIds List<string>
    A list of security groups associated with the VPC endpoint.
    VpcAttachmentOptions Pulumi.AwsNative.Osis.Inputs.PipelineVpcOptionsVpcAttachmentOptionsProperties
    Options for attaching a VPC to the pipeline.
    VpcEndpointManagement Pulumi.AwsNative.Osis.PipelineVpcOptionsVpcEndpointManagement
    Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
    SubnetIds []string
    A list of subnet IDs associated with the VPC endpoint.
    SecurityGroupIds []string
    A list of security groups associated with the VPC endpoint.
    VpcAttachmentOptions PipelineVpcOptionsVpcAttachmentOptionsProperties
    Options for attaching a VPC to the pipeline.
    VpcEndpointManagement PipelineVpcOptionsVpcEndpointManagement
    Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
    subnetIds List<String>
    A list of subnet IDs associated with the VPC endpoint.
    securityGroupIds List<String>
    A list of security groups associated with the VPC endpoint.
    vpcAttachmentOptions PipelineVpcOptionsVpcAttachmentOptionsProperties
    Options for attaching a VPC to the pipeline.
    vpcEndpointManagement PipelineVpcOptionsVpcEndpointManagement
    Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
    subnetIds string[]
    A list of subnet IDs associated with the VPC endpoint.
    securityGroupIds string[]
    A list of security groups associated with the VPC endpoint.
    vpcAttachmentOptions PipelineVpcOptionsVpcAttachmentOptionsProperties
    Options for attaching a VPC to the pipeline.
    vpcEndpointManagement PipelineVpcOptionsVpcEndpointManagement
    Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
    subnet_ids Sequence[str]
    A list of subnet IDs associated with the VPC endpoint.
    security_group_ids Sequence[str]
    A list of security groups associated with the VPC endpoint.
    vpc_attachment_options PipelineVpcOptionsVpcAttachmentOptionsProperties
    Options for attaching a VPC to the pipeline.
    vpc_endpoint_management PipelineVpcOptionsVpcEndpointManagement
    Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
    subnetIds List<String>
    A list of subnet IDs associated with the VPC endpoint.
    securityGroupIds List<String>
    A list of security groups associated with the VPC endpoint.
    vpcAttachmentOptions Property Map
    Options for attaching a VPC to the pipeline.
    vpcEndpointManagement "CUSTOMER" | "SERVICE"
    Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.

    PipelineVpcOptionsVpcAttachmentOptionsProperties, PipelineVpcOptionsVpcAttachmentOptionsPropertiesArgs

    AttachToVpc bool
    Whether the pipeline should be attached to the provided VPC
    CidrBlock string
    The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
    AttachToVpc bool
    Whether the pipeline should be attached to the provided VPC
    CidrBlock string
    The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
    attachToVpc Boolean
    Whether the pipeline should be attached to the provided VPC
    cidrBlock String
    The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
    attachToVpc boolean
    Whether the pipeline should be attached to the provided VPC
    cidrBlock string
    The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
    attach_to_vpc bool
    Whether the pipeline should be attached to the provided VPC
    cidr_block str
    The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
    attachToVpc Boolean
    Whether the pipeline should be attached to the provided VPC
    cidrBlock String
    The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).

    PipelineVpcOptionsVpcEndpointManagement, PipelineVpcOptionsVpcEndpointManagementArgs

    Customer
    CUSTOMER
    Service
    SERVICE
    PipelineVpcOptionsVpcEndpointManagementCustomer
    CUSTOMER
    PipelineVpcOptionsVpcEndpointManagementService
    SERVICE
    Customer
    CUSTOMER
    Service
    SERVICE
    Customer
    CUSTOMER
    Service
    SERVICE
    CUSTOMER
    CUSTOMER
    SERVICE
    SERVICE
    "CUSTOMER"
    CUSTOMER
    "SERVICE"
    SERVICE

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native