1. Packages
  2. AWS
  3. API Docs
  4. opensearchingest
  5. Pipeline
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

aws.opensearchingest.Pipeline

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

    Resource for managing an AWS OpenSearch Ingestion Pipeline.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const current = aws.getRegion({});
    const example = new aws.iam.Role("example", {assumeRolePolicy: JSON.stringify({
        Version: "2012-10-17",
        Statement: [{
            Action: "sts:AssumeRole",
            Effect: "Allow",
            Sid: "",
            Principal: {
                Service: "osis-pipelines.amazonaws.com",
            },
        }],
    })});
    const examplePipeline = new aws.opensearchingest.Pipeline("example", {
        pipelineName: "example",
        pipelineConfigurationBody: pulumi.all([example.arn, current]).apply(([arn, current]) => `version: "2"
    example-pipeline:
      source:
        http:
          path: "/example"
      sink:
        - s3:
            aws:
              sts_role_arn: "${arn}"
              region: "${current.name}"
            bucket: "example"
            threshold:
              event_collect_timeout: "60s"
            codec:
              ndjson:
    `),
        maxUnits: 1,
        minUnits: 1,
    });
    
    import pulumi
    import json
    import pulumi_aws as aws
    
    current = aws.get_region()
    example = aws.iam.Role("example", assume_role_policy=json.dumps({
        "Version": "2012-10-17",
        "Statement": [{
            "Action": "sts:AssumeRole",
            "Effect": "Allow",
            "Sid": "",
            "Principal": {
                "Service": "osis-pipelines.amazonaws.com",
            },
        }],
    }))
    example_pipeline = aws.opensearchingest.Pipeline("example",
        pipeline_name="example",
        pipeline_configuration_body=example.arn.apply(lambda arn: f"""version: "2"
    example-pipeline:
      source:
        http:
          path: "/example"
      sink:
        - s3:
            aws:
              sts_role_arn: "{arn}"
              region: "{current.name}"
            bucket: "example"
            threshold:
              event_collect_timeout: "60s"
            codec:
              ndjson:
    """),
        max_units=1,
        min_units=1)
    
    package main
    
    import (
    	"encoding/json"
    	"fmt"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/opensearchingest"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		current, err := aws.GetRegion(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		tmpJSON0, err := json.Marshal(map[string]interface{}{
    			"Version": "2012-10-17",
    			"Statement": []map[string]interface{}{
    				map[string]interface{}{
    					"Action": "sts:AssumeRole",
    					"Effect": "Allow",
    					"Sid":    "",
    					"Principal": map[string]interface{}{
    						"Service": "osis-pipelines.amazonaws.com",
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		example, err := iam.NewRole(ctx, "example", &iam.RoleArgs{
    			AssumeRolePolicy: pulumi.String(json0),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = opensearchingest.NewPipeline(ctx, "example", &opensearchingest.PipelineArgs{
    			PipelineName: pulumi.String("example"),
    			PipelineConfigurationBody: example.Arn.ApplyT(func(arn string) (string, error) {
    				return fmt.Sprintf(`version: "2"
    example-pipeline:
      source:
        http:
          path: "/example"
      sink:
        - s3:
            aws:
              sts_role_arn: "%v"
              region: "%v"
            bucket: "example"
            threshold:
              event_collect_timeout: "60s"
            codec:
              ndjson:
    `, arn, current.Name), nil
    			}).(pulumi.StringOutput),
    			MaxUnits: pulumi.Int(1),
    			MinUnits: pulumi.Int(1),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var current = Aws.GetRegion.Invoke();
    
        var example = new Aws.Iam.Role("example", new()
        {
            AssumeRolePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["Version"] = "2012-10-17",
                ["Statement"] = new[]
                {
                    new Dictionary<string, object?>
                    {
                        ["Action"] = "sts:AssumeRole",
                        ["Effect"] = "Allow",
                        ["Sid"] = "",
                        ["Principal"] = new Dictionary<string, object?>
                        {
                            ["Service"] = "osis-pipelines.amazonaws.com",
                        },
                    },
                },
            }),
        });
    
        var examplePipeline = new Aws.OpenSearchIngest.Pipeline("example", new()
        {
            PipelineName = "example",
            PipelineConfigurationBody = Output.Tuple(example.Arn, current).Apply(values =>
            {
                var arn = values.Item1;
                var current = values.Item2;
                return @$"version: ""2""
    example-pipeline:
      source:
        http:
          path: ""/example""
      sink:
        - s3:
            aws:
              sts_role_arn: ""{arn}""
              region: ""{current.Apply(getRegionResult => getRegionResult.Name)}""
            bucket: ""example""
            threshold:
              event_collect_timeout: ""60s""
            codec:
              ndjson:
    ";
            }),
            MaxUnits = 1,
            MinUnits = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.AwsFunctions;
    import com.pulumi.aws.inputs.GetRegionArgs;
    import com.pulumi.aws.iam.Role;
    import com.pulumi.aws.iam.RoleArgs;
    import com.pulumi.aws.opensearchingest.Pipeline;
    import com.pulumi.aws.opensearchingest.PipelineArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    import java.util.List;
    import java.util.ArrayList;
    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) {
            final var current = AwsFunctions.getRegion();
    
            var example = new Role("example", RoleArgs.builder()
                .assumeRolePolicy(serializeJson(
                    jsonObject(
                        jsonProperty("Version", "2012-10-17"),
                        jsonProperty("Statement", jsonArray(jsonObject(
                            jsonProperty("Action", "sts:AssumeRole"),
                            jsonProperty("Effect", "Allow"),
                            jsonProperty("Sid", ""),
                            jsonProperty("Principal", jsonObject(
                                jsonProperty("Service", "osis-pipelines.amazonaws.com")
                            ))
                        )))
                    )))
                .build());
    
            var examplePipeline = new Pipeline("examplePipeline", PipelineArgs.builder()
                .pipelineName("example")
                .pipelineConfigurationBody(example.arn().applyValue(arn -> """
    version: "2"
    example-pipeline:
      source:
        http:
          path: "/example"
      sink:
        - s3:
            aws:
              sts_role_arn: "%s"
              region: "%s"
            bucket: "example"
            threshold:
              event_collect_timeout: "60s"
            codec:
              ndjson:
    ", arn,current.applyValue(getRegionResult -> getRegionResult.name()))))
                .maxUnits(1)
                .minUnits(1)
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:iam:Role
        properties:
          assumeRolePolicy:
            fn::toJSON:
              Version: 2012-10-17
              Statement:
                - Action: sts:AssumeRole
                  Effect: Allow
                  Sid:
                  Principal:
                    Service: osis-pipelines.amazonaws.com
      examplePipeline:
        type: aws:opensearchingest:Pipeline
        name: example
        properties:
          pipelineName: example
          pipelineConfigurationBody: |
            version: "2"
            example-pipeline:
              source:
                http:
                  path: "/example"
              sink:
                - s3:
                    aws:
                      sts_role_arn: "${example.arn}"
                      region: "${current.name}"
                    bucket: "example"
                    threshold:
                      event_collect_timeout: "60s"
                    codec:
                      ndjson:        
          maxUnits: 1
          minUnits: 1
    variables:
      current:
        fn::invoke:
          Function: aws:getRegion
          Arguments: {}
    

    Using file function

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    import * as std from "@pulumi/std";
    
    const example = new aws.opensearchingest.Pipeline("example", {
        pipelineName: "example",
        pipelineConfigurationBody: std.file({
            input: "example.yaml",
        }).then(invoke => invoke.result),
        maxUnits: 1,
        minUnits: 1,
    });
    
    import pulumi
    import pulumi_aws as aws
    import pulumi_std as std
    
    example = aws.opensearchingest.Pipeline("example",
        pipeline_name="example",
        pipeline_configuration_body=std.file(input="example.yaml").result,
        max_units=1,
        min_units=1)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/opensearchingest"
    	"github.com/pulumi/pulumi-std/sdk/go/std"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		invokeFile, err := std.File(ctx, &std.FileArgs{
    			Input: "example.yaml",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = opensearchingest.NewPipeline(ctx, "example", &opensearchingest.PipelineArgs{
    			PipelineName:              pulumi.String("example"),
    			PipelineConfigurationBody: pulumi.String(invokeFile.Result),
    			MaxUnits:                  pulumi.Int(1),
    			MinUnits:                  pulumi.Int(1),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.OpenSearchIngest.Pipeline("example", new()
        {
            PipelineName = "example",
            PipelineConfigurationBody = Std.File.Invoke(new()
            {
                Input = "example.yaml",
            }).Apply(invoke => invoke.Result),
            MaxUnits = 1,
            MinUnits = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.opensearchingest.Pipeline;
    import com.pulumi.aws.opensearchingest.PipelineArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 Pipeline("example", PipelineArgs.builder()
                .pipelineName("example")
                .pipelineConfigurationBody(StdFunctions.file(FileArgs.builder()
                    .input("example.yaml")
                    .build()).result())
                .maxUnits(1)
                .minUnits(1)
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:opensearchingest:Pipeline
        properties:
          pipelineName: example
          pipelineConfigurationBody:
            fn::invoke:
              Function: std:file
              Arguments:
                input: example.yaml
              Return: result
          maxUnits: 1
          minUnits: 1
    

    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,
                 pipeline_name: Optional[str] = None,
                 buffer_options: Optional[PipelineBufferOptionsArgs] = None,
                 encryption_at_rest_options: Optional[PipelineEncryptionAtRestOptionsArgs] = None,
                 log_publishing_options: Optional[PipelineLogPublishingOptionsArgs] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 timeouts: Optional[PipelineTimeoutsArgs] = 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:opensearchingest: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.

    Constructor example

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

    var examplepipelineResourceResourceFromOpensearchingestpipeline = new Aws.OpenSearchIngest.Pipeline("examplepipelineResourceResourceFromOpensearchingestpipeline", new()
    {
        MaxUnits = 0,
        MinUnits = 0,
        PipelineConfigurationBody = "string",
        PipelineName = "string",
        BufferOptions = new Aws.OpenSearchIngest.Inputs.PipelineBufferOptionsArgs
        {
            PersistentBufferEnabled = false,
        },
        EncryptionAtRestOptions = new Aws.OpenSearchIngest.Inputs.PipelineEncryptionAtRestOptionsArgs
        {
            KmsKeyArn = "string",
        },
        LogPublishingOptions = new Aws.OpenSearchIngest.Inputs.PipelineLogPublishingOptionsArgs
        {
            CloudwatchLogDestination = new Aws.OpenSearchIngest.Inputs.PipelineLogPublishingOptionsCloudwatchLogDestinationArgs
            {
                LogGroup = "string",
            },
            IsLoggingEnabled = false,
        },
        Tags = 
        {
            { "string", "string" },
        },
        Timeouts = new Aws.OpenSearchIngest.Inputs.PipelineTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
        VpcOptions = new Aws.OpenSearchIngest.Inputs.PipelineVpcOptionsArgs
        {
            SubnetIds = new[]
            {
                "string",
            },
            SecurityGroupIds = new[]
            {
                "string",
            },
        },
    });
    
    example, err := opensearchingest.NewPipeline(ctx, "examplepipelineResourceResourceFromOpensearchingestpipeline", &opensearchingest.PipelineArgs{
    	MaxUnits:                  pulumi.Int(0),
    	MinUnits:                  pulumi.Int(0),
    	PipelineConfigurationBody: pulumi.String("string"),
    	PipelineName:              pulumi.String("string"),
    	BufferOptions: &opensearchingest.PipelineBufferOptionsArgs{
    		PersistentBufferEnabled: pulumi.Bool(false),
    	},
    	EncryptionAtRestOptions: &opensearchingest.PipelineEncryptionAtRestOptionsArgs{
    		KmsKeyArn: pulumi.String("string"),
    	},
    	LogPublishingOptions: &opensearchingest.PipelineLogPublishingOptionsArgs{
    		CloudwatchLogDestination: &opensearchingest.PipelineLogPublishingOptionsCloudwatchLogDestinationArgs{
    			LogGroup: pulumi.String("string"),
    		},
    		IsLoggingEnabled: pulumi.Bool(false),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Timeouts: &opensearchingest.PipelineTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    	VpcOptions: &opensearchingest.PipelineVpcOptionsArgs{
    		SubnetIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		SecurityGroupIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    })
    
    var examplepipelineResourceResourceFromOpensearchingestpipeline = new Pipeline("examplepipelineResourceResourceFromOpensearchingestpipeline", PipelineArgs.builder()
        .maxUnits(0)
        .minUnits(0)
        .pipelineConfigurationBody("string")
        .pipelineName("string")
        .bufferOptions(PipelineBufferOptionsArgs.builder()
            .persistentBufferEnabled(false)
            .build())
        .encryptionAtRestOptions(PipelineEncryptionAtRestOptionsArgs.builder()
            .kmsKeyArn("string")
            .build())
        .logPublishingOptions(PipelineLogPublishingOptionsArgs.builder()
            .cloudwatchLogDestination(PipelineLogPublishingOptionsCloudwatchLogDestinationArgs.builder()
                .logGroup("string")
                .build())
            .isLoggingEnabled(false)
            .build())
        .tags(Map.of("string", "string"))
        .timeouts(PipelineTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .vpcOptions(PipelineVpcOptionsArgs.builder()
            .subnetIds("string")
            .securityGroupIds("string")
            .build())
        .build());
    
    examplepipeline_resource_resource_from_opensearchingestpipeline = aws.opensearchingest.Pipeline("examplepipelineResourceResourceFromOpensearchingestpipeline",
        max_units=0,
        min_units=0,
        pipeline_configuration_body="string",
        pipeline_name="string",
        buffer_options={
            "persistentBufferEnabled": False,
        },
        encryption_at_rest_options={
            "kmsKeyArn": "string",
        },
        log_publishing_options={
            "cloudwatchLogDestination": {
                "logGroup": "string",
            },
            "isLoggingEnabled": False,
        },
        tags={
            "string": "string",
        },
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        },
        vpc_options={
            "subnetIds": ["string"],
            "securityGroupIds": ["string"],
        })
    
    const examplepipelineResourceResourceFromOpensearchingestpipeline = new aws.opensearchingest.Pipeline("examplepipelineResourceResourceFromOpensearchingestpipeline", {
        maxUnits: 0,
        minUnits: 0,
        pipelineConfigurationBody: "string",
        pipelineName: "string",
        bufferOptions: {
            persistentBufferEnabled: false,
        },
        encryptionAtRestOptions: {
            kmsKeyArn: "string",
        },
        logPublishingOptions: {
            cloudwatchLogDestination: {
                logGroup: "string",
            },
            isLoggingEnabled: false,
        },
        tags: {
            string: "string",
        },
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
        vpcOptions: {
            subnetIds: ["string"],
            securityGroupIds: ["string"],
        },
    });
    
    type: aws:opensearchingest:Pipeline
    properties:
        bufferOptions:
            persistentBufferEnabled: false
        encryptionAtRestOptions:
            kmsKeyArn: string
        logPublishingOptions:
            cloudwatchLogDestination:
                logGroup: string
            isLoggingEnabled: false
        maxUnits: 0
        minUnits: 0
        pipelineConfigurationBody: string
        pipelineName: string
        tags:
            string: string
        timeouts:
            create: string
            delete: string
            update: string
        vpcOptions:
            securityGroupIds:
                - string
            subnetIds:
                - string
    

    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

    The Pipeline resource accepts the following input properties:

    MaxUnits int
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    MinUnits int
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    PipelineConfigurationBody string
    The pipeline configuration in YAML format. This argument 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.
    PipelineName string

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

    The following arguments are optional:

    BufferOptions PipelineBufferOptions
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    EncryptionAtRestOptions PipelineEncryptionAtRestOptions
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    LogPublishingOptions PipelineLogPublishingOptions
    Key-value pairs to configure log publishing. See log_publishing_options below.
    Tags Dictionary<string, string>
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts PipelineTimeouts
    VpcOptions PipelineVpcOptions
    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. See vpc_options below.
    MaxUnits int
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    MinUnits int
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    PipelineConfigurationBody string
    The pipeline configuration in YAML format. This argument 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.
    PipelineName string

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

    The following arguments are optional:

    BufferOptions PipelineBufferOptionsArgs
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    EncryptionAtRestOptions PipelineEncryptionAtRestOptionsArgs
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    LogPublishingOptions PipelineLogPublishingOptionsArgs
    Key-value pairs to configure log publishing. See log_publishing_options below.
    Tags map[string]string
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts PipelineTimeoutsArgs
    VpcOptions PipelineVpcOptionsArgs
    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. See vpc_options below.
    maxUnits Integer
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    minUnits Integer
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    pipelineConfigurationBody String
    The pipeline configuration in YAML format. This argument 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.
    pipelineName String

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

    The following arguments are optional:

    bufferOptions PipelineBufferOptions
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    encryptionAtRestOptions PipelineEncryptionAtRestOptions
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    logPublishingOptions PipelineLogPublishingOptions
    Key-value pairs to configure log publishing. See log_publishing_options below.
    tags Map<String,String>
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts PipelineTimeouts
    vpcOptions PipelineVpcOptions
    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. See vpc_options below.
    maxUnits number
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    minUnits number
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    pipelineConfigurationBody string
    The pipeline configuration in YAML format. This argument 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.
    pipelineName string

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

    The following arguments are optional:

    bufferOptions PipelineBufferOptions
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    encryptionAtRestOptions PipelineEncryptionAtRestOptions
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    logPublishingOptions PipelineLogPublishingOptions
    Key-value pairs to configure log publishing. See log_publishing_options below.
    tags {[key: string]: string}
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts PipelineTimeouts
    vpcOptions PipelineVpcOptions
    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. See vpc_options below.
    max_units int
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    min_units int
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    pipeline_configuration_body str
    The pipeline configuration in YAML format. This argument 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.
    pipeline_name str

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

    The following arguments are optional:

    buffer_options PipelineBufferOptionsArgs
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    encryption_at_rest_options PipelineEncryptionAtRestOptionsArgs
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    log_publishing_options PipelineLogPublishingOptionsArgs
    Key-value pairs to configure log publishing. See log_publishing_options below.
    tags Mapping[str, str]
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts PipelineTimeoutsArgs
    vpc_options PipelineVpcOptionsArgs
    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. See vpc_options below.
    maxUnits Number
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    minUnits Number
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    pipelineConfigurationBody String
    The pipeline configuration in YAML format. This argument 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.
    pipelineName String

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

    The following arguments are optional:

    bufferOptions Property Map
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    encryptionAtRestOptions Property Map
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    logPublishingOptions Property Map
    Key-value pairs to configure log publishing. See log_publishing_options below.
    tags Map<String>
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map
    vpcOptions Property Map
    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. See vpc_options below.

    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>
    The list of ingestion endpoints for the pipeline, which you can send data to.
    PipelineArn string
    Amazon Resource Name (ARN) of the pipeline.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Id string
    The provider-assigned unique ID for this managed resource.
    IngestEndpointUrls []string
    The list of ingestion endpoints for the pipeline, which you can send data to.
    PipelineArn string
    Amazon Resource Name (ARN) of the pipeline.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    id String
    The provider-assigned unique ID for this managed resource.
    ingestEndpointUrls List<String>
    The list of ingestion endpoints for the pipeline, which you can send data to.
    pipelineArn String
    Amazon Resource Name (ARN) of the pipeline.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    id string
    The provider-assigned unique ID for this managed resource.
    ingestEndpointUrls string[]
    The list of ingestion endpoints for the pipeline, which you can send data to.
    pipelineArn string
    Amazon Resource Name (ARN) of the pipeline.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    id str
    The provider-assigned unique ID for this managed resource.
    ingest_endpoint_urls Sequence[str]
    The list of ingestion endpoints for the pipeline, which you can send data to.
    pipeline_arn str
    Amazon Resource Name (ARN) of the pipeline.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    id String
    The provider-assigned unique ID for this managed resource.
    ingestEndpointUrls List<String>
    The list of ingestion endpoints for the pipeline, which you can send data to.
    pipelineArn String
    Amazon Resource Name (ARN) of the pipeline.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing Pipeline Resource

    Get an existing Pipeline 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?: PipelineState, opts?: CustomResourceOptions): Pipeline
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            buffer_options: Optional[PipelineBufferOptionsArgs] = None,
            encryption_at_rest_options: Optional[PipelineEncryptionAtRestOptionsArgs] = None,
            ingest_endpoint_urls: Optional[Sequence[str]] = None,
            log_publishing_options: Optional[PipelineLogPublishingOptionsArgs] = None,
            max_units: Optional[int] = None,
            min_units: Optional[int] = None,
            pipeline_arn: Optional[str] = None,
            pipeline_configuration_body: Optional[str] = None,
            pipeline_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            timeouts: Optional[PipelineTimeoutsArgs] = None,
            vpc_options: Optional[PipelineVpcOptionsArgs] = None) -> Pipeline
    func GetPipeline(ctx *Context, name string, id IDInput, state *PipelineState, opts ...ResourceOption) (*Pipeline, error)
    public static Pipeline Get(string name, Input<string> id, PipelineState? state, CustomResourceOptions? opts = null)
    public static Pipeline get(String name, Output<String> id, PipelineState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    BufferOptions PipelineBufferOptions
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    EncryptionAtRestOptions PipelineEncryptionAtRestOptions
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    IngestEndpointUrls List<string>
    The list of ingestion endpoints for the pipeline, which you can send data to.
    LogPublishingOptions PipelineLogPublishingOptions
    Key-value pairs to configure log publishing. See log_publishing_options below.
    MaxUnits int
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    MinUnits int
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    PipelineArn string
    Amazon Resource Name (ARN) of the pipeline.
    PipelineConfigurationBody string
    The pipeline configuration in YAML format. This argument 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.
    PipelineName string

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

    The following arguments are optional:

    Tags Dictionary<string, string>
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Timeouts PipelineTimeouts
    VpcOptions PipelineVpcOptions
    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. See vpc_options below.
    BufferOptions PipelineBufferOptionsArgs
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    EncryptionAtRestOptions PipelineEncryptionAtRestOptionsArgs
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    IngestEndpointUrls []string
    The list of ingestion endpoints for the pipeline, which you can send data to.
    LogPublishingOptions PipelineLogPublishingOptionsArgs
    Key-value pairs to configure log publishing. See log_publishing_options below.
    MaxUnits int
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    MinUnits int
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    PipelineArn string
    Amazon Resource Name (ARN) of the pipeline.
    PipelineConfigurationBody string
    The pipeline configuration in YAML format. This argument 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.
    PipelineName string

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

    The following arguments are optional:

    Tags map[string]string
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    Timeouts PipelineTimeoutsArgs
    VpcOptions PipelineVpcOptionsArgs
    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. See vpc_options below.
    bufferOptions PipelineBufferOptions
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    encryptionAtRestOptions PipelineEncryptionAtRestOptions
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    ingestEndpointUrls List<String>
    The list of ingestion endpoints for the pipeline, which you can send data to.
    logPublishingOptions PipelineLogPublishingOptions
    Key-value pairs to configure log publishing. See log_publishing_options below.
    maxUnits Integer
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    minUnits Integer
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    pipelineArn String
    Amazon Resource Name (ARN) of the pipeline.
    pipelineConfigurationBody String
    The pipeline configuration in YAML format. This argument 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.
    pipelineName String

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

    The following arguments are optional:

    tags Map<String,String>
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    timeouts PipelineTimeouts
    vpcOptions PipelineVpcOptions
    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. See vpc_options below.
    bufferOptions PipelineBufferOptions
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    encryptionAtRestOptions PipelineEncryptionAtRestOptions
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    ingestEndpointUrls string[]
    The list of ingestion endpoints for the pipeline, which you can send data to.
    logPublishingOptions PipelineLogPublishingOptions
    Key-value pairs to configure log publishing. See log_publishing_options below.
    maxUnits number
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    minUnits number
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    pipelineArn string
    Amazon Resource Name (ARN) of the pipeline.
    pipelineConfigurationBody string
    The pipeline configuration in YAML format. This argument 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.
    pipelineName string

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

    The following arguments are optional:

    tags {[key: string]: string}
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    timeouts PipelineTimeouts
    vpcOptions PipelineVpcOptions
    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. See vpc_options below.
    buffer_options PipelineBufferOptionsArgs
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    encryption_at_rest_options PipelineEncryptionAtRestOptionsArgs
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    ingest_endpoint_urls Sequence[str]
    The list of ingestion endpoints for the pipeline, which you can send data to.
    log_publishing_options PipelineLogPublishingOptionsArgs
    Key-value pairs to configure log publishing. See log_publishing_options below.
    max_units int
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    min_units int
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    pipeline_arn str
    Amazon Resource Name (ARN) of the pipeline.
    pipeline_configuration_body str
    The pipeline configuration in YAML format. This argument 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.
    pipeline_name str

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

    The following arguments are optional:

    tags Mapping[str, str]
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    timeouts PipelineTimeoutsArgs
    vpc_options PipelineVpcOptionsArgs
    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. See vpc_options below.
    bufferOptions Property Map
    Key-value pairs to configure persistent buffering for the pipeline. See buffer_options below.
    encryptionAtRestOptions Property Map
    Key-value pairs to configure encryption for data that is written to a persistent buffer. See encryption_at_rest_options below.
    ingestEndpointUrls List<String>
    The list of ingestion endpoints for the pipeline, which you can send data to.
    logPublishingOptions Property Map
    Key-value pairs to configure log publishing. See log_publishing_options below.
    maxUnits Number
    The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
    minUnits Number
    The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
    pipelineArn String
    Amazon Resource Name (ARN) of the pipeline.
    pipelineConfigurationBody String
    The pipeline configuration in YAML format. This argument 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.
    pipelineName String

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

    The following arguments are optional:

    tags Map<String>
    A map of tags to assign to the pipeline. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    timeouts Property Map
    vpcOptions Property Map
    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. See vpc_options below.

    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 ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.
    KmsKeyArn string
    The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.
    kmsKeyArn String
    The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.
    kmsKeyArn string
    The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.
    kms_key_arn str
    The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.
    kmsKeyArn String
    The ARN of the KMS key used to encrypt data-at-rest in OpenSearch Ingestion. By default, data is encrypted using an AWS owned key.

    PipelineLogPublishingOptions, PipelineLogPublishingOptionsArgs

    CloudwatchLogDestination PipelineLogPublishingOptionsCloudwatchLogDestination
    The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true. See cloudwatch_log_destination below.
    IsLoggingEnabled bool
    Whether logs should be published.
    CloudwatchLogDestination PipelineLogPublishingOptionsCloudwatchLogDestination
    The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true. See cloudwatch_log_destination below.
    IsLoggingEnabled bool
    Whether logs should be published.
    cloudwatchLogDestination PipelineLogPublishingOptionsCloudwatchLogDestination
    The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true. See cloudwatch_log_destination below.
    isLoggingEnabled Boolean
    Whether logs should be published.
    cloudwatchLogDestination PipelineLogPublishingOptionsCloudwatchLogDestination
    The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true. See cloudwatch_log_destination below.
    isLoggingEnabled boolean
    Whether logs should be published.
    cloudwatch_log_destination PipelineLogPublishingOptionsCloudwatchLogDestination
    The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true. See cloudwatch_log_destination below.
    is_logging_enabled bool
    Whether logs should be published.
    cloudwatchLogDestination Property Map
    The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true. See cloudwatch_log_destination below.
    isLoggingEnabled Boolean
    Whether logs should be published.

    PipelineLogPublishingOptionsCloudwatchLogDestination, PipelineLogPublishingOptionsCloudwatchLogDestinationArgs

    LogGroup string
    The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.
    LogGroup string
    The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.
    logGroup String
    The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.
    logGroup string
    The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.
    log_group str
    The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.
    logGroup String
    The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.

    PipelineTimeouts, PipelineTimeoutsArgs

    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.
    Update 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).
    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.
    Update 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).
    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.
    update 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).
    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.
    update 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).
    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.
    update 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).
    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.
    update 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).

    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.
    SubnetIds []string
    A list of subnet IDs associated with the VPC endpoint.
    SecurityGroupIds []string
    A list of security groups associated with the VPC endpoint.
    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.
    subnetIds string[]
    A list of subnet IDs associated with the VPC endpoint.
    securityGroupIds string[]
    A list of security groups associated with the VPC endpoint.
    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.
    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.

    Import

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

    $ pulumi import aws:opensearchingest/pipeline:Pipeline example example
    

    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
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi