Interface StartBuildBatchRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CodeBuildRequest.Builder, CopyableBuilder<StartBuildBatchRequest.Builder,StartBuildBatchRequest>, SdkBuilder<StartBuildBatchRequest.Builder,StartBuildBatchRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartBuildBatchRequest

public static interface StartBuildBatchRequest.Builder extends CodeBuildRequest.Builder, SdkPojo, CopyableBuilder<StartBuildBatchRequest.Builder,StartBuildBatchRequest>
  • Method Details

    • projectName

      StartBuildBatchRequest.Builder projectName(String 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 of ProjectSource 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(ProjectSource... secondarySourcesOverride)

      An array of ProjectSource objects that override the secondary sources defined in the batch build project.

      Parameters:
      secondarySourcesOverride - An array of ProjectSource 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 ProjectSource objects that override the secondary sources defined in the batch build project.

      This is a convenience method that creates an instance of the 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<ProjectSource>).

      Parameters:
      secondarySourcesOverride - a consumer that will call methods on ProjectSource.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 of ProjectSourceVersion 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 of ProjectSourceVersion 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 ProjectSourceVersion objects that override the secondary source versions in the batch build project.

      This is a convenience method that creates an instance of the 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<ProjectSourceVersion>).

      Parameters:
      secondarySourcesVersionOverride - a consumer that will call methods on ProjectSourceVersion.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • sourceVersion

      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:

      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 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.

      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 this sourceVersion (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 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.

      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 this sourceVersion (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

      StartBuildBatchRequest.Builder artifactsOverride(ProjectArtifacts artifactsOverride)

      An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

      Parameters:
      artifactsOverride - An array of ProjectArtifacts 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 ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      artifactsOverride - a consumer that will call methods on ProjectArtifacts.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 of ProjectArtifacts 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 of ProjectArtifacts 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 ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.

      This is a convenience method that creates an instance of the 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<ProjectArtifacts>).

      Parameters:
      secondaryArtifactsOverride - a consumer that will call methods on ProjectArtifacts.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 of EnvironmentVariable 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 of EnvironmentVariable 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 EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

      This is a convenience method that creates an instance of the 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<EnvironmentVariable>).

      Parameters:
      environmentVariablesOverride - a consumer that will call methods on EnvironmentVariable.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • sourceTypeOverride

      StartBuildBatchRequest.Builder sourceTypeOverride(String 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

      StartBuildBatchRequest.Builder sourceTypeOverride(SourceType 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

      StartBuildBatchRequest.Builder sourceLocationOverride(String 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

      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.

      Parameters:
      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.
      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 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.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      sourceAuthOverride - a consumer that will call methods on SourceAuth.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • gitCloneDepthOverride

      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.

      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 - A GitSubmodulesConfig 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 GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      gitSubmodulesConfigOverride - a consumer that will call methods on GitSubmodulesConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • buildspecOverride

      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.

      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

      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.

      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, an invalidInputException is thrown.

      The status of a build triggered by a webhook is always reported to your source provider.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • environmentTypeOverride

      StartBuildBatchRequest.Builder environmentTypeOverride(String 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

      StartBuildBatchRequest.Builder environmentTypeOverride(EnvironmentType 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

      StartBuildBatchRequest.Builder imageOverride(String 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

      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.

      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

      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.

      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

      StartBuildBatchRequest.Builder certificateOverride(String 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

      StartBuildBatchRequest.Builder cacheOverride(ProjectCache cacheOverride)

      A ProjectCache object that specifies cache overrides.

      Parameters:
      cacheOverride - A ProjectCache object that specifies cache overrides.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • cacheOverride

      default StartBuildBatchRequest.Builder cacheOverride(Consumer<ProjectCache.Builder> cacheOverride)

      A ProjectCache object that specifies cache overrides.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      cacheOverride - a consumer that will call methods on ProjectCache.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • serviceRoleOverride

      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.

      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

      StartBuildBatchRequest.Builder privilegedModeOverride(Boolean 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

      StartBuildBatchRequest.Builder buildTimeoutInMinutesOverride(Integer 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

      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>).

      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

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • logsConfigOverride

      StartBuildBatchRequest.Builder logsConfigOverride(LogsConfig logsConfigOverride)

      A LogsConfig object that override the log settings defined in the batch build project.

      Parameters:
      logsConfigOverride - A LogsConfig 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 LogsConfig object that override the log settings defined in the batch build project.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      logsConfigOverride - a consumer that will call methods on LogsConfig.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 - A RegistryCredential 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 RegistryCredential object that overrides credentials for access to a private registry.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      registryCredentialOverride - a consumer that will call methods on RegistryCredential.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 use CODEBUILD 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 use CODEBUILD 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 use CODEBUILD 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 use CODEBUILD 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 - A BuildBatchConfigOverride 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 BuildBatchConfigOverride object that contains batch build configuration overrides.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      buildBatchConfigOverride - a consumer that will call methods on ProjectBuildBatchConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • debugSessionEnabled

      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.

      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 interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.