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

ibm.getProject

Explore with Pulumi AI

Provides a read-only data source to retrieve information about a 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 project = ibm.getProject({
    projectId: ibm_project.project_instance.id,
});
Copy
import pulumi
import pulumi_ibm as ibm

project = ibm.get_project(project_id=ibm_project["project_instance"]["id"])
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.LookupProject(ctx, &ibm.LookupProjectArgs{
			ProjectId: ibm_project.Project_instance.Id,
		}, 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 project = Ibm.GetProject.Invoke(new()
    {
        ProjectId = ibm_project.Project_instance.Id,
    });

});
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.GetProjectArgs;
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 project = IbmFunctions.getProject(GetProjectArgs.builder()
            .projectId(ibm_project.project_instance().id())
            .build());

    }
}
Copy
variables:
  project:
    fn::invoke:
      function: ibm:getProject
      arguments:
        projectId: ${ibm_project.project_instance.id}
Copy

Using getProject

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 getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>
Copy
def get_project(id: Optional[str] = None,
                project_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(id: Optional[pulumi.Input[str]] = None,
                project_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]
Copy
func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput
Copy

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

public static class GetProject 
{
    public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getProject:getProject
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ProjectId This property is required. 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]+$/.
ProjectId This property is required. 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]+$/.
projectId This property is required. 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]+$/.
projectId This property is required. 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_id This property is required. 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]+$/.
projectId This property is required. 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]+$/.

getProject Result

The following output properties are available:

