AWS Native is in preview. AWS Classic is fully supported.
aws-native.osis.Pipeline
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
An OpenSearch Ingestion Service Data Prepper pipeline running Data Prepper.
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,
buffer_options: Optional[PipelineBufferOptionsArgs] = None,
encryption_at_rest_options: Optional[PipelineEncryptionAtRestOptionsArgs] = None,
log_publishing_options: Optional[PipelineLogPublishingOptionsArgs] = None,
pipeline_name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:osis: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.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const examplepipelineResourceResourceFromOsis = new aws_native.osis.Pipeline("examplepipelineResourceResourceFromOsis", {
maxUnits: 0,
minUnits: 0,
pipelineConfigurationBody: "string",
bufferOptions: {
persistentBufferEnabled: false,
},
encryptionAtRestOptions: {
kmsKeyArn: "string",
},
logPublishingOptions: {
cloudWatchLogDestination: {
logGroup: "string",
},
isLoggingEnabled: false,
},
pipelineName: "string",
tags: [{
key: "string",
value: "string",
}],
vpcOptions: {
subnetIds: ["string"],
securityGroupIds: ["string"],
},
});
Coming soon!
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:
- 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
Configuration stringBody - The Data Prepper pipeline configuration.
- Buffer
Options Pulumi.Aws Native. Osis. Inputs. Pipeline Buffer Options - Encryption
At Pulumi.Rest Options Aws Native. Osis. Inputs. Pipeline Encryption At Rest Options - Log
Publishing Pulumi.Options Aws Native. Osis. Inputs. Pipeline Log Publishing Options - Pipeline
Name string - Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
- List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Vpc
Options Pulumi.Aws Native. Osis. Inputs. Pipeline Vpc 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
Configuration stringBody - The Data Prepper pipeline configuration.
- Buffer
Options PipelineBuffer Options Args - Encryption
At PipelineRest Options Encryption At Rest Options Args - Log
Publishing PipelineOptions Log Publishing Options Args - Pipeline
Name string - Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
- Tag
Args - An array of key-value pairs to apply to this resource.
- Vpc
Options PipelineVpc Options Args
- 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
Configuration StringBody - The Data Prepper pipeline configuration.
- buffer
Options PipelineBuffer Options - encryption
At PipelineRest Options Encryption At Rest Options - log
Publishing PipelineOptions Log Publishing Options - pipeline
Name String - Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- vpc
Options PipelineVpc 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
Configuration stringBody - The Data Prepper pipeline configuration.
- buffer
Options PipelineBuffer Options - encryption
At PipelineRest Options Encryption At Rest Options - log
Publishing PipelineOptions Log Publishing Options - pipeline
Name string - Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
- Tag[]
- An array of key-value pairs to apply to this resource.
- vpc
Options PipelineVpc 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_
configuration_ strbody - The Data Prepper pipeline configuration.
- buffer_
options PipelineBuffer Options Args - encryption_
at_ Pipelinerest_ options Encryption At Rest Options Args - log_
publishing_ Pipelineoptions Log Publishing Options Args - pipeline_
name str - Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
- Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- vpc_
options PipelineVpc Options Args
- 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
Configuration StringBody - The Data Prepper pipeline configuration.
- buffer
Options Property Map - encryption
At Property MapRest Options - log
Publishing Property MapOptions - pipeline
Name String - Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
- vpc
Options Property Map
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.
- Ingest
Endpoint List<string>Urls - A list of endpoints that can be used for ingesting data into a pipeline
- Pipeline
Arn string - The Amazon Resource Name (ARN) of the pipeline.
- Vpc
Endpoints List<Pulumi.Aws Native. Osis. Outputs. Pipeline Vpc Endpoint> - The VPC interface endpoints that have access to the pipeline.
- Id string
- The provider-assigned unique ID for this managed resource.
- Ingest
Endpoint []stringUrls - A list of endpoints that can be used for ingesting data into a pipeline
- Pipeline
Arn string - The Amazon Resource Name (ARN) of the pipeline.
- Vpc
Endpoints []PipelineVpc Endpoint - The VPC interface endpoints that have access to the pipeline.
- id String
- The provider-assigned unique ID for this managed resource.
- ingest
Endpoint List<String>Urls - A list of endpoints that can be used for ingesting data into a pipeline
- pipeline
Arn String - The Amazon Resource Name (ARN) of the pipeline.
- vpc
Endpoints List<PipelineVpc Endpoint> - The VPC interface endpoints that have access to the pipeline.
- id string
- The provider-assigned unique ID for this managed resource.
- ingest
Endpoint string[]Urls - A list of endpoints that can be used for ingesting data into a pipeline
- pipeline
Arn string - The Amazon Resource Name (ARN) of the pipeline.
- vpc
Endpoints PipelineVpc Endpoint[] - The VPC interface endpoints that have access to the pipeline.
- id str
- The provider-assigned unique ID for this managed resource.
- ingest_
endpoint_ Sequence[str]urls - A list of endpoints that can be used for ingesting data into a pipeline
- pipeline_
arn str - The Amazon Resource Name (ARN) of the pipeline.
- vpc_
endpoints Sequence[PipelineVpc Endpoint] - The VPC interface endpoints that have access to the pipeline.
- id String
- The provider-assigned unique ID for this managed resource.
- ingest
Endpoint List<String>Urls - A list of endpoints that can be used for ingesting data into a pipeline
- pipeline
Arn String - The Amazon Resource Name (ARN) of the pipeline.
- vpc
Endpoints List<Property Map> - The VPC interface endpoints that have access to the pipeline.
Supporting Types
PipelineBufferOptions, PipelineBufferOptionsArgs
- 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, PipelineEncryptionAtRestOptionsArgs
- 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, PipelineLogPublishingOptionsArgs
- 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, PipelineLogPublishingOptionsCloudWatchLogDestinationPropertiesArgs
- Log
Group string
- Log
Group string
- log
Group String
- log
Group string
- log_
group str
- log
Group String
PipelineVpcEndpoint, PipelineVpcEndpointArgs
- 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, PipelineVpcOptionsArgs
- 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, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.