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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::start_build::_start_build_output::StartBuildOutputBuilder;
pub use crate::operation::start_build::_start_build_input::StartBuildInputBuilder;
impl crate::operation::start_build::builders::StartBuildInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::start_build::StartBuildOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::start_build::StartBuildError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.start_build();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `StartBuild`.
///
/// <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>
/// <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>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct StartBuildFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::start_build::builders::StartBuildInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::start_build::StartBuildOutput,
crate::operation::start_build::StartBuildError,
> for StartBuildFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::start_build::StartBuildOutput,
crate::operation::start_build::StartBuildError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl StartBuildFluentBuilder {
/// Creates a new `StartBuild`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the StartBuild as a reference.
pub fn as_input(&self) -> &crate::operation::start_build::builders::StartBuildInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::start_build::StartBuildOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::start_build::StartBuildError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::start_build::StartBuild::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::start_build::StartBuild::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::start_build::StartBuildOutput,
crate::operation::start_build::StartBuildError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The name of the CodeBuild build project to start running a build.</p>
pub fn project_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.project_name(input.into());
self
}
/// <p>The name of the CodeBuild build project to start running a build.</p>
pub fn set_project_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_project_name(input);
self
}
/// <p>The name of the CodeBuild build project to start running a build.</p>
pub fn get_project_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_project_name()
}
///
/// Appends an item to `secondarySourcesOverride`.
///
/// To override the contents of this collection use [`set_secondary_sources_override`](Self::set_secondary_sources_override).
///
/// <p>An array of <code>ProjectSource</code> objects.</p>
pub fn secondary_sources_override(mut self, input: crate::types::ProjectSource) -> Self {
self.inner = self.inner.secondary_sources_override(input);
self
}
/// <p>An array of <code>ProjectSource</code> objects.</p>
pub fn set_secondary_sources_override(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ProjectSource>>) -> Self {
self.inner = self.inner.set_secondary_sources_override(input);
self
}
/// <p>An array of <code>ProjectSource</code> objects.</p>
pub fn get_secondary_sources_override(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ProjectSource>> {
self.inner.get_secondary_sources_override()
}
///
/// Appends an item to `secondarySourcesVersionOverride`.
///
/// To override the contents of this collection use [`set_secondary_sources_version_override`](Self::set_secondary_sources_version_override).
///
/// <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>
pub fn secondary_sources_version_override(mut self, input: crate::types::ProjectSourceVersion) -> Self {
self.inner = self.inner.secondary_sources_version_override(input);
self
}
/// <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>
pub fn set_secondary_sources_version_override(
mut self,
input: ::std::option::Option<::std::vec::Vec<crate::types::ProjectSourceVersion>>,
) -> Self {
self.inner = self.inner.set_secondary_sources_version_override(input);
self
}
/// <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>
pub fn get_secondary_sources_version_override(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ProjectSourceVersion>> {
self.inner.get_secondary_sources_version_override()
}
/// <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>
/// <dl>
/// <dt>
/// CodeCommit
/// </dt>
/// <dd>
/// <p>The commit ID, branch, or Git tag to use.</p>
/// </dd>
/// <dt>
/// GitHub
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// <dt>
/// Bitbucket
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// <dt>
/// Amazon S3
/// </dt>
/// <dd>
/// <p>The version ID of the object that represents the build input ZIP file to use.</p>
/// </dd>
/// </dl>
/// <p>If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence.</p>
/// <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>
pub fn source_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.source_version(input.into());
self
}
/// <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>
/// <dl>
/// <dt>
/// CodeCommit
/// </dt>
/// <dd>
/// <p>The commit ID, branch, or Git tag to use.</p>
/// </dd>
/// <dt>
/// GitHub
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// <dt>
/// Bitbucket
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// <dt>
/// Amazon S3
/// </dt>
/// <dd>
/// <p>The version ID of the object that represents the build input ZIP file to use.</p>
/// </dd>
/// </dl>
/// <p>If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence.</p>
/// <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>
pub fn set_source_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_source_version(input);
self
}
/// <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>
/// <dl>
/// <dt>
/// CodeCommit
/// </dt>
/// <dd>
/// <p>The commit ID, branch, or Git tag to use.</p>
/// </dd>
/// <dt>
/// GitHub
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// <dt>
/// Bitbucket
/// </dt>
/// <dd>
/// <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>
/// </dd>
/// <dt>
/// Amazon S3
/// </dt>
/// <dd>
/// <p>The version ID of the object that represents the build input ZIP file to use.</p>
/// </dd>
/// </dl>
/// <p>If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence.</p>
/// <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>
pub fn get_source_version(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_source_version()
}
/// <p>Build output artifact settings that override, for this build only, the latest ones already defined in the build project.</p>
pub fn artifacts_override(mut self, input: crate::types::ProjectArtifacts) -> Self {
self.inner = self.inner.artifacts_override(input);
self
}
/// <p>Build output artifact settings that override, for this build only, the latest ones already defined in the build project.</p>
pub fn set_artifacts_override(mut self, input: ::std::option::Option<crate::types::ProjectArtifacts>) -> Self {
self.inner = self.inner.set_artifacts_override(input);
self
}
/// <p>Build output artifact settings that override, for this build only, the latest ones already defined in the build project.</p>
pub fn get_artifacts_override(&self) -> &::std::option::Option<crate::types::ProjectArtifacts> {
self.inner.get_artifacts_override()
}
///
/// Appends an item to `secondaryArtifactsOverride`.
///
/// To override the contents of this collection use [`set_secondary_artifacts_override`](Self::set_secondary_artifacts_override).
///
/// <p>An array of <code>ProjectArtifacts</code> objects.</p>
pub fn secondary_artifacts_override(mut self, input: crate::types::ProjectArtifacts) -> Self {
self.inner = self.inner.secondary_artifacts_override(input);
self
}
/// <p>An array of <code>ProjectArtifacts</code> objects.</p>
pub fn set_secondary_artifacts_override(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ProjectArtifacts>>) -> Self {
self.inner = self.inner.set_secondary_artifacts_override(input);
self
}
/// <p>An array of <code>ProjectArtifacts</code> objects.</p>
pub fn get_secondary_artifacts_override(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ProjectArtifacts>> {
self.inner.get_secondary_artifacts_override()
}
///
/// Appends an item to `environmentVariablesOverride`.
///
/// To override the contents of this collection use [`set_environment_variables_override`](Self::set_environment_variables_override).
///
/// <p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>
pub fn environment_variables_override(mut self, input: crate::types::EnvironmentVariable) -> Self {
self.inner = self.inner.environment_variables_override(input);
self
}
/// <p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>
pub fn set_environment_variables_override(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::EnvironmentVariable>>) -> Self {
self.inner = self.inner.set_environment_variables_override(input);
self
}
/// <p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>
pub fn get_environment_variables_override(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::EnvironmentVariable>> {
self.inner.get_environment_variables_override()
}
/// <p>A source input type, for this build, that overrides the source input defined in the build project.</p>
pub fn source_type_override(mut self, input: crate::types::SourceType) -> Self {
self.inner = self.inner.source_type_override(input);
self
}
/// <p>A source input type, for this build, that overrides the source input defined in the build project.</p>
pub fn set_source_type_override(mut self, input: ::std::option::Option<crate::types::SourceType>) -> Self {
self.inner = self.inner.set_source_type_override(input);
self
}
/// <p>A source input type, for this build, that overrides the source input defined in the build project.</p>
pub fn get_source_type_override(&self) -> &::std::option::Option<crate::types::SourceType> {
self.inner.get_source_type_override()
}
/// <p>A location that overrides, for this build, the source location for the one defined in the build project.</p>
pub fn source_location_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.source_location_override(input.into());
self
}
/// <p>A location that overrides, for this build, the source location for the one defined in the build project.</p>
pub fn set_source_location_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_source_location_override(input);
self
}
/// <p>A location that overrides, for this build, the source location for the one defined in the build project.</p>
pub fn get_source_location_override(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_source_location_override()
}
/// <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 or GitHub.</p>
pub fn source_auth_override(mut self, input: crate::types::SourceAuth) -> Self {
self.inner = self.inner.source_auth_override(input);
self
}
/// <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 or GitHub.</p>
pub fn set_source_auth_override(mut self, input: ::std::option::Option<crate::types::SourceAuth>) -> Self {
self.inner = self.inner.set_source_auth_override(input);
self
}
/// <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 or GitHub.</p>
pub fn get_source_auth_override(&self) -> &::std::option::Option<crate::types::SourceAuth> {
self.inner.get_source_auth_override()
}
/// <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>
pub fn git_clone_depth_override(mut self, input: i32) -> Self {
self.inner = self.inner.git_clone_depth_override(input);
self
}
/// <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>
pub fn set_git_clone_depth_override(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_git_clone_depth_override(input);
self
}
/// <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>
pub fn get_git_clone_depth_override(&self) -> &::std::option::Option<i32> {
self.inner.get_git_clone_depth_override()
}
/// <p>Information about the Git submodules configuration for this build of an CodeBuild build project.</p>
pub fn git_submodules_config_override(mut self, input: crate::types::GitSubmodulesConfig) -> Self {
self.inner = self.inner.git_submodules_config_override(input);
self
}
/// <p>Information about the Git submodules configuration for this build of an CodeBuild build project.</p>
pub fn set_git_submodules_config_override(mut self, input: ::std::option::Option<crate::types::GitSubmodulesConfig>) -> Self {
self.inner = self.inner.set_git_submodules_config_override(input);
self
}
/// <p>Information about the Git submodules configuration for this build of an CodeBuild build project.</p>
pub fn get_git_submodules_config_override(&self) -> &::std::option::Option<crate::types::GitSubmodulesConfig> {
self.inner.get_git_submodules_config_override()
}
/// <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>
/// <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>
/// <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>
/// </note>
pub fn buildspec_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.buildspec_override(input.into());
self
}
/// <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>
/// <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>
/// <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>
/// </note>
pub fn set_buildspec_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_buildspec_override(input);
self
}
/// <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>
/// <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>
/// <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>
/// </note>
pub fn get_buildspec_override(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_buildspec_override()
}
/// <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>
pub fn insecure_ssl_override(mut self, input: bool) -> Self {
self.inner = self.inner.insecure_ssl_override(input);
self
}
/// <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>
pub fn set_insecure_ssl_override(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_insecure_ssl_override(input);
self
}
/// <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>
pub fn get_insecure_ssl_override(&self) -> &::std::option::Option<bool> {
self.inner.get_insecure_ssl_override()
}
/// <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, or Bitbucket, an <code>invalidInputException</code> is thrown.</p>
/// <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>
/// <p>The status of a build triggered by a webhook is always reported to your source provider.</p>
/// </note>
pub fn report_build_status_override(mut self, input: bool) -> Self {
self.inner = self.inner.report_build_status_override(input);
self
}
/// <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, or Bitbucket, an <code>invalidInputException</code> is thrown.</p>
/// <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>
/// <p>The status of a build triggered by a webhook is always reported to your source provider.</p>
/// </note>
pub fn set_report_build_status_override(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_report_build_status_override(input);
self
}
/// <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, or Bitbucket, an <code>invalidInputException</code> is thrown.</p>
/// <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>
/// <p>The status of a build triggered by a webhook is always reported to your source provider.</p>
/// </note>
pub fn get_report_build_status_override(&self) -> &::std::option::Option<bool> {
self.inner.get_report_build_status_override()
}
/// <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>
pub fn build_status_config_override(mut self, input: crate::types::BuildStatusConfig) -> Self {
self.inner = self.inner.build_status_config_override(input);
self
}
/// <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>
pub fn set_build_status_config_override(mut self, input: ::std::option::Option<crate::types::BuildStatusConfig>) -> Self {
self.inner = self.inner.set_build_status_config_override(input);
self
}
/// <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>
pub fn get_build_status_config_override(&self) -> &::std::option::Option<crate::types::BuildStatusConfig> {
self.inner.get_build_status_config_override()
}
/// <p>A container type for this build that overrides the one specified in the build project.</p>
pub fn environment_type_override(mut self, input: crate::types::EnvironmentType) -> Self {
self.inner = self.inner.environment_type_override(input);
self
}
/// <p>A container type for this build that overrides the one specified in the build project.</p>
pub fn set_environment_type_override(mut self, input: ::std::option::Option<crate::types::EnvironmentType>) -> Self {
self.inner = self.inner.set_environment_type_override(input);
self
}
/// <p>A container type for this build that overrides the one specified in the build project.</p>
pub fn get_environment_type_override(&self) -> &::std::option::Option<crate::types::EnvironmentType> {
self.inner.get_environment_type_override()
}
/// <p>The name of an image for this build that overrides the one specified in the build project.</p>
pub fn image_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.image_override(input.into());
self
}
/// <p>The name of an image for this build that overrides the one specified in the build project.</p>
pub fn set_image_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_image_override(input);
self
}
/// <p>The name of an image for this build that overrides the one specified in the build project.</p>
pub fn get_image_override(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_image_override()
}
/// <p>The name of a compute type for this build that overrides the one specified in the build project.</p>
pub fn compute_type_override(mut self, input: crate::types::ComputeType) -> Self {
self.inner = self.inner.compute_type_override(input);
self
}
/// <p>The name of a compute type for this build that overrides the one specified in the build project.</p>
pub fn set_compute_type_override(mut self, input: ::std::option::Option<crate::types::ComputeType>) -> Self {
self.inner = self.inner.set_compute_type_override(input);
self
}
/// <p>The name of a compute type for this build that overrides the one specified in the build project.</p>
pub fn get_compute_type_override(&self) -> &::std::option::Option<crate::types::ComputeType> {
self.inner.get_compute_type_override()
}
/// <p>The name of a certificate for this build that overrides the one specified in the build project.</p>
pub fn certificate_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.certificate_override(input.into());
self
}
/// <p>The name of a certificate for this build that overrides the one specified in the build project.</p>
pub fn set_certificate_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_certificate_override(input);
self
}
/// <p>The name of a certificate for this build that overrides the one specified in the build project.</p>
pub fn get_certificate_override(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_certificate_override()
}
/// <p>A ProjectCache object specified for this build that overrides the one defined in the build project.</p>
pub fn cache_override(mut self, input: crate::types::ProjectCache) -> Self {
self.inner = self.inner.cache_override(input);
self
}
/// <p>A ProjectCache object specified for this build that overrides the one defined in the build project.</p>
pub fn set_cache_override(mut self, input: ::std::option::Option<crate::types::ProjectCache>) -> Self {
self.inner = self.inner.set_cache_override(input);
self
}
/// <p>A ProjectCache object specified for this build that overrides the one defined in the build project.</p>
pub fn get_cache_override(&self) -> &::std::option::Option<crate::types::ProjectCache> {
self.inner.get_cache_override()
}
/// <p>The name of a service role for this build that overrides the one specified in the build project.</p>
pub fn service_role_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.service_role_override(input.into());
self
}
/// <p>The name of a service role for this build that overrides the one specified in the build project.</p>
pub fn set_service_role_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_service_role_override(input);
self
}
/// <p>The name of a service role for this build that overrides the one specified in the build project.</p>
pub fn get_service_role_override(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_service_role_override()
}
/// <p>Enable this flag to override privileged mode in the build project.</p>
pub fn privileged_mode_override(mut self, input: bool) -> Self {
self.inner = self.inner.privileged_mode_override(input);
self
}
/// <p>Enable this flag to override privileged mode in the build project.</p>
pub fn set_privileged_mode_override(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_privileged_mode_override(input);
self
}
/// <p>Enable this flag to override privileged mode in the build project.</p>
pub fn get_privileged_mode_override(&self) -> &::std::option::Option<bool> {
self.inner.get_privileged_mode_override()
}
/// <p>The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.</p>
pub fn timeout_in_minutes_override(mut self, input: i32) -> Self {
self.inner = self.inner.timeout_in_minutes_override(input);
self
}
/// <p>The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.</p>
pub fn set_timeout_in_minutes_override(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_timeout_in_minutes_override(input);
self
}
/// <p>The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.</p>
pub fn get_timeout_in_minutes_override(&self) -> &::std::option::Option<i32> {
self.inner.get_timeout_in_minutes_override()
}
/// <p>The number of minutes a build is allowed to be queued before it times out.</p>
pub fn queued_timeout_in_minutes_override(mut self, input: i32) -> Self {
self.inner = self.inner.queued_timeout_in_minutes_override(input);
self
}
/// <p>The number of minutes a build is allowed to be queued before it times out.</p>
pub fn set_queued_timeout_in_minutes_override(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_queued_timeout_in_minutes_override(input);
self
}
/// <p>The number of minutes a build is allowed to be queued before it times out.</p>
pub fn get_queued_timeout_in_minutes_override(&self) -> &::std::option::Option<i32> {
self.inner.get_queued_timeout_in_minutes_override()
}
/// <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>
/// <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>
/// </note>
/// <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>
pub fn encryption_key_override(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.encryption_key_override(input.into());
self
}
/// <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>
/// <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>
/// </note>
/// <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>
pub fn set_encryption_key_override(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_encryption_key_override(input);
self
}
/// <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>
/// <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>
/// </note>
/// <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>
pub fn get_encryption_key_override(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_encryption_key_override()
}
/// <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>
pub fn idempotency_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.idempotency_token(input.into());
self
}
/// <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>
pub fn set_idempotency_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_idempotency_token(input);
self
}
/// <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>
pub fn get_idempotency_token(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_idempotency_token()
}
/// <p>Log settings for this build that override the log settings defined in the build project.</p>
pub fn logs_config_override(mut self, input: crate::types::LogsConfig) -> Self {
self.inner = self.inner.logs_config_override(input);
self
}
/// <p>Log settings for this build that override the log settings defined in the build project.</p>
pub fn set_logs_config_override(mut self, input: ::std::option::Option<crate::types::LogsConfig>) -> Self {
self.inner = self.inner.set_logs_config_override(input);
self
}
/// <p>Log settings for this build that override the log settings defined in the build project.</p>
pub fn get_logs_config_override(&self) -> &::std::option::Option<crate::types::LogsConfig> {
self.inner.get_logs_config_override()
}
/// <p>The credentials for access to a private registry.</p>
pub fn registry_credential_override(mut self, input: crate::types::RegistryCredential) -> Self {
self.inner = self.inner.registry_credential_override(input);
self
}
/// <p>The credentials for access to a private registry.</p>
pub fn set_registry_credential_override(mut self, input: ::std::option::Option<crate::types::RegistryCredential>) -> Self {
self.inner = self.inner.set_registry_credential_override(input);
self
}
/// <p>The credentials for access to a private registry.</p>
pub fn get_registry_credential_override(&self) -> &::std::option::Option<crate::types::RegistryCredential> {
self.inner.get_registry_credential_override()
}
/// <p>The type of credentials CodeBuild uses to pull images in your build. There are two valid values:</p>
/// <dl>
/// <dt>
/// CODEBUILD
/// </dt>
/// <dd>
/// <p>Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.</p>
/// </dd>
/// <dt>
/// SERVICE_ROLE
/// </dt>
/// <dd>
/// <p>Specifies that CodeBuild uses your build project's service role.</p>
/// </dd>
/// </dl>
/// <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>
pub fn image_pull_credentials_type_override(mut self, input: crate::types::ImagePullCredentialsType) -> Self {
self.inner = self.inner.image_pull_credentials_type_override(input);
self
}
/// <p>The type of credentials CodeBuild uses to pull images in your build. There are two valid values:</p>
/// <dl>
/// <dt>
/// CODEBUILD
/// </dt>
/// <dd>
/// <p>Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.</p>
/// </dd>
/// <dt>
/// SERVICE_ROLE
/// </dt>
/// <dd>
/// <p>Specifies that CodeBuild uses your build project's service role.</p>
/// </dd>
/// </dl>
/// <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>
pub fn set_image_pull_credentials_type_override(mut self, input: ::std::option::Option<crate::types::ImagePullCredentialsType>) -> Self {
self.inner = self.inner.set_image_pull_credentials_type_override(input);
self
}
/// <p>The type of credentials CodeBuild uses to pull images in your build. There are two valid values:</p>
/// <dl>
/// <dt>
/// CODEBUILD
/// </dt>
/// <dd>
/// <p>Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.</p>
/// </dd>
/// <dt>
/// SERVICE_ROLE
/// </dt>
/// <dd>
/// <p>Specifies that CodeBuild uses your build project's service role.</p>
/// </dd>
/// </dl>
/// <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>
pub fn get_image_pull_credentials_type_override(&self) -> &::std::option::Option<crate::types::ImagePullCredentialsType> {
self.inner.get_image_pull_credentials_type_override()
}
/// <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>
pub fn debug_session_enabled(mut self, input: bool) -> Self {
self.inner = self.inner.debug_session_enabled(input);
self
}
/// <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>
pub fn set_debug_session_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_debug_session_enabled(input);
self
}
/// <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>
pub fn get_debug_session_enabled(&self) -> &::std::option::Option<bool> {
self.inner.get_debug_session_enabled()
}
/// <p>A ProjectFleet object specified for this build that overrides the one defined in the build project.</p>
pub fn fleet_override(mut self, input: crate::types::ProjectFleet) -> Self {
self.inner = self.inner.fleet_override(input);
self
}
/// <p>A ProjectFleet object specified for this build that overrides the one defined in the build project.</p>
pub fn set_fleet_override(mut self, input: ::std::option::Option<crate::types::ProjectFleet>) -> Self {
self.inner = self.inner.set_fleet_override(input);
self
}
/// <p>A ProjectFleet object specified for this build that overrides the one defined in the build project.</p>
pub fn get_fleet_override(&self) -> &::std::option::Option<crate::types::ProjectFleet> {
self.inner.get_fleet_override()
}
}