AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
aws-native.osis.getPipeline
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:osis:getPipeline
arguments:
# arguments dictionary
The following arguments are supported:
- Pipeline
Arn string - The Amazon Resource Name (ARN) of the pipeline.
- Pipeline
Arn string - The Amazon Resource Name (ARN) of the pipeline.
- pipeline
Arn String - The Amazon Resource Name (ARN) of the pipeline.
- pipeline
Arn string - The Amazon Resource Name (ARN) of the pipeline.
- pipeline_
arn str - The Amazon Resource Name (ARN) of the pipeline.
- pipeline
Arn String - The Amazon Resource Name (ARN) of the pipeline.
getPipeline Result
The following output properties are available:
- Buffer
Options Pulumi.Aws Native. Osis. Outputs. Pipeline Buffer Options - Encryption
At Pulumi.Rest Options Aws Native. Osis. Outputs. Pipeline Encryption At Rest Options - Ingest
Endpoint List<string>Urls - A list of endpoints that can be used for ingesting data into a pipeline
- Log
Publishing Pulumi.Options Aws Native. Osis. Outputs. Pipeline Log Publishing Options - 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 string - The Amazon Resource Name (ARN) of the pipeline.
- Pipeline
Configuration stringBody - The Data Prepper pipeline configuration.
- List<Pulumi.
Aws Native. Outputs. Tag> - An array of key-value pairs to apply to this resource.
- Vpc
Endpoints List<Pulumi.Aws Native. Osis. Outputs. Pipeline Vpc Endpoint> - The VPC interface endpoints that have access to the pipeline.
- Buffer
Options PipelineBuffer Options - Encryption
At PipelineRest Options Encryption At Rest Options - Ingest
Endpoint []stringUrls - A list of endpoints that can be used for ingesting data into a pipeline
- Log
Publishing PipelineOptions Log Publishing Options - 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 string - The Amazon Resource Name (ARN) of the pipeline.
- Pipeline
Configuration stringBody - The Data Prepper pipeline configuration.
- Tag
- An array of key-value pairs to apply to this resource.
- Vpc
Endpoints []PipelineVpc Endpoint - The VPC interface endpoints that have access to the pipeline.
- buffer
Options PipelineBuffer Options - encryption
At PipelineRest Options Encryption At Rest Options - ingest
Endpoint List<String>Urls - A list of endpoints that can be used for ingesting data into a pipeline
- log
Publishing PipelineOptions Log Publishing Options - max
Units Integer - The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
- min
Units Integer - The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
- pipeline
Arn String - The Amazon Resource Name (ARN) of the pipeline.
- pipeline
Configuration StringBody - The Data Prepper pipeline configuration.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- vpc
Endpoints List<PipelineVpc Endpoint> - The VPC interface endpoints that have access to the pipeline.
- buffer
Options PipelineBuffer Options - encryption
At PipelineRest Options Encryption At Rest Options - ingest
Endpoint string[]Urls - A list of endpoints that can be used for ingesting data into a pipeline
- log
Publishing PipelineOptions Log Publishing Options - max
Units number - The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
- min
Units number - The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
- pipeline
Arn string - The Amazon Resource Name (ARN) of the pipeline.
- pipeline
Configuration stringBody - The Data Prepper pipeline configuration.
- Tag[]
- An array of key-value pairs to apply to this resource.
- vpc
Endpoints PipelineVpc Endpoint[] - The VPC interface endpoints that have access to the pipeline.
- buffer_
options PipelineBuffer Options - encryption_
at_ Pipelinerest_ options Encryption At Rest Options - ingest_
endpoint_ Sequence[str]urls - A list of endpoints that can be used for ingesting data into a pipeline
- log_
publishing_ Pipelineoptions Log Publishing Options - 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_ strbody - The Data Prepper pipeline configuration.
- Sequence[root_Tag]
- An array of key-value pairs to apply to this resource.
- vpc_
endpoints Sequence[PipelineVpc Endpoint] - The VPC interface endpoints that have access to the pipeline.
- buffer
Options Property Map - encryption
At Property MapRest Options - ingest
Endpoint List<String>Urls - A list of endpoints that can be used for ingesting data into a pipeline
- log
Publishing Property MapOptions - max
Units Number - The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
- min
Units Number - The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs).
- pipeline
Arn String - The Amazon Resource Name (ARN) of the pipeline.
- pipeline
Configuration StringBody - The Data Prepper pipeline configuration.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
- vpc
Endpoints List<Property Map> - The VPC interface endpoints that have access to the pipeline.
Supporting Types
PipelineBufferOptions
- Persistent
Buffer boolEnabled - Whether persistent buffering should be enabled.
- Persistent
Buffer boolEnabled - Whether persistent buffering should be enabled.
- persistent
Buffer BooleanEnabled - Whether persistent buffering should be enabled.
- persistent
Buffer booleanEnabled - Whether persistent buffering should be enabled.
- persistent_
buffer_ boolenabled - Whether persistent buffering should be enabled.
- persistent
Buffer BooleanEnabled - Whether persistent buffering should be enabled.
PipelineEncryptionAtRestOptions
- Kms
Key stringArn - The KMS key to use for encrypting data. By default an AWS owned key is used
- Kms
Key stringArn - The KMS key to use for encrypting data. By default an AWS owned key is used
- kms
Key StringArn - The KMS key to use for encrypting data. By default an AWS owned key is used
- kms
Key stringArn - The KMS key to use for encrypting data. By default an AWS owned key is used
- kms_
key_ strarn - The KMS key to use for encrypting data. By default an AWS owned key is used
- kms
Key StringArn - The KMS key to use for encrypting data. By default an AWS owned key is used
PipelineLogPublishingOptions
- Cloud
Watch Pulumi.Log Destination Aws Native. Osis. Inputs. Pipeline Log Publishing Options Cloud Watch Log Destination Properties - The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
- Is
Logging boolEnabled - Whether logs should be published.
- Cloud
Watch PipelineLog Destination Log Publishing Options Cloud Watch Log Destination Properties - The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
- Is
Logging boolEnabled - Whether logs should be published.
- cloud
Watch PipelineLog Destination Log Publishing Options Cloud Watch Log Destination Properties - The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
- is
Logging BooleanEnabled - Whether logs should be published.
- cloud
Watch PipelineLog Destination Log Publishing Options Cloud Watch Log Destination Properties - The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
- is
Logging booleanEnabled - Whether logs should be published.
- cloud_
watch_ Pipelinelog_ destination Log Publishing Options Cloud Watch Log Destination Properties - The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
- is_
logging_ boolenabled - Whether logs should be published.
- cloud
Watch Property MapLog Destination - The destination for OpenSearch Ingestion Service logs sent to Amazon CloudWatch.
- is
Logging BooleanEnabled - Whether logs should be published.
PipelineLogPublishingOptionsCloudWatchLogDestinationProperties
- Log
Group string
- Log
Group string
- log
Group String
- log
Group string
- log_
group str
- log
Group String
PipelineVpcEndpoint
- Vpc
Endpoint stringId - The unique identifier of the endpoint.
- Vpc
Id string - The ID for your VPC. AWS Privatelink generates this value when you create a VPC.
- Vpc
Options Pulumi.Aws Native. Osis. Inputs. Pipeline Vpc Options
- Vpc
Endpoint stringId - The unique identifier of the endpoint.
- Vpc
Id string - The ID for your VPC. AWS Privatelink generates this value when you create a VPC.
- Vpc
Options PipelineVpc Options
- vpc
Endpoint StringId - The unique identifier of the endpoint.
- vpc
Id String - The ID for your VPC. AWS Privatelink generates this value when you create a VPC.
- vpc
Options PipelineVpc Options
- vpc
Endpoint stringId - The unique identifier of the endpoint.
- vpc
Id string - The ID for your VPC. AWS Privatelink generates this value when you create a VPC.
- vpc
Options PipelineVpc Options
- vpc_
endpoint_ strid - 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 PipelineVpc Options
- vpc
Endpoint StringId - The unique identifier of the endpoint.
- vpc
Id String - The ID for your VPC. AWS Privatelink generates this value when you create a VPC.
- vpc
Options Property Map
PipelineVpcOptions
- Subnet
Ids List<string> - A list of subnet IDs associated with the VPC endpoint.
- Security
Group List<string>Ids - A list of security groups associated with the VPC endpoint.
- Subnet
Ids []string - A list of subnet IDs associated with the VPC endpoint.
- Security
Group []stringIds - A list of security groups associated with the VPC endpoint.
- subnet
Ids List<String> - A list of subnet IDs associated with the VPC endpoint.
- security
Group List<String>Ids - A list of security groups associated with the VPC endpoint.
- subnet
Ids string[] - A list of subnet IDs associated with the VPC endpoint.
- security
Group string[]Ids - 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_ Sequence[str]ids - A list of security groups associated with the VPC endpoint.
- subnet
Ids List<String> - A list of subnet IDs associated with the VPC endpoint.
- security
Group List<String>Ids - A list of security groups associated with the VPC endpoint.
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi