Struct aws_sdk_codebuild::types::builders::BuildBatchBuilder

#[non_exhaustive]
pub struct BuildBatchBuilder { /* private fields */ }

A builder for BuildBatch.

Implementations

impl BuildBatchBuilder

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

The identifier of the batch build.

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

The identifier of the batch build.

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

The identifier of the batch build.

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

The ARN of the batch build.

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

The ARN of the batch build.

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

The ARN of the batch build.

pub fn start_time(self, input: DateTime) -> Self

The date and time that the batch build started.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The date and time that the batch build started.

pub fn get_start_time(&self) -> &Option<DateTime>

The date and time that the batch build started.

pub fn end_time(self, input: DateTime) -> Self

The date and time that the batch build ended.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The date and time that the batch build ended.

pub fn get_end_time(&self) -> &Option<DateTime>

The date and time that the batch build ended.

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

The current phase of the batch build.

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

The current phase of the batch build.

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

The current phase of the batch build.

pub fn build_batch_status(self, input: StatusType) -> Self

The status of the batch build.

pub fn set_build_batch_status(self, input: Option<StatusType>) -> Self

The status of the batch build.

pub fn get_build_batch_status(&self) -> &Option<StatusType>

The status of the batch build.

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

The identifier of the version of the source code to be built.

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

The identifier of the version of the source code to be built.

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

The identifier of the version of the source code to be built.

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

The identifier of the resolved version of this batch build's source code.

• For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

• For CodePipeline, the source revision provided by CodePipeline.

• For Amazon S3, this does not apply.

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

The identifier of the resolved version of this batch build's source code.

• For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

• For CodePipeline, the source revision provided by CodePipeline.

• For Amazon S3, this does not apply.

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

The identifier of the resolved version of this batch build's source code.

• For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

• For CodePipeline, the source revision provided by CodePipeline.

• For Amazon S3, this does not apply.

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

The name of the batch build project.

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

The name of the batch build project.

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

The name of the batch build project.

pub fn phases(self, input: BuildBatchPhase) -> Self

Appends an item to phases.

To override the contents of this collection use set_phases.

An array of BuildBatchPhase objects the specify the phases of the batch build.

pub fn set_phases(self, input: Option<Vec<BuildBatchPhase>>) -> Self

An array of BuildBatchPhase objects the specify the phases of the batch build.

pub fn get_phases(&self) -> &Option<Vec<BuildBatchPhase>>

An array of BuildBatchPhase objects the specify the phases of the batch build.

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

Information about the build input source code for the build project.

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

Information about the build input source code for the build project.

pub fn get_source(&self) -> &Option<ProjectSource>

Information about the build input source code for the build project.

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

Appends an item to secondary_sources.

To override the contents of this collection use set_secondary_sources.

An array of ProjectSource objects that define the sources for the batch build.

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

An array of ProjectSource objects that define the sources for the batch build.

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

An array of ProjectSource objects that define the sources for the batch build.

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

Appends an item to secondary_source_versions.

To override the contents of this collection use set_secondary_source_versions.

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.

• For 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.

• For 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.

• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

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

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.

• For 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.

• For 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.

• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

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

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.

• For 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.

• For 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.

• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

pub fn artifacts(self, input: BuildArtifacts) -> Self

A BuildArtifacts object the defines the build artifacts for this batch build.

pub fn set_artifacts(self, input: Option<BuildArtifacts>) -> Self

A BuildArtifacts object the defines the build artifacts for this batch build.

pub fn get_artifacts(&self) -> &Option<BuildArtifacts>

A BuildArtifacts object the defines the build artifacts for this batch build.

pub fn secondary_artifacts(self, input: BuildArtifacts) -> Self

Appends an item to secondary_artifacts.

To override the contents of this collection use set_secondary_artifacts.

An array of BuildArtifacts objects the define the build artifacts for this batch build.

pub fn set_secondary_artifacts(self, input: Option<Vec<BuildArtifacts>>) -> Self

