You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeBuild::Types::BuildBatch

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains information about a batch build.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the batch build.

Returns:

  • (String) —

    The ARN of the batch build.

#artifacts ⇒ Types::BuildArtifacts

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

Returns:

  • (Types::BuildArtifacts) —

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

#build_batch_config ⇒ Types::ProjectBuildBatchConfig

Contains configuration information about a batch build project.

Returns:

#build_batch_number ⇒ Integer

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.

Returns:

  • (Integer) —

    The number of the batch build.

#build_batch_status ⇒ String

The status of the batch build.

Possible values:

  • SUCCEEDED
  • FAILED
  • FAULT
  • TIMED_OUT
  • IN_PROGRESS
  • STOPPED

Returns:

  • (String) —

    The status of the batch build.

#build_groups ⇒ Array<Types::BuildGroup>

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

Returns:

  • (Array<Types::BuildGroup>) —

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

#build_timeout_in_minutes ⇒ Integer

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

Returns:

  • (Integer) —

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

#cache ⇒ Types::ProjectCache

Information about the cache for the build project.

Returns:

#complete ⇒ Boolean

Indicates if the batch build is complete.

Returns:

  • (Boolean) —

    Indicates if the batch build is complete.

#current_phase ⇒ String

The current phase of the batch build.

Returns:

  • (String) —

    The current phase of the batch build.

#encryption_key ⇒ String

The AWS Key Management Service (AWS KMS) 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/<alias-name>).

Returns:

  • (String) —

    The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the batch build output artifacts.

#end_time ⇒ Time

The date and time that the batch build ended.

Returns:

  • (Time) —

    The date and time that the batch build ended.

#environment ⇒ Types::ProjectEnvironment

Information about the build environment of the build project.

Returns:

#file_system_locations ⇒ Array<Types::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.

Returns:

#id ⇒ String

The identifier of the batch build.

Returns:

  • (String) —

    The identifier of the batch build.

#initiator ⇒ String

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

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

  • If an AWS Identity and Access Management (IAM) user started the build, the user\'s name.

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

Returns:

  • (String) —

    The entity that started the batch build.

#log_config ⇒ Types::LogsConfig

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

Returns:

#phases ⇒ Array<Types::BuildBatchPhase>

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

Returns:

  • (Array<Types::BuildBatchPhase>) —

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

#project_name ⇒ String

The name of the batch build project.

Returns:

  • (String) —

    The name of the batch build project.

#queued_timeout_in_minutes ⇒ Integer

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

Returns:

  • (Integer) —

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

#resolved_source_version ⇒ String

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

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

  • For AWS CodePipeline, the source revision provided by AWS CodePipeline.

  • For Amazon Simple Storage Service (Amazon S3), this does not apply.

Returns:

  • (String) —

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

#secondary_artifacts ⇒ Array<Types::BuildArtifacts>

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

Returns:

  • (Array<Types::BuildArtifacts>) —

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

#secondary_source_versions ⇒ Array<Types::ProjectSourceVersion>

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

  • For AWS 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.

Returns:

#secondary_sources ⇒ Array<Types::ProjectSource>

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

Returns:

  • (Array<Types::ProjectSource>) —

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

#service_role ⇒ String

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

Returns:

  • (String) —

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

#source ⇒ Types::ProjectSource

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

Returns:

#source_version ⇒ String

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

Returns:

  • (String) —

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

#start_time ⇒ Time

The date and time that the batch build started.

Returns:

  • (Time) —

    The date and time that the batch build started.

#vpc_config ⇒ Types::VpcConfig

Information about the VPC configuration that AWS CodeBuild accesses.

Returns:

  • (Types::VpcConfig) —

    Information about the VPC configuration that AWS CodeBuild accesses.

    .