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

ibm.Project

Explore with Pulumi AI

Create, update, and delete projects with this resource.

Example Usage

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

const projectInstance = new ibm.Project("projectInstance", {
    definition: {
        autoDeploy: true,
        description: "Sample static website test using the IBM catalog deployable architecture",
        destroyOnDelete: true,
        monitoringEnabled: true,
        name: "My static website",
    },
    location: "us-south",
    resourceGroup: "Default",
});
Copy
import pulumi
import pulumi_ibm as ibm

project_instance = ibm.Project("projectInstance",
    definition={
        "auto_deploy": True,
        "description": "Sample static website test using the IBM catalog deployable architecture",
        "destroy_on_delete": True,
        "monitoring_enabled": True,
        "name": "My static website",
    },
    location="us-south",
    resource_group="Default")
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.NewProject(ctx, "projectInstance", &ibm.ProjectArgs{
			Definition: &ibm.ProjectDefinitionArgs{
				AutoDeploy:        pulumi.Bool(true),
				Description:       pulumi.String("Sample static website test using the IBM catalog deployable architecture"),
				DestroyOnDelete:   pulumi.Bool(true),
				MonitoringEnabled: pulumi.Bool(true),
				Name:              pulumi.String("My static website"),
			},
			Location:      pulumi.String("us-south"),
			ResourceGroup: pulumi.String("Default"),
		})
		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 projectInstance = new Ibm.Project("projectInstance", new()
    {
        Definition = new Ibm.Inputs.ProjectDefinitionArgs
        {
            AutoDeploy = true,
            Description = "Sample static website test using the IBM catalog deployable architecture",
            DestroyOnDelete = true,
            MonitoringEnabled = true,
            Name = "My static website",
        },
        Location = "us-south",
        ResourceGroup = "Default",
    });

});
Copy
package generated_program;

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

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

    public static void stack(Context ctx) {
        var projectInstance = new Project("projectInstance", ProjectArgs.builder()
            .definition(ProjectDefinitionArgs.builder()
                .autoDeploy(true)
                .description("Sample static website test using the IBM catalog deployable architecture")
                .destroyOnDelete(true)
                .monitoringEnabled(true)
                .name("My static website")
                .build())
            .location("us-south")
            .resourceGroup("Default")
            .build());

    }
}
Copy
resources:
  projectInstance:
    type: ibm:Project
    properties:
      definition:
        autoDeploy: true
        description: Sample static website test using the IBM catalog deployable architecture
        destroyOnDelete: true
        monitoringEnabled: true
        name: My static website
      location: us-south
      resourceGroup: Default
Copy

Create Project Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Project(name: string, args: ProjectArgs, opts?: CustomResourceOptions);
@overload
def Project(resource_name: str,
            args: ProjectArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Project(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            definition: Optional[ProjectDefinitionArgs] = None,
            location: Optional[str] = None,
            resource_group: Optional[str] = None,
            project_id: Optional[str] = None)
func NewProject(ctx *Context, name string, args ProjectArgs, opts ...ResourceOption) (*Project, error)
public Project(string name, ProjectArgs args, CustomResourceOptions? opts = null)
public Project(String name, ProjectArgs args)
public Project(String name, ProjectArgs args, CustomResourceOptions options)
type: ibm:Project
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProjectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProjectArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProjectArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var projectResource = new Ibm.Project("projectResource", new()
{
    Definition = new Ibm.Inputs.ProjectDefinitionArgs
    {
        Description = "string",
        DestroyOnDelete = false,
        Name = "string",
        AutoDeploy = false,
        MonitoringEnabled = false,
    },
    Location = "string",
    ResourceGroup = "string",
    ProjectId = "string",
});
Copy
example, err := ibm.NewProject(ctx, "projectResource", &ibm.ProjectArgs{
Definition: &.ProjectDefinitionArgs{
Description: pulumi.String("string"),
DestroyOnDelete: pulumi.Bool(false),
Name: pulumi.String("string"),
AutoDeploy: pulumi.Bool(false),
MonitoringEnabled: pulumi.Bool(false),
},
Location: pulumi.String("string"),
ResourceGroup: pulumi.String("string"),
ProjectId: pulumi.String("string"),
})
Copy
var projectResource = new Project("projectResource", ProjectArgs.builder()
    .definition(ProjectDefinitionArgs.builder()
        .description("string")
        .destroyOnDelete(false)
        .name("string")
        .autoDeploy(false)
        .monitoringEnabled(false)
        .build())
    .location("string")
    .resourceGroup("string")
    .projectId("string")
    .build());
Copy
project_resource = ibm.Project("projectResource",
    definition={
        "description": "string",
        "destroy_on_delete": False,
        "name": "string",
        "auto_deploy": False,
        "monitoring_enabled": False,
    },
    location="string",
    resource_group="string",
    project_id="string")
Copy
const projectResource = new ibm.Project("projectResource", {
    definition: {
        description: "string",
        destroyOnDelete: false,
        name: "string",
        autoDeploy: false,
        monitoringEnabled: false,
    },
    location: "string",
    resourceGroup: "string",
    projectId: "string",
});
Copy
type: ibm:Project
properties:
    definition:
        autoDeploy: false
        description: string
        destroyOnDelete: false
        monitoringEnabled: false
        name: string
    location: string
    projectId: string
    resourceGroup: string
Copy

Project Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Project resource accepts the following input properties:

Definition This property is required. ProjectDefinition
The definition of the project. Nested schema for definition:
Location This property is required. 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]*$/.
ResourceGroup This property is required. 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]*$/.
ProjectId string
(String) The unique ID.

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

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

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

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

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

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