An array of BuildArtifacts objects the define the build artifacts for this batch build.

pub fn get_secondary_artifacts(&self) -> &Option<Vec<BuildArtifacts>>

An array of BuildArtifacts objects the define the build artifacts for this batch build.

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

Information about the cache for the build project.

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

Information about the cache for the build project.

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

Information about the cache for the build project.

pub fn environment(self, input: ProjectEnvironment) -> Self

Information about the build environment of the build project.

pub fn set_environment(self, input: Option<ProjectEnvironment>) -> Self

Information about the build environment of the build project.

pub fn get_environment(&self) -> &Option<ProjectEnvironment>

Information about the build environment of the build project.

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

The name of a service role used for builds in the batch.

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

The name of a service role used for builds in the batch.

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

The name of a service role used for builds in the batch.

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

Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.

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

Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.

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

Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.

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

Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.

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

Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.

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

Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.

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

Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.

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

Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.

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

Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.

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

Indicates if the batch build is complete.

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

Indicates if the batch build is complete.

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

Indicates if the batch build is complete.

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

The entity that started the batch build. Valid values include:

• If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

• If a user started the build, the user's name.

• If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

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

The entity that started the batch build. Valid values include:

• If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

• If a user started the build, the user's name.

• If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

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

The entity that started the batch build. Valid values include:

• If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

• If a user started the build, the user's name.

• If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

pub fn vpc_config(self, input: VpcConfig) -> Self

Information about the VPC configuration that CodeBuild accesses.

pub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self

Information about the VPC configuration that CodeBuild accesses.

pub fn get_vpc_config(&self) -> &Option<VpcConfig>

Information about the VPC configuration that CodeBuild accesses.

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

The Key Management Service customer master key (CMK) to be used for encrypting the batch 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(self, input: Option<String>) -> Self

The Key Management Service customer master key (CMK) to be used for encrypting the batch 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(&self) -> &Option<String>

The Key Management Service customer master key (CMK) to be used for encrypting the batch 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 build_batch_number(self, input: i64) -> Self

The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.

pub fn set_build_batch_number(self, input: Option<i64>) -> Self

The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.

pub fn get_build_batch_number(&self) -> &Option<i64>

The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.

pub fn file_system_locations(self, input: ProjectFileSystemLocation) -> Self

Appends an item to file_system_locations.

To override the contents of this collection use set_file_system_locations.

An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

pub fn set_file_system_locations( self, input: Option<Vec<ProjectFileSystemLocation>> ) -> Self

An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

pub fn get_file_system_locations( &self ) -> &Option<Vec<ProjectFileSystemLocation>>

An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

pub fn build_batch_config(self, input: ProjectBuildBatchConfig) -> Self

Contains configuration information about a batch build project.

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

Contains configuration information about a batch build project.

pub fn get_build_batch_config(&self) -> &Option<ProjectBuildBatchConfig>

Contains configuration information about a batch build project.

pub fn build_groups(self, input: BuildGroup) -> Self

Appends an item to build_groups.

To override the contents of this collection use set_build_groups.

An array of BuildGroup objects that define the build groups for the batch build.

pub fn set_build_groups(self, input: Option<Vec<BuildGroup>>) -> Self

An array of BuildGroup objects that define the build groups for the batch build.

pub fn get_build_groups(&self) -> &Option<Vec<BuildGroup>>

An array of BuildGroup objects that define the build groups for the batch build.

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.

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

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 build(self) -> BuildBatch

Consumes the builder and constructs a BuildBatch.

Trait Implementations

impl Clone for BuildBatchBuilder

fn clone(&self) -> BuildBatchBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuildBatchBuilder

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

Formats the value using the given formatter.

impl Default for BuildBatchBuilder

fn default() -> BuildBatchBuilder

Returns the “default value” for a type.

impl PartialEq for BuildBatchBuilder

fn eq(&self, other: &BuildBatchBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BuildBatchBuilder