aws_sdk_osis/client/
create_pipeline.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreatePipeline`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`pipeline_name(impl Into<String>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::pipeline_name) / [`set_pipeline_name(Option<String>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::set_pipeline_name):<br>required: **true**<br><p>The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.</p><br>
7    ///   - [`min_units(i32)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::min_units) / [`set_min_units(Option<i32>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::set_min_units):<br>required: **true**<br><p>The minimum pipeline capacity, in Ingestion Compute Units (ICUs).</p><br>
8    ///   - [`max_units(i32)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::max_units) / [`set_max_units(Option<i32>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::set_max_units):<br>required: **true**<br><p>The maximum pipeline capacity, in Ingestion Compute Units (ICUs).</p><br>
9    ///   - [`pipeline_configuration_body(impl Into<String>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::pipeline_configuration_body) / [`set_pipeline_configuration_body(Option<String>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::set_pipeline_configuration_body):<br>required: **true**<br><p>The pipeline configuration in YAML format. The command 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 <code>\n</code>.</p><br>
10    ///   - [`log_publishing_options(LogPublishingOptions)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::log_publishing_options) / [`set_log_publishing_options(Option<LogPublishingOptions>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::set_log_publishing_options):<br>required: **false**<br><p>Key-value pairs to configure log publishing.</p><br>
11    ///   - [`vpc_options(VpcOptions)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::vpc_options) / [`set_vpc_options(Option<VpcOptions>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::set_vpc_options):<br>required: **false**<br><p>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.</p><br>
12    ///   - [`buffer_options(BufferOptions)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::buffer_options) / [`set_buffer_options(Option<BufferOptions>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::set_buffer_options):<br>required: **false**<br><p>Key-value pairs to configure persistent buffering for the pipeline.</p><br>
13    ///   - [`encryption_at_rest_options(EncryptionAtRestOptions)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::encryption_at_rest_options) / [`set_encryption_at_rest_options(Option<EncryptionAtRestOptions>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::set_encryption_at_rest_options):<br>required: **false**<br><p>Key-value pairs to configure encryption for data that is written to a persistent buffer.</p><br>
14    ///   - [`tags(Tag)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::set_tags):<br>required: **false**<br><p>List of tags to add to the pipeline upon creation.</p><br>
15    ///   - [`pipeline_role_arn(impl Into<String>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::pipeline_role_arn) / [`set_pipeline_role_arn(Option<String>)`](crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::set_pipeline_role_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access Amazon Web Services resources.</p><br>
16    /// - On success, responds with [`CreatePipelineOutput`](crate::operation::create_pipeline::CreatePipelineOutput) with field(s):
17    ///   - [`pipeline(Option<Pipeline>)`](crate::operation::create_pipeline::CreatePipelineOutput::pipeline): <p>Container for information about the created pipeline.</p>
18    /// - On failure, responds with [`SdkError<CreatePipelineError>`](crate::operation::create_pipeline::CreatePipelineError)
19    pub fn create_pipeline(&self) -> crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder {
20        crate::operation::create_pipeline::builders::CreatePipelineFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_osis/client/create_pipeline.rs

aws_sdk_osis/client/
create_pipeline.rs
