NAME
Paws::CodeBuild::Build
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::CodeBuild::Build object:
$service_obj->Method(Att1 => { Arn => $value, ..., VpcConfig => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::Build object:
$result = $service_obj->Method(...);
$result->Att1->Arn
DESCRIPTION
Information about a build.
ATTRIBUTES
Arn => Str
The Amazon Resource Name (ARN) of the build.
Artifacts => Paws::CodeBuild::BuildArtifacts
Information about the output artifacts for the build.
BuildBatchArn => Str
The ARN of the batch build that this build is a member of, if applicable.
BuildComplete => Bool
Whether the build is complete. True if complete; otherwise, false.
BuildNumber => Int
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.
BuildStatus => Str
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.
Cache => Paws::CodeBuild::ProjectCache
Information about the cache for the build.
CurrentPhase => Str
The current build phase.
DebugSession => Paws::CodeBuild::DebugSession
Contains information about the debug session for this build.
EncryptionKey => Str
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/<alias-name>
).
EndTime => Str
When the build process ended, expressed in Unix time format.
Environment => Paws::CodeBuild::ProjectEnvironment
Information about the build environment for this build.
ExportedEnvironmentVariables => ArrayRef[Paws::CodeBuild::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 (https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html) in the CodePipeline User Guide.
FileSystemLocations => ArrayRef[Paws::CodeBuild::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.
Id => Str
The unique ID for the build.
Initiator => Str
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 an Identity and Access Management 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
.
Logs => Paws::CodeBuild::LogsLocation
Information about the build's logs in CloudWatch Logs.
NetworkInterface => Paws::CodeBuild::NetworkInterface
Describes a network interface.
Phases => ArrayRef[Paws::CodeBuild::BuildPhase]
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
ProjectName => Str
The name of the CodeBuild project.
QueuedTimeoutInMinutes => Int
The number of minutes a build is allowed to be queued before it times out.
ReportArns => ArrayRef[Str|Undef]
An array of the ARNs associated with this build's reports.
ResolvedSourceVersion => Str
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.
SecondaryArtifacts => ArrayRef[Paws::CodeBuild::BuildArtifacts]
An array of ProjectArtifacts
objects.
SecondarySources => ArrayRef[Paws::CodeBuild::ProjectSource]
An array of ProjectSource
objects.
SecondarySourceVersions => ArrayRef[Paws::CodeBuild::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.
ServiceRole => Str
The name of a service role used for this build.
Source => Paws::CodeBuild::ProjectSource
Information about the source code to be built.
SourceVersion => Str
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 (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) in the CodeBuild User Guide.
StartTime => Str
When the build process started, expressed in Unix time format.
TimeoutInMinutes => Int
How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
VpcConfig => Paws::CodeBuild::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.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::CodeBuild
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues