Struct aws_sdk_codebuild::operation::start_build::builders::StartBuildFluentBuilder

pub struct StartBuildFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartBuild.

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.

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.

Implementations

impl StartBuildFluentBuilder

pub fn as_input(&self) -> &StartBuildInputBuilder

Access the StartBuild as a reference.

pub async fn send( self ) -> Result<StartBuildOutput, SdkError<StartBuildError, HttpResponse>>

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, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<StartBuildOutput, StartBuildError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn project_name(self, input: impl Into<String>) -> Self

The name of the CodeBuild build project to start running a build.

pub fn set_project_name(self, input: Option<String>) -> Self

The name of the CodeBuild build project to start running a build.

pub fn get_project_name(&self) -> &Option<String>

The name of the CodeBuild build project to start running a build.

pub fn secondary_sources_override(self, input: ProjectSource) -> Self

Appends an item to secondarySourcesOverride.

To override the contents of this collection use set_secondary_sources_override.

An array of ProjectSource objects.

pub fn set_secondary_sources_override( self, input: Option<Vec<ProjectSource>> ) -> Self

An array of ProjectSource objects.

pub fn get_secondary_sources_override(&self) -> &Option<Vec<ProjectSource>>

An array of ProjectSource objects.

pub fn secondary_sources_version_override( self, input: ProjectSourceVersion ) -> Self

Appends an item to secondarySourcesVersionOverride.

To override the contents of this collection use set_secondary_sources_version_override.

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

pub fn set_secondary_sources_version_override( self, input: Option<Vec<ProjectSourceVersion>> ) -> Self

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

pub fn get_secondary_sources_version_override( &self ) -> &Option<Vec<ProjectSourceVersion>>

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

pub fn source_version(self, input: impl Into<String>) -> Self

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:

CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

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 pr/pull-request-ID (for example pr/25). 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.

Bitbucket

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.

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

pub fn set_source_version(self, input: Option<String>) -> Self

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:

CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

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 pr/pull-request-ID (for example pr/25). 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.

Bitbucket

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.

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

pub fn get_source_version(&self) -> &Option<String>

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:

CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

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 pr/pull-request-ID (for example pr/25). 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.

Bitbucket

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.

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

pub fn artifacts_override(self, input: ProjectArtifacts) -> Self

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

pub fn set_artifacts_override(self, input: Option<ProjectArtifacts>) -> Self

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

pub fn get_artifacts_override(&self) -> &Option<ProjectArtifacts>

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

pub fn secondary_artifacts_override(self, input: ProjectArtifacts) -> Self

Appends an item to secondaryArtifactsOverride.

To override the contents of this collection use set_secondary_artifacts_override.

An array of ProjectArtifacts objects.

pub fn set_secondary_artifacts_override( self, input: Option<Vec<ProjectArtifacts>> ) -> Self

An array of ProjectArtifacts objects.

pub fn get_secondary_artifacts_override(&self) -> &Option<Vec<ProjectArtifacts>>

An array of ProjectArtifacts objects.

pub fn environment_variables_override(self, input: EnvironmentVariable) -> Self

Appends an item to environmentVariablesOverride.

To override the contents of this collection use set_environment_variables_override.

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

pub fn set_environment_variables_override( self, input: Option<Vec<EnvironmentVariable>> ) -> Self

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

pub fn get_environment_variables_override( &self ) -> &Option<Vec<EnvironmentVariable>>

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

pub fn source_type_override(self, input: SourceType) -> Self

A source input type, for this build, that overrides the source input defined in the build project.

pub fn set_source_type_override(self, input: Option<SourceType>) -> Self

A source input type, for this build, that overrides the source input defined in the build project.

pub fn get_source_type_override(&self) -> &Option<SourceType>

A source input type, for this build, that overrides the source input defined in the build project.

pub fn source_location_override(self, input: impl Into<String>) -> Self

A location that overrides, for this build, the source location for the one defined in the build project.

pub fn set_source_location_override(self, input: Option<String>) -> Self

A location that overrides, for this build, the source location for the one defined in the build project.

pub fn get_source_location_override(&self) -> &Option<String>

A location that overrides, for this build, the source location for the one defined in the build project.

