import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Resource for managing an AWS OpenSearch Ingestion Pipeline. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const current = aws.getRegion({}); * const exampleRole = 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 example = new aws.opensearchingest.Pipeline("example", { * pipelineName: "example", * pipelineConfigurationBody: pulumi.all([exampleRole.arn, current]).apply(([arn, current]) => `version: \"2\" * example-pipeline: * source: * http: * path: \"/example\" * sink: * - s3: * aws: * sts_role_arn: \"${arn}\" * region: \"${current.region}\" * bucket: \"example\" * threshold: * event_collect_timeout: \"60s\" * codec: * ndjson: * `), * maxUnits: 1, * minUnits: 1, * }); * ``` * * ### Using file function * * ```typescript * 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 * * ### Identity Schema * * #### Required * * * `name` (String) Name of the pipeline. * * #### 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 using the `pipelineName`. For example: * * ```sh * $ pulumi import aws:opensearchingest/pipeline:Pipeline example example * ``` */ export declare class Pipeline extends pulumi.CustomResource { /** * Get an existing Pipeline resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: PipelineState, opts?: pulumi.CustomResourceOptions): Pipeline; /** * Returns true if the given object is an instance of Pipeline. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Pipeline; /** * Key-value pairs to configure persistent buffering for the pipeline. See `bufferOptions` below. */ readonly bufferOptions: pulumi.Output; /** * Key-value pairs to configure encryption for data that is written to a persistent buffer. See `encryptionAtRestOptions` below. */ readonly encryptionAtRestOptions: pulumi.Output; /** * The list of ingestion endpoints for the pipeline, which you can send data to. */ readonly ingestEndpointUrls: pulumi.Output; /** * Key-value pairs to configure log publishing. See `logPublishingOptions` below. */ readonly logPublishingOptions: pulumi.Output; /** * The maximum pipeline capacity, in Ingestion Compute Units (ICUs). */ readonly maxUnits: pulumi.Output; /** * The minimum pipeline capacity, in Ingestion Compute Units (ICUs). */ readonly minUnits: pulumi.Output; /** * ARN of the pipeline. */ readonly pipelineArn: pulumi.Output; /** * 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`. */ readonly pipelineConfigurationBody: pulumi.Output; /** * Name of the pipeline. Pipeline names are unique across the pipelines owned by an account within an AWS Region. * * The following arguments are optional: */ readonly pipelineName: pulumi.Output; /** * ARN of the IAM role that grants the pipeline permission to access AWS resources. */ readonly pipelineRoleArn: pulumi.Output; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ readonly region: pulumi.Output; /** * A map of tags to assign to the pipeline. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; readonly timeouts: pulumi.Output; /** * 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 `vpcOptions` below. */ readonly vpcOptions: pulumi.Output; /** * Create a Pipeline resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: PipelineArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Pipeline resources. */ export interface PipelineState { /** * Key-value pairs to configure persistent buffering for the pipeline. See `bufferOptions` below. */ bufferOptions?: pulumi.Input; /** * Key-value pairs to configure encryption for data that is written to a persistent buffer. See `encryptionAtRestOptions` below. */ encryptionAtRestOptions?: pulumi.Input; /** * The list of ingestion endpoints for the pipeline, which you can send data to. */ ingestEndpointUrls?: pulumi.Input[] | undefined>; /** * Key-value pairs to configure log publishing. See `logPublishingOptions` below. */ logPublishingOptions?: pulumi.Input; /** * The maximum pipeline capacity, in Ingestion Compute Units (ICUs). */ maxUnits?: pulumi.Input; /** * The minimum pipeline capacity, in Ingestion Compute Units (ICUs). */ minUnits?: pulumi.Input; /** * ARN of the pipeline. */ pipelineArn?: pulumi.Input; /** * 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`. */ pipelineConfigurationBody?: pulumi.Input; /** * Name of the pipeline. Pipeline names are unique across the pipelines owned by an account within an AWS Region. * * The following arguments are optional: */ pipelineName?: pulumi.Input; /** * ARN of the IAM role that grants the pipeline permission to access AWS resources. */ pipelineRoleArn?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * A map of tags to assign to the pipeline. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; timeouts?: pulumi.Input; /** * 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 `vpcOptions` below. */ vpcOptions?: pulumi.Input; } /** * The set of arguments for constructing a Pipeline resource. */ export interface PipelineArgs { /** * Key-value pairs to configure persistent buffering for the pipeline. See `bufferOptions` below. */ bufferOptions?: pulumi.Input; /** * Key-value pairs to configure encryption for data that is written to a persistent buffer. See `encryptionAtRestOptions` below. */ encryptionAtRestOptions?: pulumi.Input; /** * Key-value pairs to configure log publishing. See `logPublishingOptions` below. */ logPublishingOptions?: pulumi.Input; /** * The maximum pipeline capacity, in Ingestion Compute Units (ICUs). */ maxUnits: pulumi.Input; /** * The minimum pipeline capacity, in Ingestion Compute Units (ICUs). */ minUnits: pulumi.Input; /** * 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`. */ pipelineConfigurationBody: pulumi.Input; /** * Name of the pipeline. Pipeline names are unique across the pipelines owned by an account within an AWS Region. * * The following arguments are optional: */ pipelineName: pulumi.Input; /** * ARN of the IAM role that grants the pipeline permission to access AWS resources. */ pipelineRoleArn?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * A map of tags to assign to the pipeline. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; timeouts?: pulumi.Input; /** * 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 `vpcOptions` below. */ vpcOptions?: pulumi.Input; } //# sourceMappingURL=pipeline.d.ts.map