1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreatePipelineInput {
/// <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>
pub pipeline_name: ::std::option::Option<::std::string::String>,
/// <p>The minimum pipeline capacity, in Ingestion Compute Units (ICUs).</p>
pub min_units: ::std::option::Option<i32>,
/// <p>The maximum pipeline capacity, in Ingestion Compute Units (ICUs).</p>
pub max_units: ::std::option::Option<i32>,
/// <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>
pub pipeline_configuration_body: ::std::option::Option<::std::string::String>,
/// <p>Key-value pairs to configure log publishing.</p>
pub log_publishing_options: ::std::option::Option<crate::types::LogPublishingOptions>,
/// <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>
pub vpc_options: ::std::option::Option<crate::types::VpcOptions>,
/// <p>Key-value pairs to configure persistent buffering for the pipeline.</p>
pub buffer_options: ::std::option::Option<crate::types::BufferOptions>,
/// <p>Key-value pairs to configure encryption for data that is written to a persistent buffer.</p>
pub encryption_at_rest_options: ::std::option::Option<crate::types::EncryptionAtRestOptions>,
/// <p>List of tags to add to the pipeline upon creation.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
/// <p>The Amazon Resource Name (ARN) of an IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline-security-overview.html">Setting up roles and users in Amazon OpenSearch Ingestion</a>.</p>
pub pipeline_role_arn: ::std::option::Option<::std::string::String>,
}
impl CreatePipelineInput {
/// <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>
pub fn pipeline_name(&self) -> ::std::option::Option<&str> {
self.pipeline_name.as_deref()
}
/// <p>The minimum pipeline capacity, in Ingestion Compute Units (ICUs).</p>
pub fn min_units(&self) -> ::std::option::Option<i32> {
self.min_units
}
/// <p>The maximum pipeline capacity, in Ingestion Compute Units (ICUs).</p>
pub fn max_units(&self) -> ::std::option::Option<i32> {
self.max_units
}
/// <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>
pub fn pipeline_configuration_body(&self) -> ::std::option::Option<&str> {
self.pipeline_configuration_body.as_deref()
}
/// <p>Key-value pairs to configure log publishing.</p>
pub fn log_publishing_options(&self) -> ::std::option::Option<&crate::types::LogPublishingOptions> {
self.log_publishing_options.as_ref()
}
/// <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>
pub fn vpc_options(&self) -> ::std::option::Option<&crate::types::VpcOptions> {
self.vpc_options.as_ref()
}
/// <p>Key-value pairs to configure persistent buffering for the pipeline.</p>
pub fn buffer_options(&self) -> ::std::option::Option<&crate::types::BufferOptions> {
self.buffer_options.as_ref()
}
/// <p>Key-value pairs to configure encryption for data that is written to a persistent buffer.</p>
pub fn encryption_at_rest_options(&self) -> ::std::option::Option<&crate::types::EncryptionAtRestOptions> {
self.encryption_at_rest_options.as_ref()
}
/// <p>List of tags to add to the pipeline upon creation.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
pub fn tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
/// <p>The Amazon Resource Name (ARN) of an IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline-security-overview.html">Setting up roles and users in Amazon OpenSearch Ingestion</a>.</p>
pub fn pipeline_role_arn(&self) -> ::std::option::Option<&str> {
self.pipeline_role_arn.as_deref()
}
}
impl CreatePipelineInput {
/// Creates a new builder-style object to manufacture [`CreatePipelineInput`](crate::operation::create_pipeline::CreatePipelineInput).
pub fn builder() -> crate::operation::create_pipeline::builders::CreatePipelineInputBuilder {
crate::operation::create_pipeline::builders::CreatePipelineInputBuilder::default()
}
}
/// A builder for [`CreatePipelineInput`](crate::operation::create_pipeline::CreatePipelineInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreatePipelineInputBuilder {
pub(crate) pipeline_name: ::std::option::Option<::std::string::String>,
pub(crate) min_units: ::std::option::Option<i32>,
pub(crate) max_units: ::std::option::Option<i32>,
pub(crate) pipeline_configuration_body: ::std::option::Option<::std::string::String>,
pub(crate) log_publishing_options: ::std::option::Option<crate::types::LogPublishingOptions>,
pub(crate) vpc_options: ::std::option::Option<crate::types::VpcOptions>,
pub(crate) buffer_options: ::std::option::Option<crate::types::BufferOptions>,
pub(crate) encryption_at_rest_options: ::std::option::Option<crate::types::EncryptionAtRestOptions>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
pub(crate) pipeline_role_arn: ::std::option::Option<::std::string::String>,
}
impl CreatePipelineInputBuilder {
/// <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>
/// This field is required.
pub fn pipeline_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.pipeline_name = ::std::option::Option::Some(input.into());
self
}
/// <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>
pub fn set_pipeline_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.pipeline_name = input;
self
}
/// <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>
pub fn get_pipeline_name(&self) -> &::std::option::Option<::std::string::String> {
&self.pipeline_name
}
/// <p>The minimum pipeline capacity, in Ingestion Compute Units (ICUs).</p>
/// This field is required.
pub fn min_units(mut self, input: i32) -> Self {
self.min_units = ::std::option::Option::Some(input);
self
}
/// <p>The minimum pipeline capacity, in Ingestion Compute Units (ICUs).</p>
pub fn set_min_units(mut self, input: ::std::option::Option<i32>) -> Self {
self.min_units = input;
self
}
/// <p>The minimum pipeline capacity, in Ingestion Compute Units (ICUs).</p>
pub fn get_min_units(&self) -> &::std::option::Option<i32> {
&self.min_units
}
/// <p>The maximum pipeline capacity, in Ingestion Compute Units (ICUs).</p>
/// This field is required.
pub fn max_units(mut self, input: i32) -> Self {
self.max_units = ::std::option::Option::Some(input);
self
}
/// <p>The maximum pipeline capacity, in Ingestion Compute Units (ICUs).</p>
pub fn set_max_units(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_units = input;
self
}
/// <p>The maximum pipeline capacity, in Ingestion Compute Units (ICUs).</p>
pub fn get_max_units(&self) -> &::std::option::Option<i32> {
&self.max_units
}
/// <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>
/// This field is required.
pub fn pipeline_configuration_body(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.pipeline_configuration_body = ::std::option::Option::Some(input.into());
self
}
/// <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>
pub fn set_pipeline_configuration_body(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.pipeline_configuration_body = input;
self
}
/// <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>
pub fn get_pipeline_configuration_body(&self) -> &::std::option::Option<::std::string::String> {
&self.pipeline_configuration_body
}
/// <p>Key-value pairs to configure log publishing.</p>
pub fn log_publishing_options(mut self, input: crate::types::LogPublishingOptions) -> Self {
self.log_publishing_options = ::std::option::Option::Some(input);
self
}
/// <p>Key-value pairs to configure log publishing.</p>
pub fn set_log_publishing_options(mut self, input: ::std::option::Option<crate::types::LogPublishingOptions>) -> Self {
self.log_publishing_options = input;
self
}
/// <p>Key-value pairs to configure log publishing.</p>
pub fn get_log_publishing_options(&self) -> &::std::option::Option<crate::types::LogPublishingOptions> {
&self.log_publishing_options
}
/// <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>
pub fn vpc_options(mut self, input: crate::types::VpcOptions) -> Self {
self.vpc_options = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_vpc_options(mut self, input: ::std::option::Option<crate::types::VpcOptions>) -> Self {
self.vpc_options = input;
self
}
/// <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>
pub fn get_vpc_options(&self) -> &::std::option::Option<crate::types::VpcOptions> {
&self.vpc_options
}
/// <p>Key-value pairs to configure persistent buffering for the pipeline.</p>
pub fn buffer_options(mut self, input: crate::types::BufferOptions) -> Self {
self.buffer_options = ::std::option::Option::Some(input);
self
}
/// <p>Key-value pairs to configure persistent buffering for the pipeline.</p>
pub fn set_buffer_options(mut self, input: ::std::option::Option<crate::types::BufferOptions>) -> Self {
self.buffer_options = input;
self
}
/// <p>Key-value pairs to configure persistent buffering for the pipeline.</p>
pub fn get_buffer_options(&self) -> &::std::option::Option<crate::types::BufferOptions> {
&self.buffer_options
}
/// <p>Key-value pairs to configure encryption for data that is written to a persistent buffer.</p>
pub fn encryption_at_rest_options(mut self, input: crate::types::EncryptionAtRestOptions) -> Self {
self.encryption_at_rest_options = ::std::option::Option::Some(input);
self
}
/// <p>Key-value pairs to configure encryption for data that is written to a persistent buffer.</p>
pub fn set_encryption_at_rest_options(mut self, input: ::std::option::Option<crate::types::EncryptionAtRestOptions>) -> Self {
self.encryption_at_rest_options = input;
self
}
/// <p>Key-value pairs to configure encryption for data that is written to a persistent buffer.</p>
pub fn get_encryption_at_rest_options(&self) -> &::std::option::Option<crate::types::EncryptionAtRestOptions> {
&self.encryption_at_rest_options
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>List of tags to add to the pipeline upon creation.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>List of tags to add to the pipeline upon creation.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>List of tags to add to the pipeline upon creation.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// <p>The Amazon Resource Name (ARN) of an IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline-security-overview.html">Setting up roles and users in Amazon OpenSearch Ingestion</a>.</p>
pub fn pipeline_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.pipeline_role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of an IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline-security-overview.html">Setting up roles and users in Amazon OpenSearch Ingestion</a>.</p>
pub fn set_pipeline_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.pipeline_role_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of an IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline-security-overview.html">Setting up roles and users in Amazon OpenSearch Ingestion</a>.</p>
pub fn get_pipeline_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.pipeline_role_arn
}
/// Consumes the builder and constructs a [`CreatePipelineInput`](crate::operation::create_pipeline::CreatePipelineInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_pipeline::CreatePipelineInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_pipeline::CreatePipelineInput {
pipeline_name: self.pipeline_name,
min_units: self.min_units,
max_units: self.max_units,
pipeline_configuration_body: self.pipeline_configuration_body,
log_publishing_options: self.log_publishing_options,
vpc_options: self.vpc_options,
buffer_options: self.buffer_options,
encryption_at_rest_options: self.encryption_at_rest_options,
tags: self.tags,
pipeline_role_arn: self.pipeline_role_arn,
})
}
}