pub fn source_auth_override(self, input: SourceAuth) -> Self

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.

pub fn set_source_auth_override(self, input: Option<SourceAuth>) -> Self

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.

pub fn get_source_auth_override(&self) -> &Option<SourceAuth>

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.

pub fn git_clone_depth_override(self, input: i32) -> Self

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.

pub fn set_git_clone_depth_override(self, input: Option<i32>) -> Self

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.

pub fn get_git_clone_depth_override(&self) -> &Option<i32>

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.

pub fn git_submodules_config_override(self, input: GitSubmodulesConfig) -> Self

Information about the Git submodules configuration for this build of an CodeBuild build project.

pub fn set_git_submodules_config_override( self, input: Option<GitSubmodulesConfig> ) -> Self

Information about the Git submodules configuration for this build of an CodeBuild build project.

pub fn get_git_submodules_config_override(&self) -> &Option<GitSubmodulesConfig>

Information about the Git submodules configuration for this build of an CodeBuild build project.

pub fn buildspec_override(self, input: impl Into<String>) -> Self

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.

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 CODEBUILD_SRC_DIR 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, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). 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 Buildspec File Name and Storage Location.

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.

pub fn set_buildspec_override(self, input: Option<String>) -> Self

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.

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 CODEBUILD_SRC_DIR 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, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). 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 Buildspec File Name and Storage Location.

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.

pub fn get_buildspec_override(&self) -> &Option<String>

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.

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 CODEBUILD_SRC_DIR 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, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). 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 Buildspec File Name and Storage Location.

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.

pub fn insecure_ssl_override(self, input: bool) -> Self

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.

pub fn set_insecure_ssl_override(self, input: Option<bool>) -> Self

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.

pub fn get_insecure_ssl_override(&self) -> &Option<bool>

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.

pub fn report_build_status_override(self, input: bool) -> Self

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 invalidInputException is thrown.

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 Source provider access in the CodeBuild User Guide.

The status of a build triggered by a webhook is always reported to your source provider.

pub fn set_report_build_status_override(self, input: Option<bool>) -> Self

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 invalidInputException is thrown.

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 Source provider access in the CodeBuild User Guide.

The status of a build triggered by a webhook is always reported to your source provider.

pub fn get_report_build_status_override(&self) -> &Option<bool>

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 invalidInputException is thrown.

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 Source provider access in the CodeBuild User Guide.

The status of a build triggered by a webhook is always reported to your source provider.

pub fn build_status_config_override(self, input: BuildStatusConfig) -> Self

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 GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

pub fn set_build_status_config_override( self, input: Option<BuildStatusConfig> ) -> Self

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 GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

pub fn get_build_status_config_override(&self) -> &Option<BuildStatusConfig>

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 GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

pub fn environment_type_override(self, input: EnvironmentType) -> Self

A container type for this build that overrides the one specified in the build project.

pub fn set_environment_type_override( self, input: Option<EnvironmentType> ) -> Self

A container type for this build that overrides the one specified in the build project.

pub fn get_environment_type_override(&self) -> &Option<EnvironmentType>

A container type for this build that overrides the one specified in the build project.

pub fn image_override(self, input: impl Into<String>) -> Self

The name of an image for this build that overrides the one specified in the build project.

pub fn set_image_override(self, input: Option<String>) -> Self

The name of an image for this build that overrides the one specified in the build project.

pub fn get_image_override(&self) -> &Option<String>

The name of an image for this build that overrides the one specified in the build project.

pub fn compute_type_override(self, input: ComputeType) -> Self

The name of a compute type for this build that overrides the one specified in the build project.

pub fn set_compute_type_override(self, input: Option<ComputeType>) -> Self

The name of a compute type for this build that overrides the one specified in the build project.

pub fn get_compute_type_override(&self) -> &Option<ComputeType>

The name of a compute type for this build that overrides the one specified in the build project.

pub fn certificate_override(self, input: impl Into<String>) -> Self

The name of a certificate for this build that overrides the one specified in the build project.

pub fn set_certificate_override(self, input: Option<String>) -> Self

The name of a certificate for this build that overrides the one specified in the build project.

pub fn get_certificate_override(&self) -> &Option<String>

