@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StartBuildRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
StartBuildRequest() |
Modifier and Type | Method and Description |
---|---|
StartBuildRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
ProjectArtifacts |
getArtifactsOverride()
Build output artifact settings that override, for this build only, the latest ones already defined in the build
project.
|
String |
getBuildspecOverride()
A buildspec file declaration that overrides the latest one defined in the build project, for this build only.
|
BuildStatusConfig |
getBuildStatusConfigOverride()
Contains information that defines how the build project reports the build status to the source provider.
|
ProjectCache |
getCacheOverride()
A ProjectCache object specified for this build that overrides the one defined in the build project.
|
String |
getCertificateOverride()
The name of a certificate for this build that overrides the one specified in the build project.
|
String |
getComputeTypeOverride()
The name of a compute type for this build that overrides the one specified in the build project.
|
Boolean |
getDebugSessionEnabled()
Specifies if session debugging is enabled for this build.
|
String |
getEncryptionKeyOverride()
The Key Management Service customer master key (CMK) that overrides the one specified in the build project.
|
String |
getEnvironmentTypeOverride()
A container type for this build that overrides the one specified in the build project.
|
List<EnvironmentVariable> |
getEnvironmentVariablesOverride()
A set of environment variables that overrides, for this build only, the latest ones already defined in the build
project.
|
ProjectFleet |
getFleetOverride()
A ProjectFleet object specified for this build that overrides the one defined in the build project.
|
Integer |
getGitCloneDepthOverride()
The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous
depth of history defined in the build project.
|
GitSubmodulesConfig |
getGitSubmodulesConfigOverride()
Information about the Git submodules configuration for this build of an CodeBuild build project.
|
String |
getIdempotencyToken()
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request.
|
String |
getImageOverride()
The name of an image for this build that overrides the one specified in the build project.
|
String |
getImagePullCredentialsTypeOverride()
The type of credentials CodeBuild uses to pull images in your build.
|
Boolean |
getInsecureSslOverride()
Enable this flag to override the insecure SSL setting that is specified in the build project.
|
LogsConfig |
getLogsConfigOverride()
Log settings for this build that override the log settings defined in the build project.
|
Boolean |
getPrivilegedModeOverride()
Enable this flag to override privileged mode in the build project.
|
String |
getProjectName()
The name of the CodeBuild build project to start running a build.
|
Integer |
getQueuedTimeoutInMinutesOverride()
The number of minutes a build is allowed to be queued before it times out.
|
RegistryCredential |
getRegistryCredentialOverride()
The credentials for access to a private registry.
|
Boolean |
getReportBuildStatusOverride()
Set to true to report to your source provider the status of a build's start and completion.
|
List<ProjectArtifacts> |
getSecondaryArtifactsOverride()
An array of
ProjectArtifacts objects. |
List<ProjectSource> |
getSecondarySourcesOverride()
An array of
ProjectSource objects. |
List<ProjectSourceVersion> |
getSecondarySourcesVersionOverride()
An array of
ProjectSourceVersion objects that specify one or more versions of the project's
secondary sources to be used for this build only. |
String |
getServiceRoleOverride()
The name of a service role for this build that overrides the one specified in the build project.
|
SourceAuth |
getSourceAuthOverride()
An authorization type for this build that overrides the one defined in the build project.
|
String |
getSourceLocationOverride()
A location that overrides, for this build, the source location for the one defined in the build project.
|
String |
getSourceTypeOverride()
A source input type, for this build, that overrides the source input defined in the build project.
|
String |
getSourceVersion()
The version of the build input to be built, for this build only.
|
Integer |
getTimeoutInMinutesOverride()
The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest
setting already defined in the build project.
|
int |
hashCode() |
Boolean |
isDebugSessionEnabled()
Specifies if session debugging is enabled for this build.
|
Boolean |
isInsecureSslOverride()
Enable this flag to override the insecure SSL setting that is specified in the build project.
|
Boolean |
isPrivilegedModeOverride()
Enable this flag to override privileged mode in the build project.
|
Boolean |
isReportBuildStatusOverride()
Set to true to report to your source provider the status of a build's start and completion.
|
void |
setArtifactsOverride(ProjectArtifacts artifactsOverride)
Build output artifact settings that override, for this build only, the latest ones already defined in the build
project.
|
void |
setBuildspecOverride(String buildspecOverride)
A buildspec file declaration that overrides the latest one defined in the build project, for this build only.
|
void |
setBuildStatusConfigOverride(BuildStatusConfig buildStatusConfigOverride)
Contains information that defines how the build project reports the build status to the source provider.
|
void |
setCacheOverride(ProjectCache cacheOverride)
A ProjectCache object specified for this build that overrides the one defined in the build project.
|
void |
setCertificateOverride(String certificateOverride)
The name of a certificate for this build that overrides the one specified in the build project.
|
void |
setComputeTypeOverride(String computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
|
void |
setDebugSessionEnabled(Boolean debugSessionEnabled)
Specifies if session debugging is enabled for this build.
|
void |
setEncryptionKeyOverride(String encryptionKeyOverride)
The Key Management Service customer master key (CMK) that overrides the one specified in the build project.
|
void |
setEnvironmentTypeOverride(String environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
|
void |
setEnvironmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the build
project.
|
void |
setFleetOverride(ProjectFleet fleetOverride)
A ProjectFleet object specified for this build that overrides the one defined in the build project.
|
void |
setGitCloneDepthOverride(Integer gitCloneDepthOverride)
The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous
depth of history defined in the build project.
|
void |
setGitSubmodulesConfigOverride(GitSubmodulesConfig gitSubmodulesConfigOverride)
Information about the Git submodules configuration for this build of an CodeBuild build project.
|
void |
setIdempotencyToken(String idempotencyToken)
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request.
|
void |
setImageOverride(String imageOverride)
The name of an image for this build that overrides the one specified in the build project.
|
void |
setImagePullCredentialsTypeOverride(String imagePullCredentialsTypeOverride)
The type of credentials CodeBuild uses to pull images in your build.
|
void |
setInsecureSslOverride(Boolean insecureSslOverride)
Enable this flag to override the insecure SSL setting that is specified in the build project.
|
void |
setLogsConfigOverride(LogsConfig logsConfigOverride)
Log settings for this build that override the log settings defined in the build project.
|
void |
setPrivilegedModeOverride(Boolean privilegedModeOverride)
Enable this flag to override privileged mode in the build project.
|
void |
setProjectName(String projectName)
The name of the CodeBuild build project to start running a build.
|
void |
setQueuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride)
The number of minutes a build is allowed to be queued before it times out.
|
void |
setRegistryCredentialOverride(RegistryCredential registryCredentialOverride)
The credentials for access to a private registry.
|
void |
setReportBuildStatusOverride(Boolean reportBuildStatusOverride)
Set to true to report to your source provider the status of a build's start and completion.
|
void |
setSecondaryArtifactsOverride(Collection<ProjectArtifacts> secondaryArtifactsOverride)
An array of
ProjectArtifacts objects. |
void |
setSecondarySourcesOverride(Collection<ProjectSource> secondarySourcesOverride)
An array of
ProjectSource objects. |
void |
setSecondarySourcesVersionOverride(Collection<ProjectSourceVersion> secondarySourcesVersionOverride)
An array of
ProjectSourceVersion objects that specify one or more versions of the project's
secondary sources to be used for this build only. |
void |
setServiceRoleOverride(String serviceRoleOverride)
The name of a service role for this build that overrides the one specified in the build project.
|
void |
setSourceAuthOverride(SourceAuth sourceAuthOverride)
An authorization type for this build that overrides the one defined in the build project.
|
void |
setSourceLocationOverride(String sourceLocationOverride)
A location that overrides, for this build, the source location for the one defined in the build project.
|
void |
setSourceTypeOverride(String sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
|
void |
setSourceVersion(String sourceVersion)
The version of the build input to be built, for this build only.
|
void |
setTimeoutInMinutesOverride(Integer timeoutInMinutesOverride)
The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest
setting already defined in the build project.
|
String |
toString()
Returns a string representation of this object.
|
StartBuildRequest |
withArtifactsOverride(ProjectArtifacts artifactsOverride)
Build output artifact settings that override, for this build only, the latest ones already defined in the build
project.
|
StartBuildRequest |
withBuildspecOverride(String buildspecOverride)
A buildspec file declaration that overrides the latest one defined in the build project, for this build only.
|
StartBuildRequest |
withBuildStatusConfigOverride(BuildStatusConfig buildStatusConfigOverride)
Contains information that defines how the build project reports the build status to the source provider.
|
StartBuildRequest |
withCacheOverride(ProjectCache cacheOverride)
A ProjectCache object specified for this build that overrides the one defined in the build project.
|
StartBuildRequest |
withCertificateOverride(String certificateOverride)
The name of a certificate for this build that overrides the one specified in the build project.
|
StartBuildRequest |
withComputeTypeOverride(ComputeType computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
|
StartBuildRequest |
withComputeTypeOverride(String computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
|
StartBuildRequest |
withDebugSessionEnabled(Boolean debugSessionEnabled)
Specifies if session debugging is enabled for this build.
|
StartBuildRequest |
withEncryptionKeyOverride(String encryptionKeyOverride)
The Key Management Service customer master key (CMK) that overrides the one specified in the build project.
|
StartBuildRequest |
withEnvironmentTypeOverride(EnvironmentType environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
|
StartBuildRequest |
withEnvironmentTypeOverride(String environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
|
StartBuildRequest |
withEnvironmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the build
project.
|
StartBuildRequest |
withEnvironmentVariablesOverride(EnvironmentVariable... environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the build
project.
|
StartBuildRequest |
withFleetOverride(ProjectFleet fleetOverride)
A ProjectFleet object specified for this build that overrides the one defined in the build project.
|
StartBuildRequest |
withGitCloneDepthOverride(Integer gitCloneDepthOverride)
The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous
depth of history defined in the build project.
|
StartBuildRequest |
withGitSubmodulesConfigOverride(GitSubmodulesConfig gitSubmodulesConfigOverride)
Information about the Git submodules configuration for this build of an CodeBuild build project.
|
StartBuildRequest |
withIdempotencyToken(String idempotencyToken)
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request.
|
StartBuildRequest |
withImageOverride(String imageOverride)
The name of an image for this build that overrides the one specified in the build project.
|
StartBuildRequest |
withImagePullCredentialsTypeOverride(ImagePullCredentialsType imagePullCredentialsTypeOverride)
The type of credentials CodeBuild uses to pull images in your build.
|
StartBuildRequest |
withImagePullCredentialsTypeOverride(String imagePullCredentialsTypeOverride)
The type of credentials CodeBuild uses to pull images in your build.
|
StartBuildRequest |
withInsecureSslOverride(Boolean insecureSslOverride)
Enable this flag to override the insecure SSL setting that is specified in the build project.
|
StartBuildRequest |
withLogsConfigOverride(LogsConfig logsConfigOverride)
Log settings for this build that override the log settings defined in the build project.
|
StartBuildRequest |
withPrivilegedModeOverride(Boolean privilegedModeOverride)
Enable this flag to override privileged mode in the build project.
|
StartBuildRequest |
withProjectName(String projectName)
The name of the CodeBuild build project to start running a build.
|
StartBuildRequest |
withQueuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride)
The number of minutes a build is allowed to be queued before it times out.
|
StartBuildRequest |
withRegistryCredentialOverride(RegistryCredential registryCredentialOverride)
The credentials for access to a private registry.
|
StartBuildRequest |
withReportBuildStatusOverride(Boolean reportBuildStatusOverride)
Set to true to report to your source provider the status of a build's start and completion.
|
StartBuildRequest |
withSecondaryArtifactsOverride(Collection<ProjectArtifacts> secondaryArtifactsOverride)
An array of
ProjectArtifacts objects. |
StartBuildRequest |
withSecondaryArtifactsOverride(ProjectArtifacts... secondaryArtifactsOverride)
An array of
ProjectArtifacts objects. |
StartBuildRequest |
withSecondarySourcesOverride(Collection<ProjectSource> secondarySourcesOverride)
An array of
ProjectSource objects. |
StartBuildRequest |
withSecondarySourcesOverride(ProjectSource... secondarySourcesOverride)
An array of
ProjectSource objects. |
StartBuildRequest |
withSecondarySourcesVersionOverride(Collection<ProjectSourceVersion> secondarySourcesVersionOverride)
An array of
ProjectSourceVersion objects that specify one or more versions of the project's
secondary sources to be used for this build only. |
StartBuildRequest |
withSecondarySourcesVersionOverride(ProjectSourceVersion... secondarySourcesVersionOverride)
An array of
ProjectSourceVersion objects that specify one or more versions of the project's
secondary sources to be used for this build only. |
StartBuildRequest |
withServiceRoleOverride(String serviceRoleOverride)
The name of a service role for this build that overrides the one specified in the build project.
|
StartBuildRequest |
withSourceAuthOverride(SourceAuth sourceAuthOverride)
An authorization type for this build that overrides the one defined in the build project.
|
StartBuildRequest |
withSourceLocationOverride(String sourceLocationOverride)
A location that overrides, for this build, the source location for the one defined in the build project.
|
StartBuildRequest |
withSourceTypeOverride(SourceType sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
|
StartBuildRequest |
withSourceTypeOverride(String sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
|
StartBuildRequest |
withSourceVersion(String sourceVersion)
The version of the build input to be built, for this build only.
|
StartBuildRequest |
withTimeoutInMinutesOverride(Integer timeoutInMinutesOverride)
The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest
setting already defined in the build project.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setProjectName(String projectName)
The name of the CodeBuild build project to start running a build.
projectName
- The name of the CodeBuild build project to start running a build.public String getProjectName()
The name of the CodeBuild build project to start running a build.
public StartBuildRequest withProjectName(String projectName)
The name of the CodeBuild build project to start running a build.
projectName
- The name of the CodeBuild build project to start running a build.public List<ProjectSource> getSecondarySourcesOverride()
An array of ProjectSource
objects.
ProjectSource
objects.public void setSecondarySourcesOverride(Collection<ProjectSource> secondarySourcesOverride)
An array of ProjectSource
objects.
secondarySourcesOverride
- An array of ProjectSource
objects.public StartBuildRequest withSecondarySourcesOverride(ProjectSource... secondarySourcesOverride)
An array of ProjectSource
objects.
NOTE: This method appends the values to the existing list (if any). Use
setSecondarySourcesOverride(java.util.Collection)
or
withSecondarySourcesOverride(java.util.Collection)
if you want to override the existing values.
secondarySourcesOverride
- An array of ProjectSource
objects.public StartBuildRequest withSecondarySourcesOverride(Collection<ProjectSource> secondarySourcesOverride)
An array of ProjectSource
objects.
secondarySourcesOverride
- An array of ProjectSource
objects.public List<ProjectSourceVersion> getSecondarySourcesVersionOverride()
An array of ProjectSourceVersion
objects that specify one or more versions of the project's
secondary sources to be used for this build only.
ProjectSourceVersion
objects that specify one or more versions of the project's
secondary sources to be used for this build only.public void setSecondarySourcesVersionOverride(Collection<ProjectSourceVersion> secondarySourcesVersionOverride)
An array of ProjectSourceVersion
objects that specify one or more versions of the project's
secondary sources to be used for this build only.
secondarySourcesVersionOverride
- An array of ProjectSourceVersion
objects that specify one or more versions of the project's
secondary sources to be used for this build only.public StartBuildRequest withSecondarySourcesVersionOverride(ProjectSourceVersion... secondarySourcesVersionOverride)
An array of ProjectSourceVersion
objects that specify one or more versions of the project's
secondary sources to be used for this build only.
NOTE: This method appends the values to the existing list (if any). Use
setSecondarySourcesVersionOverride(java.util.Collection)
or
withSecondarySourcesVersionOverride(java.util.Collection)
if you want to override the existing values.
secondarySourcesVersionOverride
- An array of ProjectSourceVersion
objects that specify one or more versions of the project's
secondary sources to be used for this build only.public StartBuildRequest withSecondarySourcesVersionOverride(Collection<ProjectSourceVersion> secondarySourcesVersionOverride)
An array of ProjectSourceVersion
objects that specify one or more versions of the project's
secondary sources to be used for this build only.
secondarySourcesVersionOverride
- An array of ProjectSourceVersion
objects that specify one or more versions of the project's
secondary sources to be used for this build only.public void setSourceVersion(String sourceVersion)
The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
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.
The commit ID, branch, or Git tag to use.
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.
The version ID of the object that represents the build input ZIP file to use.
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 CodeBuild User Guide.
sourceVersion
- The version of the build input to be built, for this build only. If not specified, the latest version is
used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
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.
The commit ID, branch, or Git tag to use.
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.
The version ID of the object that represents the build input ZIP file to use.
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 CodeBuild User Guide.
public String getSourceVersion()
The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
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.
The commit ID, branch, or Git tag to use.
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.
The version ID of the object that represents the build input ZIP file to use.
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 CodeBuild User Guide.
The commit ID, branch, or Git tag to use.
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.
The commit ID, branch, or Git tag to use.
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.
The version ID of the object that represents the build input ZIP file to use.
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 CodeBuild User Guide.
public StartBuildRequest withSourceVersion(String sourceVersion)
The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
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.
The commit ID, branch, or Git tag to use.
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.
The version ID of the object that represents the build input ZIP file to use.
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 CodeBuild User Guide.
sourceVersion
- The version of the build input to be built, for this build only. If not specified, the latest version is
used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
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.
The commit ID, branch, or Git tag to use.
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.
The version ID of the object that represents the build input ZIP file to use.
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 CodeBuild User Guide.
public void setArtifactsOverride(ProjectArtifacts artifactsOverride)
Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
artifactsOverride
- Build output artifact settings that override, for this build only, the latest ones already defined in the
build project.public ProjectArtifacts getArtifactsOverride()
Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
public StartBuildRequest withArtifactsOverride(ProjectArtifacts artifactsOverride)
Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
artifactsOverride
- Build output artifact settings that override, for this build only, the latest ones already defined in the
build project.public List<ProjectArtifacts> getSecondaryArtifactsOverride()
An array of ProjectArtifacts
objects.
ProjectArtifacts
objects.public void setSecondaryArtifactsOverride(Collection<ProjectArtifacts> secondaryArtifactsOverride)
An array of ProjectArtifacts
objects.
secondaryArtifactsOverride
- An array of ProjectArtifacts
objects.public StartBuildRequest withSecondaryArtifactsOverride(ProjectArtifacts... secondaryArtifactsOverride)
An array of ProjectArtifacts
objects.
NOTE: This method appends the values to the existing list (if any). Use
setSecondaryArtifactsOverride(java.util.Collection)
or
withSecondaryArtifactsOverride(java.util.Collection)
if you want to override the existing values.
secondaryArtifactsOverride
- An array of ProjectArtifacts
objects.public StartBuildRequest withSecondaryArtifactsOverride(Collection<ProjectArtifacts> secondaryArtifactsOverride)
An array of ProjectArtifacts
objects.
secondaryArtifactsOverride
- An array of ProjectArtifacts
objects.public List<EnvironmentVariable> getEnvironmentVariablesOverride()
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
public void setEnvironmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
environmentVariablesOverride
- A set of environment variables that overrides, for this build only, the latest ones already defined in the
build project.public StartBuildRequest withEnvironmentVariablesOverride(EnvironmentVariable... environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
NOTE: This method appends the values to the existing list (if any). Use
setEnvironmentVariablesOverride(java.util.Collection)
or
withEnvironmentVariablesOverride(java.util.Collection)
if you want to override the existing values.
environmentVariablesOverride
- A set of environment variables that overrides, for this build only, the latest ones already defined in the
build project.public StartBuildRequest withEnvironmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
environmentVariablesOverride
- A set of environment variables that overrides, for this build only, the latest ones already defined in the
build project.public void setSourceTypeOverride(String sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
sourceTypeOverride
- A source input type, for this build, that overrides the source input defined in the build project.SourceType
public String getSourceTypeOverride()
A source input type, for this build, that overrides the source input defined in the build project.
SourceType
public StartBuildRequest withSourceTypeOverride(String sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
sourceTypeOverride
- A source input type, for this build, that overrides the source input defined in the build project.SourceType
public StartBuildRequest withSourceTypeOverride(SourceType sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
sourceTypeOverride
- A source input type, for this build, that overrides the source input defined in the build project.SourceType
public void setSourceLocationOverride(String sourceLocationOverride)
A location that overrides, for this build, the source location for the one defined in the build project.
sourceLocationOverride
- A location that overrides, for this build, the source location for the one defined in the build project.public String getSourceLocationOverride()
A location that overrides, for this build, the source location for the one defined in the build project.
public StartBuildRequest withSourceLocationOverride(String sourceLocationOverride)
A location that overrides, for this build, the source location for the one defined in the build project.
sourceLocationOverride
- A location that overrides, for this build, the source location for the one defined in the build project.public void setSourceAuthOverride(SourceAuth sourceAuthOverride)
An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket, GitHub, GitLab, or GitLab Self Managed.
sourceAuthOverride
- An authorization type for this build that overrides the one defined in the build project. This override
applies only if the build project's source is BitBucket, GitHub, GitLab, or GitLab Self Managed.public SourceAuth getSourceAuthOverride()
An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket, GitHub, GitLab, or GitLab Self Managed.
public StartBuildRequest withSourceAuthOverride(SourceAuth sourceAuthOverride)
An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket, GitHub, GitLab, or GitLab Self Managed.
sourceAuthOverride
- An authorization type for this build that overrides the one defined in the build project. This override
applies only if the build project's source is BitBucket, GitHub, GitLab, or GitLab Self Managed.public void setGitCloneDepthOverride(Integer gitCloneDepthOverride)
The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.
gitCloneDepthOverride
- The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any
previous depth of history defined in the build project.public Integer getGitCloneDepthOverride()
The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.
public StartBuildRequest withGitCloneDepthOverride(Integer gitCloneDepthOverride)
The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.
gitCloneDepthOverride
- The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any
previous depth of history defined in the build project.public void setGitSubmodulesConfigOverride(GitSubmodulesConfig gitSubmodulesConfigOverride)
Information about the Git submodules configuration for this build of an CodeBuild build project.
gitSubmodulesConfigOverride
- Information about the Git submodules configuration for this build of an CodeBuild build project.public GitSubmodulesConfig getGitSubmodulesConfigOverride()
Information about the Git submodules configuration for this build of an CodeBuild build project.
public StartBuildRequest withGitSubmodulesConfigOverride(GitSubmodulesConfig gitSubmodulesConfigOverride)
Information about the Git submodules configuration for this build of an CodeBuild build project.
gitSubmodulesConfigOverride
- Information about the Git submodules configuration for this build of an CodeBuild build project.public void setBuildspecOverride(String buildspecOverride)
A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file
relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the path to an S3
bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is
not provided or is set to an empty string, the source code must contain a buildspec file in its root directory.
For more information, see Buildspec File Name and Storage Location.
Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.
buildspecOverride
- A buildspec file declaration that overrides the latest one defined in the build project, for this build
only. The buildspec defined on the project is not changed.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec
file relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the
path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project.
Specify the buildspec file using its ARN (for example,
arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is not provided or is set to
an empty string, the source code must contain a buildspec file in its root directory. For more
information, see Buildspec File Name and Storage Location.
Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.
public String getBuildspecOverride()
A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file
relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the path to an S3
bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is
not provided or is set to an empty string, the source code must contain a buildspec file in its root directory.
For more information, see Buildspec File Name and Storage Location.
Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec
file relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the
path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project.
Specify the buildspec file using its ARN (for example,
arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is not provided or is set to
an empty string, the source code must contain a buildspec file in its root directory. For more
information, see Buildspec File Name and Storage Location.
Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.
public StartBuildRequest withBuildspecOverride(String buildspecOverride)
A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file
relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the path to an S3
bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is
not provided or is set to an empty string, the source code must contain a buildspec file in its root directory.
For more information, see Buildspec File Name and Storage Location.
Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.
buildspecOverride
- A buildspec file declaration that overrides the latest one defined in the build project, for this build
only. The buildspec defined on the project is not changed.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec
file relative to the value of the built-in CODEBUILD_SRC_DIR
environment variable, or the
path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project.
Specify the buildspec file using its ARN (for example,
arn:aws:s3:::my-codebuild-sample2/buildspec.yml
). If this value is not provided or is set to
an empty string, the source code must contain a buildspec file in its root directory. For more
information, see Buildspec File Name and Storage Location.
Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.
public void setInsecureSslOverride(Boolean insecureSslOverride)
Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
insecureSslOverride
- Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure
SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This
override applies only if the build's source is GitHub Enterprise.public Boolean getInsecureSslOverride()
Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
public StartBuildRequest withInsecureSslOverride(Boolean insecureSslOverride)
Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
insecureSslOverride
- Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure
SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This
override applies only if the build's source is GitHub Enterprise.public Boolean isInsecureSslOverride()
Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
public void setReportBuildStatusOverride(Boolean reportBuildStatusOverride)
Set to true to report to your source provider the status of a build's start and completion. If you use this
option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
invalidInputException
is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
reportBuildStatusOverride
- Set to true to report to your source provider the status of a build's start and completion. If you use
this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
invalidInputException
is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
public Boolean getReportBuildStatusOverride()
Set to true to report to your source provider the status of a build's start and completion. If you use this
option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
invalidInputException
is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
invalidInputException
is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
public StartBuildRequest withReportBuildStatusOverride(Boolean reportBuildStatusOverride)
Set to true to report to your source provider the status of a build's start and completion. If you use this
option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
invalidInputException
is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
reportBuildStatusOverride
- Set to true to report to your source provider the status of a build's start and completion. If you use
this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
invalidInputException
is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
public Boolean isReportBuildStatusOverride()
Set to true to report to your source provider the status of a build's start and completion. If you use this
option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an
invalidInputException
is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
invalidInputException
is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
public void setBuildStatusConfigOverride(BuildStatusConfig buildStatusConfigOverride)
Contains information that defines how the build project reports the build status to the source provider. This
option is only used when the source provider is GITHUB
, GITHUB_ENTERPRISE
, or
BITBUCKET
.
buildStatusConfigOverride
- Contains information that defines how the build project reports the build status to the source provider.
This option is only used when the source provider is GITHUB
, GITHUB_ENTERPRISE
,
or BITBUCKET
.public BuildStatusConfig getBuildStatusConfigOverride()
Contains information that defines how the build project reports the build status to the source provider. This
option is only used when the source provider is GITHUB
, GITHUB_ENTERPRISE
, or
BITBUCKET
.
GITHUB
, GITHUB_ENTERPRISE
,
or BITBUCKET
.public StartBuildRequest withBuildStatusConfigOverride(BuildStatusConfig buildStatusConfigOverride)
Contains information that defines how the build project reports the build status to the source provider. This
option is only used when the source provider is GITHUB
, GITHUB_ENTERPRISE
, or
BITBUCKET
.
buildStatusConfigOverride
- Contains information that defines how the build project reports the build status to the source provider.
This option is only used when the source provider is GITHUB
, GITHUB_ENTERPRISE
,
or BITBUCKET
.public void setEnvironmentTypeOverride(String environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
environmentTypeOverride
- A container type for this build that overrides the one specified in the build project.EnvironmentType
public String getEnvironmentTypeOverride()
A container type for this build that overrides the one specified in the build project.
EnvironmentType
public StartBuildRequest withEnvironmentTypeOverride(String environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
environmentTypeOverride
- A container type for this build that overrides the one specified in the build project.EnvironmentType
public StartBuildRequest withEnvironmentTypeOverride(EnvironmentType environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
environmentTypeOverride
- A container type for this build that overrides the one specified in the build project.EnvironmentType
public void setImageOverride(String imageOverride)
The name of an image for this build that overrides the one specified in the build project.
imageOverride
- The name of an image for this build that overrides the one specified in the build project.public String getImageOverride()
The name of an image for this build that overrides the one specified in the build project.
public StartBuildRequest withImageOverride(String imageOverride)
The name of an image for this build that overrides the one specified in the build project.
imageOverride
- The name of an image for this build that overrides the one specified in the build project.public void setComputeTypeOverride(String computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
computeTypeOverride
- The name of a compute type for this build that overrides the one specified in the build project.ComputeType
public String getComputeTypeOverride()
The name of a compute type for this build that overrides the one specified in the build project.
ComputeType
public StartBuildRequest withComputeTypeOverride(String computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
computeTypeOverride
- The name of a compute type for this build that overrides the one specified in the build project.ComputeType
public StartBuildRequest withComputeTypeOverride(ComputeType computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
computeTypeOverride
- The name of a compute type for this build that overrides the one specified in the build project.ComputeType
public void setCertificateOverride(String certificateOverride)
The name of a certificate for this build that overrides the one specified in the build project.
certificateOverride
- The name of a certificate for this build that overrides the one specified in the build project.public String getCertificateOverride()
The name of a certificate for this build that overrides the one specified in the build project.
public StartBuildRequest withCertificateOverride(String certificateOverride)
The name of a certificate for this build that overrides the one specified in the build project.
certificateOverride
- The name of a certificate for this build that overrides the one specified in the build project.public void setCacheOverride(ProjectCache cacheOverride)
A ProjectCache object specified for this build that overrides the one defined in the build project.
cacheOverride
- A ProjectCache object specified for this build that overrides the one defined in the build project.public ProjectCache getCacheOverride()
A ProjectCache object specified for this build that overrides the one defined in the build project.
public StartBuildRequest withCacheOverride(ProjectCache cacheOverride)
A ProjectCache object specified for this build that overrides the one defined in the build project.
cacheOverride
- A ProjectCache object specified for this build that overrides the one defined in the build project.public void setServiceRoleOverride(String serviceRoleOverride)
The name of a service role for this build that overrides the one specified in the build project.
serviceRoleOverride
- The name of a service role for this build that overrides the one specified in the build project.public String getServiceRoleOverride()
The name of a service role for this build that overrides the one specified in the build project.
public StartBuildRequest withServiceRoleOverride(String serviceRoleOverride)
The name of a service role for this build that overrides the one specified in the build project.
serviceRoleOverride
- The name of a service role for this build that overrides the one specified in the build project.public void setPrivilegedModeOverride(Boolean privilegedModeOverride)
Enable this flag to override privileged mode in the build project.
privilegedModeOverride
- Enable this flag to override privileged mode in the build project.public Boolean getPrivilegedModeOverride()
Enable this flag to override privileged mode in the build project.
public StartBuildRequest withPrivilegedModeOverride(Boolean privilegedModeOverride)
Enable this flag to override privileged mode in the build project.
privilegedModeOverride
- Enable this flag to override privileged mode in the build project.public Boolean isPrivilegedModeOverride()
Enable this flag to override privileged mode in the build project.
public void setTimeoutInMinutesOverride(Integer timeoutInMinutesOverride)
The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.
timeoutInMinutesOverride
- The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the
latest setting already defined in the build project.public Integer getTimeoutInMinutesOverride()
The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.
public StartBuildRequest withTimeoutInMinutesOverride(Integer timeoutInMinutesOverride)
The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.
timeoutInMinutesOverride
- The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the
latest setting already defined in the build project.public void setQueuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride)
The number of minutes a build is allowed to be queued before it times out.
queuedTimeoutInMinutesOverride
- The number of minutes a build is allowed to be queued before it times out.public Integer getQueuedTimeoutInMinutesOverride()
The number of minutes a build is allowed to be queued before it times out.
public StartBuildRequest withQueuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride)
The number of minutes a build is allowed to be queued before it times out.
queuedTimeoutInMinutesOverride
- The number of minutes a build is allowed to be queued before it times out.public void setEncryptionKeyOverride(String encryptionKeyOverride)
The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts 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>
).
encryptionKeyOverride
- The Key Management Service customer master key (CMK) that overrides the one specified in the build
project. The CMK key encrypts 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>
).
public String getEncryptionKeyOverride()
The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts 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>
).
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>
).
public StartBuildRequest withEncryptionKeyOverride(String encryptionKeyOverride)
The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts 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>
).
encryptionKeyOverride
- The Key Management Service customer master key (CMK) that overrides the one specified in the build
project. The CMK key encrypts 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>
).
public void setIdempotencyToken(String idempotencyToken)
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
idempotencyToken
- A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The
token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild
request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.public String getIdempotencyToken()
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
public StartBuildRequest withIdempotencyToken(String idempotencyToken)
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
idempotencyToken
- A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The
token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild
request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.public void setLogsConfigOverride(LogsConfig logsConfigOverride)
Log settings for this build that override the log settings defined in the build project.
logsConfigOverride
- Log settings for this build that override the log settings defined in the build project.public LogsConfig getLogsConfigOverride()
Log settings for this build that override the log settings defined in the build project.
public StartBuildRequest withLogsConfigOverride(LogsConfig logsConfigOverride)
Log settings for this build that override the log settings defined in the build project.
logsConfigOverride
- Log settings for this build that override the log settings defined in the build project.public void setRegistryCredentialOverride(RegistryCredential registryCredentialOverride)
The credentials for access to a private registry.
registryCredentialOverride
- The credentials for access to a private registry.public RegistryCredential getRegistryCredentialOverride()
The credentials for access to a private registry.
public StartBuildRequest withRegistryCredentialOverride(RegistryCredential registryCredentialOverride)
The credentials for access to a private registry.
registryCredentialOverride
- The credentials for access to a private registry.public void setImagePullCredentialsTypeOverride(String imagePullCredentialsTypeOverride)
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials. When
using an CodeBuild curated image, you must use CODEBUILD
credentials.
imagePullCredentialsTypeOverride
- The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials.
When using an CodeBuild curated image, you must use CODEBUILD
credentials.
ImagePullCredentialsType
public String getImagePullCredentialsTypeOverride()
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials. When
using an CodeBuild curated image, you must use CODEBUILD
credentials.
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials.
When using an CodeBuild curated image, you must use CODEBUILD
credentials.
ImagePullCredentialsType
public StartBuildRequest withImagePullCredentialsTypeOverride(String imagePullCredentialsTypeOverride)
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials. When
using an CodeBuild curated image, you must use CODEBUILD
credentials.
imagePullCredentialsTypeOverride
- The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials.
When using an CodeBuild curated image, you must use CODEBUILD
credentials.
ImagePullCredentialsType
public StartBuildRequest withImagePullCredentialsTypeOverride(ImagePullCredentialsType imagePullCredentialsTypeOverride)
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials. When
using an CodeBuild curated image, you must use CODEBUILD
credentials.
imagePullCredentialsTypeOverride
- The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
Specifies that CodeBuild uses your build project's service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE
credentials.
When using an CodeBuild curated image, you must use CODEBUILD
credentials.
ImagePullCredentialsType
public void setDebugSessionEnabled(Boolean debugSessionEnabled)
Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
debugSessionEnabled
- Specifies if session debugging is enabled for this build. For more information, see Viewing a running build
in Session Manager.public Boolean getDebugSessionEnabled()
Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
public StartBuildRequest withDebugSessionEnabled(Boolean debugSessionEnabled)
Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
debugSessionEnabled
- Specifies if session debugging is enabled for this build. For more information, see Viewing a running build
in Session Manager.public Boolean isDebugSessionEnabled()
Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
public void setFleetOverride(ProjectFleet fleetOverride)
A ProjectFleet object specified for this build that overrides the one defined in the build project.
fleetOverride
- A ProjectFleet object specified for this build that overrides the one defined in the build project.public ProjectFleet getFleetOverride()
A ProjectFleet object specified for this build that overrides the one defined in the build project.
public StartBuildRequest withFleetOverride(ProjectFleet fleetOverride)
A ProjectFleet object specified for this build that overrides the one defined in the build project.
fleetOverride
- A ProjectFleet object specified for this build that overrides the one defined in the build project.public String toString()
toString
in class Object
Object.toString()
public StartBuildRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()