1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCodeEngineBuild
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getCodeEngineBuild

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Provides a read-only data source to retrieve information about a code_engine_build. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const codeEngineBuild = ibm.getCodeEngineBuild({
        projectId: data.ibm_code_engine_project.code_engine_project.project_id,
        name: "my-build",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    code_engine_build = ibm.get_code_engine_build(project_id=data["ibm_code_engine_project"]["code_engine_project"]["project_id"],
        name="my-build")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.LookupCodeEngineBuild(ctx, &ibm.LookupCodeEngineBuildArgs{
    			ProjectId: data.Ibm_code_engine_project.Code_engine_project.Project_id,
    			Name:      "my-build",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var codeEngineBuild = Ibm.GetCodeEngineBuild.Invoke(new()
        {
            ProjectId = data.Ibm_code_engine_project.Code_engine_project.Project_id,
            Name = "my-build",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetCodeEngineBuildArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var codeEngineBuild = IbmFunctions.getCodeEngineBuild(GetCodeEngineBuildArgs.builder()
                .projectId(data.ibm_code_engine_project().code_engine_project().project_id())
                .name("my-build")
                .build());
    
        }
    }
    
    variables:
      codeEngineBuild:
        fn::invoke:
          function: ibm:getCodeEngineBuild
          arguments:
            projectId: ${data.ibm_code_engine_project.code_engine_project.project_id}
            name: my-build
    

    Using getCodeEngineBuild

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCodeEngineBuild(args: GetCodeEngineBuildArgs, opts?: InvokeOptions): Promise<GetCodeEngineBuildResult>
    function getCodeEngineBuildOutput(args: GetCodeEngineBuildOutputArgs, opts?: InvokeOptions): Output<GetCodeEngineBuildResult>
    def get_code_engine_build(id: Optional[str] = None,
                              name: Optional[str] = None,
                              project_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetCodeEngineBuildResult
    def get_code_engine_build_output(id: Optional[pulumi.Input[str]] = None,
                              name: Optional[pulumi.Input[str]] = None,
                              project_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetCodeEngineBuildResult]
    func LookupCodeEngineBuild(ctx *Context, args *LookupCodeEngineBuildArgs, opts ...InvokeOption) (*LookupCodeEngineBuildResult, error)
    func LookupCodeEngineBuildOutput(ctx *Context, args *LookupCodeEngineBuildOutputArgs, opts ...InvokeOption) LookupCodeEngineBuildResultOutput

    > Note: This function is named LookupCodeEngineBuild in the Go SDK.

    public static class GetCodeEngineBuild 
    {
        public static Task<GetCodeEngineBuildResult> InvokeAsync(GetCodeEngineBuildArgs args, InvokeOptions? opts = null)
        public static Output<GetCodeEngineBuildResult> Invoke(GetCodeEngineBuildInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCodeEngineBuildResult> getCodeEngineBuild(GetCodeEngineBuildArgs args, InvokeOptions options)
    public static Output<GetCodeEngineBuildResult> getCodeEngineBuild(GetCodeEngineBuildArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getCodeEngineBuild:getCodeEngineBuild
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of your build.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
    ProjectId string
    The ID of the project.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    Id string
    The unique identifier of the code_engine_build.
    Name string
    The name of your build.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
    ProjectId string
    The ID of the project.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    Id string
    The unique identifier of the code_engine_build.
    name String
    The name of your build.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
    projectId String
    The ID of the project.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    id String
    The unique identifier of the code_engine_build.
    name string
    The name of your build.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
    projectId string
    The ID of the project.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    id string
    The unique identifier of the code_engine_build.
    name str
    The name of your build.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
    project_id str
    The ID of the project.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    id str
    The unique identifier of the code_engine_build.
    name String
    The name of your build.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
    projectId String
    The ID of the project.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    id String
    The unique identifier of the code_engine_build.

    getCodeEngineBuild Result

    The following output properties are available:

    BuildId string
    (String) The identifier of the resource.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    CreatedAt string
    (String) The timestamp when the resource was created.
    EntityTag string
    (String) The version of the build instance, which is used to achieve optimistic locking.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
    Href string
    (String) When you provision a new build, a URL is created identifying the location of the instance.

    • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    Id string
    The unique identifier of the code_engine_build.
    Name string
    OutputImage string
    (String) The name of the image.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
    OutputSecret string
    (String) The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    ProjectId string
    Region string
    (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
    ResourceType string
    (String) The type of the build.

    • Constraints: Allowable values are: build_v2.
    SourceContextDir string
    (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^(.*)+$/.
    SourceRevision string
    (String) Commit, tag, or branch in the source repository to pull. This field is optional if the source_type is git and uses the HEAD of default branch if not specified. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[\\S]*$/.
    SourceSecret string
    (String) Name of the secret that is used access the repository source. This field is optional if the source_type is git. Additionally, if the source_url points to a repository that requires authentication, the build will be created but cannot access any source code, until this property is provided, too. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    SourceType string
    (String) Specifies the type of source to determine if your build source is in a repository or based on local source code.* local - For builds from local source code.* git - For builds from git version controlled source code.

    • Constraints: The default value is git. Allowable values are: local, git.
    SourceUrl string
    (String) The URL of the code repository. This field is required if the source_type is git. If the source_type value is local, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like https://github.com/IBM/CodeEngine. If the repository requires authentication, you need to provide a 'ssh' URL like git@github.com:IBM/CodeEngine.git along with a source_secret that points to a secret of format ssh_auth.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^((https:\/\/a-z0-9+(:\\d{1,5})?)|((ssh:\/\/)?git@a-z0-9+(:[a-zA-Z0-9\/][\\w\\-.]*)?))(\/([\\w\\-.]|%20)+)*$/.
    Status string
    (String) The current status of the build.

    • Constraints: Allowable values are: ready, failed.
    StatusDetails List<GetCodeEngineBuildStatusDetail>
    (List) The detailed status of the build. Nested schema for status_details:
    StrategySize string
    (String) Optional size for the build, which determines the amount of resources used. Build sizes are small, medium, large, xlarge, xxlarge.

    • Constraints: The default value is medium. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    StrategySpecFile string
    (String) Optional path to the specification file that is used for build strategies for building an image.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]*$/.
    StrategyType string
    (String) The strategy to use for building the image.

    • Constraints: The default value is dockerfile. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    Timeout double
    (Integer) The maximum amount of time, in seconds, that can pass before the build must succeed or fail.

    • Constraints: The default value is 600. The maximum value is 3600. The minimum value is 1.
    BuildId string
    (String) The identifier of the resource.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    CreatedAt string
    (String) The timestamp when the resource was created.
    EntityTag string
    (String) The version of the build instance, which is used to achieve optimistic locking.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
    Href string
    (String) When you provision a new build, a URL is created identifying the location of the instance.

    • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    Id string
    The unique identifier of the code_engine_build.
    Name string
    OutputImage string
    (String) The name of the image.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
    OutputSecret string
    (String) The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    ProjectId string
    Region string
    (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
    ResourceType string
    (String) The type of the build.

    • Constraints: Allowable values are: build_v2.
    SourceContextDir string
    (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^(.*)+$/.
    SourceRevision string
    (String) Commit, tag, or branch in the source repository to pull. This field is optional if the source_type is git and uses the HEAD of default branch if not specified. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[\\S]*$/.
    SourceSecret string
    (String) Name of the secret that is used access the repository source. This field is optional if the source_type is git. Additionally, if the source_url points to a repository that requires authentication, the build will be created but cannot access any source code, until this property is provided, too. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    SourceType string
    (String) Specifies the type of source to determine if your build source is in a repository or based on local source code.* local - For builds from local source code.* git - For builds from git version controlled source code.

    • Constraints: The default value is git. Allowable values are: local, git.
    SourceUrl string
    (String) The URL of the code repository. This field is required if the source_type is git. If the source_type value is local, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like https://github.com/IBM/CodeEngine. If the repository requires authentication, you need to provide a 'ssh' URL like git@github.com:IBM/CodeEngine.git along with a source_secret that points to a secret of format ssh_auth.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^((https:\/\/a-z0-9+(:\\d{1,5})?)|((ssh:\/\/)?git@a-z0-9+(:[a-zA-Z0-9\/][\\w\\-.]*)?))(\/([\\w\\-.]|%20)+)*$/.
    Status string
    (String) The current status of the build.

    • Constraints: Allowable values are: ready, failed.
    StatusDetails []GetCodeEngineBuildStatusDetail
    (List) The detailed status of the build. Nested schema for status_details:
    StrategySize string
    (String) Optional size for the build, which determines the amount of resources used. Build sizes are small, medium, large, xlarge, xxlarge.

    • Constraints: The default value is medium. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    StrategySpecFile string
    (String) Optional path to the specification file that is used for build strategies for building an image.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]*$/.
    StrategyType string
    (String) The strategy to use for building the image.

    • Constraints: The default value is dockerfile. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    Timeout float64
    (Integer) The maximum amount of time, in seconds, that can pass before the build must succeed or fail.

    • Constraints: The default value is 600. The maximum value is 3600. The minimum value is 1.
    buildId String
    (String) The identifier of the resource.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    createdAt String
    (String) The timestamp when the resource was created.
    entityTag String
    (String) The version of the build instance, which is used to achieve optimistic locking.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
    href String
    (String) When you provision a new build, a URL is created identifying the location of the instance.

    • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id String
    The unique identifier of the code_engine_build.
    name String
    outputImage String
    (String) The name of the image.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
    outputSecret String
    (String) The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    projectId String
    region String
    (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
    resourceType String
    (String) The type of the build.

    • Constraints: Allowable values are: build_v2.
    sourceContextDir String
    (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^(.*)+$/.
    sourceRevision String
    (String) Commit, tag, or branch in the source repository to pull. This field is optional if the source_type is git and uses the HEAD of default branch if not specified. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[\\S]*$/.
    sourceSecret String
    (String) Name of the secret that is used access the repository source. This field is optional if the source_type is git. Additionally, if the source_url points to a repository that requires authentication, the build will be created but cannot access any source code, until this property is provided, too. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    sourceType String
    (String) Specifies the type of source to determine if your build source is in a repository or based on local source code.* local - For builds from local source code.* git - For builds from git version controlled source code.

    • Constraints: The default value is git. Allowable values are: local, git.
    sourceUrl String
    (String) The URL of the code repository. This field is required if the source_type is git. If the source_type value is local, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like https://github.com/IBM/CodeEngine. If the repository requires authentication, you need to provide a 'ssh' URL like git@github.com:IBM/CodeEngine.git along with a source_secret that points to a secret of format ssh_auth.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^((https:\/\/a-z0-9+(:\\d{1,5})?)|((ssh:\/\/)?git@a-z0-9+(:[a-zA-Z0-9\/][\\w\\-.]*)?))(\/([\\w\\-.]|%20)+)*$/.
    status String
    (String) The current status of the build.

    • Constraints: Allowable values are: ready, failed.
    statusDetails List<GetCodeEngineBuildStatusDetail>
    (List) The detailed status of the build. Nested schema for status_details:
    strategySize String
    (String) Optional size for the build, which determines the amount of resources used. Build sizes are small, medium, large, xlarge, xxlarge.

    • Constraints: The default value is medium. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    strategySpecFile String
    (String) Optional path to the specification file that is used for build strategies for building an image.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]*$/.
    strategyType String
    (String) The strategy to use for building the image.

    • Constraints: The default value is dockerfile. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    timeout Double
    (Integer) The maximum amount of time, in seconds, that can pass before the build must succeed or fail.

    • Constraints: The default value is 600. The maximum value is 3600. The minimum value is 1.
    buildId string
    (String) The identifier of the resource.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    createdAt string
    (String) The timestamp when the resource was created.
    entityTag string
    (String) The version of the build instance, which is used to achieve optimistic locking.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
    href string
    (String) When you provision a new build, a URL is created identifying the location of the instance.

    • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id string
    The unique identifier of the code_engine_build.
    name string
    outputImage string
    (String) The name of the image.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
    outputSecret string
    (String) The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    projectId string
    region string
    (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
    resourceType string
    (String) The type of the build.

    • Constraints: Allowable values are: build_v2.
    sourceContextDir string
    (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^(.*)+$/.
    sourceRevision string
    (String) Commit, tag, or branch in the source repository to pull. This field is optional if the source_type is git and uses the HEAD of default branch if not specified. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[\\S]*$/.
    sourceSecret string
    (String) Name of the secret that is used access the repository source. This field is optional if the source_type is git. Additionally, if the source_url points to a repository that requires authentication, the build will be created but cannot access any source code, until this property is provided, too. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    sourceType string
    (String) Specifies the type of source to determine if your build source is in a repository or based on local source code.* local - For builds from local source code.* git - For builds from git version controlled source code.

    • Constraints: The default value is git. Allowable values are: local, git.
    sourceUrl string
    (String) The URL of the code repository. This field is required if the source_type is git. If the source_type value is local, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like https://github.com/IBM/CodeEngine. If the repository requires authentication, you need to provide a 'ssh' URL like git@github.com:IBM/CodeEngine.git along with a source_secret that points to a secret of format ssh_auth.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^((https:\/\/a-z0-9+(:\\d{1,5})?)|((ssh:\/\/)?git@a-z0-9+(:[a-zA-Z0-9\/][\\w\\-.]*)?))(\/([\\w\\-.]|%20)+)*$/.
    status string
    (String) The current status of the build.

    • Constraints: Allowable values are: ready, failed.
    statusDetails GetCodeEngineBuildStatusDetail[]
    (List) The detailed status of the build. Nested schema for status_details:
    strategySize string
    (String) Optional size for the build, which determines the amount of resources used. Build sizes are small, medium, large, xlarge, xxlarge.

    • Constraints: The default value is medium. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    strategySpecFile string
    (String) Optional path to the specification file that is used for build strategies for building an image.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]*$/.
    strategyType string
    (String) The strategy to use for building the image.

    • Constraints: The default value is dockerfile. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    timeout number
    (Integer) The maximum amount of time, in seconds, that can pass before the build must succeed or fail.

    • Constraints: The default value is 600. The maximum value is 3600. The minimum value is 1.
    build_id str
    (String) The identifier of the resource.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    created_at str
    (String) The timestamp when the resource was created.
    entity_tag str
    (String) The version of the build instance, which is used to achieve optimistic locking.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
    href str
    (String) When you provision a new build, a URL is created identifying the location of the instance.

    • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id str
    The unique identifier of the code_engine_build.
    name str
    output_image str
    (String) The name of the image.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
    output_secret str
    (String) The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    project_id str
    region str
    (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
    resource_type str
    (String) The type of the build.

    • Constraints: Allowable values are: build_v2.
    source_context_dir str
    (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^(.*)+$/.
    source_revision str
    (String) Commit, tag, or branch in the source repository to pull. This field is optional if the source_type is git and uses the HEAD of default branch if not specified. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[\\S]*$/.
    source_secret str
    (String) Name of the secret that is used access the repository source. This field is optional if the source_type is git. Additionally, if the source_url points to a repository that requires authentication, the build will be created but cannot access any source code, until this property is provided, too. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    source_type str
    (String) Specifies the type of source to determine if your build source is in a repository or based on local source code.* local - For builds from local source code.* git - For builds from git version controlled source code.

    • Constraints: The default value is git. Allowable values are: local, git.
    source_url str
    (String) The URL of the code repository. This field is required if the source_type is git. If the source_type value is local, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like https://github.com/IBM/CodeEngine. If the repository requires authentication, you need to provide a 'ssh' URL like git@github.com:IBM/CodeEngine.git along with a source_secret that points to a secret of format ssh_auth.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^((https:\/\/a-z0-9+(:\\d{1,5})?)|((ssh:\/\/)?git@a-z0-9+(:[a-zA-Z0-9\/][\\w\\-.]*)?))(\/([\\w\\-.]|%20)+)*$/.
    status str
    (String) The current status of the build.

    • Constraints: Allowable values are: ready, failed.
    status_details Sequence[GetCodeEngineBuildStatusDetail]
    (List) The detailed status of the build. Nested schema for status_details:
    strategy_size str
    (String) Optional size for the build, which determines the amount of resources used. Build sizes are small, medium, large, xlarge, xxlarge.

    • Constraints: The default value is medium. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    strategy_spec_file str
    (String) Optional path to the specification file that is used for build strategies for building an image.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]*$/.
    strategy_type str
    (String) The strategy to use for building the image.

    • Constraints: The default value is dockerfile. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    timeout float
    (Integer) The maximum amount of time, in seconds, that can pass before the build must succeed or fail.

    • Constraints: The default value is 600. The maximum value is 3600. The minimum value is 1.
    buildId String
    (String) The identifier of the resource.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
    createdAt String
    (String) The timestamp when the resource was created.
    entityTag String
    (String) The version of the build instance, which is used to achieve optimistic locking.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
    href String
    (String) When you provision a new build, a URL is created identifying the location of the instance.

    • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id String
    The unique identifier of the code_engine_build.
    name String
    outputImage String
    (String) The name of the image.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
    outputSecret String
    (String) The secret that is required to access the image registry. Make sure that the secret is granted with push permissions towards the specified container registry namespace.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    projectId String
    region String
    (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
    resourceType String
    (String) The type of the build.

    • Constraints: Allowable values are: build_v2.
    sourceContextDir String
    (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^(.*)+$/.
    sourceRevision String
    (String) Commit, tag, or branch in the source repository to pull. This field is optional if the source_type is git and uses the HEAD of default branch if not specified. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[\\S]*$/.
    sourceSecret String
    (String) Name of the secret that is used access the repository source. This field is optional if the source_type is git. Additionally, if the source_url points to a repository that requires authentication, the build will be created but cannot access any source code, until this property is provided, too. If the source_type value is local, this field must be omitted.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
    sourceType String
    (String) Specifies the type of source to determine if your build source is in a repository or based on local source code.* local - For builds from local source code.* git - For builds from git version controlled source code.

    • Constraints: The default value is git. Allowable values are: local, git.
    sourceUrl String
    (String) The URL of the code repository. This field is required if the source_type is git. If the source_type value is local, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like https://github.com/IBM/CodeEngine. If the repository requires authentication, you need to provide a 'ssh' URL like git@github.com:IBM/CodeEngine.git along with a source_secret that points to a secret of format ssh_auth.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^((https:\/\/a-z0-9+(:\\d{1,5})?)|((ssh:\/\/)?git@a-z0-9+(:[a-zA-Z0-9\/][\\w\\-.]*)?))(\/([\\w\\-.]|%20)+)*$/.
    status String
    (String) The current status of the build.

    • Constraints: Allowable values are: ready, failed.
    statusDetails List<Property Map>
    (List) The detailed status of the build. Nested schema for status_details:
    strategySize String
    (String) Optional size for the build, which determines the amount of resources used. Build sizes are small, medium, large, xlarge, xxlarge.

    • Constraints: The default value is medium. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    strategySpecFile String
    (String) Optional path to the specification file that is used for build strategies for building an image.

    • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]*$/.
    strategyType String
    (String) The strategy to use for building the image.

    • Constraints: The default value is dockerfile. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /[\\S]*/.
    timeout Number
    (Integer) The maximum amount of time, in seconds, that can pass before the build must succeed or fail.

    • Constraints: The default value is 600. The maximum value is 3600. The minimum value is 1.

    Supporting Types

    GetCodeEngineBuildStatusDetail

    Reason string
    (String) Optional information to provide more context in case of a 'failed' or 'warning' status.

    • Constraints: Allowable values are: registered, strategy_not_found, cluster_build_strategy_not_found, set_owner_reference_failed, spec_source_secret_not_found, spec_output_secret_ref_not_found, spec_runtime_secret_ref_not_found, multiple_secret_ref_not_found, runtime_paths_can_not_be_empty, remote_repository_unreachable, failed.
    Reason string
    (String) Optional information to provide more context in case of a 'failed' or 'warning' status.

    • Constraints: Allowable values are: registered, strategy_not_found, cluster_build_strategy_not_found, set_owner_reference_failed, spec_source_secret_not_found, spec_output_secret_ref_not_found, spec_runtime_secret_ref_not_found, multiple_secret_ref_not_found, runtime_paths_can_not_be_empty, remote_repository_unreachable, failed.
    reason String
    (String) Optional information to provide more context in case of a 'failed' or 'warning' status.

    • Constraints: Allowable values are: registered, strategy_not_found, cluster_build_strategy_not_found, set_owner_reference_failed, spec_source_secret_not_found, spec_output_secret_ref_not_found, spec_runtime_secret_ref_not_found, multiple_secret_ref_not_found, runtime_paths_can_not_be_empty, remote_repository_unreachable, failed.
    reason string
    (String) Optional information to provide more context in case of a 'failed' or 'warning' status.

    • Constraints: Allowable values are: registered, strategy_not_found, cluster_build_strategy_not_found, set_owner_reference_failed, spec_source_secret_not_found, spec_output_secret_ref_not_found, spec_runtime_secret_ref_not_found, multiple_secret_ref_not_found, runtime_paths_can_not_be_empty, remote_repository_unreachable, failed.
    reason str
    (String) Optional information to provide more context in case of a 'failed' or 'warning' status.

    • Constraints: Allowable values are: registered, strategy_not_found, cluster_build_strategy_not_found, set_owner_reference_failed, spec_source_secret_not_found, spec_output_secret_ref_not_found, spec_runtime_secret_ref_not_found, multiple_secret_ref_not_found, runtime_paths_can_not_be_empty, remote_repository_unreachable, failed.
    reason String
    (String) Optional information to provide more context in case of a 'failed' or 'warning' status.

    • Constraints: Allowable values are: registered, strategy_not_found, cluster_build_strategy_not_found, set_owner_reference_failed, spec_source_secret_not_found, spec_output_secret_ref_not_found, spec_runtime_secret_ref_not_found, multiple_secret_ref_not_found, runtime_paths_can_not_be_empty, remote_repository_unreachable, failed.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud