ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm.getProject
Explore with Pulumi AI
Provides a read-only data source to retrieve information about a project. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const project = ibm.getProject({
projectId: ibm_project.project_instance.id,
});
import pulumi
import pulumi_ibm as ibm
project = ibm.get_project(project_id=ibm_project["project_instance"]["id"])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.LookupProject(ctx, &ibm.LookupProjectArgs{
ProjectId: ibm_project.Project_instance.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var project = Ibm.GetProject.Invoke(new()
{
ProjectId = ibm_project.Project_instance.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetProjectArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var project = IbmFunctions.getProject(GetProjectArgs.builder()
.projectId(ibm_project.project_instance().id())
.build());
}
}
variables:
project:
fn::invoke:
function: ibm:getProject
arguments:
projectId: ${ibm_project.project_instance.id}
Using getProject
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>
def get_project(id: Optional[str] = None,
project_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(id: Optional[pulumi.Input[str]] = None,
project_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]
func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput
> Note: This function is named LookupProject
in the Go SDK.
public static class GetProject
{
public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getProject:getProject
arguments:
# arguments dictionary
The following arguments are supported:
- Project
Id This property is required. string - The unique project ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Id string
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Project
Id This property is required. string - The unique project ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Id string
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- project
Id This property is required. String - The unique project ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- id String
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- project
Id This property is required. string - The unique project ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- id string
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- project_
id This property is required. str - The unique project ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- id str
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- project
Id This property is required. String - The unique project ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- id String
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
getProject Result
The following output properties are available:
- Configs
List<Get
Project Config> - (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 is100
items. The minimum length is0
items. Nested schema for configs:
- Constraints: The default value is
- Created
At 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- Cumulative
Needs boolAttention View Error - (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
.
- Constraints: The default value is
- Cumulative
Needs List<GetAttention Views Project Cumulative Needs Attention View> - (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 is50
items. The minimum length is0
items. Nested schema for cumulative_needs_attention_view:
- Constraints: The default value is
- Definitions
List<Get
Project Definition> - (List) The definition of the project reference. Nested schema for definition:
- Environments
List<Get
Project Environment> - (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 is20
items. The minimum length is0
items. Nested schema for environments:
- Constraints: The default value is
- Event
Notifications stringCrn - (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 is0
characters. The value must match regular expression/^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- Href string
- (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- Id string
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Location string
- (Forces new resource, String) The IBM Cloud location where a resource is deployed.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Project
Id string - Resource
Group string - (Forces new resource, String) The resource group name where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Resource
Group stringId - (String) The resource group ID where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^[0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- State string
- (String) The project status value.
- Constraints: Allowable values are:
ready
,deleting
,deleting_failed
.
- Constraints: Allowable values are:
- Configs
[]Get
Project Config Type - (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 is100
items. The minimum length is0
items. Nested schema for configs:
- Constraints: The default value is
- Created
At 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- Cumulative
Needs boolAttention View Error - (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
.
- Constraints: The default value is
- Cumulative
Needs []GetAttention Views Project Cumulative Needs Attention View - (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 is50
items. The minimum length is0
items. Nested schema for cumulative_needs_attention_view:
- Constraints: The default value is
- Definitions
[]Get
Project Definition - (List) The definition of the project reference. Nested schema for definition:
- Environments
[]Get
Project Environment Type - (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 is20
items. The minimum length is0
items. Nested schema for environments:
- Constraints: The default value is
- Event
Notifications stringCrn - (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 is0
characters. The value must match regular expression/^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- Href string
- (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- Id string
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Location string
- (Forces new resource, String) The IBM Cloud location where a resource is deployed.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Project
Id string - Resource
Group string - (Forces new resource, String) The resource group name where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Resource
Group stringId - (String) The resource group ID where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^[0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- State string
- (String) The project status value.
- Constraints: Allowable values are:
ready
,deleting
,deleting_failed
.
- Constraints: Allowable values are:
- configs
List<Get
Project Config> - (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 is100
items. The minimum length is0
items. Nested schema for configs:
- Constraints: The default value is
- created
At 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- cumulative
Needs BooleanAttention View Error - (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
.
- Constraints: The default value is
- cumulative
Needs List<GetAttention Views Project Cumulative Needs Attention View> - (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 is50
items. The minimum length is0
items. Nested schema for cumulative_needs_attention_view:
- Constraints: The default value is
- definitions
List<Get
Project Definition> - (List) The definition of the project reference. Nested schema for definition:
- environments
List<Get
Project Environment> - (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 is20
items. The minimum length is0
items. Nested schema for environments:
- Constraints: The default value is
- event
Notifications StringCrn - (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 is0
characters. The value must match regular expression/^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- href String
- (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- id String
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- location String
- (Forces new resource, String) The IBM Cloud location where a resource is deployed.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- project
Id String - resource
Group String - (Forces new resource, String) The resource group name where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- resource
Group StringId - (String) The resource group ID where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^[0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- state String
- (String) The project status value.
- Constraints: Allowable values are:
ready
,deleting
,deleting_failed
.
- Constraints: Allowable values are:
- configs
Get
Project Config[] - (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 is100
items. The minimum length is0
items. Nested schema for configs:
- Constraints: The default value is
- created
At 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- cumulative
Needs booleanAttention View Error - (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
.
- Constraints: The default value is
- cumulative
Needs GetAttention Views Project Cumulative Needs Attention View[] - (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 is50
items. The minimum length is0
items. Nested schema for cumulative_needs_attention_view:
- Constraints: The default value is
- definitions
Get
Project Definition[] - (List) The definition of the project reference. Nested schema for definition:
- environments
Get
Project Environment[] - (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 is20
items. The minimum length is0
items. Nested schema for environments:
- Constraints: The default value is
- event
Notifications stringCrn - (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 is0
characters. The value must match regular expression/^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- href string
- (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- id string
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- location string
- (Forces new resource, String) The IBM Cloud location where a resource is deployed.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- project
Id string - resource
Group string - (Forces new resource, String) The resource group name where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- resource
Group stringId - (String) The resource group ID where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^[0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- state string
- (String) The project status value.
- Constraints: Allowable values are:
ready
,deleting
,deleting_failed
.
- Constraints: Allowable values are:
- configs
Sequence[Get
Project Config] - (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 is100
items. The minimum length is0
items. Nested schema for configs:
- Constraints: The default value is
- 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- cumulative_
needs_ boolattention_ view_ error - (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
.
- Constraints: The default value is
- cumulative_
needs_ Sequence[Getattention_ views Project Cumulative Needs Attention View] - (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 is50
items. The minimum length is0
items. Nested schema for cumulative_needs_attention_view:
- Constraints: The default value is
- definitions
Sequence[Get
Project Definition] - (List) The definition of the project reference. Nested schema for definition:
- environments
Sequence[Get
Project Environment] - (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 is20
items. The minimum length is0
items. Nested schema for environments:
- Constraints: The default value is
- event_
notifications_ strcrn - (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 is0
characters. The value must match regular expression/^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- href str
- (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- id str
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- location str
- (Forces new resource, String) The IBM Cloud location where a resource is deployed.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- project_
id str - resource_
group str - (Forces new resource, String) The resource group name where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- resource_
group_ strid - (String) The resource group ID where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^[0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- state str
- (String) The project status value.
- Constraints: Allowable values are:
ready
,deleting
,deleting_failed
.
- Constraints: Allowable values are:
- 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 is100
items. The minimum length is0
items. Nested schema for configs:
- Constraints: The default value is
- created
At 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- cumulative
Needs BooleanAttention View Error - (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
.
- Constraints: The default value is
- cumulative
Needs List<Property Map>Attention Views - (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 is50
items. The minimum length is0
items. Nested schema for cumulative_needs_attention_view:
- Constraints: The default value is
- definitions List<Property Map>
- (List) The definition of the project reference. Nested schema for definition:
- environments List<Property Map>
- (List) The project environment. These environments are only included in the response if project environments were created on the project.
- Constraints: The default value is
[]
. The maximum length is20
items. The minimum length is0
items. Nested schema for environments:
- Constraints: The default value is
- event
Notifications StringCrn - (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 is0
characters. The value must match regular expression/^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- href String
- (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- id String
- (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- location String
- (Forces new resource, String) The IBM Cloud location where a resource is deployed.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- project
Id String - resource
Group String - (Forces new resource, String) The resource group name where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- resource
Group StringId - (String) The resource group ID where the project's data and tools are created.
- Constraints: The maximum length is
64
characters. The minimum length is0
characters. The value must match regular expression/^[0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- state String
- (String) The project status value.
- Constraints: Allowable values are:
ready
,deleting
,deleting_failed
.
- Constraints: Allowable values are:
Supporting Types
GetProjectConfig
- Approved
Versions This property is required. List<GetProject Config Approved Version> - (List) A summary of a project configuration version. Nested schema for approved_version:
- Created
At 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<GetProject Config Definition> - (List) The definition of the project reference. Nested schema for definition:
- Deployed
Versions This property is required. List<GetProject Config Deployed Version> - (List) A summary of a project configuration version. Nested schema for deployed_version:
- Deployment
Model This property is required. string - (String) The configuration type.
- Constraints: Allowable values are:
project_deployed
,user_deployed
,stack
.
- Constraints: Allowable values are:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- Modified
At 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<GetProject Config Project> - (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
.
- Constraints: Allowable values are:
- Version
This property is required. double - (Integer) The version of the configuration.
- Approved
Versions This property is required. []GetProject Config Approved Version - (List) A summary of a project configuration version. Nested schema for approved_version:
- Created
At 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. []GetProject Config Definition - (List) The definition of the project reference. Nested schema for definition:
- Deployed
Versions This property is required. []GetProject Config Deployed Version - (List) A summary of a project configuration version. Nested schema for deployed_version:
- Deployment
Model This property is required. string - (String) The configuration type.
- Constraints: Allowable values are:
project_deployed
,user_deployed
,stack
.
- Constraints: Allowable values are:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- Modified
At 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. []GetProject Config Project - (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
.
- Constraints: Allowable values are:
- Version
This property is required. float64 - (Integer) The version of the configuration.
- approved
Versions This property is required. List<GetProject Config Approved Version> - (List) A summary of a project configuration version. Nested schema for approved_version:
- created
At 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<GetProject Config Definition> - (List) The definition of the project reference. Nested schema for definition:
- deployed
Versions This property is required. List<GetProject Config Deployed Version> - (List) A summary of a project configuration version. Nested schema for deployed_version:
- deployment
Model This property is required. String - (String) The configuration type.
- Constraints: Allowable values are:
project_deployed
,user_deployed
,stack
.
- Constraints: Allowable values are:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- modified
At 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<GetProject Config Project> - (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
.
- Constraints: Allowable values are:
- version
This property is required. Double - (Integer) The version of the configuration.
- approved
Versions This property is required. GetProject Config Approved Version[] - (List) A summary of a project configuration version. Nested schema for approved_version:
- created
At 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. GetProject Config Definition[] - (List) The definition of the project reference. Nested schema for definition:
- deployed
Versions This property is required. GetProject Config Deployed Version[] - (List) A summary of a project configuration version. Nested schema for deployed_version:
- deployment
Model This property is required. string - (String) The configuration type.
- Constraints: Allowable values are:
project_deployed
,user_deployed
,stack
.
- Constraints: Allowable values are:
- href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- modified
At 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. GetProject Config Project[] - (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
.
- Constraints: Allowable values are:
- version
This property is required. number - (Integer) The version of the configuration.
- approved_
versions This property is required. Sequence[GetProject Config Approved Version] - (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[GetProject Config Definition] - (List) The definition of the project reference. Nested schema for definition:
- deployed_
versions This property is required. Sequence[GetProject Config Deployed Version] - (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
.
- Constraints: Allowable values are:
- href
This property is required. str - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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[GetProject Config Project] - (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
.
- Constraints: Allowable values are:
- version
This property is required. float - (Integer) The version of the configuration.
- approved
Versions This property is required. List<Property Map> - (List) A summary of a project configuration version. Nested schema for approved_version:
- created
At This property is required. String - (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
- definitions
This property is required. List<Property Map> - (List) The definition of the project reference. Nested schema for definition:
- deployed
Versions This property is required. List<Property Map> - (List) A summary of a project configuration version. Nested schema for deployed_version:
- deployment
Model This property is required. String - (String) The configuration type.
- Constraints: Allowable values are:
project_deployed
,user_deployed
,stack
.
- Constraints: Allowable values are:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- modified
At 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
.
- Constraints: Allowable values are:
- version
This property is required. Number - (Integer) The version of the configuration.
GetProjectConfigApprovedVersion
- Definitions
This property is required. List<GetProject Config Approved Version Definition> - (List) The definition of the project reference. Nested schema for definition:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- State
This property is required. string - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- State
Code This property is required. string - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- Version
This property is required. double - (Integer) The version of the configuration.
- Definitions
This property is required. []GetProject Config Approved Version Definition - (List) The definition of the project reference. Nested schema for definition:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- State
This property is required. string - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- State
Code This property is required. string - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- Version
This property is required. float64 - (Integer) The version of the configuration.
- definitions
This property is required. List<GetProject Config Approved Version Definition> - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- state
This property is required. String - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- state
Code This property is required. String - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- version
This property is required. Double - (Integer) The version of the configuration.
- definitions
This property is required. GetProject Config Approved Version Definition[] - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- state
This property is required. string - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- state
Code This property is required. string - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- version
This property is required. number - (Integer) The version of the configuration.
- definitions
This property is required. Sequence[GetProject Config Approved Version Definition] - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. str - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- state
This property is required. str - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- state_
code This property is required. str - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- version
This property is required. float - (Integer) The version of the configuration.
- definitions
This property is required. List<Property Map> - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- state
This property is required. String - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- state
Code This property is required. String - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- version
This property is required. Number - (Integer) The version of the configuration.
GetProjectConfigApprovedVersionDefinition
- Environment
Id This property is required. string - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Locator
Id This property is required. string
- Environment
Id This property is required. string - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Locator
Id This property is required. string
- environment
Id This property is required. String - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- locator
Id This property is required. String
- environment
Id This property is required. string - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- locator
Id This property is required. string
- environment_
id This property is required. str - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- locator_
id This property is required. str
- environment
Id This property is required. String - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- locator
Id This property is required. String
GetProjectConfigDefinition
This property is required. List<GetProject Config Definition Authorization> - (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- Compliance
Profiles This property is required. List<GetProject Config Definition Compliance Profile> - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- Description
This property is required. string - (String) A short explanation of the output value.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Environment
Id This property is required. string - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Inputs
This property is required. Dictionary<string, string> - (Map) The input variables that are used for configuration definition and environment.
- Locator
Id This property is required. string - Members
This property is required. List<GetProject Config Definition Member> - (List) The member deployabe architectures that are included in your stack.
- Constraints: The default value is
[]
. The maximum length is100
items. The minimum length is0
items. Nested schema for members:
- Constraints: The default value is
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- Resource
Crns This property is required. List<string> - (List) The CRNs of the resources that are associated with this configuration.
- Constraints: The list items must match regular expression
/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
. The maximum length is110
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Settings
This property is required. Dictionary<string, string> - (Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.
This property is required. []GetProject Config Definition Authorization - (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- Compliance
Profiles This property is required. []GetProject Config Definition Compliance Profile - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- Description
This property is required. string - (String) A short explanation of the output value.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Environment
Id This property is required. string - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Inputs
This property is required. map[string]string - (Map) The input variables that are used for configuration definition and environment.
- Locator
Id This property is required. string - Members
This property is required. []GetProject Config Definition Member - (List) The member deployabe architectures that are included in your stack.
- Constraints: The default value is
[]
. The maximum length is100
items. The minimum length is0
items. Nested schema for members:
- Constraints: The default value is
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- Resource
Crns This property is required. []string - (List) The CRNs of the resources that are associated with this configuration.
- Constraints: The list items must match regular expression
/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
. The maximum length is110
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Settings
This property is required. map[string]string - (Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.
This property is required. List<GetProject Config Definition Authorization> - (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- compliance
Profiles This property is required. List<GetProject Config Definition Compliance Profile> - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- description
This property is required. String - (String) A short explanation of the output value.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- environment
Id This property is required. String - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- inputs
This property is required. Map<String,String> - (Map) The input variables that are used for configuration definition and environment.
- locator
Id This property is required. String - members
This property is required. List<GetProject Config Definition Member> - (List) The member deployabe architectures that are included in your stack.
- Constraints: The default value is
[]
. The maximum length is100
items. The minimum length is0
items. Nested schema for members:
- Constraints: The default value is
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- resource
Crns This property is required. List<String> - (List) The CRNs of the resources that are associated with this configuration.
- Constraints: The list items must match regular expression
/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
. The maximum length is110
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- settings
This property is required. Map<String,String> - (Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.
This property is required. GetProject Config Definition Authorization[] - (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- compliance
Profiles This property is required. GetProject Config Definition Compliance Profile[] - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- description
This property is required. string - (String) A short explanation of the output value.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- environment
Id This property is required. string - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- inputs
This property is required. {[key: string]: string} - (Map) The input variables that are used for configuration definition and environment.
- locator
Id This property is required. string - members
This property is required. GetProject Config Definition Member[] - (List) The member deployabe architectures that are included in your stack.
- Constraints: The default value is
[]
. The maximum length is100
items. The minimum length is0
items. Nested schema for members:
- Constraints: The default value is
- name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- resource
Crns This property is required. string[] - (List) The CRNs of the resources that are associated with this configuration.
- Constraints: The list items must match regular expression
/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
. The maximum length is110
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- settings
This property is required. {[key: string]: string} - (Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.
This property is required. Sequence[GetProject Config Definition Authorization] - (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- compliance_
profiles This property is required. Sequence[GetProject Config Definition Compliance Profile] - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- description
This property is required. str - (String) A short explanation of the output value.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- environment_
id This property is required. str - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- inputs
This property is required. Mapping[str, str] - (Map) The input variables that are used for configuration definition and environment.
- locator_
id This property is required. str - members
This property is required. Sequence[GetProject Config Definition Member] - (List) The member deployabe architectures that are included in your stack.
- Constraints: The default value is
[]
. The maximum length is100
items. The minimum length is0
items. Nested schema for members:
- Constraints: The default value is
- name
This property is required. str - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- resource_
crns This property is required. Sequence[str] - (List) The CRNs of the resources that are associated with this configuration.
- Constraints: The list items must match regular expression
/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
. The maximum length is110
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- settings
This property is required. Mapping[str, str] - (Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.
This property is required. List<Property Map>- (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- compliance
Profiles This property is required. List<Property Map> - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- description
This property is required. String - (String) A short explanation of the output value.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- environment
Id This property is required. String - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- inputs
This property is required. Map<String> - (Map) The input variables that are used for configuration definition and environment.
- locator
Id This property is required. String - members
This property is required. List<Property Map> - (List) The member deployabe architectures that are included in your stack.
- Constraints: The default value is
[]
. The maximum length is100
items. The minimum length is0
items. Nested schema for members:
- Constraints: The default value is
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- resource
Crns This property is required. List<String> - (List) The CRNs of the resources that are associated with this configuration.
- Constraints: The list items must match regular expression
/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
. The maximum length is110
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- settings
This property is required. Map<String> - (Map) The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.
GetProjectConfigDefinitionAuthorization
- Api
Key This property is required. string - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Method
This property is required. string - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- Trusted
Profile Id This property is required. string - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Api
Key This property is required. string - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Method
This property is required. string - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- Trusted
Profile Id This property is required. string - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- api
Key This property is required. String - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- method
This property is required. String - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- trusted
Profile Id This property is required. String - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- api
Key This property is required. string - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- method
This property is required. string - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- trusted
Profile Id This property is required. string - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- api_
key This property is required. str - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- method
This property is required. str - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- trusted_
profile_ id This property is required. str - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- api
Key This property is required. String - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- method
This property is required. String - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- trusted
Profile Id This property is required. String - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
GetProjectConfigDefinitionComplianceProfile
- Attachment
Id This property is required. string - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- Instance
Id This property is required. string - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Instance
Location This property is required. string - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- Profile
Name This property is required. string - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Attachment
Id This property is required. string - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- Instance
Id This property is required. string - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Instance
Location This property is required. string - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- Profile
Name This property is required. string - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- attachment
Id This property is required. String - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- instance
Id This property is required. String - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- instance
Location This property is required. String - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- profile
Name This property is required. String - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- attachment
Id This property is required. string - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- instance
Id This property is required. string - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- instance
Location This property is required. string - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- profile
Name This property is required. string - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- attachment_
id This property is required. str - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- instance_
id This property is required. str - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- instance_
location This property is required. str - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- profile_
name This property is required. str - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- attachment
Id This property is required. String - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- instance
Id This property is required. String - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- instance
Location This property is required. String - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- profile
Name This property is required. String - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
GetProjectConfigDefinitionMember
- Config
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]+$/
.
- Constraints: The maximum length is
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- Config
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]+$/
.
- Constraints: The maximum length is
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- config
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]+$/
.
- Constraints: The maximum length is
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- config
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]+$/
.
- Constraints: The maximum length is
- name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- config_
id This property is required. str - (String) The unique ID.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- name
This property is required. str - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- config
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]+$/
.
- Constraints: The maximum length is
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
GetProjectConfigDeployedVersion
- Definitions
This property is required. List<GetProject Config Deployed Version Definition> - (List) The definition of the project reference. Nested schema for definition:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- State
This property is required. string - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- State
Code This property is required. string - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- Version
This property is required. double - (Integer) The version of the configuration.
- Definitions
This property is required. []GetProject Config Deployed Version Definition - (List) The definition of the project reference. Nested schema for definition:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- State
This property is required. string - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- State
Code This property is required. string - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- Version
This property is required. float64 - (Integer) The version of the configuration.
- definitions
This property is required. List<GetProject Config Deployed Version Definition> - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- state
This property is required. String - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- state
Code This property is required. String - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- version
This property is required. Double - (Integer) The version of the configuration.
- definitions
This property is required. GetProject Config Deployed Version Definition[] - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- state
This property is required. string - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- state
Code This property is required. string - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- version
This property is required. number - (Integer) The version of the configuration.
- definitions
This property is required. Sequence[GetProject Config Deployed Version Definition] - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. str - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- state
This property is required. str - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- state_
code This property is required. str - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- version
This property is required. float - (Integer) The version of the configuration.
- definitions
This property is required. List<Property Map> - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- state
This property is required. String - (String) The state of the configuration.
- Constraints: Allowable values are:
approved
,deleted
,deleting
,deleting_failed
,discarded
,draft
,deployed
,deploying_failed
,deploying
,superseded
,undeploying
,undeploying_failed
,validated
,validating
,validating_failed
,applied
,apply_failed
.
- Constraints: Allowable values are:
- state
Code This property is required. String - (String) Computed state code clarifying the prerequisites for validation for the configuration.
- Constraints: Allowable values are:
awaiting_input
,awaiting_prerequisite
,awaiting_validation
,awaiting_member_deployment
,awaiting_stack_setup
.
- Constraints: Allowable values are:
- version
This property is required. Number - (Integer) The version of the configuration.
GetProjectConfigDeployedVersionDefinition
- Environment
Id This property is required. string - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Locator
Id This property is required. string
- Environment
Id This property is required. string - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Locator
Id This property is required. string
- environment
Id This property is required. String - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- locator
Id This property is required. String
- environment
Id This property is required. string - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- locator
Id This property is required. string
- environment_
id This property is required. str - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- locator_
id This property is required. str
- environment
Id This property is required. String - (String) The ID of the project environment.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- locator
Id This property is required. String
GetProjectConfigProject
- Crn
This property is required. string - (String) An IBM Cloud resource name that uniquely identifies a resource.
- Constraints: The maximum length is
512
characters. The minimum length is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- Definitions
This property is required. List<GetProject Config Project Definition> - (List) The definition of the project reference. Nested schema for definition:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- Definitions
This property is required. []GetProject Config Project Definition - (List) The definition of the project reference. Nested schema for definition:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- definitions
This property is required. List<GetProject Config Project Definition> - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- definitions
This property is required. GetProject Config Project Definition[] - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- definitions
This property is required. Sequence[GetProject Config Project Definition] - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. str - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- definitions
This property is required. List<Property Map> - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
GetProjectConfigProjectDefinition
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- name
This property is required. str - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
GetProjectCumulativeNeedsAttentionView
- Config
Id 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]+$/
.
- Constraints: The maximum length is
- Config
Version 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 is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Event
Id 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]+$/
.
- Constraints: The maximum length is
- Config
Id 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]+$/
.
- Constraints: The maximum length is
- Config
Version 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 is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Event
Id 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]+$/
.
- Constraints: The maximum length is
- config
Id 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]+$/
.
- Constraints: The maximum length is
- config
Version 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 is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- event
Id 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]+$/
.
- Constraints: The maximum length is
- config
Id 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]+$/
.
- Constraints: The maximum length is
- config
Version 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 is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- event
Id 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]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- config
Id 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]+$/
.
- Constraints: The maximum length is
- config
Version 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 is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- event
Id 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]+$/
.
- Constraints: The maximum length is
GetProjectDefinition
- Auto
Deploy This property is required. bool - (Boolean) A boolean flag to enable auto deploy.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Description
This property is required. string - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- Destroy
On Delete This property is required. bool - (Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
- Monitoring
Enabled This property is required. bool - (Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- Auto
Deploy This property is required. bool - (Boolean) A boolean flag to enable auto deploy.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Description
This property is required. string - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- Destroy
On Delete This property is required. bool - (Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
- Monitoring
Enabled This property is required. bool - (Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.
- Constraints: The default value is
false
.
- Constraints: The default value is
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- auto
Deploy This property is required. Boolean - (Boolean) A boolean flag to enable auto deploy.
- Constraints: The default value is
false
.
- Constraints: The default value is
- description
This property is required. String - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- destroy
On Delete This property is required. Boolean - (Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
- monitoring
Enabled This property is required. Boolean - (Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.
- Constraints: The default value is
false
.
- Constraints: The default value is
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- auto
Deploy This property is required. boolean - (Boolean) A boolean flag to enable auto deploy.
- Constraints: The default value is
false
.
- Constraints: The default value is
- description
This property is required. string - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- destroy
On Delete This property is required. boolean - (Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
- monitoring
Enabled This property is required. boolean - (Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.
- Constraints: The default value is
false
.
- Constraints: The default value is
- name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- auto_
deploy This property is required. bool - (Boolean) A boolean flag to enable auto deploy.
- Constraints: The default value is
false
.
- Constraints: The default value is
- description
This property is required. str - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- destroy_
on_ delete This property is required. bool - (Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
- monitoring_
enabled This property is required. bool - (Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.
- Constraints: The default value is
false
.
- Constraints: The default value is
- name
This property is required. str - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- auto
Deploy This property is required. Boolean - (Boolean) A boolean flag to enable auto deploy.
- Constraints: The default value is
false
.
- Constraints: The default value is
- description
This property is required. String - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- destroy
On Delete This property is required. Boolean - (Boolean) The policy that indicates whether the resources are destroyed or not when a project is deleted.
- monitoring
Enabled This property is required. Boolean - (Boolean) A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare your configurations to your deployed resources to detect any difference.
- Constraints: The default value is
false
.
- Constraints: The default value is
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
GetProjectEnvironment
- Created
At 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<GetProject Environment Definition> - (List) The definition of the project reference. Nested schema for definition:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- Projects
This property is required. List<GetProject Environment Project> - (List) The project that is referenced by this resource. Nested schema for project:
- Created
At 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. []GetProject Environment Definition - (List) The definition of the project reference. Nested schema for definition:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- Projects
This property is required. []GetProject Environment Project - (List) The project that is referenced by this resource. Nested schema for project:
- created
At 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<GetProject Environment Definition> - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- projects
This property is required. List<GetProject Environment Project> - (List) The project that is referenced by this resource. Nested schema for project:
- created
At 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. GetProject Environment Definition[] - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- projects
This property is required. GetProject Environment Project[] - (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[GetProject Environment Definition] - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. str - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- projects
This property is required. Sequence[GetProject Environment Project] - (List) The project that is referenced by this resource. Nested schema for project:
- created
At This property is required. String - (String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.
- definitions
This property is required. List<Property Map> - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- projects
This property is required. List<Property Map> - (List) The project that is referenced by this resource. Nested schema for project:
GetProjectEnvironmentDefinition
This property is required. List<GetProject Environment Definition Authorization> - (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- Compliance
Profiles This property is required. List<GetProject Environment Definition Compliance Profile> - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- Description
This property is required. string - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- Inputs
This property is required. Dictionary<string, string> - (Map) The input variables that are used for configuration definition and environment.
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
This property is required. []GetProject Environment Definition Authorization - (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- Compliance
Profiles This property is required. []GetProject Environment Definition Compliance Profile - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- Description
This property is required. string - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- Inputs
This property is required. map[string]string - (Map) The input variables that are used for configuration definition and environment.
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
This property is required. List<GetProject Environment Definition Authorization> - (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- compliance
Profiles This property is required. List<GetProject Environment Definition Compliance Profile> - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- description
This property is required. String - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- inputs
This property is required. Map<String,String> - (Map) The input variables that are used for configuration definition and environment.
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
This property is required. GetProject Environment Definition Authorization[] - (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- compliance
Profiles This property is required. GetProject Environment Definition Compliance Profile[] - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- description
This property is required. string - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- inputs
This property is required. {[key: string]: string} - (Map) The input variables that are used for configuration definition and environment.
- name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
This property is required. Sequence[GetProject Environment Definition Authorization] - (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- compliance_
profiles This property is required. Sequence[GetProject Environment Definition Compliance Profile] - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- description
This property is required. str - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- inputs
This property is required. Mapping[str, str] - (Map) The input variables that are used for configuration definition and environment.
- name
This property is required. str - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
This property is required. List<Property Map>- (List) The authorization details. You can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:
- compliance
Profiles This property is required. List<Property Map> - (List) The profile that is required for compliance. Nested schema for compliance_profile:
- description
This property is required. String - (String) The description of the environment.
- Constraints: The default value is
''
. The maximum length is1024
characters. The minimum length is0
characters. The value must match regular expression/^$|^(?!\\s)(?!.*\\s$)[^\\x00-\\x1F]*$/
.
- Constraints: The default value is
- inputs
This property is required. Map<String> - (Map) The input variables that are used for configuration definition and environment.
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
GetProjectEnvironmentDefinitionAuthorization
- Api
Key This property is required. string - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Method
This property is required. string - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- Trusted
Profile Id This property is required. string - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Api
Key This property is required. string - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Method
This property is required. string - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- Trusted
Profile Id This property is required. string - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- api
Key This property is required. String - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- method
This property is required. String - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- trusted
Profile Id This property is required. String - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- api
Key This property is required. string - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- method
This property is required. string - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- trusted
Profile Id This property is required. string - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- api_
key This property is required. str - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- method
This property is required. str - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- trusted_
profile_ id This property is required. str - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- api
Key This property is required. String - (String) The IBM Cloud API Key. It can be either raw or pulled from the catalog via a
CRN
orJSON
blob.- Constraints: The maximum length is
512
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- method
This property is required. String - (String) The authorization method. You can authorize by using a trusted profile or an API key in Secrets Manager.
- Constraints: Allowable values are:
api_key
,trusted_profile
.
- Constraints: Allowable values are:
- trusted
Profile Id This property is required. String - (String) The trusted profile ID.
- Constraints: The maximum length is
512
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
GetProjectEnvironmentDefinitionComplianceProfile
- Attachment
Id This property is required. string - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- Instance
Id This property is required. string - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Instance
Location This property is required. string - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- Profile
Name This property is required. string - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- Attachment
Id This property is required. string - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- Instance
Id This property is required. string - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- Instance
Location This property is required. string - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- Profile
Name This property is required. string - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- attachment
Id This property is required. String - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- instance
Id This property is required. String - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- instance
Location This property is required. String - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- profile
Name This property is required. String - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- attachment
Id This property is required. string - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- instance
Id This property is required. string - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- instance
Location This property is required. string - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- profile
Name This property is required. string - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- attachment_
id This property is required. str - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- instance_
id This property is required. str - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- instance_
location This property is required. str - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- profile_
name This property is required. str - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
- attachment
Id This property is required. String - (String) A unique ID for the attachment to a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- instance
Id This property is required. String - (String) A unique ID for the instance of a compliance profile.
- Constraints: The maximum length is
128
characters. The value must match regular expression/^[\\.\\-0-9a-zA-Z]+$/
.
- Constraints: The maximum length is
- instance
Location This property is required. String - (String) The location of the compliance instance.
- Constraints: Allowable values are:
us-south
,us-east
,eu-gb
,eu-de
,ca-tor
.
- Constraints: Allowable values are:
- profile
Name This property is required. String - (String) The name of the compliance profile.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^<>\\x00-\\x1F]*$/
.
- Constraints: The maximum length is
GetProjectEnvironmentProject
- Crn
This property is required. string - (String) An IBM Cloud resource name that uniquely identifies a resource.
- Constraints: The maximum length is
512
characters. The minimum length is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- Definitions
This property is required. List<GetProject Environment Project Definition> - (List) The definition of the project reference. Nested schema for definition:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- Definitions
This property is required. []GetProject Environment Project Definition - (List) The definition of the project reference. Nested schema for definition:
- Href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- definitions
This property is required. List<GetProject Environment Project Definition> - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- definitions
This property is required. GetProject Environment Project Definition[] - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. string - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- definitions
This property is required. Sequence[GetProject Environment Project Definition] - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. str - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
- 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 is4
characters. The value must match regular expression/(?!\\s)(?!.*\\s$)^(crn)[^'"<>{}\\s\\x00-\\x1F]*/
.
- Constraints: The maximum length is
- definitions
This property is required. List<Property Map> - (List) The definition of the project reference. Nested schema for definition:
- href
This property is required. String - (String) A URL.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^(http(s)?:\/\/)[a-zA-Z0-9\\$\\-_\\.+!\\*'\\(\\),=&?\/]+$/
.
- Constraints: The maximum length is
- 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]+$/
.
- Constraints: The maximum length is
GetProjectEnvironmentProjectDefinition
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- Name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- name
This property is required. string - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- name
This property is required. str - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
- name
This property is required. String - (String) The name of the project.
- Constraints: The maximum length is
64
characters. The minimum length is1
character. The value must match regular expression/^(?!\\s)(?!.*\\s$)[^'"<>{}\\x00-\\x1F]+$/
.
- Constraints: The maximum length is
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.