Build Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]

arn

The Amazon Resource Name (ARN) of the build.

Declaration

Swift

public let arn: String?


                    
                    
                    artifacts

Information about the output artifacts for the build.

Declaration

Swift

public let artifacts: BuildArtifacts?


                    
                    
                    buildBatchArn

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

Declaration

Swift

public let buildBatchArn: String?


                    
                    
                    buildComplete

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

Declaration

Swift

public let buildComplete: Bool?


                    
                    
                    buildNumber

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.

Declaration

Swift

public let buildNumber: Int64?


                    
                    
                    buildStatus

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.

Declaration

Swift

public let buildStatus: StatusType?


                    
                    
                    cache

Information about the cache for the build.

Declaration

Swift

public let cache: ProjectCache?


                    
                    
                    currentPhase

The current build phase.

Declaration

Swift

public let currentPhase: String?


                    
                    
                    debugSession

Contains information about the debug session for this build.

Declaration

Swift

public let debugSession: DebugSession?


                    
                    
                    encryptionKey

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

Declaration

Swift

public let encryptionKey: String?


                    
                    
                    endTime

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

Declaration

Swift

public let endTime: TimeStamp?


                    
                    
                    environment

Information about the build environment for this build.

Declaration

Swift

public let environment: ProjectEnvironment?


                    
                    
                    exportedEnvironmentVariables

A list of exported environment variables for this build.

Declaration

Swift

public let exportedEnvironmentVariables: [ExportedEnvironmentVariable]?


                    
                    
                    fileSystemLocations

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.

Declaration

Swift

public let fileSystemLocations: [ProjectFileSystemLocation]?

id

The unique ID for the build.

Declaration

Swift

public let id: String?


                    
                    
                    initiator

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.

Declaration

Swift

public let initiator: String?


                    
                    
                    logs

Information about the build’s logs in Amazon CloudWatch Logs.

Declaration

Swift

public let logs: LogsLocation?


                    
                    
                    networkInterface

Describes a network interface.

Declaration

Swift

public let networkInterface: NetworkInterface?


                    
                    
                    phases

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

Declaration

Swift

public let phases: [BuildPhase]?


                    
                    
                    projectName

The name of the AWS CodeBuild project.

Declaration

Swift

public let projectName: String?


                    
                    
                    queuedTimeoutInMinutes

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

Declaration

Swift

public let queuedTimeoutInMinutes: Int?


                    
                    
                    reportArns

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

Declaration

Swift

public let reportArns: [String]?


                    
                    
                    resolvedSourceVersion

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.

Declaration

Swift

public let resolvedSourceVersion: String?


                    
                    
                    secondaryArtifacts

An array of ProjectArtifacts objects.

Declaration

Swift

public let secondaryArtifacts: [BuildArtifacts]?


                    
                    
                    secondarySources

An array of ProjectSource objects.

Declaration

Swift

public let secondarySources: [ProjectSource]?


                    
                    
                    secondarySourceVersions

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.

Declaration

Swift

public let secondarySourceVersions: [ProjectSourceVersion]?


                    
                    
                    serviceRole

The name of a service role used for this build.

Declaration

Swift

public let serviceRole: String?


                    
                    
                    source

Information about the source code to be built.

Declaration

Swift

public let source: ProjectSource?


                    
                    
                    sourceVersion

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.

Declaration

Swift

public let sourceVersion: String?


                    
                    
                    startTime

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

Declaration

Swift

public let startTime: TimeStamp?


                    
                    
                    timeoutInMinutes

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

Declaration

Swift

public let timeoutInMinutes: Int?


                    
                    
                    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.

Declaration

Swift

public let vpcConfig: VpcConfig?


                    
                    
                    init(arn:artifacts:buildBatchArn:buildComplete:buildNumber:buildStatus:cache:currentPhase:debugSession:encryptionKey:endTime:environment:exportedEnvironmentVariables:fileSystemLocations:id:initiator:logs:networkInterface:phases:projectName:queuedTimeoutInMinutes:reportArns:resolvedSourceVersion:secondaryArtifacts:secondarySources:secondarySourceVersions:serviceRole:source:sourceVersion:startTime:timeoutInMinutes:vpcConfig:)

Undocumented

Declaration

Swift

public init(arn: String? = nil, artifacts: BuildArtifacts? = nil, buildBatchArn: String? = nil, buildComplete: Bool? = nil, buildNumber: Int64? = nil, buildStatus: StatusType? = nil, cache: ProjectCache? = nil, currentPhase: String? = nil, debugSession: DebugSession? = nil, encryptionKey: String? = nil, endTime: TimeStamp? = nil, environment: ProjectEnvironment? = nil, exportedEnvironmentVariables: [ExportedEnvironmentVariable]? = nil, fileSystemLocations: [ProjectFileSystemLocation]? = nil, id: String? = nil, initiator: String? = nil, logs: LogsLocation? = nil, networkInterface: NetworkInterface? = nil, phases: [BuildPhase]? = nil, projectName: String? = nil, queuedTimeoutInMinutes: Int? = nil, reportArns: [String]? = nil, resolvedSourceVersion: String? = nil, secondaryArtifacts: [BuildArtifacts]? = nil, secondarySources: [ProjectSource]? = nil, secondarySourceVersions: [ProjectSourceVersion]? = nil, serviceRole: String? = nil, source: ProjectSource? = nil, sourceVersion: String? = nil, startTime: TimeStamp? = nil, timeoutInMinutes: Int? = nil, vpcConfig: VpcConfig? = nil)