Configs List<GetProjectConfig>
(List) The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:
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.
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]*/.
CumulativeNeedsAttentionViewError bool
(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error when you retrieved the cumulative needs attention view.

  • Constraints: The default value is false.
CumulativeNeedsAttentionViews List<GetProjectCumulativeNeedsAttentionView>
(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

  • Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:
Definitions List<GetProjectDefinition>
(List) The definition of the project reference. Nested schema for definition:
Environments List<GetProjectEnvironment>
(List) The project environment. These environments are only included in the response if project environments were created on the project.

  • Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:
EventNotificationsCrn string
(String) The CRN of the Event Notifications instance if one is connected to this project.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
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]+$/.
Location string
(Forces new resource, String) The IBM Cloud location where a resource is deployed.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
ProjectId string
ResourceGroup string
(Forces new resource, String) The resource group name where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
ResourceGroupId string
(String) The resource group ID where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^[0-9a-zA-Z]+$/.
State string
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.
Configs []GetProjectConfigType
(List) The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:
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.
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]*/.
CumulativeNeedsAttentionViewError bool
(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error when you retrieved the cumulative needs attention view.

  • Constraints: The default value is false.
CumulativeNeedsAttentionViews []GetProjectCumulativeNeedsAttentionView
(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

  • Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:
Definitions []GetProjectDefinition
(List) The definition of the project reference. Nested schema for definition:
Environments []GetProjectEnvironmentType
(List) The project environment. These environments are only included in the response if project environments were created on the project.

  • Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:
EventNotificationsCrn string
(String) The CRN of the Event Notifications instance if one is connected to this project.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
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]+$/.
Location string
(Forces new resource, String) The IBM Cloud location where a resource is deployed.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
ProjectId string
ResourceGroup string
(Forces new resource, String) The resource group name where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
ResourceGroupId string
(String) The resource group ID where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^[0-9a-zA-Z]+$/.
State string
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.
configs List<GetProjectConfig>
(List) The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:
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.
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]*/.
cumulativeNeedsAttentionViewError Boolean
(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error when you retrieved the cumulative needs attention view.

  • Constraints: The default value is false.
cumulativeNeedsAttentionViews List<GetProjectCumulativeNeedsAttentionView>
(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

  • Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:
definitions List<GetProjectDefinition>
(List) The definition of the project reference. Nested schema for definition:
environments List<GetProjectEnvironment>
(List) The project environment. These environments are only included in the response if project environments were created on the project.

  • Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:
eventNotificationsCrn String
(String) The CRN of the Event Notifications instance if one is connected to this project.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
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]+$/.
location String
(Forces new resource, String) The IBM Cloud location where a resource is deployed.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
projectId String
resourceGroup String
(Forces new resource, String) The resource group name where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
resourceGroupId String
(String) The resource group ID where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^[0-9a-zA-Z]+$/.
state String
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.
configs GetProjectConfig[]
(List) The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:
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.
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]*/.
cumulativeNeedsAttentionViewError boolean
(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error when you retrieved the cumulative needs attention view.

  • Constraints: The default value is false.
cumulativeNeedsAttentionViews GetProjectCumulativeNeedsAttentionView[]
(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

  • Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:
definitions GetProjectDefinition[]
(List) The definition of the project reference. Nested schema for definition:
environments GetProjectEnvironment[]
(List) The project environment. These environments are only included in the response if project environments were created on the project.

  • Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:
eventNotificationsCrn string
(String) The CRN of the Event Notifications instance if one is connected to this project.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
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]+$/.
location string
(Forces new resource, String) The IBM Cloud location where a resource is deployed.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
projectId string
resourceGroup string
(Forces new resource, String) The resource group name where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
resourceGroupId string
(String) The resource group ID where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^[0-9a-zA-Z]+$/.
state string
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.
configs Sequence[GetProjectConfig]
(List) The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:
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.
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]*/.
cumulative_needs_attention_view_error bool
(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error when you retrieved the cumulative needs attention view.

  • Constraints: The default value is false.
cumulative_needs_attention_views Sequence[GetProjectCumulativeNeedsAttentionView]
(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

  • Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:
definitions Sequence[GetProjectDefinition]
(List) The definition of the project reference. Nested schema for definition:
environments Sequence[GetProjectEnvironment]
(List) The project environment. These environments are only included in the response if project environments were created on the project.

  • Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:
event_notifications_crn str
(String) The CRN of the Event Notifications instance if one is connected to this project.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
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]+$/.
location str
(Forces new resource, String) The IBM Cloud location where a resource is deployed.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
project_id str
resource_group str
(Forces new resource, String) The resource group name where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
resource_group_id str
(String) The resource group ID where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^[0-9a-zA-Z]+$/.
state str
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.
configs List<Property Map>
(List) The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:
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.
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]*/.
cumulativeNeedsAttentionViewError Boolean
(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error when you retrieved the cumulative needs attention view.

  • Constraints: The default value is false.
cumulativeNeedsAttentionViews List<Property Map>
(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

  • Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:
definitions List<Property Map>
(List) The definition of the project reference. Nested schema for definition:
environments List<Property Map>
(List) The project environment. These environments are only included in the response if project environments were created on the project.

  • Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:
eventNotificationsCrn String
(String) The CRN of the Event Notifications instance if one is connected to this project.

  • Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
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]+$/.
location String
(Forces new resource, String) The IBM Cloud location where a resource is deployed.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
projectId String
resourceGroup String
(Forces new resource, String) The resource group name where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
resourceGroupId String
(String) The resource group ID where the project's data and tools are created.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^[0-9a-zA-Z]+$/.
state String
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.

Supporting Types

GetProjectConfig

ApprovedVersions This property is required. List<GetProjectConfigApprovedVersion>
(List) A summary of a project configuration version. Nested schema for approved_version:
CreatedAt This property is required. 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 This property is required. List<GetProjectConfigDefinition>
(List) The definition of the project reference. Nested schema for definition:
DeployedVersions This property is required. List<GetProjectConfigDeployedVersion>
(List) A summary of a project configuration version. Nested schema for deployed_version:
DeploymentModel This property is required. string
(String) The configuration type.

  • Constraints: Allowable values are: project_deployed, user_deployed, stack.
Href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
ModifiedAt This property is required. 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.
Projects This property is required. List<GetProjectConfigProject>
(List) The project that is referenced by this resource. Nested schema for project:
State This property is required. string
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.
Version This property is required. double
(Integer) The version of the configuration.
ApprovedVersions This property is required. []GetProjectConfigApprovedVersion
(List) A summary of a project configuration version. Nested schema for approved_version:
CreatedAt This property is required. 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 This property is required. []GetProjectConfigDefinition
(List) The definition of the project reference. Nested schema for definition:
DeployedVersions This property is required. []GetProjectConfigDeployedVersion
(List) A summary of a project configuration version. Nested schema for deployed_version:
DeploymentModel This property is required. string
(String) The configuration type.

  • Constraints: Allowable values are: project_deployed, user_deployed, stack.
Href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
ModifiedAt This property is required. 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.
Projects This property is required. []GetProjectConfigProject
(List) The project that is referenced by this resource. Nested schema for project:
State This property is required. string
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.
Version This property is required. float64
(Integer) The version of the configuration.
approvedVersions This property is required. List<GetProjectConfigApprovedVersion>
(List) A summary of a project configuration version. Nested schema for approved_version:
createdAt This property is required. 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 This property is required. List<GetProjectConfigDefinition>
(List) The definition of the project reference. Nested schema for definition:
deployedVersions This property is required. List<GetProjectConfigDeployedVersion>
(List) A summary of a project configuration version. Nested schema for deployed_version:
deploymentModel This property is required. String
(String) The configuration type.

  • Constraints: Allowable values are: project_deployed, user_deployed, stack.
href This property is required. 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 This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
modifiedAt This property is required. 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.
projects This property is required. List<GetProjectConfigProject>
(List) The project that is referenced by this resource. Nested schema for project:
state This property is required. String
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.
version This property is required. Double
(Integer) The version of the configuration.
approvedVersions This property is required. GetProjectConfigApprovedVersion[]
(List) A summary of a project configuration version. Nested schema for approved_version:
createdAt This property is required. 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 This property is required. GetProjectConfigDefinition[]
(List) The definition of the project reference. Nested schema for definition:
deployedVersions This property is required. GetProjectConfigDeployedVersion[]
(List) A summary of a project configuration version. Nested schema for deployed_version:
deploymentModel This property is required. string
(String) The configuration type.

  • Constraints: Allowable values are: project_deployed, user_deployed, stack.
href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
modifiedAt This property is required. 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.
projects This property is required. GetProjectConfigProject[]
(List) The project that is referenced by this resource. Nested schema for project:
state This property is required. string
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.
version This property is required. number
(Integer) The version of the configuration.
approved_versions This property is required. Sequence[GetProjectConfigApprovedVersion]
(List) A summary of a project configuration version. Nested schema for approved_version:
created_at This property is required. 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 This property is required. Sequence[GetProjectConfigDefinition]
(List) The definition of the project reference. Nested schema for definition:
deployed_versions This property is required. Sequence[GetProjectConfigDeployedVersion]
(List) A summary of a project configuration version. Nested schema for deployed_version:
deployment_model This property is required. str
(String) The configuration type.

  • Constraints: Allowable values are: project_deployed, user_deployed, stack.
href This property is required. 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 This property is required. str
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
modified_at This property is required. 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.
projects This property is required. Sequence[GetProjectConfigProject]
(List) The project that is referenced by this resource. Nested schema for project:
state This property is required. str
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.
version This property is required. float
(Integer) The version of the configuration.
approvedVersions This property is required. List<Property Map>
(List) A summary of a project configuration version. Nested schema for approved_version:
createdAt This property is required. 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 This property is required. List<Property Map>
(List) The definition of the project reference. Nested schema for definition:
deployedVersions This property is required. List<Property Map>
(List) A summary of a project configuration version. Nested schema for deployed_version:
deploymentModel This property is required. String
(String) The configuration type.

  • Constraints: Allowable values are: project_deployed, user_deployed, stack.
href This property is required. 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 This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
modifiedAt This property is required. 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.
projects This property is required. List<Property Map>
(List) The project that is referenced by this resource. Nested schema for project:
state This property is required. String
(String) The project status value.

  • Constraints: Allowable values are: ready, deleting, deleting_failed.
version This property is required. Number
(Integer) The version of the configuration.

GetProjectConfigApprovedVersion

Definitions This property is required. List<GetProjectConfigApprovedVersionDefinition>
(List) The definition of the project reference. Nested schema for definition:
Href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
State This property is required. string
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
StateCode This property is required. string
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
Version This property is required. double
(Integer) The version of the configuration.
Definitions This property is required. []GetProjectConfigApprovedVersionDefinition
(List) The definition of the project reference. Nested schema for definition:
Href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
State This property is required. string
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
StateCode This property is required. string
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
Version This property is required. float64
(Integer) The version of the configuration.
definitions This property is required. List<GetProjectConfigApprovedVersionDefinition>
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state This property is required. String
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
stateCode This property is required. String
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
version This property is required. Double
(Integer) The version of the configuration.
definitions This property is required. GetProjectConfigApprovedVersionDefinition[]
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state This property is required. string
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
stateCode This property is required. string
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
version This property is required. number
(Integer) The version of the configuration.
definitions This property is required. Sequence[GetProjectConfigApprovedVersionDefinition]
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state This property is required. str
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
state_code This property is required. str
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
version This property is required. float
(Integer) The version of the configuration.
definitions This property is required. List<Property Map>
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state This property is required. String
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
stateCode This property is required. String
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
version This property is required. Number
(Integer) The version of the configuration.

GetProjectConfigApprovedVersionDefinition

EnvironmentId This property is required. string
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
LocatorId This property is required. string
EnvironmentId This property is required. string
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
LocatorId This property is required. string
environmentId This property is required. String
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
locatorId This property is required. String
environmentId This property is required. string
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
locatorId This property is required. string
environment_id This property is required. str
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
locator_id This property is required. str
environmentId This property is required. String
(String) The ID of the project environment.

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

GetProjectConfigDefinition

Authorizations This property is required. List<GetProjectConfigDefinitionAuthorization>
(List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
ComplianceProfiles This property is required. List<GetProjectConfigDefinitionComplianceProfile>
(List) The profile that is required for compliance. Nested schema for compliance_profile:
Description This property is required. string
(String) A short explanation of the output value.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
EnvironmentId This property is required. string
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
Inputs This property is required. Dictionary<string, string>
(Map) The input variables that are used for configuration definition and environment.
LocatorId This property is required. string
Members This property is required. List<GetProjectConfigDefinitionMember>
(List) The member deployabe architectures that are included in your stack.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
Name This property is required. 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]+$/.
ResourceCrns This property is required. List<string>
(List) The CRNs of the resources that are associated with this configuration.

  • Constraints: The list items must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/. The maximum length is 110 items. The minimum length is 0 items.
Settings This property is required. Dictionary<string, string>
(Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.
Authorizations This property is required. []GetProjectConfigDefinitionAuthorization
(List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
ComplianceProfiles This property is required. []GetProjectConfigDefinitionComplianceProfile
(List) The profile that is required for compliance. Nested schema for compliance_profile:
Description This property is required. string
(String) A short explanation of the output value.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
EnvironmentId This property is required. string
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
Inputs This property is required. map[string]string
(Map) The input variables that are used for configuration definition and environment.
LocatorId This property is required. string
Members This property is required. []GetProjectConfigDefinitionMember
(List) The member deployabe architectures that are included in your stack.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
Name This property is required. 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]+$/.
ResourceCrns This property is required. []string
(List) The CRNs of the resources that are associated with this configuration.

  • Constraints: The list items must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/. The maximum length is 110 items. The minimum length is 0 items.
Settings This property is required. map[string]string
(Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.
authorizations This property is required. List<GetProjectConfigDefinitionAuthorization>
(List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
complianceProfiles This property is required. List<GetProjectConfigDefinitionComplianceProfile>
(List) The profile that is required for compliance. Nested schema for compliance_profile:
description This property is required. String
(String) A short explanation of the output value.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
environmentId This property is required. String
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
inputs This property is required. Map<String,String>
(Map) The input variables that are used for configuration definition and environment.
locatorId This property is required. String
members This property is required. List<GetProjectConfigDefinitionMember>
(List) The member deployabe architectures that are included in your stack.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
name This property is required. 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]+$/.
resourceCrns This property is required. List<String>
(List) The CRNs of the resources that are associated with this configuration.

  • Constraints: The list items must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/. The maximum length is 110 items. The minimum length is 0 items.
settings This property is required. Map<String,String>
(Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.
authorizations This property is required. GetProjectConfigDefinitionAuthorization[]
(List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
complianceProfiles This property is required. GetProjectConfigDefinitionComplianceProfile[]
(List) The profile that is required for compliance. Nested schema for compliance_profile:
description This property is required. string
(String) A short explanation of the output value.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
environmentId This property is required. string
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
inputs This property is required. {[key: string]: string}
(Map) The input variables that are used for configuration definition and environment.
locatorId This property is required. string
members This property is required. GetProjectConfigDefinitionMember[]
(List) The member deployabe architectures that are included in your stack.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
name This property is required. 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]+$/.
resourceCrns This property is required. string[]
(List) The CRNs of the resources that are associated with this configuration.

  • Constraints: The list items must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/. The maximum length is 110 items. The minimum length is 0 items.
settings This property is required. {[key: string]: string}
(Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.
authorizations This property is required. Sequence[GetProjectConfigDefinitionAuthorization]
(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 This property is required. Sequence[GetProjectConfigDefinitionComplianceProfile]
(List) The profile that is required for compliance. Nested schema for compliance_profile:
description This property is required. str
(String) A short explanation of the output value.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
environment_id This property is required. str
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
inputs This property is required. Mapping[str, str]
(Map) The input variables that are used for configuration definition and environment.
locator_id This property is required. str
members This property is required. Sequence[GetProjectConfigDefinitionMember]
(List) The member deployabe architectures that are included in your stack.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
name This property is required. 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]+$/.
resource_crns This property is required. Sequence[str]
(List) The CRNs of the resources that are associated with this configuration.

  • Constraints: The list items must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/. The maximum length is 110 items. The minimum length is 0 items.
settings This property is required. Mapping[str, str]
(Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.
authorizations This property is required. 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 This property is required. List<Property Map>
(List) The profile that is required for compliance. Nested schema for compliance_profile:
description This property is required. String
(String) A short explanation of the output value.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
environmentId This property is required. String
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
inputs This property is required. Map<String>
(Map) The input variables that are used for configuration definition and environment.
locatorId This property is required. String
members This property is required. List<Property Map>
(List) The member deployabe architectures that are included in your stack.

  • Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
name This property is required. 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]+$/.
resourceCrns This property is required. List<String>
(List) The CRNs of the resources that are associated with this configuration.

  • Constraints: The list items must match regular expression /(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/. The maximum length is 110 items. The minimum length is 0 items.
settings This property is required. Map<String>
(Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.

GetProjectConfigDefinitionAuthorization

ApiKey This property is required. 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 This property is required. 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 This property is required. string
(String) The trusted profile ID.

  • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
ApiKey This property is required. 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 This property is required. 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 This property is required. string
(String) The trusted profile ID.

  • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
apiKey This property is required. 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 This property is required. 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 This property is required. String
(String) The trusted profile ID.

  • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
apiKey This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. str
(String) The trusted profile ID.

  • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
apiKey This property is required. 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 This property is required. 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 This property is required. String
(String) The trusted profile ID.

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

GetProjectConfigDefinitionComplianceProfile

AttachmentId This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
InstanceId This property is required. 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 This property is required. string
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
ProfileName This property is required. 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 This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
InstanceId This property is required. 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 This property is required. string
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
ProfileName This property is required. 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 This property is required. 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 This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
instanceId This property is required. 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 This property is required. String
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
profileName This property is required. 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 This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
instanceId This property is required. 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 This property is required. string
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
profileName This property is required. 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 This property is required. 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 This property is required. str
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
instance_id This property is required. 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 This property is required. str
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
profile_name This property is required. 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 This property is required. 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 This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
instanceId This property is required. 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 This property is required. String
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
profileName This property is required. 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]*$/.

GetProjectConfigDefinitionMember

ConfigId This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
Name This property is required. 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]+$/.
ConfigId This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
Name This property is required. 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]+$/.
configId This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
name This property is required. 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]+$/.
configId This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
name This property is required. 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]+$/.
config_id This property is required. str
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
name This property is required. 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]+$/.
configId This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
name This property is required. 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]+$/.

