BuildBatch

import type { BuildBatch } from "https://aws-api.deno.dev/v0.3/services/codebuild.ts?docs=full";

Contains information about a batch build.

interface BuildBatch {

arn?: string | null;

artifacts?: BuildArtifacts | null;

buildBatchConfig?: ProjectBuildBatchConfig | null;

buildBatchNumber?: number | null;

buildBatchStatus?: StatusType | null;

buildGroups?: BuildGroup[] | null;

buildTimeoutInMinutes?: number | null;

cache?: ProjectCache | null;

complete?: boolean | null;

currentPhase?: string | null;

debugSessionEnabled?: boolean | null;

encryptionKey?: string | null;

endTime?: Date | number | null;

environment?: ProjectEnvironment | null;

fileSystemLocations?: ProjectFileSystemLocation[] | null;

id?: string | null;

initiator?: string | null;

logConfig?: LogsConfig | null;

phases?: BuildBatchPhase[] | null;

projectName?: string | null;

queuedTimeoutInMinutes?: number | null;

resolvedSourceVersion?: string | null;

secondaryArtifacts?: BuildArtifacts[] | null;

secondarySources?: ProjectSource[] | null;

secondarySourceVersions?: ProjectSourceVersion[] | null;

serviceRole?: string | null;

source?: ProjectSource | null;

sourceVersion?: string | null;

startTime?: Date | number | null;

vpcConfig?: VpcConfig | null;

}

§Properties

arn?: string | null

[src]

The ARN of the batch build.

artifacts?: BuildArtifacts | null

[src]

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

buildBatchConfig?: ProjectBuildBatchConfig | null

[src]

buildBatchNumber?: number | null

[src]

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.

buildBatchStatus?: StatusType | null

[src]

The status of the batch build.

buildGroups?: BuildGroup[] | null

[src]

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

buildTimeoutInMinutes?: number | null

[src]

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

cache?: ProjectCache | null

[src]

complete?: boolean | null

[src]

Indicates if the batch build is complete.

currentPhase?: string | null

[src]

The current phase of the batch build.

debugSessionEnabled?: boolean | null

[src]

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.

encryptionKey?: string | null

[src]

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

Note: 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>).

endTime?: Date | number | null

[src]

The date and time that the batch build ended.

environment?: ProjectEnvironment | null

[src]

fileSystemLocations?: ProjectFileSystemLocation[] | null

[src]

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.

id?: string | null

[src]

The identifier of the batch build.

initiator?: string | null

[src]

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 an IAM user started the build, the user's name.
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

logConfig?: LogsConfig | null

[src]

phases?: BuildBatchPhase[] | null

[src]

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

projectName?: string | null

[src]

The name of the batch build project.

queuedTimeoutInMinutes?: number | null

[src]

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

resolvedSourceVersion?: string | null

[src]

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.

secondaryArtifacts?: BuildArtifacts[] | null

[src]

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

secondarySources?: ProjectSource[] | null

[src]

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

secondarySourceVersions?: ProjectSourceVersion[] | null

[src]

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.

serviceRole?: string | null

[src]

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

source?: ProjectSource | null

[src]

sourceVersion?: string | null

[src]

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

startTime?: Date | number | null

[src]

The date and time that the batch build started.

vpcConfig?: VpcConfig | null

[src]