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

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

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

aws-native.osis.getPipeline

Explore with Pulumi AI

aws-native logo

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

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

    An OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.

    Using getPipeline

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPipeline(args: GetPipelineArgs, opts?: InvokeOptions): Promise<GetPipelineResult>
function getPipelineOutput(args: GetPipelineOutputArgs, opts?: InvokeOptions): Output<GetPipelineResult>
    def get_pipeline(pipeline_arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPipelineResult
def get_pipeline_output(pipeline_arn: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPipelineResult]
    func LookupPipeline(ctx *Context, args *LookupPipelineArgs, opts ...InvokeOption) (*LookupPipelineResult, error)
func LookupPipelineOutput(ctx *Context, args *LookupPipelineOutputArgs, opts ...InvokeOption) LookupPipelineResultOutput

    > Note: This function is named LookupPipeline in the Go SDK.

    public static class GetPipeline 
{
    public static Task<GetPipelineResult> InvokeAsync(GetPipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineResult> Invoke(GetPipelineInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
public static Output<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:osis:getPipeline
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PipelineArn string
    The Amazon Resource Name (ARN) of the pipeline.
    PipelineArn string
    The Amazon Resource Name (ARN) of the pipeline.
    pipelineArn String
    The Amazon Resource Name (ARN) of the pipeline.
    pipelineArn string
    The Amazon Resource Name (ARN) of the pipeline.
    pipeline_arn str
    The Amazon Resource Name (ARN) of the pipeline.
    pipelineArn String
    The Amazon Resource Name (ARN) of the pipeline.

    getPipeline Result

    The following output properties are available:

    BufferOptions Pulumi.AwsNative.Osis.Outputs.PipelineBufferOptions
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    EncryptionAtRestOptions Pulumi.AwsNative.Osis.Outputs.PipelineEncryptionAtRestOptions
    Options to control how OpenSearch encrypts buffer data.
    IngestEndpointUrls List<string>
    A list of endpoints that can be used for ingesting data into a pipeline
    LogPublishingOptions Pulumi.AwsNative.Osis.Outputs.PipelineLogPublishingOptions
    Key-value pairs that represent log publishing settings.
    MaxUnits int
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    MinUnits int
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    PipelineArn string
    The Amazon Resource Name (ARN) of the pipeline.
    PipelineConfigurationBody string
    The Data Prepper pipeline configuration.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    VpcEndpointService string
    The VPC endpoint service name for the pipeline.
    VpcEndpoints List<Pulumi.AwsNative.Osis.Outputs.PipelineVpcEndpoint>
    The VPC interface endpoints that have access to the pipeline.
    BufferOptions PipelineBufferOptions
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    EncryptionAtRestOptions PipelineEncryptionAtRestOptions
    Options to control how OpenSearch encrypts buffer data.
    IngestEndpointUrls []string
    A list of endpoints that can be used for ingesting data into a pipeline
    LogPublishingOptions PipelineLogPublishingOptions
    Key-value pairs that represent log publishing settings.
    MaxUnits int
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    MinUnits int
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    PipelineArn string
    The Amazon Resource Name (ARN) of the pipeline.
    PipelineConfigurationBody string
    The Data Prepper pipeline configuration.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    VpcEndpointService string
    The VPC endpoint service name for the pipeline.
    VpcEndpoints []PipelineVpcEndpoint
    The VPC interface endpoints that have access to the pipeline.
    bufferOptions PipelineBufferOptions
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    encryptionAtRestOptions PipelineEncryptionAtRestOptions
    Options to control how OpenSearch encrypts buffer data.
    ingestEndpointUrls List<String>
    A list of endpoints that can be used for ingesting data into a pipeline
    logPublishingOptions PipelineLogPublishingOptions
    Key-value pairs that represent log publishing settings.
    maxUnits Integer
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    minUnits Integer
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    pipelineArn String
    The Amazon Resource Name (ARN) of the pipeline.
    pipelineConfigurationBody String
    The Data Prepper pipeline configuration.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    vpcEndpointService String
    The VPC endpoint service name for the pipeline.
    vpcEndpoints List<PipelineVpcEndpoint>
    The VPC interface endpoints that have access to the pipeline.
    bufferOptions PipelineBufferOptions
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    encryptionAtRestOptions PipelineEncryptionAtRestOptions
    Options to control how OpenSearch encrypts buffer data.
    ingestEndpointUrls string[]
    A list of endpoints that can be used for ingesting data into a pipeline
    logPublishingOptions PipelineLogPublishingOptions
    Key-value pairs that represent log publishing settings.
    maxUnits number
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    minUnits number
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    pipelineArn string
    The Amazon Resource Name (ARN) of the pipeline.
    pipelineConfigurationBody string
    The Data Prepper pipeline configuration.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    vpcEndpointService string
    The VPC endpoint service name for the pipeline.
    vpcEndpoints PipelineVpcEndpoint[]
    The VPC interface endpoints that have access to the pipeline.
    buffer_options PipelineBufferOptions
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    encryption_at_rest_options PipelineEncryptionAtRestOptions
    Options to control how OpenSearch encrypts buffer data.
    ingest_endpoint_urls Sequence[str]
    A list of endpoints that can be used for ingesting data into a pipeline
    log_publishing_options PipelineLogPublishingOptions
    Key-value pairs that represent log publishing settings.
    max_units int
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    min_units int
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    pipeline_arn str
    The Amazon Resource Name (ARN) of the pipeline.
    pipeline_configuration_body str
    The Data Prepper pipeline configuration.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    vpc_endpoint_service str
    The VPC endpoint service name for the pipeline.
    vpc_endpoints Sequence[PipelineVpcEndpoint]
    The VPC interface endpoints that have access to the pipeline.
    bufferOptions Property Map
    Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions . For more information, see Persistent buffering .
    encryptionAtRestOptions Property Map
    Options to control how OpenSearch encrypts buffer data.
    ingestEndpointUrls List<String>
    A list of endpoints that can be used for ingesting data into a pipeline
    logPublishingOptions Property Map
    Key-value pairs that represent log publishing settings.
    maxUnits Number
    The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    minUnits Number
    The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
    pipelineArn String
    The Amazon Resource Name (ARN) of the pipeline.
    pipelineConfigurationBody String
    The Data Prepper pipeline configuration.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    vpcEndpointService String
    The VPC endpoint service name for the pipeline.
    vpcEndpoints List<Property Map>
    The VPC interface endpoints that have access to the pipeline.

    Supporting Types

    PipelineBufferOptions

    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

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

    PipelineLogPublishingOptions

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

    PipelineLogPublishingOptionsCloudWatchLogDestinationProperties

    LogGroup string
    LogGroup string
    logGroup String
    logGroup string
    logGroup String

    PipelineVpcEndpoint

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

    PipelineVpcOptions

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

    PipelineVpcOptionsVpcAttachmentOptionsProperties

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

    PipelineVpcOptionsVpcEndpointManagement

    Tag

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

    Package Details

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

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

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