public static interface StartBuildRequest.Builder extends CodeBuildRequest.Builder, SdkPojo, CopyableBuilder<StartBuildRequest.Builder,StartBuildRequest>
| Modifier and Type | Method and Description |
|---|---|
default StartBuildRequest.Builder |
artifactsOverride(Consumer<ProjectArtifacts.Builder> artifactsOverride)
Build output artifact settings that override, for this build only, the latest ones already defined in the
build project.
|
StartBuildRequest.Builder |
artifactsOverride(ProjectArtifacts artifactsOverride)
Build output artifact settings that override, for this build only, the latest ones already defined in the
build project.
|
StartBuildRequest.Builder |
buildspecOverride(String buildspecOverride)
A buildspec file declaration that overrides, for this build only, the latest one already defined in the build
project.
|
StartBuildRequest.Builder |
buildStatusConfigOverride(BuildStatusConfig buildStatusConfigOverride)
Contains information that defines how the build project reports the build status to the source provider.
|
default StartBuildRequest.Builder |
buildStatusConfigOverride(Consumer<BuildStatusConfig.Builder> buildStatusConfigOverride)
Contains information that defines how the build project reports the build status to the source provider.
|
default StartBuildRequest.Builder |
cacheOverride(Consumer<ProjectCache.Builder> cacheOverride)
A ProjectCache object specified for this build that overrides the one defined in the build project.
|
StartBuildRequest.Builder |
cacheOverride(ProjectCache cacheOverride)
A ProjectCache object specified for this build that overrides the one defined in the build project.
|
StartBuildRequest.Builder |
certificateOverride(String certificateOverride)
The name of a certificate for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
computeTypeOverride(ComputeType computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
computeTypeOverride(String computeTypeOverride)
The name of a compute type for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
debugSessionEnabled(Boolean debugSessionEnabled)
Specifies if session debugging is enabled for this build.
|
StartBuildRequest.Builder |
encryptionKeyOverride(String encryptionKeyOverride)
The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the
build project.
|
StartBuildRequest.Builder |
environmentTypeOverride(EnvironmentType environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
environmentTypeOverride(String environmentTypeOverride)
A container type for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
environmentVariablesOverride(Collection<EnvironmentVariable> environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the
build project.
|
StartBuildRequest.Builder |
environmentVariablesOverride(Consumer<EnvironmentVariable.Builder>... environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the
build project.
|
StartBuildRequest.Builder |
environmentVariablesOverride(EnvironmentVariable... environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the
build project.
|
StartBuildRequest.Builder |
gitCloneDepthOverride(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.
|
default StartBuildRequest.Builder |
gitSubmodulesConfigOverride(Consumer<GitSubmodulesConfig.Builder> gitSubmodulesConfigOverride)
Information about the Git submodules configuration for this build of an AWS CodeBuild build project.
|
StartBuildRequest.Builder |
gitSubmodulesConfigOverride(GitSubmodulesConfig gitSubmodulesConfigOverride)
Information about the Git submodules configuration for this build of an AWS CodeBuild build project.
|
StartBuildRequest.Builder |
idempotencyToken(String idempotencyToken)
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request.
|
StartBuildRequest.Builder |
imageOverride(String imageOverride)
The name of an image for this build that overrides the one specified in the build project.
|
StartBuildRequest.Builder |
imagePullCredentialsTypeOverride(ImagePullCredentialsType imagePullCredentialsTypeOverride)
The type of credentials AWS CodeBuild uses to pull images in your build.
|
StartBuildRequest.Builder |
imagePullCredentialsTypeOverride(String imagePullCredentialsTypeOverride)
The type of credentials AWS CodeBuild uses to pull images in your build.
|
StartBuildRequest.Builder |
insecureSslOverride(Boolean insecureSslOverride)
Enable this flag to override the insecure SSL setting that is specified in the build project.
|
default StartBuildRequest.Builder |
logsConfigOverride(Consumer<LogsConfig.Builder> logsConfigOverride)
Log settings for this build that override the log settings defined in the build project.
|
StartBuildRequest.Builder |
logsConfigOverride(LogsConfig logsConfigOverride)
Log settings for this build that override the log settings defined in the build project.
|
StartBuildRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
StartBuildRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
StartBuildRequest.Builder |
privilegedModeOverride(Boolean privilegedModeOverride)
Enable this flag to override privileged mode in the build project.
|
StartBuildRequest.Builder |
projectName(String projectName)
The name of the AWS CodeBuild build project to start running a build.
|
StartBuildRequest.Builder |
queuedTimeoutInMinutesOverride(Integer queuedTimeoutInMinutesOverride)
The number of minutes a build is allowed to be queued before it times out.
|
default StartBuildRequest.Builder |
registryCredentialOverride(Consumer<RegistryCredential.Builder> registryCredentialOverride)
The credentials for access to a private registry.
|
StartBuildRequest.Builder |
registryCredentialOverride(RegistryCredential registryCredentialOverride)
The credentials for access to a private registry.
|
StartBuildRequest.Builder |
reportBuildStatusOverride(Boolean reportBuildStatusOverride)
Set to true to report to your source provider the status of a build's start and completion.
|
StartBuildRequest.Builder |
secondaryArtifactsOverride(Collection<ProjectArtifacts> secondaryArtifactsOverride)
An array of
ProjectArtifacts objects. |
StartBuildRequest.Builder |
secondaryArtifactsOverride(Consumer<ProjectArtifacts.Builder>... secondaryArtifactsOverride)
An array of
ProjectArtifacts objects. |
StartBuildRequest.Builder |
secondaryArtifactsOverride(ProjectArtifacts... secondaryArtifactsOverride)
An array of
ProjectArtifacts objects. |
StartBuildRequest.Builder |
secondarySourcesOverride(Collection<ProjectSource> secondarySourcesOverride)
An array of
ProjectSource objects. |
StartBuildRequest.Builder |
secondarySourcesOverride(Consumer<ProjectSource.Builder>... secondarySourcesOverride)
An array of
ProjectSource objects. |
StartBuildRequest.Builder |
secondarySourcesOverride(ProjectSource... secondarySourcesOverride)
An array of
ProjectSource objects. |
StartBuildRequest.Builder |
secondarySourcesVersionOverride(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.Builder |
secondarySourcesVersionOverride(Consumer<ProjectSourceVersion.Builder>... 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.Builder |
secondarySourcesVersionOverride(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.Builder |
serviceRoleOverride(String serviceRoleOverride)
The name of a service role for this build that overrides the one specified in the build project.
|
default StartBuildRequest.Builder |
sourceAuthOverride(Consumer<SourceAuth.Builder> sourceAuthOverride)
An authorization type for this build that overrides the one defined in the build project.
|
StartBuildRequest.Builder |
sourceAuthOverride(SourceAuth sourceAuthOverride)
An authorization type for this build that overrides the one defined in the build project.
|
StartBuildRequest.Builder |
sourceLocationOverride(String sourceLocationOverride)
A location that overrides, for this build, the source location for the one defined in the build project.
|
StartBuildRequest.Builder |
sourceTypeOverride(SourceType sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
|
StartBuildRequest.Builder |
sourceTypeOverride(String sourceTypeOverride)
A source input type, for this build, that overrides the source input defined in the build project.
|
StartBuildRequest.Builder |
sourceVersion(String sourceVersion)
The version of the build input to be built, for this build only.
|
StartBuildRequest.Builder |
timeoutInMinutesOverride(Integer timeoutInMinutesOverride)
The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest
setting already defined in the build project.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildStartBuildRequest.Builder projectName(String projectName)
The name of the AWS CodeBuild build project to start running a build.
projectName - The name of the AWS CodeBuild build project to start running a build.StartBuildRequest.Builder secondarySourcesOverride(Collection<ProjectSource> secondarySourcesOverride)
An array of ProjectSource objects.
secondarySourcesOverride - An array of ProjectSource objects.StartBuildRequest.Builder secondarySourcesOverride(ProjectSource... secondarySourcesOverride)
An array of ProjectSource objects.
secondarySourcesOverride - An array of ProjectSource objects.StartBuildRequest.Builder secondarySourcesOverride(Consumer<ProjectSource.Builder>... secondarySourcesOverride)
An array of ProjectSource objects.
List.Builder avoiding the need
to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #secondarySourcesOverride(List) .secondarySourcesOverride - a consumer that will call methods on List.Builder #secondarySourcesOverride(List) StartBuildRequest.Builder secondarySourcesVersionOverride(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.StartBuildRequest.Builder secondarySourcesVersionOverride(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.StartBuildRequest.Builder secondarySourcesVersionOverride(Consumer<ProjectSourceVersion.Builder>... 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.
List.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately
and its result is passed to #secondarySourcesVersionOverride(List) .secondarySourcesVersionOverride - a consumer that will call methods on List.Builder #secondarySourcesVersionOverride(List) StartBuildRequest.Builder sourceVersion(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 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 AWS 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 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 AWS CodeBuild User Guide.
StartBuildRequest.Builder artifactsOverride(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.default StartBuildRequest.Builder artifactsOverride(Consumer<ProjectArtifacts.Builder> artifactsOverride)
Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
This is a convenience that creates an instance of theProjectArtifacts.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)StartBuildRequest.Builder secondaryArtifactsOverride(Collection<ProjectArtifacts> secondaryArtifactsOverride)
An array of ProjectArtifacts objects.
secondaryArtifactsOverride - An array of ProjectArtifacts objects.StartBuildRequest.Builder secondaryArtifactsOverride(ProjectArtifacts... secondaryArtifactsOverride)
An array of ProjectArtifacts objects.
secondaryArtifactsOverride - An array of ProjectArtifacts objects.StartBuildRequest.Builder secondaryArtifactsOverride(Consumer<ProjectArtifacts.Builder>... secondaryArtifactsOverride)
An array of ProjectArtifacts objects.
List.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #secondaryArtifactsOverride(List) .secondaryArtifactsOverride - a consumer that will call methods on List.Builder #secondaryArtifactsOverride(List) StartBuildRequest.Builder environmentVariablesOverride(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.StartBuildRequest.Builder environmentVariablesOverride(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.StartBuildRequest.Builder environmentVariablesOverride(Consumer<EnvironmentVariable.Builder>... environmentVariablesOverride)
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
This is a convenience that creates an instance of theList.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately
and its result is passed to #environmentVariablesOverride(List) .environmentVariablesOverride - a consumer that will call methods on List.Builder #environmentVariablesOverride(List) StartBuildRequest.Builder sourceTypeOverride(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,
SourceTypeStartBuildRequest.Builder sourceTypeOverride(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,
SourceTypeStartBuildRequest.Builder sourceLocationOverride(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.StartBuildRequest.Builder sourceAuthOverride(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 or GitHub.
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 or GitHub.default StartBuildRequest.Builder sourceAuthOverride(Consumer<SourceAuth.Builder> 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 or GitHub.
This is a convenience that creates an instance of theSourceAuth.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)StartBuildRequest.Builder gitCloneDepthOverride(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.StartBuildRequest.Builder gitSubmodulesConfigOverride(GitSubmodulesConfig gitSubmodulesConfigOverride)
Information about the Git submodules configuration for this build of an AWS CodeBuild build project.
gitSubmodulesConfigOverride - Information about the Git submodules configuration for this build of an AWS CodeBuild build project.default StartBuildRequest.Builder gitSubmodulesConfigOverride(Consumer<GitSubmodulesConfig.Builder> gitSubmodulesConfigOverride)
Information about the Git submodules configuration for this build of an AWS CodeBuild build project.
This is a convenience that creates an instance of theGitSubmodulesConfig.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)StartBuildRequest.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 AWS 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 AWS 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.
StartBuildRequest.Builder insecureSslOverride(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.StartBuildRequest.Builder reportBuildStatusOverride(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 AWS 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 AWS CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
StartBuildRequest.Builder buildStatusConfigOverride(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.default StartBuildRequest.Builder buildStatusConfigOverride(Consumer<BuildStatusConfig.Builder> 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.
BuildStatusConfig.Builder avoiding the need to
create one manually via BuildStatusConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to buildStatusConfigOverride(BuildStatusConfig).buildStatusConfigOverride - a consumer that will call methods on BuildStatusConfig.BuilderbuildStatusConfigOverride(BuildStatusConfig)StartBuildRequest.Builder environmentTypeOverride(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,
EnvironmentTypeStartBuildRequest.Builder environmentTypeOverride(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,
EnvironmentTypeStartBuildRequest.Builder imageOverride(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.StartBuildRequest.Builder computeTypeOverride(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,
ComputeTypeStartBuildRequest.Builder computeTypeOverride(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,
ComputeTypeStartBuildRequest.Builder certificateOverride(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.StartBuildRequest.Builder cacheOverride(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.default StartBuildRequest.Builder cacheOverride(Consumer<ProjectCache.Builder> cacheOverride)
A ProjectCache object specified for this build that overrides the one defined in the build project.
This is a convenience that creates an instance of theProjectCache.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)StartBuildRequest.Builder serviceRoleOverride(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.StartBuildRequest.Builder privilegedModeOverride(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.StartBuildRequest.Builder timeoutInMinutesOverride(Integer timeoutInMinutesOverride)
The number of build timeout minutes, from 5 to 480 (8 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 480 (8 hours), that overrides, for this build only, the
latest setting already defined in the build project.StartBuildRequest.Builder queuedTimeoutInMinutesOverride(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.StartBuildRequest.Builder encryptionKeyOverride(String encryptionKeyOverride)
The AWS Key Management Service (AWS KMS) 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 AWS Key Management Service (AWS KMS) 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>).
StartBuildRequest.Builder idempotencyToken(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, AWS 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, AWS CodeBuild returns a parameter
mismatch error.StartBuildRequest.Builder logsConfigOverride(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.default StartBuildRequest.Builder logsConfigOverride(Consumer<LogsConfig.Builder> logsConfigOverride)
Log settings for this build that override the log settings defined in the build project.
This is a convenience that creates an instance of theLogsConfig.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)StartBuildRequest.Builder registryCredentialOverride(RegistryCredential registryCredentialOverride)
The credentials for access to a private registry.
registryCredentialOverride - The credentials for access to a private registry.default StartBuildRequest.Builder registryCredentialOverride(Consumer<RegistryCredential.Builder> registryCredentialOverride)
The credentials for access to a private registry.
This is a convenience that creates an instance of theRegistryCredential.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)StartBuildRequest.Builder imagePullCredentialsTypeOverride(String imagePullCredentialsTypeOverride)
The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS 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 AWS CodeBuild curated image, you must use CODEBUILD credentials.
imagePullCredentialsTypeOverride - The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS 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 AWS CodeBuild curated image, you must use CODEBUILD
credentials.
ImagePullCredentialsType,
ImagePullCredentialsTypeStartBuildRequest.Builder imagePullCredentialsTypeOverride(ImagePullCredentialsType imagePullCredentialsTypeOverride)
The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS 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 AWS CodeBuild curated image, you must use CODEBUILD credentials.
imagePullCredentialsTypeOverride - The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS 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 AWS CodeBuild curated image, you must use CODEBUILD
credentials.
ImagePullCredentialsType,
ImagePullCredentialsTypeStartBuildRequest.Builder debugSessionEnabled(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.StartBuildRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderStartBuildRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.