The name of a certificate for this build that overrides the one specified in the build project.

pub fn cache_override(self, input: ProjectCache) -> Self

A ProjectCache object specified for this build that overrides the one defined in the build project.

pub fn set_cache_override(self, input: Option<ProjectCache>) -> Self

A ProjectCache object specified for this build that overrides the one defined in the build project.

pub fn get_cache_override(&self) -> &Option<ProjectCache>

A ProjectCache object specified for this build that overrides the one defined in the build project.

pub fn service_role_override(self, input: impl Into<String>) -> Self

The name of a service role for this build that overrides the one specified in the build project.

pub fn set_service_role_override(self, input: Option<String>) -> Self

The name of a service role for this build that overrides the one specified in the build project.

pub fn get_service_role_override(&self) -> &Option<String>

The name of a service role for this build that overrides the one specified in the build project.

pub fn privileged_mode_override(self, input: bool) -> Self

Enable this flag to override privileged mode in the build project.

pub fn set_privileged_mode_override(self, input: Option<bool>) -> Self

Enable this flag to override privileged mode in the build project.

pub fn get_privileged_mode_override(&self) -> &Option<bool>

Enable this flag to override privileged mode in the build project.

pub fn timeout_in_minutes_override(self, input: i32) -> Self

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.

pub fn set_timeout_in_minutes_override(self, input: Option<i32>) -> Self

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.

pub fn get_timeout_in_minutes_override(&self) -> &Option<i32>

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.

pub fn queued_timeout_in_minutes_override(self, input: i32) -> Self

The number of minutes a build is allowed to be queued before it times out.

pub fn set_queued_timeout_in_minutes_override(self, input: Option<i32>) -> Self

The number of minutes a build is allowed to be queued before it times out.

pub fn get_queued_timeout_in_minutes_override(&self) -> &Option<i32>

The number of minutes a build is allowed to be queued before it times out.

pub fn encryption_key_override(self, input: impl Into<String>) -> Self

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.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/).

pub fn set_encryption_key_override(self, input: Option<String>) -> Self

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.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/).

pub fn get_encryption_key_override(&self) -> &Option<String>

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.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/).

pub fn idempotency_token(self, input: impl Into<String>) -> Self

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.

pub fn set_idempotency_token(self, input: Option<String>) -> Self

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.

pub fn get_idempotency_token(&self) -> &Option<String>

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.

pub fn logs_config_override(self, input: LogsConfig) -> Self

Log settings for this build that override the log settings defined in the build project.

pub fn set_logs_config_override(self, input: Option<LogsConfig>) -> Self

Log settings for this build that override the log settings defined in the build project.

pub fn get_logs_config_override(&self) -> &Option<LogsConfig>

Log settings for this build that override the log settings defined in the build project.

pub fn registry_credential_override(self, input: RegistryCredential) -> Self

The credentials for access to a private registry.

pub fn set_registry_credential_override( self, input: Option<RegistryCredential> ) -> Self

The credentials for access to a private registry.

pub fn get_registry_credential_override(&self) -> &Option<RegistryCredential>

The credentials for access to a private registry.

pub fn image_pull_credentials_type_override( self, input: ImagePullCredentialsType ) -> Self

The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

pub fn set_image_pull_credentials_type_override( self, input: Option<ImagePullCredentialsType> ) -> Self

The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

pub fn get_image_pull_credentials_type_override( &self ) -> &Option<ImagePullCredentialsType>

The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

pub fn debug_session_enabled(self, input: bool) -> Self

Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

pub fn set_debug_session_enabled(self, input: Option<bool>) -> Self

Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

pub fn get_debug_session_enabled(&self) -> &Option<bool>

Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

pub fn fleet_override(self, input: ProjectFleet) -> Self

A ProjectFleet object specified for this build that overrides the one defined in the build project.

pub fn set_fleet_override(self, input: Option<ProjectFleet>) -> Self

A ProjectFleet object specified for this build that overrides the one defined in the build project.

pub fn get_fleet_override(&self) -> &Option<ProjectFleet>

A ProjectFleet object specified for this build that overrides the one defined in the build project.

Trait Implementations

impl Clone for StartBuildFluentBuilder

fn clone(&self) -> StartBuildFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartBuildFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.