Package software.amazon.awssdk.services.codebuild.model

Interface StartBuildRequest.Builder

    • Method Detail

      • projectName

        StartBuildRequest.Builder projectName​(String projectName)

        The name of the CodeBuild build project to start running a build.

        Parameters:
        projectName - The name of the CodeBuild build project to start running a build.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondarySourcesOverride

        StartBuildRequest.Builder secondarySourcesOverride​(Collection<ProjectSource> secondarySourcesOverride)

        An array of ProjectSource objects.

        Parameters:
        secondarySourcesOverride - An array of ProjectSource objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondarySourcesOverride

        StartBuildRequest.Builder secondarySourcesOverride​(ProjectSource... secondarySourcesOverride)

        An array of ProjectSource objects.

        Parameters:
        secondarySourcesOverride - An array of ProjectSource objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondarySourcesVersionOverride

        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.

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

      • secondarySourcesVersionOverride

        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.

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

      • secondarySourcesVersionOverride

        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.

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

        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:
        #secondarySourcesVersionOverride(java.util.Collection)

      • sourceVersion

        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:

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

        StartBuildRequest.Builder artifactsOverride​(ProjectArtifacts artifactsOverride)

        Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

        Parameters:
        artifactsOverride - Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondaryArtifactsOverride

        StartBuildRequest.Builder secondaryArtifactsOverride​(Collection<ProjectArtifacts> secondaryArtifactsOverride)

        An array of ProjectArtifacts objects.

        Parameters:
        secondaryArtifactsOverride - An array of ProjectArtifacts objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • secondaryArtifactsOverride

        StartBuildRequest.Builder secondaryArtifactsOverride​(ProjectArtifacts... secondaryArtifactsOverride)

        An array of ProjectArtifacts objects.

        Parameters:
        secondaryArtifactsOverride - An array of ProjectArtifacts objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environmentVariablesOverride

        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.

        Parameters:
        environmentVariablesOverride - A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environmentVariablesOverride

        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.

        Parameters:
        environmentVariablesOverride - A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceTypeOverride

        StartBuildRequest.Builder sourceTypeOverride​(String sourceTypeOverride)

        A source input type, for this build, that overrides the source input defined in the build project.

        Parameters:
        sourceTypeOverride - A source input type, for this build, that overrides the source input defined in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SourceType, SourceType

      • sourceTypeOverride

        StartBuildRequest.Builder sourceTypeOverride​(SourceType sourceTypeOverride)

        A source input type, for this build, that overrides the source input defined in the build project.

        Parameters:
        sourceTypeOverride - A source input type, for this build, that overrides the source input defined in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SourceType, SourceType

      • sourceLocationOverride

        StartBuildRequest.Builder sourceLocationOverride​(String sourceLocationOverride)

        A location that overrides, for this build, the source location for the one defined in the build project.

        Parameters:
        sourceLocationOverride - A location that overrides, for this build, the source location for the one defined in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceAuthOverride

        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.

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

      • gitCloneDepthOverride

        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.

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

      • gitSubmodulesConfigOverride

        StartBuildRequest.Builder gitSubmodulesConfigOverride​(GitSubmodulesConfig gitSubmodulesConfigOverride)

        Information about the Git submodules configuration for this build of an CodeBuild build project.

        Parameters:
        gitSubmodulesConfigOverride - Information about the Git submodules configuration for this build of an CodeBuild build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • buildspecOverride

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

        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.

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

      • reportBuildStatusOverride

        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 CodeBuild User Guide.

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

        Parameters:
        reportBuildStatusOverride - Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

        To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.

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

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

      • buildStatusConfigOverride

        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.

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

      • environmentTypeOverride

        StartBuildRequest.Builder environmentTypeOverride​(String environmentTypeOverride)

        A container type for this build that overrides the one specified in the build project.

        Parameters:
        environmentTypeOverride - A container type for this build that overrides the one specified in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EnvironmentType, EnvironmentType

      • environmentTypeOverride

        StartBuildRequest.Builder environmentTypeOverride​(EnvironmentType environmentTypeOverride)

        A container type for this build that overrides the one specified in the build project.

        Parameters:
        environmentTypeOverride - A container type for this build that overrides the one specified in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EnvironmentType, EnvironmentType

      • imageOverride

        StartBuildRequest.Builder imageOverride​(String imageOverride)

        The name of an image for this build that overrides the one specified in the build project.

        Parameters:
        imageOverride - The name of an image for this build that overrides the one specified in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • computeTypeOverride

        StartBuildRequest.Builder computeTypeOverride​(String computeTypeOverride)

        The name of a compute type for this build that overrides the one specified in the build project.

        Parameters:
        computeTypeOverride - The name of a compute type for this build that overrides the one specified in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ComputeType, ComputeType

      • computeTypeOverride

        StartBuildRequest.Builder computeTypeOverride​(ComputeType computeTypeOverride)

        The name of a compute type for this build that overrides the one specified in the build project.

        Parameters:
        computeTypeOverride - The name of a compute type for this build that overrides the one specified in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ComputeType, ComputeType

      • certificateOverride

        StartBuildRequest.Builder certificateOverride​(String certificateOverride)

        The name of a certificate for this build that overrides the one specified in the build project.

        Parameters:
        certificateOverride - The name of a certificate for this build that overrides the one specified in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cacheOverride

        StartBuildRequest.Builder cacheOverride​(ProjectCache cacheOverride)

        A ProjectCache object specified for this build that overrides the one defined in the build project.

        Parameters:
        cacheOverride - A ProjectCache object specified for this build that overrides the one defined in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceRoleOverride

        StartBuildRequest.Builder serviceRoleOverride​(String serviceRoleOverride)

        The name of a service role for this build that overrides the one specified in the build project.

        Parameters:
        serviceRoleOverride - The name of a service role for this build that overrides the one specified in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • privilegedModeOverride

        StartBuildRequest.Builder privilegedModeOverride​(Boolean privilegedModeOverride)

        Enable this flag to override privileged mode in the build project.

        Parameters:
        privilegedModeOverride - Enable this flag to override privileged mode in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timeoutInMinutesOverride

        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.

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

      • queuedTimeoutInMinutesOverride

        StartBuildRequest.Builder queuedTimeoutInMinutesOverride​(Integer queuedTimeoutInMinutesOverride)

        The number of minutes a build is allowed to be queued before it times out.

        Parameters:
        queuedTimeoutInMinutesOverride - The number of minutes a 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

        StartBuildRequest.Builder encryptionKeyOverride​(String encryptionKeyOverride)

        The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

        You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

        You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

        Parameters:
        encryptionKeyOverride - The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

        You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

        You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

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

      • idempotencyToken

        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, CodeBuild returns a parameter mismatch error.

        Parameters:
        idempotencyToken - A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • logsConfigOverride

        StartBuildRequest.Builder logsConfigOverride​(LogsConfig logsConfigOverride)

        Log settings for this build that override the log settings defined in the build project.

        Parameters:
        logsConfigOverride - Log settings for this build that override the log settings defined in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • registryCredentialOverride

        StartBuildRequest.Builder registryCredentialOverride​(RegistryCredential registryCredentialOverride)

        The credentials for access to a private registry.

        Parameters:
        registryCredentialOverride - The credentials for access to a private registry.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • imagePullCredentialsTypeOverride

        StartBuildRequest.Builder imagePullCredentialsTypeOverride​(String imagePullCredentialsTypeOverride)

        The type of credentials CodeBuild uses to pull images in your 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 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:
        ImagePullCredentialsType, ImagePullCredentialsType

      • imagePullCredentialsTypeOverride

        StartBuildRequest.Builder imagePullCredentialsTypeOverride​(ImagePullCredentialsType imagePullCredentialsTypeOverride)

        The type of credentials CodeBuild uses to pull images in your 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 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:
        ImagePullCredentialsType, ImagePullCredentialsType

      • fleetOverride

        StartBuildRequest.Builder fleetOverride​(ProjectFleet fleetOverride)

        A ProjectFleet object specified for this build that overrides the one defined in the build project.

        Parameters:
        fleetOverride - A ProjectFleet object specified for this build that overrides the one defined in the build project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.