1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCodeEngineProject
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getCodeEngineProject

Explore with Pulumi AI

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const codeEngineProject = ibm.getCodeEngineProject({
    projectId: "15314cc3-85b4-4338-903f-c28cdee6d005",
});
Copy
import pulumi
import pulumi_ibm as ibm

code_engine_project = ibm.get_code_engine_project(project_id="15314cc3-85b4-4338-903f-c28cdee6d005")
Copy
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.LookupCodeEngineProject(ctx, &ibm.LookupCodeEngineProjectArgs{
			ProjectId: "15314cc3-85b4-4338-903f-c28cdee6d005",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var codeEngineProject = Ibm.GetCodeEngineProject.Invoke(new()
    {
        ProjectId = "15314cc3-85b4-4338-903f-c28cdee6d005",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetCodeEngineProjectArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var codeEngineProject = IbmFunctions.getCodeEngineProject(GetCodeEngineProjectArgs.builder()
            .projectId("15314cc3-85b4-4338-903f-c28cdee6d005")
            .build());

    }
}
Copy
variables:
  codeEngineProject:
    fn::invoke:
      function: ibm:getCodeEngineProject
      arguments:
        projectId: 15314cc3-85b4-4338-903f-c28cdee6d005
Copy

Using getCodeEngineProject

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

function getCodeEngineProject(args: GetCodeEngineProjectArgs, opts?: InvokeOptions): Promise<GetCodeEngineProjectResult>
function getCodeEngineProjectOutput(args: GetCodeEngineProjectOutputArgs, opts?: InvokeOptions): Output<GetCodeEngineProjectResult>
Copy
def get_code_engine_project(id: Optional[str] = None,
                            project_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetCodeEngineProjectResult
def get_code_engine_project_output(id: Optional[pulumi.Input[str]] = None,
                            project_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetCodeEngineProjectResult]
Copy
func LookupCodeEngineProject(ctx *Context, args *LookupCodeEngineProjectArgs, opts ...InvokeOption) (*LookupCodeEngineProjectResult, error)
func LookupCodeEngineProjectOutput(ctx *Context, args *LookupCodeEngineProjectOutputArgs, opts ...InvokeOption) LookupCodeEngineProjectResultOutput
Copy

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

public static class GetCodeEngineProject 
{
    public static Task<GetCodeEngineProjectResult> InvokeAsync(GetCodeEngineProjectArgs args, InvokeOptions? opts = null)
    public static Output<GetCodeEngineProjectResult> Invoke(GetCodeEngineProjectInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCodeEngineProjectResult> getCodeEngineProject(GetCodeEngineProjectArgs args, InvokeOptions options)
public static Output<GetCodeEngineProjectResult> getCodeEngineProject(GetCodeEngineProjectArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getCodeEngineProject:getCodeEngineProject
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ProjectId This property is required. string
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Id string
The unique identifier of the code_engine_project.
ProjectId This property is required. string
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Id string
The unique identifier of the code_engine_project.
projectId This property is required. String
The ID of the project.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
id string
The unique identifier of the code_engine_project.
project_id This property is required. str
The ID of the project.

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

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

getCodeEngineProject Result

The following output properties are available:

AccountId string
(String) An alphanumeric value identifying the account ID.
CreatedAt string
(String) The timestamp when the project was created.
Crn string
(String) The CRN of the project.
Href string
(String) When you provision a new resource, a URL is created identifying the location of the instance.

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

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9\\-._: ])+$/.
ProjectId string
Region string
(String) The region for your project deployment. Possible values: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
ResourceGroupId string
(String) The ID of the resource group.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-z0-9]*$/.
ResourceType string
(String) The type of the project.

  • Constraints: Allowable values are: project_v2.
Status string
(String) The current state of the project. For example, when the project is created and is ready for use, the status of the project is active. After deleting a project it will remain in status soft_deleted for a seven day period, during which it will still be retrievable.

  • Constraints: Allowable values are: active, inactive, pending_removal, hard_deleting, hard_deletion_failed, hard_deleted, deleting, deletion_failed, soft_deleted, preparing, creating, creation_failed.
AccountId string
(String) An alphanumeric value identifying the account ID.
CreatedAt string
(String) The timestamp when the project was created.
Crn string
(String) The CRN of the project.
Href string
(String) When you provision a new resource, a URL is created identifying the location of the instance.

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

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9\\-._: ])+$/.
ProjectId string
Region string
(String) The region for your project deployment. Possible values: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
ResourceGroupId string
(String) The ID of the resource group.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-z0-9]*$/.
ResourceType string
(String) The type of the project.

  • Constraints: Allowable values are: project_v2.