GetProjectConfigDeployedVersion

Definitions This property is required. List<GetProjectConfigDeployedVersionDefinition>
(List) The definition of the project reference. Nested schema for definition:
Href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
State This property is required. string
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
StateCode This property is required. string
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
Version This property is required. double
(Integer) The version of the configuration.
Definitions This property is required. []GetProjectConfigDeployedVersionDefinition
(List) The definition of the project reference. Nested schema for definition:
Href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
State This property is required. string
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
StateCode This property is required. string
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
Version This property is required. float64
(Integer) The version of the configuration.
definitions This property is required. List<GetProjectConfigDeployedVersionDefinition>
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state This property is required. String
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
stateCode This property is required. String
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
version This property is required. Double
(Integer) The version of the configuration.
definitions This property is required. GetProjectConfigDeployedVersionDefinition[]
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state This property is required. string
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
stateCode This property is required. string
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
version This property is required. number
(Integer) The version of the configuration.
definitions This property is required. Sequence[GetProjectConfigDeployedVersionDefinition]
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state This property is required. str
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
state_code This property is required. str
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
version This property is required. float
(Integer) The version of the configuration.
definitions This property is required. List<Property Map>
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state This property is required. String
(String) The state of the configuration.

  • Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.
stateCode This property is required. String
(String) Computed state code clarifying the prerequisites for validation for the configuration.

  • Constraints: Allowable values are: awaiting_input, awaiting_prerequisite, awaiting_validation, awaiting_member_deployment, awaiting_stack_setup.
