ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm.getCodeEngineBuild
Explore with Pulumi AI
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 is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- Project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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 is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- Project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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 is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- project
Id String - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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 is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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 is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- project_
id str - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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 is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- project
Id String - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- id String
- The unique identifier of the code_engine_build.
getCodeEngineBuild Result
The following output properties are available:
- Build
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- Created
At string - (String) The timestamp when the resource was created.
- Entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Id string
- The unique identifier of the code_engine_build.
- Name string
- Output
Image string - (String) The name of the image.
- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- Output
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Project
Id 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'.
- Resource
Type string - (String) The type of the build.
- Constraints: Allowable values are:
build_v2
.
- Constraints: Allowable values are:
- Source
Context stringDir - (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^(.*)+$/
.
- Constraints: The maximum length is
- Source
Revision string - (String) Commit, tag, or branch in the source repository to pull. This field is optional if the
source_type
isgit
and uses the HEAD of default branch if not specified. If thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- Source
Secret string - (String) Name of the secret that is used access the repository source. This field is optional if the
source_type
isgit
. Additionally, if thesource_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 thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Source
Type 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
.
- Constraints: The default value is
- Source
Url string - (String) The URL of the code repository. This field is required if the
source_type
isgit
. If thesource_type
value islocal
, this field must be omitted. If the repository is publicly available you can provide a 'https' URL likehttps://github.com/IBM/CodeEngine
. If the repository requires authentication, you need to provide a 'ssh' URL likegit@github.com:IBM/CodeEngine.git
along with asource_secret
that points to a secret of formatssh_auth
.- Constraints: The maximum length is
253
characters. The minimum length is1
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)+)*$/
.
- Constraints: The maximum length is
- Status string
- (String) The current status of the build.
- Constraints: Allowable values are:
ready
,failed
.
- Constraints: Allowable values are:
- Status
Details List<GetCode Engine Build Status Detail> - (List) The detailed status of the build. Nested schema for status_details:
- Strategy
Size 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 is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- Strategy
Spec stringFile - (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 is1
character. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- Strategy
Type string - (String) The strategy to use for building the image.
- Constraints: The default value is
dockerfile
. The maximum length is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- 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 is3600
. The minimum value is1
.
- Constraints: The default value is
- Build
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- Created
At string - (String) The timestamp when the resource was created.
- Entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Id string
- The unique identifier of the code_engine_build.
- Name string
- Output
Image string - (String) The name of the image.
- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- Output
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Project
Id 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'.
- Resource
Type string - (String) The type of the build.
- Constraints: Allowable values are:
build_v2
.
- Constraints: Allowable values are:
- Source
Context stringDir - (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^(.*)+$/
.
- Constraints: The maximum length is
- Source
Revision string - (String) Commit, tag, or branch in the source repository to pull. This field is optional if the
source_type
isgit
and uses the HEAD of default branch if not specified. If thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- Source
Secret string - (String) Name of the secret that is used access the repository source. This field is optional if the
source_type
isgit
. Additionally, if thesource_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 thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Source
Type 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
.
- Constraints: The default value is
- Source
Url string - (String) The URL of the code repository. This field is required if the
source_type
isgit
. If thesource_type
value islocal
, this field must be omitted. If the repository is publicly available you can provide a 'https' URL likehttps://github.com/IBM/CodeEngine
. If the repository requires authentication, you need to provide a 'ssh' URL likegit@github.com:IBM/CodeEngine.git
along with asource_secret
that points to a secret of formatssh_auth
.- Constraints: The maximum length is
253
characters. The minimum length is1
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)+)*$/
.
- Constraints: The maximum length is
- Status string
- (String) The current status of the build.
- Constraints: Allowable values are:
ready
,failed
.
- Constraints: Allowable values are:
- Status
Details []GetCode Engine Build Status Detail - (List) The detailed status of the build. Nested schema for status_details:
- Strategy
Size 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 is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- Strategy
Spec stringFile - (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 is1
character. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- Strategy
Type string - (String) The strategy to use for building the image.
- Constraints: The default value is
dockerfile
. The maximum length is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- 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 is3600
. The minimum value is1
.
- Constraints: The default value is
- build
Id String - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- created
At String - (String) The timestamp when the resource was created.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id String
- The unique identifier of the code_engine_build.
- name String
- output
Image String - (String) The name of the image.
- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- output
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- project
Id 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'.
- resource
Type String - (String) The type of the build.
- Constraints: Allowable values are:
build_v2
.
- Constraints: Allowable values are:
- source
Context StringDir - (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^(.*)+$/
.
- Constraints: The maximum length is
- source
Revision String - (String) Commit, tag, or branch in the source repository to pull. This field is optional if the
source_type
isgit
and uses the HEAD of default branch if not specified. If thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- source
Secret String - (String) Name of the secret that is used access the repository source. This field is optional if the
source_type
isgit
. Additionally, if thesource_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 thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- source
Type 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
.
- Constraints: The default value is
- source
Url String - (String) The URL of the code repository. This field is required if the
source_type
isgit
. If thesource_type
value islocal
, this field must be omitted. If the repository is publicly available you can provide a 'https' URL likehttps://github.com/IBM/CodeEngine
. If the repository requires authentication, you need to provide a 'ssh' URL likegit@github.com:IBM/CodeEngine.git
along with asource_secret
that points to a secret of formatssh_auth
.- Constraints: The maximum length is
253
characters. The minimum length is1
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)+)*$/
.
- Constraints: The maximum length is
- status String
- (String) The current status of the build.
- Constraints: Allowable values are:
ready
,failed
.
- Constraints: Allowable values are:
- status
Details List<GetCode Engine Build Status Detail> - (List) The detailed status of the build. Nested schema for status_details:
- strategy
Size 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 is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- strategy
Spec StringFile - (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 is1
character. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- strategy
Type String - (String) The strategy to use for building the image.
- Constraints: The default value is
dockerfile
. The maximum length is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- 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 is3600
. The minimum value is1
.
- Constraints: The default value is
- build
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- created
At string - (String) The timestamp when the resource was created.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id string
- The unique identifier of the code_engine_build.
- name string
- output
Image string - (String) The name of the image.
- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- output
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- project
Id 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'.
- resource
Type string - (String) The type of the build.
- Constraints: Allowable values are:
build_v2
.
- Constraints: Allowable values are:
- source
Context stringDir - (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^(.*)+$/
.
- Constraints: The maximum length is
- source
Revision string - (String) Commit, tag, or branch in the source repository to pull. This field is optional if the
source_type
isgit
and uses the HEAD of default branch if not specified. If thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- source
Secret string - (String) Name of the secret that is used access the repository source. This field is optional if the
source_type
isgit
. Additionally, if thesource_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 thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- source
Type 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
.
- Constraints: The default value is
- source
Url string - (String) The URL of the code repository. This field is required if the
source_type
isgit
. If thesource_type
value islocal
, this field must be omitted. If the repository is publicly available you can provide a 'https' URL likehttps://github.com/IBM/CodeEngine
. If the repository requires authentication, you need to provide a 'ssh' URL likegit@github.com:IBM/CodeEngine.git
along with asource_secret
that points to a secret of formatssh_auth
.- Constraints: The maximum length is
253
characters. The minimum length is1
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)+)*$/
.
- Constraints: The maximum length is
- status string
- (String) The current status of the build.
- Constraints: Allowable values are:
ready
,failed
.
- Constraints: Allowable values are:
- status
Details GetCode Engine Build Status Detail[] - (List) The detailed status of the build. Nested schema for status_details:
- strategy
Size 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 is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- strategy
Spec stringFile - (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 is1
character. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- strategy
Type string - (String) The strategy to use for building the image.
- Constraints: The default value is
dockerfile
. The maximum length is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- 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 is3600
. The minimum value is1
.
- Constraints: The default value is
- build_
id str - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- 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 is1
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})?$/
.
- Constraints: The maximum length is
- 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- 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
.
- Constraints: Allowable values are:
- source_
context_ strdir - (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^(.*)+$/
.
- Constraints: The maximum length is
- source_
revision str - (String) Commit, tag, or branch in the source repository to pull. This field is optional if the
source_type
isgit
and uses the HEAD of default branch if not specified. If thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- source_
secret str - (String) Name of the secret that is used access the repository source. This field is optional if the
source_type
isgit
. Additionally, if thesource_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 thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- 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
.
- Constraints: The default value is
- source_
url str - (String) The URL of the code repository. This field is required if the
source_type
isgit
. If thesource_type
value islocal
, this field must be omitted. If the repository is publicly available you can provide a 'https' URL likehttps://github.com/IBM/CodeEngine
. If the repository requires authentication, you need to provide a 'ssh' URL likegit@github.com:IBM/CodeEngine.git
along with asource_secret
that points to a secret of formatssh_auth
.- Constraints: The maximum length is
253
characters. The minimum length is1
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)+)*$/
.
- Constraints: The maximum length is
- status str
- (String) The current status of the build.
- Constraints: Allowable values are:
ready
,failed
.
- Constraints: Allowable values are:
- status_
details Sequence[GetCode Engine Build Status Detail] - (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 is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- strategy_
spec_ strfile - (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 is1
character. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- strategy_
type str - (String) The strategy to use for building the image.
- Constraints: The default value is
dockerfile
. The maximum length is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- 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 is3600
. The minimum value is1
.
- Constraints: The default value is
- build
Id String - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- created
At String - (String) The timestamp when the resource was created.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id String
- The unique identifier of the code_engine_build.
- name String
- output
Image String - (String) The name of the image.
- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- output
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- project
Id 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'.
- resource
Type String - (String) The type of the build.
- Constraints: Allowable values are:
build_v2
.
- Constraints: Allowable values are:
- source
Context StringDir - (String) Optional directory in the repository that contains the buildpacks file or the Dockerfile.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^(.*)+$/
.
- Constraints: The maximum length is
- source
Revision String - (String) Commit, tag, or branch in the source repository to pull. This field is optional if the
source_type
isgit
and uses the HEAD of default branch if not specified. If thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- source
Secret String - (String) Name of the secret that is used access the repository source. This field is optional if the
source_type
isgit
. Additionally, if thesource_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 thesource_type
value islocal
, this field must be omitted.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- source
Type 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
.
- Constraints: The default value is
- source
Url String - (String) The URL of the code repository. This field is required if the
source_type
isgit
. If thesource_type
value islocal
, this field must be omitted. If the repository is publicly available you can provide a 'https' URL likehttps://github.com/IBM/CodeEngine
. If the repository requires authentication, you need to provide a 'ssh' URL likegit@github.com:IBM/CodeEngine.git
along with asource_secret
that points to a secret of formatssh_auth
.- Constraints: The maximum length is
253
characters. The minimum length is1
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)+)*$/
.
- Constraints: The maximum length is
- status String
- (String) The current status of the build.
- Constraints: Allowable values are:
ready
,failed
.
- Constraints: Allowable values are:
- status
Details List<Property Map> - (List) The detailed status of the build. Nested schema for status_details:
- strategy
Size 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 is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- strategy
Spec StringFile - (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 is1
character. The value must match regular expression/^[\\S]*$/
.
- Constraints: The maximum length is
- strategy
Type String - (String) The strategy to use for building the image.
- Constraints: The default value is
dockerfile
. The maximum length is253
characters. The minimum length is1
character. The value must match regular expression/[\\S]*/
.
- Constraints: The default value is
- 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 is3600
. The minimum value is1
.
- Constraints: The default value is
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
.
- Constraints: Allowable values are:
- 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
.
- Constraints: Allowable values are:
- 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
.
- Constraints: Allowable values are:
- 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
.
- Constraints: Allowable values are:
- 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
.
- Constraints: Allowable values are:
- 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
.
- Constraints: Allowable values are:
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.