Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. opensearchingest
  6. PipelineEndpoint
Viewing docs for AWS v7.40.0
published on Thursday, Jul 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.opensearchingest.PipelineEndpoint

aws logo
Viewing docs for AWS v7.40.0
published on Thursday, Jul 30, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Resource for managing an AWS OpenSearch Ingestion Pipeline Endpoint.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.opensearchingest.PipelineEndpoint("example", {
    pipelineArn: exampleAwsOsisPipeline.pipelineArn,
    vpcOptions: {
        securityGroupIds: [exampleAwsSecurityGroup.id],
        subnetIds: [exampleAwsSubnet.id],
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.opensearchingest.PipelineEndpoint("example",
    pipeline_arn=example_aws_osis_pipeline["pipelineArn"],
    vpc_options={
        "security_group_ids": [example_aws_security_group["id"]],
        "subnet_ids": [example_aws_subnet["id"]],
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/opensearchingest"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opensearchingest.NewPipelineEndpoint(ctx, "example", &opensearchingest.PipelineEndpointArgs{
			PipelineArn: pulumi.Any(exampleAwsOsisPipeline.PipelineArn),
			VpcOptions: &opensearchingest.PipelineEndpointVpcOptionsArgs{
				SecurityGroupIds: pulumi.StringArray{
					exampleAwsSecurityGroup.Id,
				},
				SubnetIds: pulumi.StringArray{
					exampleAwsSubnet.Id,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.OpenSearchIngest.PipelineEndpoint("example", new()
    {
        PipelineArn = exampleAwsOsisPipeline.PipelineArn,
        VpcOptions = new Aws.OpenSearchIngest.Inputs.PipelineEndpointVpcOptionsArgs
        {
            SecurityGroupIds = new[]
            {
                exampleAwsSecurityGroup.Id,
            },
            SubnetIds = new[]
            {
                exampleAwsSubnet.Id,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opensearchingest.PipelineEndpoint;
import com.pulumi.aws.opensearchingest.PipelineEndpointArgs;
import com.pulumi.aws.opensearchingest.inputs.PipelineEndpointVpcOptionsArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new PipelineEndpoint("example", PipelineEndpointArgs.builder()
            .pipelineArn(exampleAwsOsisPipeline.pipelineArn())
            .vpcOptions(PipelineEndpointVpcOptionsArgs.builder()
                .securityGroupIds(exampleAwsSecurityGroup.id())
                .subnetIds(exampleAwsSubnet.id())
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:opensearchingest:PipelineEndpoint
    properties:
      pipelineArn: ${exampleAwsOsisPipeline.pipelineArn}
      vpcOptions:
        securityGroupIds:
          - ${exampleAwsSecurityGroup.id}
        subnetIds:
          - ${exampleAwsSubnet.id}

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_opensearchingest_pipelineendpoint" "example" {
  pipeline_arn = exampleAwsOsisPipeline.pipelineArn
  vpc_options = {
    security_group_ids = [exampleAwsSecurityGroup.id]
    subnet_ids         = [exampleAwsSubnet.id]
  }
}

    Create PipelineEndpoint Resource

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

    Constructor syntax

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

@overload
def PipelineEndpoint(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     pipeline_arn: Optional[str] = None,
                     region: Optional[str] = None,
                     timeouts: Optional[PipelineEndpointTimeoutsArgs] = None,
                     vpc_options: Optional[PipelineEndpointVpcOptionsArgs] = None)
    func NewPipelineEndpoint(ctx *Context, name string, args PipelineEndpointArgs, opts ...ResourceOption) (*PipelineEndpoint, error)
    public PipelineEndpoint(string name, PipelineEndpointArgs args, CustomResourceOptions? opts = null)
    public PipelineEndpoint(String name, PipelineEndpointArgs args)
public PipelineEndpoint(String name, PipelineEndpointArgs args, CustomResourceOptions options)

    type: aws:opensearchingest:PipelineEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_opensearchingest_pipeline_endpoint" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PipelineEndpointArgs
    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 PipelineEndpointArgs
    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 PipelineEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PipelineEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PipelineEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var pipelineEndpointResource = new Aws.OpenSearchIngest.PipelineEndpoint("pipelineEndpointResource", new()
{
    PipelineArn = "string",
    Region = "string",
    Timeouts = new Aws.OpenSearchIngest.Inputs.PipelineEndpointTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    VpcOptions = new Aws.OpenSearchIngest.Inputs.PipelineEndpointVpcOptionsArgs
    {
        SubnetIds = new[]
        {
            "string",
        },
        SecurityGroupIds = new[]
        {
            "string",
        },
    },
});

    example, err := opensearchingest.NewPipelineEndpoint(ctx, "pipelineEndpointResource", &opensearchingest.PipelineEndpointArgs{
	PipelineArn: pulumi.String("string"),
	Region:      pulumi.String("string"),
	Timeouts: &opensearchingest.PipelineEndpointTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
	VpcOptions: &opensearchingest.PipelineEndpointVpcOptionsArgs{
		SubnetIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		SecurityGroupIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

    resource "aws_opensearchingest_pipeline_endpoint" "pipelineEndpointResource" {
  lifecycle {
    create_before_destroy = true
  }
  pipeline_arn = "string"
  region       = "string"
  timeouts = {
    create = "string"
    delete = "string"
  }
  vpc_options = {
    subnet_ids         = ["string"]
    security_group_ids = ["string"]
  }
}

    var pipelineEndpointResource = new PipelineEndpoint("pipelineEndpointResource", PipelineEndpointArgs.builder()
    .pipelineArn("string")
    .region("string")
    .timeouts(PipelineEndpointTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .vpcOptions(PipelineEndpointVpcOptionsArgs.builder()
        .subnetIds("string")
        .securityGroupIds("string")
        .build())
    .build());

    pipeline_endpoint_resource = aws.opensearchingest.PipelineEndpoint("pipelineEndpointResource",
    pipeline_arn="string",
    region="string",
    timeouts={
        "create": "string",
        "delete": "string",
    },
    vpc_options={
        "subnet_ids": ["string"],
        "security_group_ids": ["string"],
    })

    const pipelineEndpointResource = new aws.opensearchingest.PipelineEndpoint("pipelineEndpointResource", {
    pipelineArn: "string",
    region: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
    vpcOptions: {
        subnetIds: ["string"],
        securityGroupIds: ["string"],
    },
});

    type: aws:opensearchingest:PipelineEndpoint
properties:
    pipelineArn: string
    region: string
    timeouts:
        create: string
        delete: string
    vpcOptions:
        securityGroupIds:
            - string
        subnetIds:
            - string

    PipelineEndpoint 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 PipelineEndpoint resource accepts the following input properties:

    PipelineArn string
    ARN of the pipeline to create the endpoint for.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Timeouts PipelineEndpointTimeouts
    VpcOptions PipelineEndpointVpcOptions

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    PipelineArn string
    ARN of the pipeline to create the endpoint for.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Timeouts PipelineEndpointTimeoutsArgs
    VpcOptions PipelineEndpointVpcOptionsArgs

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    pipeline_arn string
    ARN of the pipeline to create the endpoint for.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    timeouts object
    vpc_options object

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    pipelineArn String
    ARN of the pipeline to create the endpoint for.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    timeouts PipelineEndpointTimeouts
    vpcOptions PipelineEndpointVpcOptions

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    pipelineArn string
    ARN of the pipeline to create the endpoint for.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    timeouts PipelineEndpointTimeouts
    vpcOptions PipelineEndpointVpcOptions

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    pipeline_arn str
    ARN of the pipeline to create the endpoint for.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    timeouts PipelineEndpointTimeoutsArgs
    vpc_options PipelineEndpointVpcOptionsArgs

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    pipelineArn String
    ARN of the pipeline to create the endpoint for.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    timeouts Property Map
    vpcOptions Property Map

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the endpoint.
    VpcId string
    ID of the VPC. Derived from subnetIds.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the endpoint.
    VpcId string
    ID of the VPC. Derived from subnetIds.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the endpoint.
    vpc_id string
    ID of the VPC. Derived from subnetIds.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the endpoint.
    vpcId String
    ID of the VPC. Derived from subnetIds.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the endpoint.
    vpcId string
    ID of the VPC. Derived from subnetIds.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of the endpoint.
    vpc_id str
    ID of the VPC. Derived from subnetIds.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the endpoint.
    vpcId String
    ID of the VPC. Derived from subnetIds.

    Look up Existing PipelineEndpoint Resource

    Get an existing PipelineEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PipelineEndpointState, opts?: CustomResourceOptions): PipelineEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        pipeline_arn: Optional[str] = None,
        region: Optional[str] = None,
        status: Optional[str] = None,
        timeouts: Optional[PipelineEndpointTimeoutsArgs] = None,
        vpc_id: Optional[str] = None,
        vpc_options: Optional[PipelineEndpointVpcOptionsArgs] = None) -> PipelineEndpoint
    func GetPipelineEndpoint(ctx *Context, name string, id IDInput, state *PipelineEndpointState, opts ...ResourceOption) (*PipelineEndpoint, error)
    public static PipelineEndpoint Get(string name, Input<string> id, PipelineEndpointState? state, CustomResourceOptions? opts = null)
    public static PipelineEndpoint get(String name, Output<String> id, PipelineEndpointState state, CustomResourceOptions options)
    resources:  _:    type: aws:opensearchingest:PipelineEndpoint    get:      id: ${id}
    import {
  to = aws_opensearchingest_pipeline_endpoint.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    PipelineArn string
    ARN of the pipeline to create the endpoint for.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Status string
    Status of the endpoint.
    Timeouts PipelineEndpointTimeouts
    VpcId string
    ID of the VPC. Derived from subnetIds.
    VpcOptions PipelineEndpointVpcOptions

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    PipelineArn string
    ARN of the pipeline to create the endpoint for.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Status string
    Status of the endpoint.
    Timeouts PipelineEndpointTimeoutsArgs
    VpcId string
    ID of the VPC. Derived from subnetIds.
    VpcOptions PipelineEndpointVpcOptionsArgs

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    pipeline_arn string
    ARN of the pipeline to create the endpoint for.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status string
    Status of the endpoint.
    timeouts object
    vpc_id string
    ID of the VPC. Derived from subnetIds.
    vpc_options object

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    pipelineArn String
    ARN of the pipeline to create the endpoint for.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status String
    Status of the endpoint.
    timeouts PipelineEndpointTimeouts
    vpcId String
    ID of the VPC. Derived from subnetIds.
    vpcOptions PipelineEndpointVpcOptions

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    pipelineArn string
    ARN of the pipeline to create the endpoint for.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status string
    Status of the endpoint.
    timeouts PipelineEndpointTimeouts
    vpcId string
    ID of the VPC. Derived from subnetIds.
    vpcOptions PipelineEndpointVpcOptions

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    pipeline_arn str
    ARN of the pipeline to create the endpoint for.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status str
    Status of the endpoint.
    timeouts PipelineEndpointTimeoutsArgs
    vpc_id str
    ID of the VPC. Derived from subnetIds.
    vpc_options PipelineEndpointVpcOptionsArgs

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    pipelineArn String
    ARN of the pipeline to create the endpoint for.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status String
    Status of the endpoint.
    timeouts Property Map
    vpcId String
    ID of the VPC. Derived from subnetIds.
    vpcOptions Property Map

    VPC options for the pipeline endpoint. See vpcOptions Block below.

    The following arguments are optional:

    Supporting Types

    PipelineEndpointTimeouts, PipelineEndpointTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    PipelineEndpointVpcOptions, PipelineEndpointVpcOptionsArgs

    SubnetIds List<string>
    List of subnet IDs associated with the VPC endpoint.
    SecurityGroupIds List<string>
    List of security groups associated with the VPC endpoint.
    SubnetIds []string
    List of subnet IDs associated with the VPC endpoint.
    SecurityGroupIds []string
    List of security groups associated with the VPC endpoint.
    subnet_ids list(string)
    List of subnet IDs associated with the VPC endpoint.
    security_group_ids list(string)
    List of security groups associated with the VPC endpoint.
    subnetIds List<String>
    List of subnet IDs associated with the VPC endpoint.
    securityGroupIds List<String>
    List of security groups associated with the VPC endpoint.
    subnetIds string[]
    List of subnet IDs associated with the VPC endpoint.
    securityGroupIds string[]
    List of security groups associated with the VPC endpoint.
    subnet_ids Sequence[str]
    List of subnet IDs associated with the VPC endpoint.
    security_group_ids Sequence[str]
    List of security groups associated with the VPC endpoint.
    subnetIds List<String>
    List of subnet IDs associated with the VPC endpoint.
    securityGroupIds List<String>
    List of security groups associated with the VPC endpoint.

    Import

    Identity Schema

    Required

    • id (String) ID of the pipeline endpoint.

    Optional

    • accountId (String) AWS Account where this resource is managed.
    • region (String) Region where this resource is managed.

    Using pulumi import, import OpenSearch Ingestion Pipeline Endpoint using the id. For example:

    $ pulumi import aws:opensearchingest/pipelineEndpoint:PipelineEndpoint example endpoint-id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.40.0
    published on Thursday, Jul 30, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial