Struct aws_sdk_codebuild::client::fluent_builders::StartBuildBatch

pub struct StartBuildBatch { /* private fields */ }

Fluent builder constructing a request to StartBuildBatch.

Starts a batch build for a project.

Implementations

impl StartBuildBatch

pub async fn send(
    self
) -> Result<StartBuildBatchOutput, SdkError<StartBuildBatchError>>

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 project_name(self, input: impl Into<String>) -> Self

The name of the project.

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

The name of the project.

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 that override the secondary sources defined in the batch build project.

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

An array of ProjectSource objects that override the secondary sources defined in the batch build project.

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 override the secondary source versions in the batch build project.

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

An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.

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

The version of the batch 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 batch 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

An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

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

An array of ProjectArtifacts objects that contains information about the build output artifact overrides for 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 that override the secondary artifacts defined in the batch build project.

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

An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.

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.

An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

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

An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

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

The source input type that overrides the source input defined in the batch build project.

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

The source input type that overrides the source input defined in the batch build project.

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

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

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

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

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

A SourceAuth object that overrides the one defined in the batch 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

A SourceAuth object that overrides the one defined in the batch 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 batch build only, any previous depth of history defined in the batch 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 batch build only, any previous depth of history defined in the batch build project.

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

A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

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

A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

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

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

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.

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

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

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.

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

Enable this flag to override the insecure SSL setting that is specified in the batch 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 batch 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_batch_status_override(self, input: bool) -> Self

Set to true to report to your source provider the status of a batch 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.

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

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

Set to true to report to your source provider the status of a batch 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

A ProjectCache object that specifies cache overrides.

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

A ProjectCache object that specifies cache overrides.

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

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

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

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

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

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

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

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

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

Overrides the build timeout specified in the batch build project.

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

Overrides the build timeout specified in the batch build project.

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

The number of minutes a batch 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 batch 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 batch 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 batch 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 StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch 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 StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

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

A LogsConfig object that override the log settings defined in the batch build project.

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

A LogsConfig object that override the log settings defined in the batch build project.

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

A RegistryCredential object that overrides credentials for access to a private registry.

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

A RegistryCredential object that overrides 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 batch 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 batch 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 build_batch_config_override(self, input: ProjectBuildBatchConfig) -> Self

A BuildBatchConfigOverride object that contains batch build configuration overrides.

pub fn set_build_batch_config_override(
    self,
    input: Option<ProjectBuildBatchConfig>
) -> Self

A BuildBatchConfigOverride object that contains batch build configuration overrides.

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

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

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

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

Trait Implementations

impl Clone for StartBuildBatch

fn clone(&self) -> StartBuildBatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartBuildBatch

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

Formats the value using the given formatter.