Status string
(String) The current state of the project. For example, when the project is created and is ready for use, the status of the project is active. After deleting a project it will remain in status soft_deleted for a seven day period, during which it will still be retrievable.

  • Constraints: Allowable values are: active, inactive, pending_removal, hard_deleting, hard_deletion_failed, hard_deleted, deleting, deletion_failed, soft_deleted, preparing, creating, creation_failed.
accountId String
(String) An alphanumeric value identifying the account ID.
createdAt String
(String) The timestamp when the project was created.
crn String
(String) The CRN of the project.
href String
(String) When you provision a new resource, a URL is created identifying the location of the instance.

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

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9\\-._: ])+$/.
projectId String
region String
(String) The region for your project deployment. Possible values: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
resourceGroupId String
(String) The ID of the resource group.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-z0-9]*$/.
resourceType String
(String) The type of the project.

  • Constraints: Allowable values are: project_v2.
status String
(String) The current state of the project. For example, when the project is created and is ready for use, the status of the project is active. After deleting a project it will remain in status soft_deleted for a seven day period, during which it will still be retrievable.

  • Constraints: Allowable values are: active, inactive, pending_removal, hard_deleting, hard_deletion_failed, hard_deleted, deleting, deletion_failed, soft_deleted, preparing, creating, creation_failed.
accountId string
(String) An alphanumeric value identifying the account ID.
createdAt string
(String) The timestamp when the project was created.
crn string
(String) The CRN of the project.
href string
(String) When you provision a new resource, a URL is created identifying the location of the instance.

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

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9\\-._: ])+$/.
projectId string
region string
(String) The region for your project deployment. Possible values: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
resourceGroupId string
(String) The ID of the resource group.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-z0-9]*$/.
resourceType string
(String) The type of the project.

  • Constraints: Allowable values are: project_v2.
status string
(String) The current state of the project. For example, when the project is created and is ready for use, the status of the project is active. After deleting a project it will remain in status soft_deleted for a seven day period, during which it will still be retrievable.

  • Constraints: Allowable values are: active, inactive, pending_removal, hard_deleting, hard_deletion_failed, hard_deleted, deleting, deletion_failed, soft_deleted, preparing, creating, creation_failed.
account_id str
(String) An alphanumeric value identifying the account ID.
created_at str
(String) The timestamp when the project was created.
crn str
(String) The CRN of the project.
href str
(String) When you provision a new resource, a URL is created identifying the location of the instance.

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

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9\\-._: ])+$/.
project_id str
region str
(String) The region for your project deployment. Possible values: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
resource_group_id str
(String) The ID of the resource group.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-z0-9]*$/.
resource_type str
(String) The type of the project.

  • Constraints: Allowable values are: project_v2.
status str
(String) The current state of the project. For example, when the project is created and is ready for use, the status of the project is active. After deleting a project it will remain in status soft_deleted for a seven day period, during which it will still be retrievable.

  • Constraints: Allowable values are: active, inactive, pending_removal, hard_deleting, hard_deletion_failed, hard_deleted, deleting, deletion_failed, soft_deleted, preparing, creating, creation_failed.
accountId String
(String) An alphanumeric value identifying the account ID.
createdAt String
(String) The timestamp when the project was created.
crn String
(String) The CRN of the project.
href String
(String) When you provision a new resource, a URL is created identifying the location of the instance.

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

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^([^\\x00-\\x7F]|[a-zA-Z0-9\\-._: ])+$/.
projectId String
region String
(String) The region for your project deployment. Possible values: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
resourceGroupId String
(String) The ID of the resource group.

  • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /^[a-z0-9]*$/.
resourceType String
(String) The type of the project.

  • Constraints: Allowable values are: project_v2.
status String
(String) The current state of the project. For example, when the project is created and is ready for use, the status of the project is active. After deleting a project it will remain in status soft_deleted for a seven day period, during which it will still be retrievable.

  • Constraints: Allowable values are: active, inactive, pending_removal, hard_deleting, hard_deletion_failed, hard_deleted, deleting, deletion_failed, soft_deleted, preparing, creating, creation_failed.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.