Struct aws_sdk_codebuild::types::builders::BuildBuilder

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

A builder for Build.

Implementations

impl BuildBuilder

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

The unique ID for the build.

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

The unique ID for the build.

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

The unique ID for the build.

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

The Amazon Resource Name (ARN) of the build.

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

The Amazon Resource Name (ARN) of the build.

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

The Amazon Resource Name (ARN) of the build.

pub fn build_number(self, input: i64) -> Self

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

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

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

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

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

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

When the build process started, expressed in Unix time format.

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

When the build process started, expressed in Unix time format.

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

When the build process started, expressed in Unix time format.

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

When the build process ended, expressed in Unix time format.

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

When the build process ended, expressed in Unix time format.

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

When the build process ended, expressed in Unix time format.

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

The current build phase.

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

The current build phase.

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

The current build phase.

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

The current status of the build. Valid values include:

• FAILED: The build failed.

• FAULT: The build faulted.

• IN_PROGRESS: The build is still in progress.

• STOPPED: The build stopped.

• SUCCEEDED: The build succeeded.

• TIMED_OUT: The build timed out.

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

The current status of the build. Valid values include:

• FAILED: The build failed.

• FAULT: The build faulted.

• IN_PROGRESS: The build is still in progress.

• STOPPED: The build stopped.

• SUCCEEDED: The build succeeded.

• TIMED_OUT: The build timed out.

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

The current status of the build. Valid values include:

• FAILED: The build failed.

• FAULT: The build faulted.

• IN_PROGRESS: The build is still in progress.

• STOPPED: The build stopped.

• SUCCEEDED: The build succeeded.

• TIMED_OUT: The build timed out.

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

Any version identifier for the version of the source code to be built. 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

Any version identifier for the version of the source code to be built. 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>

Any version identifier for the version of the source code to be built. 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 resolved_source_version(self, input: impl Into<String>) -> Self

An identifier for the version of this 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

An identifier for the version of this 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>

An identifier for the version of this 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 CodeBuild project.

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

The name of the CodeBuild project.

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

The name of the CodeBuild project.

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

Appends an item to phases.

To override the contents of this collection use set_phases.

Information about all previous build phases that are complete and information about any current build phase that is not yet complete.

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

Information about all previous build phases that are complete and information about any current build phase that is not yet complete.

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

Information about all previous build phases that are complete and information about any current build phase that is not yet complete.

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

Information about the source code to be built.

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

Information about the source code to be built.

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

Information about the source code to be built.

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.

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

An array of ProjectSource objects.

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

An array of ProjectSource objects.

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

Information about the output artifacts for the build.

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

Information about the output artifacts for the build.

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

Information about the output artifacts for the 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 ProjectArtifacts objects.

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

An array of ProjectArtifacts objects.

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

An array of ProjectArtifacts objects.

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

Information about the cache for the build.

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

Information about the cache for the build.

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

Information about the cache for the build.

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

Information about the build environment for this build.

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

Information about the build environment for this build.

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

Information about the build environment for this build.

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

The name of a service role used for this build.

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

The name of a service role used for this build.

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

The name of a service role used for this build.

pub fn logs(self, input: LogsLocation) -> Self

Information about the build's logs in CloudWatch Logs.

pub fn set_logs(self, input: Option<LogsLocation>) -> Self

Information about the build's logs in CloudWatch Logs.

pub fn get_logs(&self) -> &Option<LogsLocation>

Information about the build's logs in CloudWatch Logs.

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

How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.

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

How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.

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

How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.

pub fn queued_timeout_in_minutes(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(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(&self) -> &Option<i32>

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

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

Whether the build is complete. True if complete; otherwise, false.

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

Whether the build is complete. True if complete; otherwise, false.

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

Whether the build is complete. True if complete; otherwise, false.

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

The entity that started the 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 (for example, MyUserName).

• 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 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 (for example, MyUserName).

• 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 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 (for example, MyUserName).

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

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

If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.

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

If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.

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

If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.

pub fn network_interface(self, input: NetworkInterface) -> Self

Describes a network interface.

pub fn set_network_interface(self, input: Option<NetworkInterface>) -> Self

Describes a network interface.

pub fn get_network_interface(&self) -> &Option<NetworkInterface>

Describes a network interface.

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

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

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

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

Appends an item to exported_environment_variables.

To override the contents of this collection use set_exported_environment_variables.

A list of exported environment variables for this build.

Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.

pub fn set_exported_environment_variables( self, input: Option<Vec<ExportedEnvironmentVariable>> ) -> Self

A list of exported environment variables for this build.

Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.

pub fn get_exported_environment_variables( &self ) -> &Option<Vec<ExportedEnvironmentVariable>>

A list of exported environment variables for this build.

Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.

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

Appends an item to report_arns.

To override the contents of this collection use set_report_arns.

An array of the ARNs associated with this build's reports.

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

An array of the ARNs associated with this build's reports.

pub fn get_report_arns(&self) -> &Option<Vec<String>>

An array of the ARNs associated with this build's reports.

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 a CodeBuild 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 a CodeBuild 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 a CodeBuild 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 debug_session(self, input: DebugSession) -> Self

Contains information about the debug session for this build.

pub fn set_debug_session(self, input: Option<DebugSession>) -> Self

Contains information about the debug session for this build.

pub fn get_debug_session(&self) -> &Option<DebugSession>

Contains information about the debug session for this build.

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

The ARN of the batch build that this build is a member of, if applicable.

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

The ARN of the batch build that this build is a member of, if applicable.

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

The ARN of the batch build that this build is a member of, if applicable.

pub fn build(self) -> Build

Consumes the builder and constructs a Build.

Trait Implementations

impl Clone for BuildBuilder

fn clone(&self) -> BuildBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuildBuilder

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

Formats the value using the given formatter.

impl Default for BuildBuilder

fn default() -> BuildBuilder

Returns the “default value” for a type.

impl PartialEq for BuildBuilder

fn eq(&self, other: &BuildBuilder) -> 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 BuildBuilder