Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getProjectEnvironment
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getProjectEnvironment

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source to retrieve information about a project_environment. 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 projectEnvironment = ibm.getProjectEnvironment({
    projectEnvironmentId: ibm_project_environment.project_environment_instance.project_environment_id,
    projectId: ibm_project_environment.project_environment_instance.project_id,
});

    import pulumi
import pulumi_ibm as ibm

project_environment = ibm.get_project_environment(project_environment_id=ibm_project_environment["project_environment_instance"]["project_environment_id"],
    project_id=ibm_project_environment["project_environment_instance"]["project_id"])

    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.LookupProjectEnvironment(ctx, &ibm.LookupProjectEnvironmentArgs{
			ProjectEnvironmentId: ibm_project_environment.Project_environment_instance.Project_environment_id,
			ProjectId:            ibm_project_environment.Project_environment_instance.Project_id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var projectEnvironment = Ibm.GetProjectEnvironment.Invoke(new()
    {
        ProjectEnvironmentId = ibm_project_environment.Project_environment_instance.Project_environment_id,
        ProjectId = ibm_project_environment.Project_environment_instance.Project_id,
    });

});

    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.GetProjectEnvironmentArgs;
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 projectEnvironment = IbmFunctions.getProjectEnvironment(GetProjectEnvironmentArgs.builder()
            .projectEnvironmentId(ibm_project_environment.project_environment_instance().project_environment_id())
            .projectId(ibm_project_environment.project_environment_instance().project_id())
            .build());

    }
}

    variables:
  projectEnvironment:
    fn::invoke:
      function: ibm:getProjectEnvironment
      arguments:
        projectEnvironmentId: ${ibm_project_environment.project_environment_instance.project_environment_id}
        projectId: ${ibm_project_environment.project_environment_instance.project_id}

    Using getProjectEnvironment

    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 getProjectEnvironment(args: GetProjectEnvironmentArgs, opts?: InvokeOptions): Promise<GetProjectEnvironmentResult>
