aws_sdk_codebuild/operation/start_build/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_build::_start_build_output::StartBuildOutputBuilder;
3
4pub use crate::operation::start_build::_start_build_input::StartBuildInputBuilder;
5
6impl crate::operation::start_build::builders::StartBuildInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::start_build::StartBuildOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::start_build::StartBuildError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.start_build();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `StartBuild`.
24///
25/// <p>Starts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output.</p>
26/// <p>You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct StartBuildFluentBuilder {
29 handle: ::std::sync::Arc<crate::client::Handle>,
30 inner: crate::operation::start_build::builders::StartBuildInputBuilder,
31 config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34 crate::client::customize::internal::CustomizableSend<
35 crate::operation::start_build::StartBuildOutput,
36 crate::operation::start_build::StartBuildError,
37 > for StartBuildFluentBuilder
38{
39 fn send(
40 self,
41 config_override: crate::config::Builder,
42 ) -> crate::client::customize::internal::BoxFuture<
43 crate::client::customize::internal::SendResult<
44 crate::operation::start_build::StartBuildOutput,
45 crate::operation::start_build::StartBuildError,
46 >,
47 > {
48 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49 }
50}
51impl StartBuildFluentBuilder {
52 /// Creates a new `StartBuildFluentBuilder`.
53 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54 Self {
55 handle,
56 inner: ::std::default::Default::default(),
57 config_override: ::std::option::Option::None,
58 }
59 }
60 /// Access the StartBuild as a reference.
61 pub fn as_input(&self) -> &crate::operation::start_build::builders::StartBuildInputBuilder {
62 &self.inner
63 }
64 /// Sends the request and returns the response.
65 ///
66 /// If an error occurs, an `SdkError` will be returned with additional details that
67 /// can be matched against.
68 ///
69 /// By default, any retryable failures will be retried twice. Retry behavior
70 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71 /// set when configuring the client.
72 pub async fn send(
73 self,
74 ) -> ::std::result::Result<
75 crate::operation::start_build::StartBuildOutput,
76 ::aws_smithy_runtime_api::client::result::SdkError<
77 crate::operation::start_build::StartBuildError,
78 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79 >,
80 > {
81 let input = self
82 .inner
83 .build()
84 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85 let runtime_plugins = crate::operation::start_build::StartBuild::operation_runtime_plugins(
86 self.handle.runtime_plugins.clone(),
87 &self.handle.conf,
88 self.config_override,
89 );
90 crate::operation::start_build::StartBuild::orchestrate(&runtime_plugins, input).await
91 }
92
93 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94 pub fn customize(
95 self,
96 ) -> crate::client::customize::CustomizableOperation<
97 crate::operation::start_build::StartBuildOutput,
98 crate::operation::start_build::StartBuildError,
99 Self,
100 > {
101 crate::client::customize::CustomizableOperation::new(self)
102 }
103 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104 self.set_config_override(::std::option::Option::Some(config_override.into()));
105 self
106 }
107
108 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109 self.config_override = config_override;
110 self
111 }
112 /// <p>The name of the CodeBuild build project to start running a build.</p>
113 pub fn project_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114 self.inner = self.inner.project_name(input.into());
115 self
116 }
117 /// <p>The name of the CodeBuild build project to start running a build.</p>
118 pub fn set_project_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119 self.inner = self.inner.set_project_name(input);
120 self
121 }
122 /// <p>The name of the CodeBuild build project to start running a build.</p>
123 pub fn get_project_name(&self) -> &::std::option::Option<::std::string::String> {
124 self.inner.get_project_name()
125 }
126 ///
127 /// Appends an item to `secondarySourcesOverride`.
128 ///
129 /// To override the contents of this collection use [`set_secondary_sources_override`](Self::set_secondary_sources_override).
130 ///
131 /// <p>An array of <code>ProjectSource</code> objects.</p>
132 pub fn secondary_sources_override(mut self, input: crate::types::ProjectSource) -> Self {
133 self.inner = self.inner.secondary_sources_override(input);
134 self
135 }
136 /// <p>An array of <code>ProjectSource</code> objects.</p>
137 pub fn set_secondary_sources_override(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ProjectSource>>) -> Self {
138 self.inner = self.inner.set_secondary_sources_override(input);
139 self
140 }
141 /// <p>An array of <code>ProjectSource</code> objects.</p>
142 pub fn get_secondary_sources_override(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ProjectSource>> {
143 self.inner.get_secondary_sources_override()
144 }
145 ///
146 /// Appends an item to `secondarySourcesVersionOverride`.
147 ///
148 /// To override the contents of this collection use [`set_secondary_sources_version_override`](Self::set_secondary_sources_version_override).
149 ///
150 /// <p>An array of <code>ProjectSourceVersion</code> objects that specify one or more versions of the project's secondary sources to be used for this build only.</p>
151 pub fn secondary_sources_version_override(mut self, input: crate::types::ProjectSourceVersion) -> Self {
152 self.inner = self.inner.secondary_sources_version_override(input);
153 self
154 }
155 /// <p>An array of <code>ProjectSourceVersion</code> objects that specify one or more versions of the project's secondary sources to be used for this build only.</p>
156 pub fn set_secondary_sources_version_override(
157 mut self,
158 input: ::std::option::Option<::std::vec::Vec<crate::types::ProjectSourceVersion>>,
159 ) -> Self {
160 self.inner = self.inner.set_secondary_sources_version_override(input);
161 self
162 }
163 /// <p>An array of <code>ProjectSourceVersion</code> objects that specify one or more versions of the project's secondary sources to be used for this build only.</p>
164 pub fn get_secondary_sources_version_override(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ProjectSourceVersion>> {
165 self.inner.get_secondary_sources_version_override()
166 }
167 /// <p>The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:</p>
168 /// <dl>
169 /// <dt>
170 /// CodeCommit
171 /// </dt>
172 /// <dd>
173 /// <p>The commit ID, branch, or Git tag to use.</p>
174 /// </dd>
175 /// <dt>
176 /// GitHub
177 /// </dt>
178 /// <dd>
179 /// <p>The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p>
180 /// </dd>
181 /// <dt>
182 /// GitLab
183 /// </dt>
184 /// <dd>
185 /// <p>The commit ID, branch, or Git tag to use.</p>
186 /// </dd>
187 /// <dt>
188 /// Bitbucket
189 /// </dt>
190 /// <dd>
191 /// <p>The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p>
192 /// </dd>
193 /// <dt>
194 /// Amazon S3
195 /// </dt>
196 /// <dd>
197 /// <p>The version ID of the object that represents the build input ZIP file to use.</p>
198 /// </dd>
199 /// </dl>
200 /// <p>If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence.</p>
201 /// <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>.</p>
202 pub fn source_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
203 self.inner = self.inner.source_version(input.into());
204 self
205 }
206 /// <p>The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:</p>
207 /// <dl>
208 /// <dt>
209 /// CodeCommit
210 /// </dt>
211 /// <dd>
212 /// <p>The commit ID, branch, or Git tag to use.</p>
213 /// </dd>
214 /// <dt>
215 /// GitHub
216 /// </dt>
217 /// <dd>
218 /// <p>The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p>
219 /// </dd>
220 /// <dt>
221 /// GitLab
222 /// </dt>
223 /// <dd>
224 /// <p>The commit ID, branch, or Git tag to use.</p>
225 /// </dd>
226 /// <dt>
227 /// Bitbucket
228 /// </dt>
229 /// <dd>
230 /// <p>The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p>
231 /// </dd>
232 /// <dt>
233 /// Amazon S3
234 /// </dt>
235 /// <dd>
236 /// <p>The version ID of the object that represents the build input ZIP file to use.</p>
237 /// </dd>
238 /// </dl>
239 /// <p>If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence.</p>
240 /// <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>.</p>
241 pub fn set_source_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
242 self.inner = self.inner.set_source_version(input);
243 self
244 }
245 /// <p>The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:</p>
246 /// <dl>
247 /// <dt>
248 /// CodeCommit
249 /// </dt>
250 /// <dd>
251 /// <p>The commit ID, branch, or Git tag to use.</p>
252 /// </dd>
253 /// <dt>
254 /// GitHub
255 /// </dt>
256 /// <dd>
257 /// <p>The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p>
258 /// </dd>
259 /// <dt>
260 /// GitLab
261 /// </dt>
262 /// <dd>
263 /// <p>The commit ID, branch, or Git tag to use.</p>
264 /// </dd>
265 /// <dt>
266 /// Bitbucket
267 /// </dt>
268 /// <dd>
269 /// <p>The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p>
270 /// </dd>
271 /// <dt>
272 /// Amazon S3
273 /// </dt>
274 /// <dd>
275 /// <p>The version ID of the object that represents the build input ZIP file to use.</p>
276 /// </dd>
277 /// </dl>
278 /// <p>If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence.</p>
279 /// <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>.</p>
280 pub fn get_source_version(&self) -> &::std::option::Option<::std::string::String> {
281 self.inner.get_source_version()
282 }
283 /// <p>Build output artifact settings that override, for this build only, the latest ones already defined in the build project.</p>
284 pub fn artifacts_override(mut self, input: crate::types::ProjectArtifacts) -> Self {
285 self.inner = self.inner.artifacts_override(input);
286 self
287 }
288 /// <p>Build output artifact settings that override, for this build only, the latest ones already defined in the build project.</p>
289 pub fn set_artifacts_override(mut self, input: ::std::option::Option<crate::types::ProjectArtifacts>) -> Self {
290 self.inner = self.inner.set_artifacts_override(input);
291 self
292 }
293 /// <p>Build output artifact settings that override, for this build only, the latest ones already defined in the build project.</p>
294 pub fn get_artifacts_override(&self) -> &::std::option::Option<crate::types::ProjectArtifacts> {
295 self.inner.get_artifacts_override()
296 }
297 ///
298 /// Appends an item to `secondaryArtifactsOverride`.
299 ///
300 /// To override the contents of this collection use [`set_secondary_artifacts_override`](Self::set_secondary_artifacts_override).
301 ///
302 /// <p>An array of <code>ProjectArtifacts</code> objects.</p>
303 pub fn secondary_artifacts_override(mut self, input: crate::types::ProjectArtifacts) -> Self {
304 self.inner = self.inner.secondary_artifacts_override(input);
305 self
306 }
307 /// <p>An array of <code>ProjectArtifacts</code> objects.</p>
308 pub fn set_secondary_artifacts_override(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ProjectArtifacts>>) -> Self {
309 self.inner = self.inner.set_secondary_artifacts_override(input);
310 self
311 }
312 /// <p>An array of <code>ProjectArtifacts</code> objects.</p>
313 pub fn get_secondary_artifacts_override(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ProjectArtifacts>> {
314 self.inner.get_secondary_artifacts_override()
315 }
316 ///
317 /// Appends an item to `environmentVariablesOverride`.
318 ///
319 /// To override the contents of this collection use [`set_environment_variables_override`](Self::set_environment_variables_override).
320 ///
321 /// <p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>
322 pub fn environment_variables_override(mut self, input: crate::types::EnvironmentVariable) -> Self {
323 self.inner = self.inner.environment_variables_override(input);
324 self
325 }
326 /// <p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>
327 pub fn set_environment_variables_override(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::EnvironmentVariable>>) -> Self {
328 self.inner = self.inner.set_environment_variables_override(input);
329 self
330 }
331 /// <p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>
332 pub fn get_environment_variables_override(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::EnvironmentVariable>> {
333 self.inner.get_environment_variables_override()
334 }
335 /// <p>A source input type, for this build, that overrides the source input defined in the build project.</p>
336 pub fn source_type_override(mut self, input: crate::types::SourceType) -> Self {
337 self.inner = self.inner.source_type_override(input);
338 self
339 }
340 /// <p>A source input type, for this build, that overrides the source input defined in the build project.</p>
341 pub fn set_source_type_override(mut self, input: ::std::option::Option<crate::types::SourceType>) -> Self {
342 self.inner = self.inner.set_source_type_override(input);
343 self
344 }
345 /// <p>A source input type, for this build, that overrides the source input defined in the build project.</p>
346 pub fn get_source_type_override(&self) -> &::std::option::Option<crate::types::SourceType> {
347 self.inner.get_source_type_override()
348 }
349 /// <p>A location that overrides, for this build, the source location for the one defined in the build project.</p>
350 pub fn source_location_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
351 self.inner = self.inner.source_location_override(input.into());
352 self
353 }
354 /// <p>A location that overrides, for this build, the source location for the one defined in the build project.</p>
355 pub fn set_source_location_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
356 self.inner = self.inner.set_source_location_override(input);
357 self
358 }
359 /// <p>A location that overrides, for this build, the source location for the one defined in the build project.</p>
360 pub fn get_source_location_override(&self) -> &::std::option::Option<::std::string::String> {
361 self.inner.get_source_location_override()
362 }
363 /// <p>An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket, GitHub, GitLab, or GitLab Self Managed.</p>
364 pub fn source_auth_override(mut self, input: crate::types::SourceAuth) -> Self {
365 self.inner = self.inner.source_auth_override(input);
366 self
367 }
368 /// <p>An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket, GitHub, GitLab, or GitLab Self Managed.</p>
369 pub fn set_source_auth_override(mut self, input: ::std::option::Option<crate::types::SourceAuth>) -> Self {
370 self.inner = self.inner.set_source_auth_override(input);
371 self
372 }
373 /// <p>An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket, GitHub, GitLab, or GitLab Self Managed.</p>
374 pub fn get_source_auth_override(&self) -> &::std::option::Option<crate::types::SourceAuth> {
375 self.inner.get_source_auth_override()
376 }
377 /// <p>The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.</p>
378 pub fn git_clone_depth_override(mut self, input: i32) -> Self {
379 self.inner = self.inner.git_clone_depth_override(input);
380 self
381 }
382 /// <p>The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.</p>
383 pub fn set_git_clone_depth_override(mut self, input: ::std::option::Option<i32>) -> Self {
384 self.inner = self.inner.set_git_clone_depth_override(input);
385 self
386 }
387 /// <p>The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.</p>
388 pub fn get_git_clone_depth_override(&self) -> &::std::option::Option<i32> {
389 self.inner.get_git_clone_depth_override()
390 }
391 /// <p>Information about the Git submodules configuration for this build of an CodeBuild build project.</p>
392 pub fn git_submodules_config_override(mut self, input: crate::types::GitSubmodulesConfig) -> Self {
393 self.inner = self.inner.git_submodules_config_override(input);
394 self
395 }
396 /// <p>Information about the Git submodules configuration for this build of an CodeBuild build project.</p>
397 pub fn set_git_submodules_config_override(mut self, input: ::std::option::Option<crate::types::GitSubmodulesConfig>) -> Self {
398 self.inner = self.inner.set_git_submodules_config_override(input);
399 self
400 }
401 /// <p>Information about the Git submodules configuration for this build of an CodeBuild build project.</p>
402 pub fn get_git_submodules_config_override(&self) -> &::std::option::Option<crate::types::GitSubmodulesConfig> {
403 self.inner.get_git_submodules_config_override()
404 }
405 /// <p>A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.</p>
406 /// <p>If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>.</p><note>
407 /// <p>Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.</p>
408 /// </note>
409 pub fn buildspec_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
410 self.inner = self.inner.buildspec_override(input.into());
411 self
412 }
413 /// <p>A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.</p>
414 /// <p>If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>.</p><note>
415 /// <p>Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.</p>
416 /// </note>
417 pub fn set_buildspec_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
418 self.inner = self.inner.set_buildspec_override(input);
419 self
420 }
421 /// <p>A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.</p>
422 /// <p>If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>.</p><note>
423 /// <p>Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.</p>
424 /// </note>
425 pub fn get_buildspec_override(&self) -> &::std::option::Option<::std::string::String> {
426 self.inner.get_buildspec_override()
427 }
428 /// <p>Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.</p>
429 pub fn insecure_ssl_override(mut self, input: bool) -> Self {
430 self.inner = self.inner.insecure_ssl_override(input);
431 self
432 }
433 /// <p>Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.</p>
434 pub fn set_insecure_ssl_override(mut self, input: ::std::option::Option<bool>) -> Self {
435 self.inner = self.inner.set_insecure_ssl_override(input);
436 self
437 }
438 /// <p>Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.</p>
439 pub fn get_insecure_ssl_override(&self) -> &::std::option::Option<bool> {
440 self.inner.get_insecure_ssl_override()
441 }
442 /// <p>Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket, an <code>invalidInputException</code> is thrown.</p>
443 /// <p>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</p><note>
444 /// <p>The status of a build triggered by a webhook is always reported to your source provider.</p>
445 /// </note>
446 pub fn report_build_status_override(mut self, input: bool) -> Self {
447 self.inner = self.inner.report_build_status_override(input);
448 self
449 }
450 /// <p>Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket, an <code>invalidInputException</code> is thrown.</p>
451 /// <p>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</p><note>
452 /// <p>The status of a build triggered by a webhook is always reported to your source provider.</p>
453 /// </note>
454 pub fn set_report_build_status_override(mut self, input: ::std::option::Option<bool>) -> Self {
455 self.inner = self.inner.set_report_build_status_override(input);
456 self
457 }
458 /// <p>Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket, an <code>invalidInputException</code> is thrown.</p>
459 /// <p>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</p><note>
460 /// <p>The status of a build triggered by a webhook is always reported to your source provider.</p>
461 /// </note>
462 pub fn get_report_build_status_override(&self) -> &::std::option::Option<bool> {
463 self.inner.get_report_build_status_override()
464 }
465 /// <p>Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.</p>
466 pub fn build_status_config_override(mut self, input: crate::types::BuildStatusConfig) -> Self {
467 self.inner = self.inner.build_status_config_override(input);
468 self
469 }
470 /// <p>Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.</p>
471 pub fn set_build_status_config_override(mut self, input: ::std::option::Option<crate::types::BuildStatusConfig>) -> Self {
472 self.inner = self.inner.set_build_status_config_override(input);
473 self
474 }
475 /// <p>Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.</p>
476 pub fn get_build_status_config_override(&self) -> &::std::option::Option<crate::types::BuildStatusConfig> {
477 self.inner.get_build_status_config_override()
478 }
479 /// <p>A container type for this build that overrides the one specified in the build project.</p>
480 pub fn environment_type_override(mut self, input: crate::types::EnvironmentType) -> Self {
481 self.inner = self.inner.environment_type_override(input);
482 self
483 }
484 /// <p>A container type for this build that overrides the one specified in the build project.</p>
485 pub fn set_environment_type_override(mut self, input: ::std::option::Option<crate::types::EnvironmentType>) -> Self {
486 self.inner = self.inner.set_environment_type_override(input);
487 self
488 }
489 /// <p>A container type for this build that overrides the one specified in the build project.</p>
490 pub fn get_environment_type_override(&self) -> &::std::option::Option<crate::types::EnvironmentType> {
491 self.inner.get_environment_type_override()
492 }
493 /// <p>The name of an image for this build that overrides the one specified in the build project.</p>
494 pub fn image_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
495 self.inner = self.inner.image_override(input.into());
496 self
497 }
498 /// <p>The name of an image for this build that overrides the one specified in the build project.</p>
499 pub fn set_image_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
500 self.inner = self.inner.set_image_override(input);
501 self
502 }
503 /// <p>The name of an image for this build that overrides the one specified in the build project.</p>
504 pub fn get_image_override(&self) -> &::std::option::Option<::std::string::String> {
505 self.inner.get_image_override()
506 }
507 /// <p>The name of a compute type for this build that overrides the one specified in the build project.</p>
508 pub fn compute_type_override(mut self, input: crate::types::ComputeType) -> Self {
509 self.inner = self.inner.compute_type_override(input);
510 self
511 }
512 /// <p>The name of a compute type for this build that overrides the one specified in the build project.</p>
513 pub fn set_compute_type_override(mut self, input: ::std::option::Option<crate::types::ComputeType>) -> Self {
514 self.inner = self.inner.set_compute_type_override(input);
515 self
516 }
517 /// <p>The name of a compute type for this build that overrides the one specified in the build project.</p>
518 pub fn get_compute_type_override(&self) -> &::std::option::Option<crate::types::ComputeType> {
519 self.inner.get_compute_type_override()
520 }
521 /// <p>The name of a certificate for this build that overrides the one specified in the build project.</p>
522 pub fn certificate_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
523 self.inner = self.inner.certificate_override(input.into());
524 self
525 }
526 /// <p>The name of a certificate for this build that overrides the one specified in the build project.</p>
527 pub fn set_certificate_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
528 self.inner = self.inner.set_certificate_override(input);
529 self
530 }
531 /// <p>The name of a certificate for this build that overrides the one specified in the build project.</p>
532 pub fn get_certificate_override(&self) -> &::std::option::Option<::std::string::String> {
533 self.inner.get_certificate_override()
534 }
535 /// <p>A ProjectCache object specified for this build that overrides the one defined in the build project.</p>
536 pub fn cache_override(mut self, input: crate::types::ProjectCache) -> Self {
537 self.inner = self.inner.cache_override(input);
538 self
539 }
540 /// <p>A ProjectCache object specified for this build that overrides the one defined in the build project.</p>
541 pub fn set_cache_override(mut self, input: ::std::option::Option<crate::types::ProjectCache>) -> Self {
542 self.inner = self.inner.set_cache_override(input);
543 self
544 }
545 /// <p>A ProjectCache object specified for this build that overrides the one defined in the build project.</p>
546 pub fn get_cache_override(&self) -> &::std::option::Option<crate::types::ProjectCache> {
547 self.inner.get_cache_override()
548 }
549 /// <p>The name of a service role for this build that overrides the one specified in the build project.</p>
550 pub fn service_role_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
551 self.inner = self.inner.service_role_override(input.into());
552 self
553 }
554 /// <p>The name of a service role for this build that overrides the one specified in the build project.</p>
555 pub fn set_service_role_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
556 self.inner = self.inner.set_service_role_override(input);
557 self
558 }
559 /// <p>The name of a service role for this build that overrides the one specified in the build project.</p>
560 pub fn get_service_role_override(&self) -> &::std::option::Option<::std::string::String> {
561 self.inner.get_service_role_override()
562 }
563 /// <p>Enable this flag to override privileged mode in the build project.</p>
564 pub fn privileged_mode_override(mut self, input: bool) -> Self {
565 self.inner = self.inner.privileged_mode_override(input);
566 self
567 }
568 /// <p>Enable this flag to override privileged mode in the build project.</p>
569 pub fn set_privileged_mode_override(mut self, input: ::std::option::Option<bool>) -> Self {
570 self.inner = self.inner.set_privileged_mode_override(input);
571 self
572 }
573 /// <p>Enable this flag to override privileged mode in the build project.</p>
574 pub fn get_privileged_mode_override(&self) -> &::std::option::Option<bool> {
575 self.inner.get_privileged_mode_override()
576 }
577 /// <p>The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.</p>
578 pub fn timeout_in_minutes_override(mut self, input: i32) -> Self {
579 self.inner = self.inner.timeout_in_minutes_override(input);
580 self
581 }
582 /// <p>The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.</p>
583 pub fn set_timeout_in_minutes_override(mut self, input: ::std::option::Option<i32>) -> Self {
584 self.inner = self.inner.set_timeout_in_minutes_override(input);
585 self
586 }
587 /// <p>The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.</p>
588 pub fn get_timeout_in_minutes_override(&self) -> &::std::option::Option<i32> {
589 self.inner.get_timeout_in_minutes_override()
590 }
591 /// <p>The number of minutes a build is allowed to be queued before it times out.</p>
592 pub fn queued_timeout_in_minutes_override(mut self, input: i32) -> Self {
593 self.inner = self.inner.queued_timeout_in_minutes_override(input);
594 self
595 }
596 /// <p>The number of minutes a build is allowed to be queued before it times out.</p>
597 pub fn set_queued_timeout_in_minutes_override(mut self, input: ::std::option::Option<i32>) -> Self {
598 self.inner = self.inner.set_queued_timeout_in_minutes_override(input);
599 self
600 }
601 /// <p>The number of minutes a build is allowed to be queued before it times out.</p>
602 pub fn get_queued_timeout_in_minutes_override(&self) -> &::std::option::Option<i32> {
603 self.inner.get_queued_timeout_in_minutes_override()
604 }
605 /// <p>The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.</p><note>
606 /// <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.</p>
607 /// </note>
608 /// <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></alias-name></code>).</p>
609 pub fn encryption_key_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
610 self.inner = self.inner.encryption_key_override(input.into());
611 self
612 }
613 /// <p>The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.</p><note>
614 /// <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.</p>
615 /// </note>
616 /// <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></alias-name></code>).</p>
617 pub fn set_encryption_key_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
618 self.inner = self.inner.set_encryption_key_override(input);
619 self
620 }
621 /// <p>The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.</p><note>
622 /// <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.</p>
623 /// </note>
624 /// <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></alias-name></code>).</p>
625 pub fn get_encryption_key_override(&self) -> &::std::option::Option<::std::string::String> {
626 self.inner.get_encryption_key_override()
627 }
628 /// <p>A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.</p>
629 pub fn idempotency_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
630 self.inner = self.inner.idempotency_token(input.into());
631 self
632 }
633 /// <p>A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.</p>
634 pub fn set_idempotency_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
635 self.inner = self.inner.set_idempotency_token(input);
636 self
637 }
638 /// <p>A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.</p>
639 pub fn get_idempotency_token(&self) -> &::std::option::Option<::std::string::String> {
640 self.inner.get_idempotency_token()
641 }
642 /// <p>Log settings for this build that override the log settings defined in the build project.</p>
643 pub fn logs_config_override(mut self, input: crate::types::LogsConfig) -> Self {
644 self.inner = self.inner.logs_config_override(input);
645 self
646 }
647 /// <p>Log settings for this build that override the log settings defined in the build project.</p>
648 pub fn set_logs_config_override(mut self, input: ::std::option::Option<crate::types::LogsConfig>) -> Self {
649 self.inner = self.inner.set_logs_config_override(input);
650 self
651 }
652 /// <p>Log settings for this build that override the log settings defined in the build project.</p>
653 pub fn get_logs_config_override(&self) -> &::std::option::Option<crate::types::LogsConfig> {
654 self.inner.get_logs_config_override()
655 }
656 /// <p>The credentials for access to a private registry.</p>
657 pub fn registry_credential_override(mut self, input: crate::types::RegistryCredential) -> Self {
658 self.inner = self.inner.registry_credential_override(input);
659 self
660 }
661 /// <p>The credentials for access to a private registry.</p>
662 pub fn set_registry_credential_override(mut self, input: ::std::option::Option<crate::types::RegistryCredential>) -> Self {
663 self.inner = self.inner.set_registry_credential_override(input);
664 self
665 }
666 /// <p>The credentials for access to a private registry.</p>
667 pub fn get_registry_credential_override(&self) -> &::std::option::Option<crate::types::RegistryCredential> {
668 self.inner.get_registry_credential_override()
669 }
670 /// <p>The type of credentials CodeBuild uses to pull images in your build. There are two valid values:</p>
671 /// <dl>
672 /// <dt>
673 /// CODEBUILD
674 /// </dt>
675 /// <dd>
676 /// <p>Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.</p>
677 /// </dd>
678 /// <dt>
679 /// SERVICE_ROLE
680 /// </dt>
681 /// <dd>
682 /// <p>Specifies that CodeBuild uses your build project's service role.</p>
683 /// </dd>
684 /// </dl>
685 /// <p>When using a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When using an CodeBuild curated image, you must use <code>CODEBUILD</code> credentials.</p>
686 pub fn image_pull_credentials_type_override(mut self, input: crate::types::ImagePullCredentialsType) -> Self {
687 self.inner = self.inner.image_pull_credentials_type_override(input);
688 self
689 }
690 /// <p>The type of credentials CodeBuild uses to pull images in your build. There are two valid values:</p>
691 /// <dl>
692 /// <dt>
693 /// CODEBUILD
694 /// </dt>
695 /// <dd>
696 /// <p>Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.</p>
697 /// </dd>
698 /// <dt>
699 /// SERVICE_ROLE
700 /// </dt>
701 /// <dd>
702 /// <p>Specifies that CodeBuild uses your build project's service role.</p>
703 /// </dd>
704 /// </dl>
705 /// <p>When using a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When using an CodeBuild curated image, you must use <code>CODEBUILD</code> credentials.</p>
706 pub fn set_image_pull_credentials_type_override(mut self, input: ::std::option::Option<crate::types::ImagePullCredentialsType>) -> Self {
707 self.inner = self.inner.set_image_pull_credentials_type_override(input);
708 self
709 }
710 /// <p>The type of credentials CodeBuild uses to pull images in your build. There are two valid values:</p>
711 /// <dl>
712 /// <dt>
713 /// CODEBUILD
714 /// </dt>
715 /// <dd>
716 /// <p>Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.</p>
717 /// </dd>
718 /// <dt>
719 /// SERVICE_ROLE
720 /// </dt>
721 /// <dd>
722 /// <p>Specifies that CodeBuild uses your build project's service role.</p>
723 /// </dd>
724 /// </dl>
725 /// <p>When using a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When using an CodeBuild curated image, you must use <code>CODEBUILD</code> credentials.</p>
726 pub fn get_image_pull_credentials_type_override(&self) -> &::std::option::Option<crate::types::ImagePullCredentialsType> {
727 self.inner.get_image_pull_credentials_type_override()
728 }
729 /// <p>Specifies if session debugging is enabled for this build. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>.</p>
730 pub fn debug_session_enabled(mut self, input: bool) -> Self {
731 self.inner = self.inner.debug_session_enabled(input);
732 self
733 }
734 /// <p>Specifies if session debugging is enabled for this build. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>.</p>
735 pub fn set_debug_session_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
736 self.inner = self.inner.set_debug_session_enabled(input);
737 self
738 }
739 /// <p>Specifies if session debugging is enabled for this build. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>.</p>
740 pub fn get_debug_session_enabled(&self) -> &::std::option::Option<bool> {
741 self.inner.get_debug_session_enabled()
742 }
743 /// <p>A ProjectFleet object specified for this build that overrides the one defined in the build project.</p>
744 pub fn fleet_override(mut self, input: crate::types::ProjectFleet) -> Self {
745 self.inner = self.inner.fleet_override(input);
746 self
747 }
748 /// <p>A ProjectFleet object specified for this build that overrides the one defined in the build project.</p>
749 pub fn set_fleet_override(mut self, input: ::std::option::Option<crate::types::ProjectFleet>) -> Self {
750 self.inner = self.inner.set_fleet_override(input);
751 self
752 }
753 /// <p>A ProjectFleet object specified for this build that overrides the one defined in the build project.</p>
754 pub fn get_fleet_override(&self) -> &::std::option::Option<crate::types::ProjectFleet> {
755 self.inner.get_fleet_override()
756 }
757 /// <p>The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the <code>RetryBuild</code> API to automatically retry your build for up to 2 additional times.</p>
758 pub fn auto_retry_limit_override(mut self, input: i32) -> Self {
759 self.inner = self.inner.auto_retry_limit_override(input);
760 self
761 }
762 /// <p>The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the <code>RetryBuild</code> API to automatically retry your build for up to 2 additional times.</p>
763 pub fn set_auto_retry_limit_override(mut self, input: ::std::option::Option<i32>) -> Self {
764 self.inner = self.inner.set_auto_retry_limit_override(input);
765 self
766 }
767 /// <p>The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the <code>RetryBuild</code> API to automatically retry your build for up to 2 additional times.</p>
768 pub fn get_auto_retry_limit_override(&self) -> &::std::option::Option<i32> {
769 self.inner.get_auto_retry_limit_override()
770 }
771}