Outputs

All input properties are implicitly available as output properties. Additionally, the Project resource produces the following output properties:

Configs List<ProjectConfig>
(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<ProjectCumulativeNeedsAttentionView>
(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:
Environments List<ProjectEnvironment>
(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
The provider-assigned unique ID for this managed resource.
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 []ProjectConfigType
(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 []ProjectCumulativeNeedsAttentionView
(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:
Environments []ProjectEnvironmentType
(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
The provider-assigned unique ID for this managed resource.
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<ProjectConfig>
(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<ProjectCumulativeNeedsAttentionView>
(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:
environments List<ProjectEnvironment>
(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
The provider-assigned unique ID for this managed resource.
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 ProjectConfig[]
(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 ProjectCumulativeNeedsAttentionView[]
(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:
environments ProjectEnvironment[]
(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
The provider-assigned unique ID for this managed resource.
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[ProjectConfig]
(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[ProjectCumulativeNeedsAttentionView]
(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:
environments Sequence[ProjectEnvironment]
(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
The provider-assigned unique ID for this managed resource.
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:
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
The provider-assigned unique ID for this managed resource.
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.

Look up Existing Project Resource

Get an existing Project resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ProjectState, opts?: CustomResourceOptions): Project
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configs: Optional[Sequence[ProjectConfigArgs]] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        cumulative_needs_attention_view_error: Optional[bool] = None,
        cumulative_needs_attention_views: Optional[Sequence[ProjectCumulativeNeedsAttentionViewArgs]] = None,
        definition: Optional[ProjectDefinitionArgs] = None,
        environments: Optional[Sequence[ProjectEnvironmentArgs]] = None,
        event_notifications_crn: Optional[str] = None,
        href: Optional[str] = None,
        location: Optional[str] = None,
        project_id: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        state: Optional[str] = None) -> Project
func GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)
public static Project Get(string name, Input<string> id, ProjectState? state, CustomResourceOptions? opts = null)
public static Project get(String name, Output<String> id, ProjectState state, CustomResourceOptions options)
resources:  _:    type: ibm:Project    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Configs List<ProjectConfig>
(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<ProjectCumulativeNeedsAttentionView>
(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:
Definition ProjectDefinition
The definition of the project. Nested schema for definition:
Environments List<ProjectEnvironment>
(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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
Location 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
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
ResourceGroup 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 []ProjectConfigTypeArgs
(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 []ProjectCumulativeNeedsAttentionViewArgs
(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:
Definition ProjectDefinitionArgs
The definition of the project. Nested schema for definition:
Environments []ProjectEnvironmentTypeArgs
(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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
Location 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
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
ResourceGroup 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<ProjectConfig>
(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<ProjectCumulativeNeedsAttentionView>
(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:
definition ProjectDefinition
The definition of the project. Nested schema for definition:
environments List<ProjectEnvironment>
(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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
location 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
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
resourceGroup 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 ProjectConfig[]
(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 ProjectCumulativeNeedsAttentionView[]
(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:
definition ProjectDefinition
The definition of the project. Nested schema for definition:
environments ProjectEnvironment[]
(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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
location 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
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
resourceGroup 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[ProjectConfigArgs]
(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[ProjectCumulativeNeedsAttentionViewArgs]
(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:
definition ProjectDefinitionArgs
The definition of the project. Nested schema for definition:
environments Sequence[ProjectEnvironmentArgs]
(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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
location str
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
(String) The unique ID.

  • Constraints: The maximum length is 128 characters. The value must match regular expression /^[\\.\\-0-9a-zA-Z]+$/.
resource_group str
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:
definition Property Map
The definition of the project. 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\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
location 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
(String) The unique ID.

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

ProjectConfig
, ProjectConfigArgs

ApprovedVersions This property is required. List<ProjectConfigApprovedVersion>
(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<ProjectConfigDefinition>
The definition of the project. Nested schema for definition:
DeployedVersions This property is required. List<ProjectConfigDeployedVersion>
(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<ProjectConfigProject>
(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. []ProjectConfigApprovedVersion
(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. []ProjectConfigDefinition
The definition of the project. Nested schema for definition:
DeployedVersions This property is required. []ProjectConfigDeployedVersion
(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. []ProjectConfigProject
(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<ProjectConfigApprovedVersion>
(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<ProjectConfigDefinition>
The definition of the project. Nested schema for definition:
deployedVersions This property is required. List<ProjectConfigDeployedVersion>
(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<ProjectConfigProject>
(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. ProjectConfigApprovedVersion[]
(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. ProjectConfigDefinition[]
The definition of the project. Nested schema for definition:
deployedVersions This property is required. ProjectConfigDeployedVersion[]
(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. ProjectConfigProject[]
(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[ProjectConfigApprovedVersion]
(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[ProjectConfigDefinition]
The definition of the project. Nested schema for definition:
deployed_versions This property is required. Sequence[ProjectConfigDeployedVersion]
(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[ProjectConfigProject]
(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>
The definition of the project. 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.

ProjectConfigApprovedVersion
, ProjectConfigApprovedVersionArgs

Definitions List<ProjectConfigApprovedVersionDefinition>
Nested schema for definition:
Href string
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
State 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 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 double
(Integer) The version of the configuration.
Definitions []ProjectConfigApprovedVersionDefinition
Nested schema for definition:
Href string
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
State 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 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 float64
(Integer) The version of the configuration.
definitions List<ProjectConfigApprovedVersionDefinition>
Nested schema for definition:
href String
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state 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 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 Double
(Integer) The version of the configuration.
definitions ProjectConfigApprovedVersionDefinition[]
Nested schema for definition:
href string
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state 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 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 number
(Integer) The version of the configuration.
definitions Sequence[ProjectConfigApprovedVersionDefinition]
Nested schema for definition:
href str
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state 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 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 float
(Integer) The version of the configuration.
definitions List<Property Map>
Nested schema for definition:
href String
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state 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 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 Number
(Integer) The version of the configuration.

ProjectConfigApprovedVersionDefinition
, ProjectConfigApprovedVersionDefinitionArgs

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

ProjectConfigDefinition
, ProjectConfigDefinitionArgs

Authorizations ProjectConfigDefinitionAuthorizations
The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
ComplianceProfile ProjectConfigDefinitionComplianceProfile
The profile that is required for compliance. Nested schema for compliance_profile:
Description string
A project configuration description.

  • 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]*$/.
EnvironmentId 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 Dictionary<string, string>
The input variables that are used for configuration definition and environment.
LocatorId string
Members List<ProjectConfigDefinitionMember>
The member deployabe architectures that are included in your stack.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
Name string
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
ResourceCrns List<string>
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 Dictionary<string, string>
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 ProjectConfigDefinitionAuthorizations
The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
ComplianceProfile ProjectConfigDefinitionComplianceProfile
The profile that is required for compliance. Nested schema for compliance_profile:
Description string
A project configuration description.

  • 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]*$/.
EnvironmentId 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 map[string]string
The input variables that are used for configuration definition and environment.
LocatorId string
Members []ProjectConfigDefinitionMember
The member deployabe architectures that are included in your stack.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
Name string
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
ResourceCrns []string
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 map[string]string
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 ProjectConfigDefinitionAuthorizations
The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
complianceProfile ProjectConfigDefinitionComplianceProfile
The profile that is required for compliance. Nested schema for compliance_profile:
description String
A project configuration description.

  • 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]*$/.
environmentId 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 Map<String,String>
The input variables that are used for configuration definition and environment.
locatorId String
members List<ProjectConfigDefinitionMember>
The member deployabe architectures that are included in your stack.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
name String
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
resourceCrns List<String>
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 Map<String,String>
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 ProjectConfigDefinitionAuthorizations
The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
complianceProfile ProjectConfigDefinitionComplianceProfile
The profile that is required for compliance. Nested schema for compliance_profile:
description string
A project configuration description.

  • 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]*$/.
environmentId 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 {[key: string]: string}
The input variables that are used for configuration definition and environment.
locatorId string
members ProjectConfigDefinitionMember[]
The member deployabe architectures that are included in your stack.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
name string
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
resourceCrns string[]
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 {[key: string]: string}
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 ProjectConfigDefinitionAuthorizations
The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
compliance_profile ProjectConfigDefinitionComplianceProfile
The profile that is required for compliance. Nested schema for compliance_profile:
description str
A project configuration description.

  • 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]*$/.
environment_id str
The ID of the project environment.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
name str
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
resource_crns Sequence[str]
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 Mapping[str, str]
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 Property Map
The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
complianceProfile Property Map
The profile that is required for compliance. Nested schema for compliance_profile:
description String
A project configuration description.

  • 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]*$/.
environmentId 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 Map<String>
The input variables that are used for configuration definition and environment.
locatorId String
members List<Property Map>
The member deployabe architectures that are included in your stack.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:
name String
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
resourceCrns List<String>
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 Map<String>
The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.

ProjectConfigDefinitionAuthorizations
, ProjectConfigDefinitionAuthorizationsArgs

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ProjectConfigDefinitionComplianceProfile
, ProjectConfigDefinitionComplianceProfileArgs

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ProjectConfigDefinitionMember
, ProjectConfigDefinitionMemberArgs

ConfigId This property is required. 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
The name matching the alias in the stack definition.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
ConfigId This property is required. 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
The name matching the alias in the stack definition.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
configId This property is required. 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
The name matching the alias in the stack definition.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
configId This property is required. 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
The name matching the alias in the stack definition.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
config_id This property is required. str
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
The name matching the alias in the stack definition.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
configId This property is required. 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
The name matching the alias in the stack definition.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

ProjectConfigDeployedVersion
, ProjectConfigDeployedVersionArgs

Definitions List<ProjectConfigDeployedVersionDefinition>
Nested schema for definition:
Href string
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
State 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 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 double
(Integer) The version of the configuration.
Definitions []ProjectConfigDeployedVersionDefinition
Nested schema for definition:
Href string
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
State 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 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 float64
(Integer) The version of the configuration.
definitions List<ProjectConfigDeployedVersionDefinition>
Nested schema for definition:
href String
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state 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 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 Double
(Integer) The version of the configuration.
definitions ProjectConfigDeployedVersionDefinition[]
Nested schema for definition:
href string
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state 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 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 number
(Integer) The version of the configuration.
definitions Sequence[ProjectConfigDeployedVersionDefinition]
Nested schema for definition:
href str
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state 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 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 float
(Integer) The version of the configuration.
definitions List<Property Map>
Nested schema for definition:
href String
(String) A URL.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/.
state 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 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 Number
(Integer) The version of the configuration.

ProjectConfigDeployedVersionDefinition
, ProjectConfigDeployedVersionDefinitionArgs

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

ProjectConfigProject
, ProjectConfigProjectArgs

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<ProjectConfigProjectDefinition>
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. []ProjectConfigProjectDefinition
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<ProjectConfigProjectDefinition>
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. ProjectConfigProjectDefinition[]
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[ProjectConfigProjectDefinition]
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>
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]+$/.

ProjectConfigProjectDefinition
, ProjectConfigProjectDefinitionArgs

Name This property is required. string
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
Name This property is required. string
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
name This property is required. String
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
name This property is required. string
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
name This property is required. str
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.
name This property is required. String
The configuration name. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9][a-zA-Z0-9-_ ]*$/.

ProjectCumulativeNeedsAttentionView
, ProjectCumulativeNeedsAttentionViewArgs

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]+$/.

ProjectDefinition
, ProjectDefinitionArgs

Description This property is required. string
A brief explanation of the project's use in the configuration of a deployable architecture. You can create a project without providing a description.

  • 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
The policy that indicates whether the resources are destroyed or not when a project is deleted.
Name This property is required. string
The name of the project. It's unique within the account across regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
AutoDeploy bool
A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
MonitoringEnabled bool
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.
Description This property is required. string
A brief explanation of the project's use in the configuration of a deployable architecture. You can create a project without providing a description.

  • 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
The policy that indicates whether the resources are destroyed or not when a project is deleted.
Name This property is required. string
The name of the project. It's unique within the account across regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
AutoDeploy bool
A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
MonitoringEnabled bool
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.
description This property is required. String
A brief explanation of the project's use in the configuration of a deployable architecture. You can create a project without providing a description.

  • 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
The policy that indicates whether the resources are destroyed or not when a project is deleted.
name This property is required. String
The name of the project. It's unique within the account across regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
autoDeploy Boolean
A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
monitoringEnabled 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.
description This property is required. string
A brief explanation of the project's use in the configuration of a deployable architecture. You can create a project without providing a description.

  • 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
The policy that indicates whether the resources are destroyed or not when a project is deleted.
name This property is required. string
The name of the project. It's unique within the account across regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
autoDeploy boolean
A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
monitoringEnabled 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.
description This property is required. str
A brief explanation of the project's use in the configuration of a deployable architecture. You can create a project without providing a description.

  • 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
The policy that indicates whether the resources are destroyed or not when a project is deleted.
name This property is required. str
The name of the project. It's unique within the account across regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
auto_deploy bool
A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
monitoring_enabled bool
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.
description This property is required. String
A brief explanation of the project's use in the configuration of a deployable architecture. You can create a project without providing a description.

  • 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
The policy that indicates whether the resources are destroyed or not when a project is deleted.
name This property is required. String
The name of the project. It's unique within the account across regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
autoDeploy Boolean
A boolean flag to enable auto deploy.

  • Constraints: The default value is false.
monitoringEnabled 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.

ProjectEnvironment
, ProjectEnvironmentArgs

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<ProjectEnvironmentDefinition>
The definition of the project. 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<ProjectEnvironmentProject>
(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. []ProjectEnvironmentDefinition
The definition of the project. 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. []ProjectEnvironmentProject
(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<ProjectEnvironmentDefinition>
The definition of the project. 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<ProjectEnvironmentProject>
(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. ProjectEnvironmentDefinition[]
The definition of the project. 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. ProjectEnvironmentProject[]
(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[ProjectEnvironmentDefinition]
The definition of the project. 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[ProjectEnvironmentProject]
(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>
The definition of the project. 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:

ProjectEnvironmentDefinition
, ProjectEnvironmentDefinitionArgs

Name This property is required. string
The name of the environment. It's unique within the account across projects and regions.

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

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

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

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

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

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

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

  • Constraints: The default value is ''. The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/.
inputs {[key: string]: string}
The input variables that are used for configuration definition and environment.
name This property is required. str
The name of the environment. It's unique within the account across projects and regions.

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

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

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

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

ProjectEnvironmentDefinitionAuthorizations
, ProjectEnvironmentDefinitionAuthorizationsArgs

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ProjectEnvironmentDefinitionComplianceProfile
, ProjectEnvironmentDefinitionComplianceProfileArgs

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ProjectEnvironmentProject
, ProjectEnvironmentProjectArgs

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<ProjectEnvironmentProjectDefinition>
The environment definition. 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. []ProjectEnvironmentProjectDefinition
The environment definition. 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<ProjectEnvironmentProjectDefinition>
The environment definition. 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. ProjectEnvironmentProjectDefinition[]
The environment definition. 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[ProjectEnvironmentProjectDefinition]
The environment definition. 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>
The environment definition. 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]+$/.

ProjectEnvironmentProjectDefinition
, ProjectEnvironmentProjectDefinitionArgs

Name This property is required. string
The name of the environment. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
Name This property is required. string
The name of the environment. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
name This property is required. String
The name of the environment. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
name This property is required. string
The name of the environment. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
name This property is required. str
The name of the environment. It's unique within the account across projects and regions.

  • Constraints: The maximum length is 128 characters. The minimum length is 1 character. The value must match regular expression /^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/.
name This property is required. String
The name of the environment. It's unique within the account across projects and regions.

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

Import

You can import the ibm_project resource by using id. The unique project ID.

Syntax

```sh
$ pulumi import ibm:index/project:Project project <id>
```

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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