function getProjectEnvironmentOutput(args: GetProjectEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetProjectEnvironmentResult>
    def get_project_environment(id: Optional[str] = None,
                            project_environment_id: Optional[str] = None,
                            project_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetProjectEnvironmentResult
def get_project_environment_output(id: Optional[pulumi.Input[str]] = None,
                            project_environment_id: Optional[pulumi.Input[str]] = None,
                            project_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetProjectEnvironmentResult]
    func LookupProjectEnvironment(ctx *Context, args *LookupProjectEnvironmentArgs, opts ...InvokeOption) (*LookupProjectEnvironmentResult, error)
func LookupProjectEnvironmentOutput(ctx *Context, args *LookupProjectEnvironmentOutputArgs, opts ...InvokeOption) LookupProjectEnvironmentResultOutput

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

    public static class GetProjectEnvironment 
{
    public static Task<GetProjectEnvironmentResult> InvokeAsync(GetProjectEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectEnvironmentResult> Invoke(GetProjectEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetProjectEnvironmentResult> getProjectEnvironment(GetProjectEnvironmentArgs args, InvokeOptions options)
public static Output<GetProjectEnvironmentResult> getProjectEnvironment(GetProjectEnvironmentArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getProjectEnvironment:getProjectEnvironment
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ProjectEnvironmentId string
    The environment ID.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$).+$/.
    ProjectId string
    The unique project ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    Id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    ProjectEnvironmentId string
    The environment ID.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$).+$/.
    ProjectId string
    The unique project ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    Id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    projectEnvironmentId String
    The environment ID.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$).+$/.
    projectId String
    The unique project ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    id String
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    projectEnvironmentId string
    The environment ID.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$).+$/.
    projectId string
    The unique project ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    project_environment_id str
    The environment ID.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$).+$/.
    project_id str
    The unique project ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    id str
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    projectEnvironmentId String
    The environment ID.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$).+$/.
    projectId String
    The unique project ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    id String
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.

    getProjectEnvironment Result

    The following output properties are available:

    CreatedAt string
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    Definitions List<GetProjectEnvironmentDefinition>
    (List) The definition of the project reference. Nested schema for definition:
    Href string
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    Id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    ModifiedAt string
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    ProjectEnvironmentId string
    ProjectId string
    Projects List<GetProjectEnvironmentProject>
    (List) The project that is referenced by this resource. Nested schema for project:
    TargetAccount string
    (String) The target account ID derived from the authentication block values. The target account exists only if the environment currently has an authorization block.

    • Constraints: The maximum length is 64 characters. The value must match regular expression /^[a-zA-Z0-9.-]+$/.
    CreatedAt string
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    Definitions []GetProjectEnvironmentDefinition
    (List) The definition of the project reference. Nested schema for definition:
    Href string
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    Id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    ModifiedAt string
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    ProjectEnvironmentId string
    ProjectId string
    Projects []GetProjectEnvironmentProject
    (List) The project that is referenced by this resource. Nested schema for project:
    TargetAccount string
    (String) The target account ID derived from the authentication block values. The target account exists only if the environment currently has an authorization block.

    • Constraints: The maximum length is 64 characters. The value must match regular expression /^[a-zA-Z0-9.-]+$/.
    createdAt String
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    definitions List<GetProjectEnvironmentDefinition>
    (List) The definition of the project reference. Nested schema for definition:
    href String
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    id String
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    modifiedAt String
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    projectEnvironmentId String
    projectId String
    projects List<GetProjectEnvironmentProject>
    (List) The project that is referenced by this resource. Nested schema for project:
    targetAccount String
    (String) The target account ID derived from the authentication block values. The target account exists only if the environment currently has an authorization block.

    • Constraints: The maximum length is 64 characters. The value must match regular expression /^[a-zA-Z0-9.-]+$/.
    createdAt string
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    definitions GetProjectEnvironmentDefinition[]
    (List) The definition of the project reference. Nested schema for definition:
    href string
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    modifiedAt string
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    projectEnvironmentId string
    projectId string
    projects GetProjectEnvironmentProject[]
    (List) The project that is referenced by this resource. Nested schema for project:
    targetAccount string
    (String) The target account ID derived from the authentication block values. The target account exists only if the environment currently has an authorization block.

    • Constraints: The maximum length is 64 characters. The value must match regular expression /^[a-zA-Z0-9.-]+$/.
    created_at str
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    definitions Sequence[GetProjectEnvironmentDefinition]
    (List) The definition of the project reference. Nested schema for definition:
    href str
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    id str
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    modified_at str
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    project_environment_id str
    project_id str
    projects Sequence[GetProjectEnvironmentProject]
    (List) The project that is referenced by this resource. Nested schema for project:
    target_account str
    (String) The target account ID derived from the authentication block values. The target account exists only if the environment currently has an authorization block.

    • Constraints: The maximum length is 64 characters. The value must match regular expression /^[a-zA-Z0-9.-]+$/.
    createdAt String
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    definitions List<Property Map>
    (List) The definition of the project reference. Nested schema for definition:
    href String
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    id String
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    modifiedAt String
    (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
    projectEnvironmentId String
    projectId String
    projects List<Property Map>
    (List) The project that is referenced by this resource. Nested schema for project:
    targetAccount String
    (String) The target account ID derived from the authentication block values. The target account exists only if the environment currently has an authorization block.

    • Constraints: The maximum length is 64 characters. The value must match regular expression /^[a-zA-Z0-9.-]+$/.

    Supporting Types

    GetProjectEnvironmentDefinition

    Authorizations List<GetProjectEnvironmentDefinitionAuthorization>
    (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
    ComplianceProfiles List<GetProjectEnvironmentDefinitionComplianceProfile>
    (List) The profile that is required for compliance. Nested schema for compliance_profile:
    Description string
    (String) The description of the environment.

    • Constraints: The default value is ''. The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
    Inputs Dictionary<string, string>
    (Map) The input variables that are used for configuration definition and environment.
    Name string
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
    Authorizations []GetProjectEnvironmentDefinitionAuthorization
    (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
    ComplianceProfiles []GetProjectEnvironmentDefinitionComplianceProfile
    (List) The profile that is required for compliance. Nested schema for compliance_profile:
    Description string
    (String) The description of the environment.

    • Constraints: The default value is ''. The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
    Inputs map[string]string
    (Map) The input variables that are used for configuration definition and environment.
    Name string
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
    authorizations List<GetProjectEnvironmentDefinitionAuthorization>
    (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
    complianceProfiles List<GetProjectEnvironmentDefinitionComplianceProfile>
    (List) The profile that is required for compliance. Nested schema for compliance_profile:
    description String
    (String) The description of the environment.

    • Constraints: The default value is ''. The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
    inputs Map<String,String>
    (Map) The input variables that are used for configuration definition and environment.
    name String
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
    authorizations GetProjectEnvironmentDefinitionAuthorization[]
    (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
    complianceProfiles GetProjectEnvironmentDefinitionComplianceProfile[]
    (List) The profile that is required for compliance. Nested schema for compliance_profile:
    description string
    (String) The description of the environment.

    • Constraints: The default value is ''. The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
    inputs {[key: string]: string}
    (Map) The input variables that are used for configuration definition and environment.
    name string
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
    authorizations Sequence[GetProjectEnvironmentDefinitionAuthorization]
    (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
    compliance_profiles Sequence[GetProjectEnvironmentDefinitionComplianceProfile]
    (List) The profile that is required for compliance. Nested schema for compliance_profile:
    description str
    (String) The description of the environment.

    • Constraints: The default value is ''. The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
    inputs Mapping[str, str]
    (Map) The input variables that are used for configuration definition and environment.
    name str
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
    authorizations List<Property Map>
    (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
    complianceProfiles List<Property Map>
    (List) The profile that is required for compliance. Nested schema for compliance_profile:
    description String
    (String) The description of the environment.

    • Constraints: The default value is ''. The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
    inputs Map<String>
    (Map) The input variables that are used for configuration definition and environment.
    name String
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.

    GetProjectEnvironmentDefinitionAuthorization

    ApiKey string
    (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a CRN or JSON blob.

    • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.
    Method string
    (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.

    • Constraints: Allowable values are: api_key, trusted_profile.
    TrustedProfileId string
    (String) The trusted profile ID.

    • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    ApiKey string
    (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a CRN or JSON blob.

    • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.
    Method string
    (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.

    • Constraints: Allowable values are: api_key, trusted_profile.
    TrustedProfileId string
    (String) The trusted profile ID.

    • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    apiKey String
    (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a CRN or JSON blob.

    • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.
    method String
    (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.

    • Constraints: Allowable values are: api_key, trusted_profile.
    trustedProfileId String
    (String) The trusted profile ID.

    • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    apiKey string
    (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a CRN or JSON blob.

    • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.
    method string
    (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.

    • Constraints: Allowable values are: api_key, trusted_profile.
    trustedProfileId string
    (String) The trusted profile ID.

    • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    api_key str
    (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a CRN or JSON blob.

    • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.
    method str
    (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.

    • Constraints: Allowable values are: api_key, trusted_profile.
    trusted_profile_id str
    (String) The trusted profile ID.

    • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    apiKey String
    (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a CRN or JSON blob.

    • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.
    method String
    (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.

    • Constraints: Allowable values are: api_key, trusted_profile.
    trustedProfileId String
    (String) The trusted profile ID.

    • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.

    GetProjectEnvironmentDefinitionComplianceProfile

    AttachmentId string
    (String) A unique ID for the attachment to a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    Id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    InstanceId string
    (String) A unique ID for the instance of a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    InstanceLocation string
    (String) The location of the compliance instance.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
    ProfileName string
    (String) The name of the compliance profile.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.
    AttachmentId string
    (String) A unique ID for the attachment to a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    Id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    InstanceId string
    (String) A unique ID for the instance of a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    InstanceLocation string
    (String) The location of the compliance instance.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
    ProfileName string
    (String) The name of the compliance profile.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.
    attachmentId String
    (String) A unique ID for the attachment to a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    id String
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    instanceId String
    (String) A unique ID for the instance of a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    instanceLocation String
    (String) The location of the compliance instance.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
    profileName String
    (String) The name of the compliance profile.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.
    attachmentId string
    (String) A unique ID for the attachment to a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    instanceId string
    (String) A unique ID for the instance of a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    instanceLocation string
    (String) The location of the compliance instance.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
    profileName string
    (String) The name of the compliance profile.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.
    attachment_id str
    (String) A unique ID for the attachment to a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    id str
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    instance_id str
    (String) A unique ID for the instance of a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    instance_location str
    (String) The location of the compliance instance.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
    profile_name str
    (String) The name of the compliance profile.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.
    attachmentId String
    (String) A unique ID for the attachment to a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    id String
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    instanceId String
    (String) A unique ID for the instance of a compliance profile.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    instanceLocation String
    (String) The location of the compliance instance.

    • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
    profileName String
    (String) The name of the compliance profile.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/.

    GetProjectEnvironmentProject

    Crn string
    (String) An IBM Cloud resource name that uniquely identifies a resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 4 characters. The value must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/.
    Definitions List<GetProjectEnvironmentProjectDefinition>
    (List) The definition of the project reference. Nested schema for definition:
    Href string
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    Id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    Crn string
    (String) An IBM Cloud resource name that uniquely identifies a resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 4 characters. The value must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/.
    Definitions []GetProjectEnvironmentProjectDefinition
    (List) The definition of the project reference. Nested schema for definition:
    Href string
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    Id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    crn String
    (String) An IBM Cloud resource name that uniquely identifies a resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 4 characters. The value must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/.
    definitions List<GetProjectEnvironmentProjectDefinition>
    (List) The definition of the project reference. Nested schema for definition:
    href String
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    id String
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    crn string
    (String) An IBM Cloud resource name that uniquely identifies a resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 4 characters. The value must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/.
    definitions GetProjectEnvironmentProjectDefinition[]
    (List) The definition of the project reference. Nested schema for definition:
    href string
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    id string
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    crn str
    (String) An IBM Cloud resource name that uniquely identifies a resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 4 characters. The value must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/.
    definitions Sequence[GetProjectEnvironmentProjectDefinition]
    (List) The definition of the project reference. Nested schema for definition:
    href str
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    id str
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
    crn String
    (String) An IBM Cloud resource name that uniquely identifies a resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 4 characters. The value must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/.
    definitions List<Property Map>
    (List) The definition of the project reference. Nested schema for definition:
    href String
    (String) A URL.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
    id String
    (String) The unique ID.

    • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.

    GetProjectEnvironmentProjectDefinition

    Name string
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
    Name string
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
    name String
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
    name string
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
    name str
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
    name String
    (String) The name of the project.

    • Constraints: The maximum length is 64 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.

    Package Details

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