version This property is required. Number
(Integer) The version of the configuration.

GetProjectConfigDeployedVersionDefinition

EnvironmentId This property is required. string
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
LocatorId This property is required. string
EnvironmentId This property is required. string
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
LocatorId This property is required. string
environmentId This property is required. String
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
locatorId This property is required. String
environmentId This property is required. string
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
locatorId This property is required. string
environment_id This property is required. str
(String) The ID of the project environment.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
locator_id This property is required. str
environmentId This property is required. String
(String) The ID of the project environment.

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

GetProjectConfigProject

Crn This property is required. 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 This property is required. List<GetProjectConfigProjectDefinition>
(List) The definition of the project reference. Nested schema for definition:
Href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
Crn This property is required. 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 This property is required. []GetProjectConfigProjectDefinition
(List) The definition of the project reference. Nested schema for definition:
Href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
crn This property is required. 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 This property is required. List<GetProjectConfigProjectDefinition>
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
crn This property is required. 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 This property is required. GetProjectConfigProjectDefinition[]
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
crn This property is required. 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 This property is required. Sequence[GetProjectConfigProjectDefinition]
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. str
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
crn This property is required. 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 This property is required. List<Property Map>
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. String
(String) The unique ID.

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

GetProjectConfigProjectDefinition

Name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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]+$/.

