ibm.CodeEngineBuild
Explore with Pulumi AI
Create, update, and delete code_engine_builds with this resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const codeEngineBuildInstance = new ibm.CodeEngineBuild("codeEngineBuildInstance", {
projectId: ibm_code_engine_project.code_engine_project_instance.project_id,
outputImage: "private.de.icr.io/icr_namespace/image-name",
outputSecret: "ce-auto-icr-private-eu-de",
sourceUrl: "https://github.com/IBM/CodeEngine",
strategyType: "dockerfile",
});
import pulumi
import pulumi_ibm as ibm
code_engine_build_instance = ibm.CodeEngineBuild("codeEngineBuildInstance",
project_id=ibm_code_engine_project["code_engine_project_instance"]["project_id"],
output_image="private.de.icr.io/icr_namespace/image-name",
output_secret="ce-auto-icr-private-eu-de",
source_url="https://github.com/IBM/CodeEngine",
strategy_type="dockerfile")
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.NewCodeEngineBuild(ctx, "codeEngineBuildInstance", &ibm.CodeEngineBuildArgs{
ProjectId: pulumi.Any(ibm_code_engine_project.Code_engine_project_instance.Project_id),
OutputImage: pulumi.String("private.de.icr.io/icr_namespace/image-name"),
OutputSecret: pulumi.String("ce-auto-icr-private-eu-de"),
SourceUrl: pulumi.String("https://github.com/IBM/CodeEngine"),
StrategyType: pulumi.String("dockerfile"),
})
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 codeEngineBuildInstance = new Ibm.CodeEngineBuild("codeEngineBuildInstance", new()
{
ProjectId = ibm_code_engine_project.Code_engine_project_instance.Project_id,
OutputImage = "private.de.icr.io/icr_namespace/image-name",
OutputSecret = "ce-auto-icr-private-eu-de",
SourceUrl = "https://github.com/IBM/CodeEngine",
StrategyType = "dockerfile",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CodeEngineBuild;
import com.pulumi.ibm.CodeEngineBuildArgs;
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) {
var codeEngineBuildInstance = new CodeEngineBuild("codeEngineBuildInstance", CodeEngineBuildArgs.builder()
.projectId(ibm_code_engine_project.code_engine_project_instance().project_id())
.outputImage("private.de.icr.io/icr_namespace/image-name")
.outputSecret("ce-auto-icr-private-eu-de")
.sourceUrl("https://github.com/IBM/CodeEngine")
.strategyType("dockerfile")
.build());
}
}
resources:
codeEngineBuildInstance:
type: ibm:CodeEngineBuild
properties:
projectId: ${ibm_code_engine_project.code_engine_project_instance.project_id}
outputImage: private.de.icr.io/icr_namespace/image-name
outputSecret: ce-auto-icr-private-eu-de
sourceUrl: https://github.com/IBM/CodeEngine
strategyType: dockerfile
Create CodeEngineBuild Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CodeEngineBuild(name: string, args: CodeEngineBuildArgs, opts?: CustomResourceOptions);
@overload
def CodeEngineBuild(resource_name: str,
args: CodeEngineBuildArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CodeEngineBuild(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
strategy_type: Optional[str] = None,
output_image: Optional[str] = None,
output_secret: Optional[str] = None,
source_revision: Optional[str] = None,
source_context_dir: Optional[str] = None,
code_engine_build_id: Optional[str] = None,
source_secret: Optional[str] = None,
source_type: Optional[str] = None,
source_url: Optional[str] = None,
strategy_size: Optional[str] = None,
strategy_spec_file: Optional[str] = None,
name: Optional[str] = None,
timeout: Optional[float] = None)
func NewCodeEngineBuild(ctx *Context, name string, args CodeEngineBuildArgs, opts ...ResourceOption) (*CodeEngineBuild, error)
public CodeEngineBuild(string name, CodeEngineBuildArgs args, CustomResourceOptions? opts = null)
public CodeEngineBuild(String name, CodeEngineBuildArgs args)
public CodeEngineBuild(String name, CodeEngineBuildArgs args, CustomResourceOptions options)
type: ibm:CodeEngineBuild
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CodeEngineBuildArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CodeEngineBuildArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CodeEngineBuildArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CodeEngineBuildArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CodeEngineBuildArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var codeEngineBuildResource = new Ibm.CodeEngineBuild("codeEngineBuildResource", new()
{
ProjectId = "string",
StrategyType = "string",
OutputImage = "string",
OutputSecret = "string",
SourceRevision = "string",
SourceContextDir = "string",
CodeEngineBuildId = "string",
SourceSecret = "string",
SourceType = "string",
SourceUrl = "string",
StrategySize = "string",
StrategySpecFile = "string",
Name = "string",
Timeout = 0,
});
example, err := ibm.NewCodeEngineBuild(ctx, "codeEngineBuildResource", &ibm.CodeEngineBuildArgs{
ProjectId: pulumi.String("string"),
StrategyType: pulumi.String("string"),
OutputImage: pulumi.String("string"),
OutputSecret: pulumi.String("string"),
SourceRevision: pulumi.String("string"),
SourceContextDir: pulumi.String("string"),
CodeEngineBuildId: pulumi.String("string"),
SourceSecret: pulumi.String("string"),
SourceType: pulumi.String("string"),
SourceUrl: pulumi.String("string"),
StrategySize: pulumi.String("string"),
StrategySpecFile: pulumi.String("string"),
Name: pulumi.String("string"),
Timeout: pulumi.Float64(0),
})
var codeEngineBuildResource = new CodeEngineBuild("codeEngineBuildResource", CodeEngineBuildArgs.builder()
.projectId("string")
.strategyType("string")
.outputImage("string")
.outputSecret("string")
.sourceRevision("string")
.sourceContextDir("string")
.codeEngineBuildId("string")
.sourceSecret("string")
.sourceType("string")
.sourceUrl("string")
.strategySize("string")
.strategySpecFile("string")
.name("string")
.timeout(0)
.build());
code_engine_build_resource = ibm.CodeEngineBuild("codeEngineBuildResource",
project_id="string",
strategy_type="string",
output_image="string",
output_secret="string",
source_revision="string",
source_context_dir="string",
code_engine_build_id="string",
source_secret="string",
source_type="string",
source_url="string",
strategy_size="string",
strategy_spec_file="string",
name="string",
timeout=0)
const codeEngineBuildResource = new ibm.CodeEngineBuild("codeEngineBuildResource", {
projectId: "string",
strategyType: "string",
outputImage: "string",
outputSecret: "string",
sourceRevision: "string",
sourceContextDir: "string",
codeEngineBuildId: "string",
sourceSecret: "string",
sourceType: "string",
sourceUrl: "string",
strategySize: "string",
strategySpecFile: "string",
name: "string",
timeout: 0,
});
type: ibm:CodeEngineBuild
properties:
codeEngineBuildId: string
name: string
outputImage: string
outputSecret: string
projectId: string
sourceContextDir: string
sourceRevision: string
sourceSecret: string
sourceType: string
sourceUrl: string
strategySize: string
strategySpecFile: string
strategyType: string
timeout: 0
CodeEngineBuild Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CodeEngineBuild resource accepts the following input properties:
- Output
Image 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 - 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 - 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
- Strategy
Type 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
- Code
Engine stringBuild Id - The unique identifier of the code_engine_build.
- Name string
- The name of the 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
- Source
Context stringDir - 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 - 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 - 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 - 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 - 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
- Strategy
Size 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 - 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
- Timeout double
- 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
- Output
Image 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 - 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 - 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
- Strategy
Type 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
- Code
Engine stringBuild Id - The unique identifier of the code_engine_build.
- Name string
- The name of the 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
- Source
Context stringDir - 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 - 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 - 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 - 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 - 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
- Strategy
Size 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 - 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
- Timeout float64
- 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
- output
Image 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 - 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 - 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
- strategy
Type 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
- code
Engine StringBuild Id - The unique identifier of the code_engine_build.
- name String
- The name of the 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
- source
Context StringDir - 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 - 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 - 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 - 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 - 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
- strategy
Size 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 - 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
- timeout Double
- 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
- output
Image 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 - 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 - 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
- strategy
Type 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
- code
Engine stringBuild Id - The unique identifier of the code_engine_build.
- name string
- The name of the 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
- source
Context stringDir - 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 - 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 - 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 - 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 - 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
- strategy
Size 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 - 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
- timeout number
- 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
- output_
image str - 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 - 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 - 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
- strategy_
type str - 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
- code_
engine_ strbuild_ id - The unique identifier of the code_engine_build.
- name str
- The name of the 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
- source_
context_ strdir - 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 - 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 - 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 - 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 - 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
- strategy_
size str - 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 - 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
- timeout float
- 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
- output
Image 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 - 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 - 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
- strategy
Type 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
- code
Engine StringBuild Id - The unique identifier of the code_engine_build.
- name String
- The name of the 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
- source
Context StringDir - 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 - 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 - 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 - 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 - 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
- strategy
Size 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 - 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
- timeout Number
- 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
Outputs
All input properties are implicitly available as output properties. Additionally, the CodeEngineBuild resource produces the following output properties:
- 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
- Etag string
- ETag identifier for code_engine_build.
- 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 provider-assigned unique ID for this managed resource.
- 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:
- Status string
- (String) The current status of the build.
- Constraints: Allowable values are:
ready
,failed
.
- Constraints: Allowable values are:
- Status
Details List<CodeEngine Build Status Detail> - (List) The detailed status of the build. Nested schema for status_details:
- 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
- Etag string
- ETag identifier for code_engine_build.
- 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 provider-assigned unique ID for this managed resource.
- 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:
- Status string
- (String) The current status of the build.
- Constraints: Allowable values are:
ready
,failed
.
- Constraints: Allowable values are:
- Status
Details []CodeEngine Build Status Detail - (List) The detailed status of the build. Nested schema for status_details:
- 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
- etag String
- ETag identifier for code_engine_build.
- 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 provider-assigned unique ID for this managed resource.
- 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:
- status String
- (String) The current status of the build.
- Constraints: Allowable values are:
ready
,failed
.
- Constraints: Allowable values are:
- status
Details List<CodeEngine Build Status Detail> - (List) The detailed status of the build. Nested schema for status_details:
- 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
- etag string
- ETag identifier for code_engine_build.
- 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 provider-assigned unique ID for this managed resource.
- 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:
- status string
- (String) The current status of the build.
- Constraints: Allowable values are:
ready
,failed
.
- Constraints: Allowable values are:
- status
Details CodeEngine Build Status Detail[] - (List) The detailed status of the build. Nested schema for status_details:
- 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
- etag str
- ETag identifier for code_engine_build.
- 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 provider-assigned unique ID for this managed resource.
- 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:
- status str
- (String) The current status of the build.
- Constraints: Allowable values are:
ready
,failed
.
- Constraints: Allowable values are:
- status_
details Sequence[CodeEngine Build Status Detail] - (List) The detailed status of the build. Nested schema for status_details:
- 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
- etag String
- ETag identifier for code_engine_build.
- 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 provider-assigned unique ID for this managed resource.
- 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:
- 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:
Look up Existing CodeEngineBuild Resource
Get an existing CodeEngineBuild resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CodeEngineBuildState, opts?: CustomResourceOptions): CodeEngineBuild
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
build_id: Optional[str] = None,
code_engine_build_id: Optional[str] = None,
created_at: Optional[str] = None,
entity_tag: Optional[str] = None,
etag: Optional[str] = None,
href: Optional[str] = None,
name: Optional[str] = None,
output_image: Optional[str] = None,
output_secret: Optional[str] = None,
project_id: Optional[str] = None,
region: Optional[str] = None,
resource_type: Optional[str] = None,
source_context_dir: Optional[str] = None,
source_revision: Optional[str] = None,
source_secret: Optional[str] = None,
source_type: Optional[str] = None,
source_url: Optional[str] = None,
status: Optional[str] = None,
status_details: Optional[Sequence[CodeEngineBuildStatusDetailArgs]] = None,
strategy_size: Optional[str] = None,
strategy_spec_file: Optional[str] = None,
strategy_type: Optional[str] = None,
timeout: Optional[float] = None) -> CodeEngineBuild
func GetCodeEngineBuild(ctx *Context, name string, id IDInput, state *CodeEngineBuildState, opts ...ResourceOption) (*CodeEngineBuild, error)
public static CodeEngineBuild Get(string name, Input<string> id, CodeEngineBuildState? state, CustomResourceOptions? opts = null)
public static CodeEngineBuild get(String name, Output<String> id, CodeEngineBuildState state, CustomResourceOptions options)
resources: _: type: ibm:CodeEngineBuild get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- 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
- Code
Engine stringBuild Id - The unique identifier of the code_engine_build.
- 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
- Etag string
- ETag identifier for code_engine_build.
- 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
- Name string
- The name of the 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
- Output
Image 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 - 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 - 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
- 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 - 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 - 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 - 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 - 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 - 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<CodeEngine Build Status Detail> - (List) The detailed status of the build. Nested schema for status_details:
- Strategy
Size 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 - 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 - 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
- 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
- Code
Engine stringBuild Id - The unique identifier of the code_engine_build.
- 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
- Etag string
- ETag identifier for code_engine_build.
- 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
- Name string
- The name of the 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
- Output
Image 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 - 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 - 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
- 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 - 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 - 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 - 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 - 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 - 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 []CodeEngine Build Status Detail Args - (List) The detailed status of the build. Nested schema for status_details:
- Strategy
Size 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 - 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 - 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
- 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
- code
Engine StringBuild Id - The unique identifier of the code_engine_build.
- 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
- etag String
- ETag identifier for code_engine_build.
- 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
- name String
- The name of the 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
- output
Image 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 - 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 - 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
- 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 - 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 - 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 - 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 - 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 - 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<CodeEngine Build Status Detail> - (List) The detailed status of the build. Nested schema for status_details:
- strategy
Size 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 - 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 - 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
- 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
- code
Engine stringBuild Id - The unique identifier of the code_engine_build.
- 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
- etag string
- ETag identifier for code_engine_build.
- 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
- name string
- The name of the 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
- output
Image 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 - 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 - 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
- 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 - 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 - 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 - 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 - 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 - 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 CodeEngine Build Status Detail[] - (List) The detailed status of the build. Nested schema for status_details:
- strategy
Size 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 - 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 - 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
- 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
- code_
engine_ strbuild_ id - The unique identifier of the code_engine_build.
- 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
- etag str
- ETag identifier for code_engine_build.
- 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
- name str
- The name of the 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
- output_
image str - 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 - 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 - 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
- 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 - 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 - 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 - 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 - 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 - 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[CodeEngine Build Status Detail Args] - (List) The detailed status of the build. Nested schema for status_details:
- strategy_
size str - 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 - 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 - 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
- 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
- code
Engine StringBuild Id - The unique identifier of the code_engine_build.
- 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
- etag String
- ETag identifier for code_engine_build.
- 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
- name String
- The name of the 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
- output
Image 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 - 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 - 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
- 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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
- 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
CodeEngineBuildStatusDetail, CodeEngineBuildStatusDetailArgs
- 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:
Import
You can import the ibm_code_engine_build
resource by using name
.
The name
property can be formed from project_id
, and name
in the following format:
<project_id>/<name>
project_id
: A string in the format15314cc3-85b4-4338-903f-c28cdee6d005
. The ID of the project.name
: A string in the formatmy-build
. The name of the build.
Syntax
```sh $ pulumi import ibm:index/codeEngineBuild:CodeEngineBuild code_engine_build <project_id>/<name> ```
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.