Interface StartBuildBatchRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CodeBuildRequest.Builder
,CopyableBuilder<StartBuildBatchRequest.Builder,
,StartBuildBatchRequest> SdkBuilder<StartBuildBatchRequest.Builder,
,StartBuildBatchRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartBuildBatchRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault StartBuildBatchRequest.Builder
artifactsOverride
(Consumer<ProjectArtifacts.Builder> artifactsOverride) An array ofProjectArtifacts
objects that contains information about the build output artifact overrides for the build project.artifactsOverride
(ProjectArtifacts artifactsOverride) An array ofProjectArtifacts
objects that contains information about the build output artifact overrides for the build project.default StartBuildBatchRequest.Builder
buildBatchConfigOverride
(Consumer<ProjectBuildBatchConfig.Builder> buildBatchConfigOverride) ABuildBatchConfigOverride
object that contains batch build configuration overrides.buildBatchConfigOverride
(ProjectBuildBatchConfig buildBatchConfigOverride) ABuildBatchConfigOverride
object that contains batch build configuration overrides.buildspecOverride
(String buildspecOverride) A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.buildTimeoutInMinutesOverride
(Integer buildTimeoutInMinutesOverride) Overrides the build timeout specified in the batch build project.default StartBuildBatchRequest.Builder
cacheOverride
(Consumer<ProjectCache.Builder> cacheOverride) AProjectCache
object that specifies cache overrides.cacheOverride
(ProjectCache cacheOverride) AProjectCache
object that specifies cache overrides.certificateOverride
(String certificateOverride) The name of a certificate for this batch build that overrides the one specified in the batch build project.computeTypeOverride
(String computeTypeOverride) The name of a compute type for this batch build that overrides the one specified in the batch build project.computeTypeOverride
(ComputeType computeTypeOverride) The name of a compute type for this batch build that overrides the one specified in the batch build project.debugSessionEnabled
(Boolean debugSessionEnabled) Specifies if session debugging is enabled for this batch build.encryptionKeyOverride
(String encryptionKeyOverride) The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project.environmentTypeOverride
(String environmentTypeOverride) A container type for this batch build that overrides the one specified in the batch build project.environmentTypeOverride
(EnvironmentType environmentTypeOverride) A container type for this batch build that overrides the one specified in the batch build project.environmentVariablesOverride
(Collection<EnvironmentVariable> environmentVariablesOverride) An array ofEnvironmentVariable
objects that override, or add to, the environment variables defined in the batch build project.environmentVariablesOverride
(Consumer<EnvironmentVariable.Builder>... environmentVariablesOverride) An array ofEnvironmentVariable
objects that override, or add to, the environment variables defined in the batch build project.environmentVariablesOverride
(EnvironmentVariable... environmentVariablesOverride) An array ofEnvironmentVariable
objects that override, or add to, the environment variables defined in the batch build project.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) AGitSubmodulesConfig
object that overrides the Git submodules configuration for this batch build.gitSubmodulesConfigOverride
(GitSubmodulesConfig gitSubmodulesConfigOverride) AGitSubmodulesConfig
object that overrides the Git submodules configuration for this batch build.idempotencyToken
(String idempotencyToken) A unique, case sensitive identifier you provide to ensure the idempotency of theStartBuildBatch
request.imageOverride
(String imageOverride) The name of an image for this batch build that overrides the one specified in the batch build project.imagePullCredentialsTypeOverride
(String imagePullCredentialsTypeOverride) The type of credentials CodeBuild uses to pull images in your batch build.imagePullCredentialsTypeOverride
(ImagePullCredentialsType imagePullCredentialsTypeOverride) The type of credentials CodeBuild uses to pull images in your batch build.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) ALogsConfig
object that override the log settings defined in the batch build project.logsConfigOverride
(LogsConfig logsConfigOverride) ALogsConfig
object that override the log settings defined in the batch build project.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.privilegedModeOverride
(Boolean privilegedModeOverride) Enable this flag to override privileged mode in the batch build project.projectName
(String projectName) The name of the project.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) ARegistryCredential
object that overrides credentials for access to a private registry.registryCredentialOverride
(RegistryCredential registryCredentialOverride) ARegistryCredential
object that overrides credentials for access to a private registry.reportBuildBatchStatusOverride
(Boolean reportBuildBatchStatusOverride) Set totrue
to report to your source provider the status of a batch build's start and completion.secondaryArtifactsOverride
(Collection<ProjectArtifacts> secondaryArtifactsOverride) An array ofProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.secondaryArtifactsOverride
(Consumer<ProjectArtifacts.Builder>... secondaryArtifactsOverride) An array ofProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.secondaryArtifactsOverride
(ProjectArtifacts... secondaryArtifactsOverride) An array ofProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.secondarySourcesOverride
(Collection<ProjectSource> secondarySourcesOverride) An array ofProjectSource
objects that override the secondary sources defined in the batch build project.secondarySourcesOverride
(Consumer<ProjectSource.Builder>... secondarySourcesOverride) An array ofProjectSource
objects that override the secondary sources defined in the batch build project.secondarySourcesOverride
(ProjectSource... secondarySourcesOverride) An array ofProjectSource
objects that override the secondary sources defined in the batch build project.secondarySourcesVersionOverride
(Collection<ProjectSourceVersion> secondarySourcesVersionOverride) An array ofProjectSourceVersion
objects that override the secondary source versions in the batch build project.secondarySourcesVersionOverride
(Consumer<ProjectSourceVersion.Builder>... secondarySourcesVersionOverride) An array ofProjectSourceVersion
objects that override the secondary source versions in the batch build project.secondarySourcesVersionOverride
(ProjectSourceVersion... secondarySourcesVersionOverride) An array ofProjectSourceVersion
objects that override the secondary source versions in the batch build project.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) ASourceAuth
object that overrides the one defined in the batch build project.sourceAuthOverride
(SourceAuth sourceAuthOverride) ASourceAuth
object that overrides the one defined in the batch build project.sourceLocationOverride
(String sourceLocationOverride) A location that overrides, for this batch build, the source location defined in the batch build project.sourceTypeOverride
(String sourceTypeOverride) The source input type that overrides the source input defined in the batch build project.sourceTypeOverride
(SourceType sourceTypeOverride) The source input type that overrides the source input defined in the batch build project.sourceVersion
(String sourceVersion) The version of the batch build input to be built, for this build only.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.codebuild.model.CodeBuildRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
projectName
The name of the project.
- Parameters:
projectName
- The name of the project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secondarySourcesOverride
StartBuildBatchRequest.Builder secondarySourcesOverride(Collection<ProjectSource> secondarySourcesOverride) An array of
ProjectSource
objects that override the secondary sources defined in the batch build project.- Parameters:
secondarySourcesOverride
- An array ofProjectSource
objects that override the secondary sources defined in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secondarySourcesOverride
An array of
ProjectSource
objects that override the secondary sources defined in the batch build project.- Parameters:
secondarySourcesOverride
- An array ofProjectSource
objects that override the secondary sources defined in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secondarySourcesOverride
StartBuildBatchRequest.Builder secondarySourcesOverride(Consumer<ProjectSource.Builder>... secondarySourcesOverride) An array of
This is a convenience method that creates an instance of theProjectSource
objects that override the secondary sources defined in the batch build project.ProjectSource.Builder
avoiding the need to create one manually viaProjectSource.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosecondarySourcesOverride(List<ProjectSource>)
.- Parameters:
secondarySourcesOverride
- a consumer that will call methods onProjectSource.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
secondarySourcesVersionOverride
StartBuildBatchRequest.Builder secondarySourcesVersionOverride(Collection<ProjectSourceVersion> secondarySourcesVersionOverride) An array of
ProjectSourceVersion
objects that override the secondary source versions in the batch build project.- Parameters:
secondarySourcesVersionOverride
- An array ofProjectSourceVersion
objects that override the secondary source versions in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secondarySourcesVersionOverride
StartBuildBatchRequest.Builder secondarySourcesVersionOverride(ProjectSourceVersion... secondarySourcesVersionOverride) An array of
ProjectSourceVersion
objects that override the secondary source versions in the batch build project.- Parameters:
secondarySourcesVersionOverride
- An array ofProjectSourceVersion
objects that override the secondary source versions in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secondarySourcesVersionOverride
StartBuildBatchRequest.Builder secondarySourcesVersionOverride(Consumer<ProjectSourceVersion.Builder>... secondarySourcesVersionOverride) An array of
This is a convenience method that creates an instance of theProjectSourceVersion
objects that override the secondary source versions in the batch build project.ProjectSourceVersion.Builder
avoiding the need to create one manually viaProjectSourceVersion.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosecondarySourcesVersionOverride(List<ProjectSourceVersion>)
.- Parameters:
secondarySourcesVersionOverride
- a consumer that will call methods onProjectSourceVersion.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
- CodeCommit
-
The commit ID, branch, or Git tag to use.
- GitHub
-
The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format
pr/pull-request-ID
(for examplepr/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. - Bitbucket
-
The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
- Amazon S3
-
The version ID of the object that represents the build input ZIP file to use.
If
sourceVersion
is specified at the project level, then thissourceVersion
(at the build level) takes precedence.For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
- Parameters:
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:- CodeCommit
-
The commit ID, branch, or Git tag to use.
- GitHub
-
The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format
pr/pull-request-ID
(for examplepr/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. - Bitbucket
-
The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
- Amazon S3
-
The version ID of the object that represents the build input ZIP file to use.
If
sourceVersion
is specified at the project level, then thissourceVersion
(at the build level) takes precedence.For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
artifactsOverride
An array of
ProjectArtifacts
objects that contains information about the build output artifact overrides for the build project.- Parameters:
artifactsOverride
- An array ofProjectArtifacts
objects that contains information about the build output artifact overrides for the build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
artifactsOverride
default StartBuildBatchRequest.Builder artifactsOverride(Consumer<ProjectArtifacts.Builder> artifactsOverride) An array of
This is a convenience method that creates an instance of theProjectArtifacts
objects that contains information about the build output artifact overrides for the build project.ProjectArtifacts.Builder
avoiding the need to create one manually viaProjectArtifacts.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toartifactsOverride(ProjectArtifacts)
.- Parameters:
artifactsOverride
- a consumer that will call methods onProjectArtifacts.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
secondaryArtifactsOverride
StartBuildBatchRequest.Builder secondaryArtifactsOverride(Collection<ProjectArtifacts> secondaryArtifactsOverride) An array of
ProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.- Parameters:
secondaryArtifactsOverride
- An array ofProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secondaryArtifactsOverride
StartBuildBatchRequest.Builder secondaryArtifactsOverride(ProjectArtifacts... secondaryArtifactsOverride) An array of
ProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.- Parameters:
secondaryArtifactsOverride
- An array ofProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secondaryArtifactsOverride
StartBuildBatchRequest.Builder secondaryArtifactsOverride(Consumer<ProjectArtifacts.Builder>... secondaryArtifactsOverride) An array of
This is a convenience method that creates an instance of theProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.ProjectArtifacts.Builder
avoiding the need to create one manually viaProjectArtifacts.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosecondaryArtifactsOverride(List<ProjectArtifacts>)
.- Parameters:
secondaryArtifactsOverride
- a consumer that will call methods onProjectArtifacts.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
environmentVariablesOverride
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.- Parameters:
environmentVariablesOverride
- An array ofEnvironmentVariable
objects that override, or add to, the environment variables defined in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environmentVariablesOverride
StartBuildBatchRequest.Builder environmentVariablesOverride(EnvironmentVariable... environmentVariablesOverride) An array of
EnvironmentVariable
objects that override, or add to, the environment variables defined in the batch build project.- Parameters:
environmentVariablesOverride
- An array ofEnvironmentVariable
objects that override, or add to, the environment variables defined in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environmentVariablesOverride
StartBuildBatchRequest.Builder environmentVariablesOverride(Consumer<EnvironmentVariable.Builder>... environmentVariablesOverride) An array of
This is a convenience method that creates an instance of theEnvironmentVariable
objects that override, or add to, the environment variables defined in the batch build project.EnvironmentVariable.Builder
avoiding the need to create one manually viaEnvironmentVariable.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenvironmentVariablesOverride(List<EnvironmentVariable>)
.- Parameters:
environmentVariablesOverride
- a consumer that will call methods onEnvironmentVariable.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceTypeOverride
The source input type that overrides the source input defined in the batch build project.
- Parameters:
sourceTypeOverride
- The source input type that overrides the source input defined in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceTypeOverride
The source input type that overrides the source input defined in the batch build project.
- Parameters:
sourceTypeOverride
- The source input type that overrides the source input defined in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceLocationOverride
A location that overrides, for this batch build, the source location defined in the batch build project.
- Parameters:
sourceLocationOverride
- A location that overrides, for this batch build, the source location defined in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
sourceAuthOverride
- ASourceAuth
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceAuthOverride
default StartBuildBatchRequest.Builder sourceAuthOverride(Consumer<SourceAuth.Builder> sourceAuthOverride) A
This is a convenience method that creates an instance of theSourceAuth
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 viaSourceAuth.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosourceAuthOverride(SourceAuth)
.- Parameters:
sourceAuthOverride
- a consumer that will call methods onSourceAuth.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gitSubmodulesConfigOverride
StartBuildBatchRequest.Builder gitSubmodulesConfigOverride(GitSubmodulesConfig gitSubmodulesConfigOverride) A
GitSubmodulesConfig
object that overrides the Git submodules configuration for this batch build.- Parameters:
gitSubmodulesConfigOverride
- AGitSubmodulesConfig
object that overrides the Git submodules configuration for this batch build.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gitSubmodulesConfigOverride
default StartBuildBatchRequest.Builder gitSubmodulesConfigOverride(Consumer<GitSubmodulesConfig.Builder> gitSubmodulesConfigOverride) A
This is a convenience method that creates an instance of theGitSubmodulesConfig
object that overrides the Git submodules configuration for this batch build.GitSubmodulesConfig.Builder
avoiding the need to create one manually viaGitSubmodulesConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togitSubmodulesConfigOverride(GitSubmodulesConfig)
.- Parameters:
gitSubmodulesConfigOverride
- a consumer that will call methods onGitSubmodulesConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reportBuildBatchStatusOverride
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, aninvalidInputException
is thrown.The status of a build triggered by a webhook is always reported to your source provider.
- Parameters:
reportBuildBatchStatusOverride
- Set totrue
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, aninvalidInputException
is thrown.The status of a build triggered by a webhook is always reported to your source provider.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environmentTypeOverride
A container type for this batch build that overrides the one specified in the batch build project.
- Parameters:
environmentTypeOverride
- A container type for this batch build that overrides the one specified in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
environmentTypeOverride
A container type for this batch build that overrides the one specified in the batch build project.
- Parameters:
environmentTypeOverride
- A container type for this batch build that overrides the one specified in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imageOverride
The name of an image for this batch build that overrides the one specified in the batch build project.
- Parameters:
imageOverride
- The name of an image for this batch build that overrides the one specified in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
computeTypeOverride
The name of a compute type for this batch build that overrides the one specified in the batch build project.
- Parameters:
computeTypeOverride
- The name of a compute type for this batch build that overrides the one specified in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
computeTypeOverride
The name of a compute type for this batch build that overrides the one specified in the batch build project.
- Parameters:
computeTypeOverride
- The name of a compute type for this batch build that overrides the one specified in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
certificateOverride
The name of a certificate for this batch build that overrides the one specified in the batch build project.
- Parameters:
certificateOverride
- The name of a certificate for this batch build that overrides the one specified in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheOverride
A
ProjectCache
object that specifies cache overrides.- Parameters:
cacheOverride
- AProjectCache
object that specifies cache overrides.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheOverride
A
This is a convenience method that creates an instance of theProjectCache
object that specifies cache overrides.ProjectCache.Builder
avoiding the need to create one manually viaProjectCache.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocacheOverride(ProjectCache)
.- Parameters:
cacheOverride
- a consumer that will call methods onProjectCache.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serviceRoleOverride
The name of a service role for this batch build that overrides the one specified in the batch build project.
- Parameters:
serviceRoleOverride
- The name of a service role for this batch build that overrides the one specified in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
privilegedModeOverride
Enable this flag to override privileged mode in the batch build project.
- Parameters:
privilegedModeOverride
- Enable this flag to override privileged mode in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
buildTimeoutInMinutesOverride
Overrides the build timeout specified in the batch build project.
- Parameters:
buildTimeoutInMinutesOverride
- Overrides the build timeout specified in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
queuedTimeoutInMinutesOverride
StartBuildBatchRequest.Builder queuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride) The number of minutes a batch build is allowed to be queued before it times out.
- Parameters:
queuedTimeoutInMinutesOverride
- The number of minutes a batch build is allowed to be queued before it times out.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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>
).- Parameters:
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>
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
idempotencyToken
A unique, case sensitive identifier you provide to ensure the idempotency of the
StartBuildBatch
request. The token is included in theStartBuildBatch
request and is valid for five minutes. If you repeat theStartBuildBatch
request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.- Parameters:
idempotencyToken
- A unique, case sensitive identifier you provide to ensure the idempotency of theStartBuildBatch
request. The token is included in theStartBuildBatch
request and is valid for five minutes. If you repeat theStartBuildBatch
request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logsConfigOverride
A
LogsConfig
object that override the log settings defined in the batch build project.- Parameters:
logsConfigOverride
- ALogsConfig
object that override the log settings defined in the batch build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logsConfigOverride
default StartBuildBatchRequest.Builder logsConfigOverride(Consumer<LogsConfig.Builder> logsConfigOverride) A
This is a convenience method that creates an instance of theLogsConfig
object that override the log settings defined in the batch build project.LogsConfig.Builder
avoiding the need to create one manually viaLogsConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologsConfigOverride(LogsConfig)
.- Parameters:
logsConfigOverride
- a consumer that will call methods onLogsConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
registryCredentialOverride
StartBuildBatchRequest.Builder registryCredentialOverride(RegistryCredential registryCredentialOverride) A
RegistryCredential
object that overrides credentials for access to a private registry.- Parameters:
registryCredentialOverride
- ARegistryCredential
object that overrides credentials for access to a private registry.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
registryCredentialOverride
default StartBuildBatchRequest.Builder registryCredentialOverride(Consumer<RegistryCredential.Builder> registryCredentialOverride) A
This is a convenience method that creates an instance of theRegistryCredential
object that overrides credentials for access to a private registry.RegistryCredential.Builder
avoiding the need to create one manually viaRegistryCredential.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toregistryCredentialOverride(RegistryCredential)
.- Parameters:
registryCredentialOverride
- a consumer that will call methods onRegistryCredential.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imagePullCredentialsTypeOverride
StartBuildBatchRequest.Builder imagePullCredentialsTypeOverride(String imagePullCredentialsTypeOverride) The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:
- CODEBUILD
-
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
- SERVICE_ROLE
-
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 useCODEBUILD
credentials.- Parameters:
imagePullCredentialsTypeOverride
- The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:- CODEBUILD
-
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
- SERVICE_ROLE
-
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 useCODEBUILD
credentials.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imagePullCredentialsTypeOverride
StartBuildBatchRequest.Builder imagePullCredentialsTypeOverride(ImagePullCredentialsType imagePullCredentialsTypeOverride) The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:
- CODEBUILD
-
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
- SERVICE_ROLE
-
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 useCODEBUILD
credentials.- Parameters:
imagePullCredentialsTypeOverride
- The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:- CODEBUILD
-
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
- SERVICE_ROLE
-
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 useCODEBUILD
credentials.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
buildBatchConfigOverride
StartBuildBatchRequest.Builder buildBatchConfigOverride(ProjectBuildBatchConfig buildBatchConfigOverride) A
BuildBatchConfigOverride
object that contains batch build configuration overrides.- Parameters:
buildBatchConfigOverride
- ABuildBatchConfigOverride
object that contains batch build configuration overrides.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
buildBatchConfigOverride
default StartBuildBatchRequest.Builder buildBatchConfigOverride(Consumer<ProjectBuildBatchConfig.Builder> buildBatchConfigOverride) A
This is a convenience method that creates an instance of theBuildBatchConfigOverride
object that contains batch build configuration overrides.ProjectBuildBatchConfig.Builder
avoiding the need to create one manually viaProjectBuildBatchConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobuildBatchConfigOverride(ProjectBuildBatchConfig)
.- Parameters:
buildBatchConfigOverride
- a consumer that will call methods onProjectBuildBatchConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
StartBuildBatchRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartBuildBatchRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-