GetProjectCumulativeNeedsAttentionView

ConfigId This property is required. string
(String) A unique ID for the configuration.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
ConfigVersion This property is required. double
(Integer) The version number of the configuration.
Event This property is required. string
(String) The event name.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
EventId This property is required. string
(String) A unique ID for this individual event.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
ConfigId This property is required. string
(String) A unique ID for the configuration.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
ConfigVersion This property is required. float64
(Integer) The version number of the configuration.
Event This property is required. string
(String) The event name.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
EventId This property is required. string
(String) A unique ID for this individual event.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
configId This property is required. String
(String) A unique ID for the configuration.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
configVersion This property is required. Double
(Integer) The version number of the configuration.
event This property is required. String
(String) The event name.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
eventId This property is required. String
(String) A unique ID for this individual event.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
configId This property is required. string
(String) A unique ID for the configuration.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
configVersion This property is required. number
(Integer) The version number of the configuration.
event This property is required. string
(String) The event name.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
eventId This property is required. string
(String) A unique ID for this individual event.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
config_id This property is required. str
(String) A unique ID for the configuration.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
config_version This property is required. float
(Integer) The version number of the configuration.
event This property is required. str
(String) The event name.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
event_id This property is required. str
(String) A unique ID for this individual event.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
configId This property is required. String
(String) A unique ID for the configuration.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
configVersion This property is required. Number
(Integer) The version number of the configuration.
event This property is required. String
(String) The event name.

  • Constraints: The maximum length is 64 characters. The minimum length is 0 characters. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/.
