public static interface StartBuildBatchRequest.Builder extends CodeBuildRequest.Builder, SdkPojo, CopyableBuilder<StartBuildBatchRequest.Builder,StartBuildBatchRequest>
| Modifier and Type | Method and Description |
|---|---|
default StartBuildBatchRequest.Builder |
artifactsOverride(Consumer<ProjectArtifacts.Builder> artifactsOverride)
An array of
ProjectArtifacts objects that contains information about the build output artifact
overrides for the build project. |
StartBuildBatchRequest.Builder |
artifactsOverride(ProjectArtifacts artifactsOverride)
An array of
ProjectArtifacts objects that contains information about the build output artifact
overrides for the build project. |
default StartBuildBatchRequest.Builder |
buildBatchConfigOverride(Consumer<ProjectBuildBatchConfig.Builder> buildBatchConfigOverride)
A
BuildBatchConfigOverride object that contains batch build configuration overrides. |
StartBuildBatchRequest.Builder |
buildBatchConfigOverride(ProjectBuildBatchConfig buildBatchConfigOverride)
A
BuildBatchConfigOverride object that contains batch build configuration overrides. |
StartBuildBatchRequest.Builder |
buildspecOverride(String buildspecOverride)
A buildspec file declaration that overrides, for this build only, the latest one already defined in the build
project.
|
StartBuildBatchRequest.Builder |
buildTimeoutInMinutesOverride(Integer buildTimeoutInMinutesOverride)
Overrides the build timeout specified in the batch build project.
|
default StartBuildBatchRequest.Builder |
cacheOverride(Consumer<ProjectCache.Builder> cacheOverride)
A
ProjectCache object that specifies cache overrides. |
StartBuildBatchRequest.Builder |
cacheOverride(ProjectCache cacheOverride)
A
ProjectCache object that specifies cache overrides. |
StartBuildBatchRequest.Builder |
certificateOverride(String certificateOverride)
The name of a certificate for this batch build that overrides the one specified in the batch build project.
|
StartBuildBatchRequest.Builder |
computeTypeOverride(ComputeType computeTypeOverride)
The name of a compute type for this batch build that overrides the one specified in the batch build project.
|
StartBuildBatchRequest.Builder |
computeTypeOverride(String computeTypeOverride)
The name of a compute type for this batch build that overrides the one specified in the batch build project.
|
StartBuildBatchRequest.Builder |
debugSessionEnabled(Boolean debugSessionEnabled)
Specifies if session debugging is enabled for this batch build.
|
StartBuildBatchRequest.Builder |
encryptionKeyOverride(String encryptionKeyOverride)
The Key Management Service customer master key (CMK) that overrides the one specified in the batch build
project.
|
StartBuildBatchRequest.Builder |
environmentTypeOverride(EnvironmentType environmentTypeOverride)
A container type for this batch build that overrides the one specified in the batch build project.
|
StartBuildBatchRequest.Builder |
environmentTypeOverride(String environmentTypeOverride)
A container type for this batch build that overrides the one specified in the batch build project.
|
StartBuildBatchRequest.Builder |
environmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride)
An array of
EnvironmentVariable objects that override, or add to, the environment variables
defined in the batch build project. |
StartBuildBatchRequest.Builder |
environmentVariablesOverride(Consumer<EnvironmentVariable.Builder>... environmentVariablesOverride)
An array of
EnvironmentVariable objects that override, or add to, the environment variables
defined in the batch build project. |
StartBuildBatchRequest.Builder |
environmentVariablesOverride(EnvironmentVariable... environmentVariablesOverride)
An array of
EnvironmentVariable objects that override, or add to, the environment variables
defined in the batch build project. |
StartBuildBatchRequest.Builder |
gitCloneDepthOverride(Integer gitCloneDepthOverride)
The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any
previous depth of history defined in the batch build project.
|
default StartBuildBatchRequest.Builder |
gitSubmodulesConfigOverride(Consumer<GitSubmodulesConfig.Builder> gitSubmodulesConfigOverride)
A
GitSubmodulesConfig object that overrides the Git submodules configuration for this batch
build. |
StartBuildBatchRequest.Builder |
gitSubmodulesConfigOverride(GitSubmodulesConfig gitSubmodulesConfigOverride)
A
GitSubmodulesConfig object that overrides the Git submodules configuration for this batch
build. |
StartBuildBatchRequest.Builder |
idempotencyToken(String idempotencyToken)
A unique, case sensitive identifier you provide to ensure the idempotency of the
StartBuildBatch
request. |
StartBuildBatchRequest.Builder |
imageOverride(String imageOverride)
The name of an image for this batch build that overrides the one specified in the batch build project.
|
StartBuildBatchRequest.Builder |
imagePullCredentialsTypeOverride(ImagePullCredentialsType imagePullCredentialsTypeOverride)
The type of credentials CodeBuild uses to pull images in your batch build.
|
StartBuildBatchRequest.Builder |
imagePullCredentialsTypeOverride(String imagePullCredentialsTypeOverride)
The type of credentials CodeBuild uses to pull images in your batch build.
|
StartBuildBatchRequest.Builder |
insecureSslOverride(Boolean insecureSslOverride)
Enable this flag to override the insecure SSL setting that is specified in the batch build project.
|
default StartBuildBatchRequest.Builder |
logsConfigOverride(Consumer<LogsConfig.Builder> logsConfigOverride)
A
LogsConfig object that override the log settings defined in the batch build project. |
StartBuildBatchRequest.Builder |
logsConfigOverride(LogsConfig logsConfigOverride)
A
LogsConfig object that override the log settings defined in the batch build project. |
StartBuildBatchRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
StartBuildBatchRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
StartBuildBatchRequest.Builder |
privilegedModeOverride(Boolean privilegedModeOverride)
Enable this flag to override privileged mode in the batch build project.
|
StartBuildBatchRequest.Builder |
projectName(String projectName)
The name of the project.
|
StartBuildBatchRequest.Builder |
queuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride)
The number of minutes a batch build is allowed to be queued before it times out.
|
default StartBuildBatchRequest.Builder |
registryCredentialOverride(Consumer<RegistryCredential.Builder> registryCredentialOverride)
A
RegistryCredential object that overrides credentials for access to a private registry. |
StartBuildBatchRequest.Builder |
registryCredentialOverride(RegistryCredential registryCredentialOverride)
A
RegistryCredential object that overrides credentials for access to a private registry. |
StartBuildBatchRequest.Builder |
reportBuildBatchStatusOverride(Boolean reportBuildBatchStatusOverride)
Set to
true to report to your source provider the status of a batch build's start and
completion. |
StartBuildBatchRequest.Builder |
secondaryArtifactsOverride(Collection<ProjectArtifacts> secondaryArtifactsOverride)
An array of
ProjectArtifacts objects that override the secondary artifacts defined in the batch
build project. |
StartBuildBatchRequest.Builder |
secondaryArtifactsOverride(Consumer<ProjectArtifacts.Builder>... secondaryArtifactsOverride)
An array of
ProjectArtifacts objects that override the secondary artifacts defined in the batch
build project. |
StartBuildBatchRequest.Builder |
secondaryArtifactsOverride(ProjectArtifacts... secondaryArtifactsOverride)
An array of
ProjectArtifacts objects that override the secondary artifacts defined in the batch
build project. |
StartBuildBatchRequest.Builder |
secondarySourcesOverride(Collection<ProjectSource> secondarySourcesOverride)
An array of
ProjectSource objects that override the secondary sources defined in the batch build
project. |
StartBuildBatchRequest.Builder |
secondarySourcesOverride(Consumer<ProjectSource.Builder>... secondarySourcesOverride)
An array of
ProjectSource objects that override the secondary sources defined in the batch build
project. |
StartBuildBatchRequest.Builder |
secondarySourcesOverride(ProjectSource... secondarySourcesOverride)
An array of
ProjectSource objects that override the secondary sources defined in the batch build
project. |
StartBuildBatchRequest.Builder |
secondarySourcesVersionOverride(Collection<ProjectSourceVersion> secondarySourcesVersionOverride)
An array of
ProjectSourceVersion objects that override the secondary source versions in the
batch build project. |
StartBuildBatchRequest.Builder |
secondarySourcesVersionOverride(Consumer<ProjectSourceVersion.Builder>... secondarySourcesVersionOverride)
An array of
ProjectSourceVersion objects that override the secondary source versions in the
batch build project. |
StartBuildBatchRequest.Builder |
secondarySourcesVersionOverride(ProjectSourceVersion... secondarySourcesVersionOverride)
An array of
ProjectSourceVersion objects that override the secondary source versions in the
batch build project. |
StartBuildBatchRequest.Builder |
serviceRoleOverride(String serviceRoleOverride)
The name of a service role for this batch build that overrides the one specified in the batch build project.
|
default StartBuildBatchRequest.Builder |
sourceAuthOverride(Consumer<SourceAuth.Builder> sourceAuthOverride)
A
SourceAuth object that overrides the one defined in the batch build project. |
StartBuildBatchRequest.Builder |
sourceAuthOverride(SourceAuth sourceAuthOverride)
A
SourceAuth object that overrides the one defined in the batch build project. |
StartBuildBatchRequest.Builder |
sourceLocationOverride(String sourceLocationOverride)
A location that overrides, for this batch build, the source location defined in the batch build project.
|
StartBuildBatchRequest.Builder |
sourceTypeOverride(SourceType sourceTypeOverride)
The source input type that overrides the source input defined in the batch build project.
|
StartBuildBatchRequest.Builder |
sourceTypeOverride(String sourceTypeOverride)
The source input type that overrides the source input defined in the batch build project.
|
StartBuildBatchRequest.Builder |
sourceVersion(String sourceVersion)
The version of the batch build input to be built, for this build only.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildStartBuildBatchRequest.Builder projectName(String projectName)
The name of the project.
projectName - The name of the project.StartBuildBatchRequest.Builder secondarySourcesOverride(Collection<ProjectSource> secondarySourcesOverride)
An array of ProjectSource objects that override the secondary sources defined in the batch build
project.
secondarySourcesOverride - An array of ProjectSource objects that override the secondary sources defined in the
batch build project.StartBuildBatchRequest.Builder secondarySourcesOverride(ProjectSource... secondarySourcesOverride)
An array of ProjectSource objects that override the secondary sources defined in the batch build
project.
secondarySourcesOverride - An array of ProjectSource objects that override the secondary sources defined in the
batch build project.StartBuildBatchRequest.Builder secondarySourcesOverride(Consumer<ProjectSource.Builder>... secondarySourcesOverride)
An array of ProjectSource objects that override the secondary sources defined in the batch build
project.
ProjectSource.Builder avoiding the need to create one
manually via ProjectSource.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately
and its result is passed to #secondarySourcesOverride(List.
secondarySourcesOverride - a consumer that will call methods on
ProjectSource.Builder#secondarySourcesOverride(java.util.Collection) StartBuildBatchRequest.Builder secondarySourcesVersionOverride(Collection<ProjectSourceVersion> secondarySourcesVersionOverride)
An array of ProjectSourceVersion objects that override the secondary source versions in the
batch build project.
secondarySourcesVersionOverride - An array of ProjectSourceVersion objects that override the secondary source versions in
the batch build project.StartBuildBatchRequest.Builder secondarySourcesVersionOverride(ProjectSourceVersion... secondarySourcesVersionOverride)
An array of ProjectSourceVersion objects that override the secondary source versions in the
batch build project.
secondarySourcesVersionOverride - An array of ProjectSourceVersion objects that override the secondary source versions in
the batch build project.StartBuildBatchRequest.Builder secondarySourcesVersionOverride(Consumer<ProjectSourceVersion.Builder>... secondarySourcesVersionOverride)
An array of ProjectSourceVersion objects that override the secondary source versions in the
batch build project.
ProjectSourceVersion.Builder avoiding the need to
create one manually via
ProjectSourceVersion.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #secondarySourcesVersionOverride(List.
secondarySourcesVersionOverride - a consumer that will call methods on
ProjectSourceVersion.Builder#secondarySourcesVersionOverride(java.util.Collection) StartBuildBatchRequest.Builder sourceVersion(String sourceVersion)
The version of the batch 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 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 batch 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 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.
StartBuildBatchRequest.Builder artifactsOverride(ProjectArtifacts artifactsOverride)
An array of ProjectArtifacts objects that contains information about the build output artifact
overrides for the build project.
artifactsOverride - An array of ProjectArtifacts objects that contains information about the build output
artifact overrides for the build project.default StartBuildBatchRequest.Builder artifactsOverride(Consumer<ProjectArtifacts.Builder> artifactsOverride)
An array of ProjectArtifacts objects that contains information about the build output artifact
overrides for the build project.
ProjectArtifacts.Builder avoiding the
need to create one manually via ProjectArtifacts.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to artifactsOverride(ProjectArtifacts).
artifactsOverride - a consumer that will call methods on ProjectArtifacts.BuilderartifactsOverride(ProjectArtifacts)StartBuildBatchRequest.Builder secondaryArtifactsOverride(Collection<ProjectArtifacts> secondaryArtifactsOverride)
An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch
build project.
secondaryArtifactsOverride - An array of ProjectArtifacts objects that override the secondary artifacts defined in the
batch build project.StartBuildBatchRequest.Builder secondaryArtifactsOverride(ProjectArtifacts... secondaryArtifactsOverride)
An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch
build project.
secondaryArtifactsOverride - An array of ProjectArtifacts objects that override the secondary artifacts defined in the
batch build project.StartBuildBatchRequest.Builder secondaryArtifactsOverride(Consumer<ProjectArtifacts.Builder>... secondaryArtifactsOverride)
An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch
build project.
ProjectArtifacts.Builder avoiding the need to create
one manually via ProjectArtifacts.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #secondaryArtifactsOverride(List.
secondaryArtifactsOverride - a consumer that will call methods on
ProjectArtifacts.Builder#secondaryArtifactsOverride(java.util.Collection) StartBuildBatchRequest.Builder environmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride)
An array of EnvironmentVariable objects that override, or add to, the environment variables
defined in the batch build project.
environmentVariablesOverride - An array of EnvironmentVariable objects that override, or add to, the environment
variables defined in the batch build project.StartBuildBatchRequest.Builder environmentVariablesOverride(EnvironmentVariable... environmentVariablesOverride)
An array of EnvironmentVariable objects that override, or add to, the environment variables
defined in the batch build project.
environmentVariablesOverride - An array of EnvironmentVariable objects that override, or add to, the environment
variables defined in the batch build project.StartBuildBatchRequest.Builder environmentVariablesOverride(Consumer<EnvironmentVariable.Builder>... environmentVariablesOverride)
An array of EnvironmentVariable objects that override, or add to, the environment variables
defined in the batch build project.
EnvironmentVariable.Builder avoiding the need to
create one manually via EnvironmentVariable.builder()
.
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #environmentVariablesOverride(List.
environmentVariablesOverride - a consumer that will call methods on
EnvironmentVariable.Builder#environmentVariablesOverride(java.util.Collection) StartBuildBatchRequest.Builder sourceTypeOverride(String sourceTypeOverride)
The source input type that overrides the source input defined in the batch build project.
sourceTypeOverride - The source input type that overrides the source input defined in the batch build project.SourceType,
SourceTypeStartBuildBatchRequest.Builder sourceTypeOverride(SourceType sourceTypeOverride)
The source input type that overrides the source input defined in the batch build project.
sourceTypeOverride - The source input type that overrides the source input defined in the batch build project.SourceType,
SourceTypeStartBuildBatchRequest.Builder sourceLocationOverride(String sourceLocationOverride)
A location that overrides, for this batch build, the source location defined in the batch build project.
sourceLocationOverride - A location that overrides, for this batch build, the source location defined in the batch build
project.StartBuildBatchRequest.Builder sourceAuthOverride(SourceAuth sourceAuthOverride)
A SourceAuth object that overrides the one defined in the batch build project. This override
applies only if the build project's source is BitBucket or GitHub.
sourceAuthOverride - A SourceAuth object that overrides the one defined in the batch build project. This
override applies only if the build project's source is BitBucket or GitHub.default StartBuildBatchRequest.Builder sourceAuthOverride(Consumer<SourceAuth.Builder> sourceAuthOverride)
A SourceAuth object that overrides the one defined in the batch build project. This override
applies only if the build project's source is BitBucket or GitHub.
SourceAuth.Builder avoiding the need to
create one manually via SourceAuth.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to sourceAuthOverride(SourceAuth).
sourceAuthOverride - a consumer that will call methods on SourceAuth.BuildersourceAuthOverride(SourceAuth)StartBuildBatchRequest.Builder gitCloneDepthOverride(Integer gitCloneDepthOverride)
The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.
gitCloneDepthOverride - The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build
only, any previous depth of history defined in the batch build project.StartBuildBatchRequest.Builder gitSubmodulesConfigOverride(GitSubmodulesConfig gitSubmodulesConfigOverride)
A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch
build.
gitSubmodulesConfigOverride - A GitSubmodulesConfig object that overrides the Git submodules configuration for this
batch build.default StartBuildBatchRequest.Builder gitSubmodulesConfigOverride(Consumer<GitSubmodulesConfig.Builder> gitSubmodulesConfigOverride)
A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch
build.
GitSubmodulesConfig.Builder avoiding the
need to create one manually via GitSubmodulesConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to gitSubmodulesConfigOverride(GitSubmodulesConfig).
gitSubmodulesConfigOverride - a consumer that will call methods on GitSubmodulesConfig.BuildergitSubmodulesConfigOverride(GitSubmodulesConfig)StartBuildBatchRequest.Builder buildspecOverride(String buildspecOverride)
A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
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.
buildspecOverride - A buildspec file declaration that overrides, for this build only, the latest one already defined in
the build project.
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.
StartBuildBatchRequest.Builder insecureSslOverride(Boolean insecureSslOverride)
Enable this flag to override the insecure SSL setting that is specified in the batch 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 batch 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.StartBuildBatchRequest.Builder reportBuildBatchStatusOverride(Boolean reportBuildBatchStatusOverride)
Set to true to report to your source provider the status of a batch 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.
The status of a build triggered by a webhook is always reported to your source provider.
reportBuildBatchStatusOverride - Set to true to report to your source provider the status of a batch 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. The status of a build triggered by a webhook is always reported to your source provider.
StartBuildBatchRequest.Builder environmentTypeOverride(String environmentTypeOverride)
A container type for this batch build that overrides the one specified in the batch build project.
environmentTypeOverride - A container type for this batch build that overrides the one specified in the batch build project.EnvironmentType,
EnvironmentTypeStartBuildBatchRequest.Builder environmentTypeOverride(EnvironmentType environmentTypeOverride)
A container type for this batch build that overrides the one specified in the batch build project.
environmentTypeOverride - A container type for this batch build that overrides the one specified in the batch build project.EnvironmentType,
EnvironmentTypeStartBuildBatchRequest.Builder imageOverride(String imageOverride)
The name of an image for this batch build that overrides the one specified in the batch build project.
imageOverride - The name of an image for this batch build that overrides the one specified in the batch build project.StartBuildBatchRequest.Builder computeTypeOverride(String computeTypeOverride)
The name of a compute type for this batch build that overrides the one specified in the batch build project.
computeTypeOverride - The name of a compute type for this batch build that overrides the one specified in the batch build
project.ComputeType,
ComputeTypeStartBuildBatchRequest.Builder computeTypeOverride(ComputeType computeTypeOverride)
The name of a compute type for this batch build that overrides the one specified in the batch build project.
computeTypeOverride - The name of a compute type for this batch build that overrides the one specified in the batch build
project.ComputeType,
ComputeTypeStartBuildBatchRequest.Builder certificateOverride(String certificateOverride)
The name of a certificate for this batch build that overrides the one specified in the batch build project.
certificateOverride - The name of a certificate for this batch build that overrides the one specified in the batch build
project.StartBuildBatchRequest.Builder cacheOverride(ProjectCache cacheOverride)
A ProjectCache object that specifies cache overrides.
cacheOverride - A ProjectCache object that specifies cache overrides.default StartBuildBatchRequest.Builder cacheOverride(Consumer<ProjectCache.Builder> cacheOverride)
A ProjectCache object that specifies cache overrides.
ProjectCache.Builder avoiding the need
to create one manually via ProjectCache.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to cacheOverride(ProjectCache).
cacheOverride - a consumer that will call methods on ProjectCache.BuildercacheOverride(ProjectCache)StartBuildBatchRequest.Builder serviceRoleOverride(String serviceRoleOverride)
The name of a service role for this batch build that overrides the one specified in the batch build project.
serviceRoleOverride - The name of a service role for this batch build that overrides the one specified in the batch build
project.StartBuildBatchRequest.Builder privilegedModeOverride(Boolean privilegedModeOverride)
Enable this flag to override privileged mode in the batch build project.
privilegedModeOverride - Enable this flag to override privileged mode in the batch build project.StartBuildBatchRequest.Builder buildTimeoutInMinutesOverride(Integer buildTimeoutInMinutesOverride)
Overrides the build timeout specified in the batch build project.
buildTimeoutInMinutesOverride - Overrides the build timeout specified in the batch build project.StartBuildBatchRequest.Builder queuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride)
The number of minutes a batch build is allowed to be queued before it times out.
queuedTimeoutInMinutesOverride - The number of minutes a batch build is allowed to be queued before it times out.StartBuildBatchRequest.Builder encryptionKeyOverride(String encryptionKeyOverride)
The Key Management Service customer master key (CMK) that overrides the one specified in the batch 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 batch
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>).
StartBuildBatchRequest.Builder idempotencyToken(String idempotencyToken)
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch
request. The token is included in the StartBuildBatch request and is valid for five minutes. If
you repeat the StartBuildBatch 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
StartBuildBatch request. The token is included in the StartBuildBatch
request and is valid for five minutes. If you repeat the StartBuildBatch request with the
same token, but change a parameter, CodeBuild returns a parameter mismatch error.StartBuildBatchRequest.Builder logsConfigOverride(LogsConfig logsConfigOverride)
A LogsConfig object that override the log settings defined in the batch build project.
logsConfigOverride - A LogsConfig object that override the log settings defined in the batch build project.default StartBuildBatchRequest.Builder logsConfigOverride(Consumer<LogsConfig.Builder> logsConfigOverride)
A LogsConfig object that override the log settings defined in the batch build project.
LogsConfig.Builder avoiding the need to
create one manually via LogsConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to logsConfigOverride(LogsConfig).
logsConfigOverride - a consumer that will call methods on LogsConfig.BuilderlogsConfigOverride(LogsConfig)StartBuildBatchRequest.Builder registryCredentialOverride(RegistryCredential registryCredentialOverride)
A RegistryCredential object that overrides credentials for access to a private registry.
registryCredentialOverride - A RegistryCredential object that overrides credentials for access to a private registry.default StartBuildBatchRequest.Builder registryCredentialOverride(Consumer<RegistryCredential.Builder> registryCredentialOverride)
A RegistryCredential object that overrides credentials for access to a private registry.
RegistryCredential.Builder avoiding the
need to create one manually via RegistryCredential.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to registryCredentialOverride(RegistryCredential).
registryCredentialOverride - a consumer that will call methods on RegistryCredential.BuilderregistryCredentialOverride(RegistryCredential)StartBuildBatchRequest.Builder imagePullCredentialsTypeOverride(String imagePullCredentialsTypeOverride)
The type of credentials CodeBuild uses to pull images in your batch 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 batch 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,
ImagePullCredentialsTypeStartBuildBatchRequest.Builder imagePullCredentialsTypeOverride(ImagePullCredentialsType imagePullCredentialsTypeOverride)
The type of credentials CodeBuild uses to pull images in your batch 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 batch 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,
ImagePullCredentialsTypeStartBuildBatchRequest.Builder buildBatchConfigOverride(ProjectBuildBatchConfig buildBatchConfigOverride)
A BuildBatchConfigOverride object that contains batch build configuration overrides.
buildBatchConfigOverride - A BuildBatchConfigOverride object that contains batch build configuration overrides.default StartBuildBatchRequest.Builder buildBatchConfigOverride(Consumer<ProjectBuildBatchConfig.Builder> buildBatchConfigOverride)
A BuildBatchConfigOverride object that contains batch build configuration overrides.
ProjectBuildBatchConfig.Builder avoiding
the need to create one manually via ProjectBuildBatchConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to buildBatchConfigOverride(ProjectBuildBatchConfig).
buildBatchConfigOverride - a consumer that will call methods on ProjectBuildBatchConfig.BuilderbuildBatchConfigOverride(ProjectBuildBatchConfig)StartBuildBatchRequest.Builder debugSessionEnabled(Boolean debugSessionEnabled)
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.
debugSessionEnabled - 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.StartBuildBatchRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderStartBuildBatchRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.