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

Class: Aws::CodeBuild::Types::Build

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

Overview

Information about a build.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the build.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the build.

#artifacts ⇒ Types::BuildArtifacts

Information about the output artifacts for the build.

Returns:

#build_batch_arn ⇒ String

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

Returns:

  • (String) —

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

#build_complete ⇒ Boolean

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

Returns:

  • (Boolean) —

    Whether the build is complete.

#build_number ⇒ Integer

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.

Returns:

  • (Integer) —

    The number of the build.

#build_status ⇒ String

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.

    Possible values:

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

Returns:

  • (String) —

    The current status of the build.

#cache ⇒ Types::ProjectCache

Information about the cache for the build.

Returns:

#current_phase ⇒ String

The current build phase.

Returns:

  • (String) —

    The current build phase.

#debug_session ⇒ Types::DebugSession

Contains information about the debug session for this build.

Returns:

#encryption_key ⇒ String

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

Returns:

  • (String) —

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

#end_time ⇒ Time

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

Returns:

  • (Time) —

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

#environment ⇒ Types::ProjectEnvironment

Information about the build environment for this build.

Returns:

#exported_environment_variables ⇒ Array<Types::ExportedEnvironmentVariable>

A list of exported environment variables for this build.

Returns:

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

Returns:

#id ⇒ String

The unique ID for the build.

Returns:

  • (String) —

    The unique ID for the build.

#initiator ⇒ String

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

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

Returns:

  • (String) —

    The entity that started the build.

#logs ⇒ Types::LogsLocation

Information about the build\'s logs in Amazon CloudWatch Logs.

Returns:

#network_interface ⇒ Types::NetworkInterface

Describes a network interface.

Returns:

#phases ⇒ Array<Types::BuildPhase>

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

Returns:

  • (Array<Types::BuildPhase>) —

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

#project_name ⇒ String

The name of the AWS CodeBuild project.

Returns:

  • (String) —

    The name of the AWS CodeBuild project.

#queued_timeout_in_minutes ⇒ Integer

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

Returns:

  • (Integer) —

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

#report_arns ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#resolved_source_version ⇒ String

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

    An identifier for the version of this build\'s source code.

#secondary_artifacts ⇒ Array<Types::BuildArtifacts>

An array of ProjectArtifacts objects.

Returns:

#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.

Returns:

#service_role ⇒ String

The name of a service role used for this build.

Returns:

  • (String) —

    The name of a service role used for this build.

#source ⇒ Types::ProjectSource

Information about the source code to be built.

Returns:

#source_version ⇒ 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 AWS CodeBuild User Guide.

Returns:

  • (String) —

    Any version identifier for the version of the source code to be built.

#start_time ⇒ Time

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

Returns:

  • (Time) —

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

#timeout_in_minutes ⇒ Integer

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

Returns:

  • (Integer) —

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

#vpc_config ⇒ Types::VpcConfig

If your AWS 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.

Returns:

  • (Types::VpcConfig) —

    If your AWS 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.