eventId This property is required. String
(String) A unique ID for this individual event.

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

GetProjectDefinition

AutoDeploy This property is required. bool
(Boolean) A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
Description This property is required. 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]*$/.
DestroyOnDelete This property is required. bool
(Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
MonitoringEnabled This property is required. bool
(Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.

  • Constraints: The default value is false.
Name This property is required. 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]+$/.
AutoDeploy This property is required. bool
(Boolean) A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
Description This property is required. 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]*$/.
DestroyOnDelete This property is required. bool
(Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
MonitoringEnabled This property is required. bool
(Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.

  • Constraints: The default value is false.
Name This property is required. 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]+$/.
autoDeploy This property is required. Boolean
(Boolean) A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
description This property is required. 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]*$/.
destroyOnDelete This property is required. Boolean
(Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
monitoringEnabled This property is required. Boolean
(Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.

  • Constraints: The default value is false.
name This property is required. 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]+$/.
autoDeploy This property is required. boolean
(Boolean) A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
description This property is required. 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]*$/.
destroyOnDelete This property is required. boolean
(Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
monitoringEnabled This property is required. boolean
(Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.

  • Constraints: The default value is false.
name This property is required. 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]+$/.
auto_deploy This property is required. bool
(Boolean) A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
description This property is required. 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]*$/.
destroy_on_delete This property is required. bool
(Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
monitoring_enabled This property is required. bool
(Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.

  • Constraints: The default value is false.
name This property is required. 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]+$/.
autoDeploy This property is required. Boolean
(Boolean) A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
description This property is required. 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]*$/.
destroyOnDelete This property is required. Boolean
(Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
monitoringEnabled This property is required. Boolean
(Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.

  • Constraints: The default value is false.
name This property is required. 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]+$/.

GetProjectEnvironment

CreatedAt This property is required. 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 This property is required. List<GetProjectEnvironmentDefinition>
(List) The definition of the project reference. Nested schema for definition:
Href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
Projects This property is required. List<GetProjectEnvironmentProject>
(List) The project that is referenced by this resource. Nested schema for project:
CreatedAt This property is required. 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 This property is required. []GetProjectEnvironmentDefinition
(List) The definition of the project reference. Nested schema for definition:
Href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
Projects This property is required. []GetProjectEnvironmentProject
(List) The project that is referenced by this resource. Nested schema for project:
createdAt This property is required. 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 This property is required. List<GetProjectEnvironmentDefinition>
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
projects This property is required. List<GetProjectEnvironmentProject>
(List) The project that is referenced by this resource. Nested schema for project:
createdAt This property is required. 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 This property is required. GetProjectEnvironmentDefinition[]
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
projects This property is required. GetProjectEnvironmentProject[]
(List) The project that is referenced by this resource. Nested schema for project:
created_at This property is required. 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 This property is required. Sequence[GetProjectEnvironmentDefinition]
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. str
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
projects This property is required. Sequence[GetProjectEnvironmentProject]
(List) The project that is referenced by this resource. Nested schema for project:
createdAt This property is required. 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 This property is required. List<Property Map>
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
projects This property is required. List<Property Map>
(List) The project that is referenced by this resource. Nested schema for project:

GetProjectEnvironmentDefinition

Authorizations This property is required. 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 This property is required. List<GetProjectEnvironmentDefinitionComplianceProfile>
(List) The profile that is required for compliance. Nested schema for compliance_profile:
Description This property is required. 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 This property is required. Dictionary<string, string>
(Map) The input variables that are used for configuration definition and environment.
Name This property is required. 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 This property is required. []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 This property is required. []GetProjectEnvironmentDefinitionComplianceProfile
(List) The profile that is required for compliance. Nested schema for compliance_profile:
Description This property is required. 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 This property is required. map[string]string
(Map) The input variables that are used for configuration definition and environment.
Name This property is required. 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 This property is required. 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 This property is required. List<GetProjectEnvironmentDefinitionComplianceProfile>
(List) The profile that is required for compliance. Nested schema for compliance_profile:
description This property is required. 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 This property is required. Map<String,String>
(Map) The input variables that are used for configuration definition and environment.
name This property is required. 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 This property is required. 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 This property is required. GetProjectEnvironmentDefinitionComplianceProfile[]
(List) The profile that is required for compliance. Nested schema for compliance_profile:
description This property is required. 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 This property is required. {[key: string]: string}
(Map) The input variables that are used for configuration definition and environment.
name This property is required. 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 This property is required. 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 This property is required. Sequence[GetProjectEnvironmentDefinitionComplianceProfile]
(List) The profile that is required for compliance. Nested schema for compliance_profile:
description This property is required. 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 This property is required. Mapping[str, str]
(Map) The input variables that are used for configuration definition and environment.
name This property is required. 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 This property is required. 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 This property is required. List<Property Map>
(List) The profile that is required for compliance. Nested schema for compliance_profile:
description This property is required. 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 This property is required. Map<String>
(Map) The input variables that are used for configuration definition and environment.
name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
(String) The trusted profile ID.

  • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
ApiKey This property is required. 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 This property is required. 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 This property is required. string
(String) The trusted profile ID.

  • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
apiKey This property is required. 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 This property is required. 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 This property is required. String
(String) The trusted profile ID.

  • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
apiKey This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. str
(String) The trusted profile ID.

  • Constraints: The maximum length is 512 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
apiKey This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
InstanceId This property is required. 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 This property is required. string
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
ProfileName This property is required. 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 This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
InstanceId This property is required. 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 This property is required. string
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
ProfileName This property is required. 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 This property is required. 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 This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
instanceId This property is required. 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 This property is required. String
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
profileName This property is required. 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 This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
instanceId This property is required. 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 This property is required. string
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
profileName This property is required. 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 This property is required. 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 This property is required. str
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
instance_id This property is required. 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 This property is required. str
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
profile_name This property is required. 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 This property is required. 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 This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
instanceId This property is required. 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 This property is required. String
(String) The location of the compliance instance.

  • Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.
profileName This property is required. 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 This property is required. 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 This property is required. List<GetProjectEnvironmentProjectDefinition>
(List) The definition of the project reference. Nested schema for definition:
Href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
Crn This property is required. 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 This property is required. []GetProjectEnvironmentProjectDefinition
(List) The definition of the project reference. Nested schema for definition:
Href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
crn This property is required. 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 This property is required. List<GetProjectEnvironmentProjectDefinition>
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. String
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
crn This property is required. 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 This property is required. GetProjectEnvironmentProjectDefinition[]
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. string
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
crn This property is required. 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 This property is required. Sequence[GetProjectEnvironmentProjectDefinition]
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. str
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
crn This property is required. 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 This property is required. List<Property Map>
(List) The definition of the project reference. Nested schema for definition:
href This property is required. 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 This property is required. String
(String) The unique ID.

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

GetProjectEnvironmentProjectDefinition

Name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.