ibm.Project

configs List<ProjectConfig>

The definition of the project. Nested schema for definition:

location String

The IBM Cloud location where a resource is deployed.

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

resourceGroup String

The resource group name where the project's data and tools are created.

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

The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:

environments List<ProjectEnvironment>

The project environment. These environments are only included in the response if project environments were created on the project.

Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:

projectId String

The unique identifier of the project.

configs ProjectConfig[]

The definition of the project. Nested schema for definition:

location string

The IBM Cloud location where a resource is deployed.

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

resourceGroup string

The resource group name where the project's data and tools are created.

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

The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:

environments ProjectEnvironment[]

The project environment. These environments are only included in the response if project environments were created on the project.

Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:

projectId string

The unique identifier of the project.

definition ProjectDefinitionArgs

The definition of the project. Nested schema for definition:

location str

The IBM Cloud location where a resource is deployed.

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

resource_group str

The resource group name where the project's data and tools are created.

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

configs Sequence[ProjectConfigArgs]

The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:

environments Sequence[ProjectEnvironmentArgs]

The project environment. These environments are only included in the response if project environments were created on the project.

Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:

project_id str

The unique identifier of the project.

definition Property Map

The definition of the project. Nested schema for definition:

location String

The IBM Cloud location where a resource is deployed.

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

resourceGroup String

The resource group name where the project's data and tools are created.

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

configs List<Property Map>

The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:

environments List<Property Map>

The project environment. These environments are only included in the response if project environments were created on the project.

Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:

projectId String

The unique identifier of the project.

Outputs

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

CreatedAt string

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

Crn string

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

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

CumulativeNeedsAttentionViews List<ProjectCumulativeNeedsAttentionView>

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

Href string

(String) A Url.

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

Id string

The provider-assigned unique ID for this managed resource.

ResourceGroupId string

(String) The resource group ID where the project's data and tools are created.

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

State string

(String) The project status value.

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

CreatedAt string

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

Crn string

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

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

CumulativeNeedsAttentionViews []ProjectCumulativeNeedsAttentionView

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

Href string

(String) A Url.

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

Id string

The provider-assigned unique ID for this managed resource.

ResourceGroupId string

(String) The resource group ID where the project's data and tools are created.

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

State string

(String) The project status value.

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

createdAt String

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

crn String

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

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

cumulativeNeedsAttentionViews List<ProjectCumulativeNeedsAttentionView>

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

cumulativeNeedsAttentionViews ProjectCumulativeNeedsAttentionView[]

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

href String

(String) A Url.

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

id String

The provider-assigned unique ID for this managed resource.

resourceGroupId String

(String) The resource group ID where the project's data and tools are created.

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

state String

(String) The project status value.

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

createdAt string

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

crn string

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

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

cumulativeNeedsAttentionViewError boolean

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

eventNotificationsCrn string

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

href string

(String) A Url.

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

id string

The provider-assigned unique ID for this managed resource.

resourceGroupId string

(String) The resource group ID where the project's data and tools are created.

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

state string

(String) The project status value.

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

cumulative_needs_attention_views Sequence[ProjectCumulativeNeedsAttentionView]

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

crn str

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

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

cumulative_needs_attention_view_error bool

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

event_notifications_crn str

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

href str

(String) A Url.

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

id str

The provider-assigned unique ID for this managed resource.

resource_group_id str

(String) The resource group ID where the project's data and tools are created.

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

state str

(String) The project status value.

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

createdAt String

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

crn String

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

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

cumulativeNeedsAttentionViews List<Property Map>

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

Configs List<ProjectConfig>

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

href String

(String) A Url.

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

id String

The provider-assigned unique ID for this managed resource.

resourceGroupId String

(String) The resource group ID where the project's data and tools are created.

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

state String

(String) The project status value.

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

Look up Existing Project Resource

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

public static get(name: string, id: Input<ID>, state?: ProjectState, opts?: CustomResourceOptions): Project

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configs: Optional[Sequence[ProjectConfigArgs]] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        cumulative_needs_attention_view_error: Optional[bool] = None,
        cumulative_needs_attention_views: Optional[Sequence[ProjectCumulativeNeedsAttentionViewArgs]] = None,
        definition: Optional[ProjectDefinitionArgs] = None,
        environments: Optional[Sequence[ProjectEnvironmentArgs]] = None,
        event_notifications_crn: Optional[str] = None,
        href: Optional[str] = None,
        location: Optional[str] = None,
        project_id: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        state: Optional[str] = None) -> Project

func GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)

public static Project Get(string name, Input<string> id, ProjectState? state, CustomResourceOptions? opts = null)

public static Project get(String name, Output<String> id, ProjectState state, CustomResourceOptions options)

resources:  _:    type: ibm:Project    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:

CreatedAt string

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

Crn string

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

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

CumulativeNeedsAttentionViews List<ProjectCumulativeNeedsAttentionView>

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

Definition ProjectDefinition

The definition of the project. Nested schema for definition:

Environments List<ProjectEnvironment>

The project environment. These environments are only included in the response if project environments were created on the project.

Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:

Configs []ProjectConfigTypeArgs

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

Href string

(String) A Url.

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

Location string

The IBM Cloud location where a resource is deployed.

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

ProjectId string

The unique identifier of the project.

ResourceGroup string

The resource group name where the project's data and tools are created.

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

ResourceGroupId string

(String) The resource group ID where the project's data and tools are created.

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

State string

(String) The project status value.

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

The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:

CreatedAt string

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

Crn string

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

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

CumulativeNeedsAttentionViews []ProjectCumulativeNeedsAttentionViewArgs

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

Definition ProjectDefinitionArgs

The definition of the project. Nested schema for definition:

Environments []ProjectEnvironmentTypeArgs

The project environment. These environments are only included in the response if project environments were created on the project.

Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:

configs List<ProjectConfig>

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

Href string

(String) A Url.

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

Location string

The IBM Cloud location where a resource is deployed.

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

ProjectId string

The unique identifier of the project.

ResourceGroup string

The resource group name where the project's data and tools are created.

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

ResourceGroupId string

(String) The resource group ID where the project's data and tools are created.

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

State string

(String) The project status value.

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

The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:

createdAt String

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

crn String

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

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

cumulativeNeedsAttentionViews List<ProjectCumulativeNeedsAttentionView>

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

environments List<ProjectEnvironment>

The definition of the project. Nested schema for definition:

The project environment. These environments are only included in the response if project environments were created on the project.

Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:

configs ProjectConfig[]

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

href String

(String) A Url.

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

location String

The IBM Cloud location where a resource is deployed.

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

projectId String

The unique identifier of the project.

resourceGroup String

The resource group name where the project's data and tools are created.

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

resourceGroupId String

(String) The resource group ID where the project's data and tools are created.

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

state String

(String) The project status value.

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

The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:

createdAt string

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

crn string

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

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

cumulativeNeedsAttentionViewError boolean

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

cumulativeNeedsAttentionViews ProjectCumulativeNeedsAttentionView[]

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

environments ProjectEnvironment[]

The definition of the project. Nested schema for definition:

The project environment. These environments are only included in the response if project environments were created on the project.

Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:

eventNotificationsCrn string

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

href string

(String) A Url.

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

location string

The IBM Cloud location where a resource is deployed.

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

projectId string

The unique identifier of the project.

resourceGroup string

The resource group name where the project's data and tools are created.

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

resourceGroupId string

(String) The resource group ID where the project's data and tools are created.

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

state string

(String) The project status value.

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

configs Sequence[ProjectConfigArgs]

The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:

cumulative_needs_attention_views Sequence[ProjectCumulativeNeedsAttentionViewArgs]

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

crn str

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

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

cumulative_needs_attention_view_error bool

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

definition ProjectDefinitionArgs

The definition of the project. Nested schema for definition:

environments Sequence[ProjectEnvironmentArgs]

The project environment. These environments are only included in the response if project environments were created on the project.

Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:

event_notifications_crn str

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

href str

(String) A Url.

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

location str

The IBM Cloud location where a resource is deployed.

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

project_id str

The unique identifier of the project.

resource_group str

The resource group name where the project's data and tools are created.

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

resource_group_id str

(String) The resource group ID where the project's data and tools are created.

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

state str

(String) The project status value.

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

configs List<Property Map>

The project configurations. These configurations are only included in the response of creating a project if a configuration array is specified in the request payload.

Constraints: The default value is []. The maximum length is 100 items. The minimum length is 0 items. Nested schema for configs:

createdAt String

(String) A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

crn String

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

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

cumulativeNeedsAttentionViews List<Property Map>

(Boolean) A value of true indicates that the fetch of the needs attention items failed. This property only exists if there was an error while retrieving the cumulative needs attention view.

Constraints: The default value is false.

(List) The cumulative list of needs attention items for a project. If the view is successfully retrieved, an empty or nonempty array is returned.

Constraints: The default value is []. The maximum length is 50 items. The minimum length is 0 items. Nested schema for cumulative_needs_attention_view:

definition Property Map

The definition of the project. Nested schema for definition:

environments List<Property Map>

The project environment. These environments are only included in the response if project environments were created on the project.

Constraints: The default value is []. The maximum length is 20 items. The minimum length is 0 items. Nested schema for environments:

ApprovedVersions List<ProjectConfigApprovedVersion>

(String) The CRN of the Event Notifications instance if one is connected to this project.

Constraints: The maximum length is 512 characters. The minimum length is 0 characters. The value must match regular expression /^$|^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

href String

(String) A Url.

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

location String

The IBM Cloud location where a resource is deployed.

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

projectId String

The unique identifier of the project.

resourceGroup String

The resource group name where the project's data and tools are created.

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

resourceGroupId String

(String) The resource group ID where the project's data and tools are created.

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

state String

(String) The project status value.

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

Supporting Types

ProjectConfig, ProjectConfigArgs

A summary of a project configuration version. Nested schema for approved_version:

CreatedAt string

A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

Definitions List<ProjectConfigDefinition>

The description of a project configuration. Nested schema for definition:

DeployedVersions List<ProjectConfigDeployedVersion>

A summary of a project configuration version. Nested schema for deployed_version:

DeploymentModel string

The configuration type.

Constraints: Allowable values are: project_deployed, user_deployed, stack.

Href string

A Url.

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

Id string

The ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.

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

ModifiedAt 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 List<ProjectConfigProject>

The project that is referenced by this resource. Nested schema for project:

State 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.

Version double

The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

ApprovedVersions []ProjectConfigApprovedVersion

A summary of a project configuration version. Nested schema for approved_version:

CreatedAt 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 []ProjectConfigDefinition

The description of a project configuration. Nested schema for definition:

DeployedVersions []ProjectConfigDeployedVersion

A summary of a project configuration version. Nested schema for deployed_version:

DeploymentModel string

The configuration type.

Constraints: Allowable values are: project_deployed, user_deployed, stack.

Href string

A Url.

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

Id string

The ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.

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

ModifiedAt 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 []ProjectConfigProject

The project that is referenced by this resource. Nested schema for project:

State 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.

Version float64

The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

approvedVersions List<ProjectConfigApprovedVersion>

A summary of a project configuration version. Nested schema for approved_version:

createdAt String

A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

definitions List<ProjectConfigDefinition>

The description of a project configuration. Nested schema for definition:

deployedVersions List<ProjectConfigDeployedVersion>

A summary of a project configuration version. Nested schema for deployed_version:

deploymentModel String

The configuration type.

Constraints: Allowable values are: project_deployed, user_deployed, stack.

href String

A Url.

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

id String

The ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.

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

modifiedAt 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 List<ProjectConfigProject>

The project that is referenced by this resource. Nested schema for project:

state 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.

version Double

The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

approvedVersions ProjectConfigApprovedVersion[]

A summary of a project configuration version. Nested schema for approved_version:

createdAt 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 ProjectConfigDefinition[]

The description of a project configuration. Nested schema for definition:

deployedVersions ProjectConfigDeployedVersion[]

A summary of a project configuration version. Nested schema for deployed_version:

deploymentModel string

The configuration type.

Constraints: Allowable values are: project_deployed, user_deployed, stack.

href string

A Url.

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

id string

The ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.

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

modifiedAt 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 ProjectConfigProject[]

The project that is referenced by this resource. Nested schema for project:

state 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.

version number

The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

approved_versions Sequence[ProjectConfigApprovedVersion]

A summary of a project configuration version. Nested schema for approved_version:

definitions Sequence[ProjectConfigDefinition]

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.

The description of a project configuration. Nested schema for definition:

deployed_versions Sequence[ProjectConfigDeployedVersion]

A summary of a project configuration version. Nested schema for deployed_version:

deployment_model str

The configuration type.

Constraints: Allowable values are: project_deployed, user_deployed, stack.

href str

A Url.

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

id str

The ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.

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

modified_at str

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 Sequence[ProjectConfigProject]

The project that is referenced by this resource. Nested schema for project:

state str

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.

version float

The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

approvedVersions List<Property Map>

A summary of a project configuration version. Nested schema for approved_version:

createdAt 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.

deployedVersions List<Property Map>

The description of a project configuration. Nested schema for definition:

A summary of a project configuration version. Nested schema for deployed_version:

deploymentModel String

The configuration type.

Constraints: Allowable values are: project_deployed, user_deployed, stack.

href String

A Url.

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

id String

The ID of the configuration. If this parameter is empty, an ID is automatically created for the configuration.

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

modifiedAt 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 List<Property Map>

The project that is referenced by this resource. Nested schema for project:

state 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.

version Number

The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

ProjectConfigApprovedVersion, ProjectConfigApprovedVersionArgs

Definitions List<ProjectConfigApprovedVersionDefinition>

Nested schema for definition:

Href string

(String) A Url.

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

State string

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

Version double

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

Definitions []ProjectConfigApprovedVersionDefinition

Nested schema for definition:

Href string

(String) A Url.

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

State string

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

Version float64

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

definitions List<ProjectConfigApprovedVersionDefinition>

Nested schema for definition:

href String

(String) A Url.

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

state String

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

version Double

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

definitions ProjectConfigApprovedVersionDefinition[]

Nested schema for definition:

href string

(String) A Url.

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

state string

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

version number

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

definitions Sequence[ProjectConfigApprovedVersionDefinition]

Nested schema for definition:

href str

(String) A Url.

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

state str

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

version float

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

Authorizations ProjectConfigDefinitionAuthorizations

Nested schema for definition:

href String

(String) A Url.

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

state String

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

version Number

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

ProjectConfigApprovedVersionDefinition, ProjectConfigApprovedVersionDefinitionArgs

EnvironmentId string

The ID of the project environment.

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

LocatorId string

EnvironmentId string

The ID of the project environment.

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

LocatorId string

environmentId String

The ID of the project environment.

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

locatorId String

environmentId string

The ID of the project environment.

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

locatorId string

environment_id str

The ID of the project environment.

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

locator_id str

environmentId String

The ID of the project environment.

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

locatorId String

ProjectConfigDefinition, ProjectConfigDefinitionArgs

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

ComplianceProfile ProjectConfigDefinitionComplianceProfile

The profile that is required for compliance. Nested schema for compliance_profile:

Description string

A project configuration description.

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

EnvironmentId string

The ID of the project environment.

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

Inputs Dictionary<string, string>

The input variables that are used for configuration definition and environment.

LocatorId string

Members List<ProjectConfigDefinitionMember>

The member deployabe architectures that are included in the stack.

Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:

Name string

The configuration name. It's unique within the account across projects and regions.

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

ResourceCrns List<string>

The CRNs of the resources that are associated with this configuration.

Constraints: The list items must match regular expression /^(?!\\s)(?!.*\\s$)(crn)[^'"<>{}\\s\\x00-\\x1F]*$/. The maximum length is 110 items. The minimum length is 0 items.

Settings Dictionary<string, string>

The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.

Authorizations ProjectConfigDefinitionAuthorizations

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

ComplianceProfile ProjectConfigDefinitionComplianceProfile

The profile that is required for compliance. Nested schema for compliance_profile:

Description string

A project configuration description.

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

EnvironmentId string

The ID of the project environment.

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

Inputs map[string]string

The input variables that are used for configuration definition and environment.

LocatorId string

Members []ProjectConfigDefinitionMember

The member deployabe architectures that are included in the stack.

Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:

Name string

The configuration name. It's unique within the account across projects and regions.

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

ResourceCrns []string

The CRNs of the resources that are associated with this configuration.

Constraints: The list items must match regular expression /^(?!\\s)(?!.*\\s$)(crn)[^'"<>{}\\s\\x00-\\x1F]*$/. The maximum length is 110 items. The minimum length is 0 items.

Settings map[string]string

The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.

authorizations ProjectConfigDefinitionAuthorizations

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

complianceProfile ProjectConfigDefinitionComplianceProfile

The profile that is required for compliance. Nested schema for compliance_profile:

description String

A project configuration description.

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

environmentId String

The ID of the project environment.

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

inputs Map<String,String>

The input variables that are used for configuration definition and environment.

locatorId String

members List<ProjectConfigDefinitionMember>

The member deployabe architectures that are included in the stack.

Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:

name String

The configuration name. It's unique within the account across projects and regions.

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

resourceCrns List<String>

The CRNs of the resources that are associated with this configuration.

Constraints: The list items must match regular expression /^(?!\\s)(?!.*\\s$)(crn)[^'"<>{}\\s\\x00-\\x1F]*$/. The maximum length is 110 items. The minimum length is 0 items.

settings Map<String,String>

The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.

authorizations ProjectConfigDefinitionAuthorizations

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

complianceProfile ProjectConfigDefinitionComplianceProfile

The profile that is required for compliance. Nested schema for compliance_profile:

description string

A project configuration description.

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

environmentId string

The ID of the project environment.

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

inputs {[key: string]: string}

The input variables that are used for configuration definition and environment.

locatorId string

members ProjectConfigDefinitionMember[]

The member deployabe architectures that are included in the stack.

Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:

name string

The configuration name. It's unique within the account across projects and regions.

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

resourceCrns string[]

The CRNs of the resources that are associated with this configuration.

Constraints: The list items must match regular expression /^(?!\\s)(?!.*\\s$)(crn)[^'"<>{}\\s\\x00-\\x1F]*$/. The maximum length is 110 items. The minimum length is 0 items.

settings {[key: string]: string}

The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.

authorizations ProjectConfigDefinitionAuthorizations

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

compliance_profile ProjectConfigDefinitionComplianceProfile

The profile that is required for compliance. Nested schema for compliance_profile:

description str

A project configuration description.

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

environment_id str

The ID of the project environment.

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

inputs Mapping[str, str]

The input variables that are used for configuration definition and environment.

locator_id str

members Sequence[ProjectConfigDefinitionMember]

The member deployabe architectures that are included in the stack.

Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:

name str

The configuration name. It's unique within the account across projects and regions.

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

resource_crns Sequence[str]

The CRNs of the resources that are associated with this configuration.

Constraints: The list items must match regular expression /^(?!\\s)(?!.*\\s$)(crn)[^'"<>{}\\s\\x00-\\x1F]*$/. The maximum length is 110 items. The minimum length is 0 items.

settings Mapping[str, str]

The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.

authorizations Property Map

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

complianceProfile Property Map

The profile that is required for compliance. Nested schema for compliance_profile:

description String

A project configuration description.

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

environmentId String

The ID of the project environment.

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

inputs Map<String>

The input variables that are used for configuration definition and environment.

locatorId String

members List<Property Map>

The member deployabe architectures that are included in the stack.

Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for members:

name String

The configuration name. It's unique within the account across projects and regions.

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

resourceCrns List<String>

The CRNs of the resources that are associated with this configuration.

Constraints: The list items must match regular expression /^(?!\\s)(?!.*\\s$)(crn)[^'"<>{}\\s\\x00-\\x1F]*$/. The maximum length is 110 items. The minimum length is 0 items.

settings Map<String>

The Schematics environment variables to use to deploy the configuration. Settings are only available if they are specified when the configuration is initially created.

ProjectConfigDefinitionAuthorizations, ProjectConfigDefinitionAuthorizationsArgs

ApiKey string

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

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

Method string

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

TrustedProfileId string

The trusted profile ID.

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

ApiKey string

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

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

Method string

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

TrustedProfileId string

The trusted profile ID.

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

apiKey String

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

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

method String

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

trustedProfileId String

The trusted profile ID.

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

apiKey string

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

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

method string

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

trustedProfileId string

The trusted profile ID.

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

api_key str

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

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

method str

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

trusted_profile_id str

The trusted profile ID.

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

apiKey String

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

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

method String

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

trustedProfileId String

The trusted profile ID.

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

ProjectConfigDefinitionComplianceProfile, ProjectConfigDefinitionComplianceProfileArgs

AttachmentId string

A unique ID for the attachment to a compliance profile.

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

Id string

The unique ID for the compliance profile.

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

InstanceId string

A unique ID for the instance of a compliance profile.

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

InstanceLocation string

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

ProfileName string

The name of the compliance profile.

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

WpInstanceId string

A unique ID for the instance of a Workload Protection.

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

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

WpInstanceName string

The name of the Workload Protection instance.

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

WpPolicyId string

The unique ID for the Workload Protection policy.

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

WpPolicyName string

The name of the Workload Protection policy.

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

WpZoneId string

A unique ID for the zone to a Workload Protection policy.

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

WpZoneName string

A unique ID for the zone to a Workload Protection policy.

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

AttachmentId string

A unique ID for the attachment to a compliance profile.

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

Id string

The unique ID for the compliance profile.

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

InstanceId string

A unique ID for the instance of a compliance profile.

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

InstanceLocation string

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

ProfileName string

The name of the compliance profile.

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

WpInstanceId string

A unique ID for the instance of a Workload Protection.

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

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

WpInstanceName string

The name of the Workload Protection instance.

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

WpPolicyId string

The unique ID for the Workload Protection policy.

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

WpPolicyName string

The name of the Workload Protection policy.

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

WpZoneId string

A unique ID for the zone to a Workload Protection policy.

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

WpZoneName string

A unique ID for the zone to a Workload Protection policy.

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

attachmentId String

A unique ID for the attachment to a compliance profile.

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

id String

The unique ID for the compliance profile.

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

instanceId String

A unique ID for the instance of a compliance profile.

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

instanceLocation String

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

profileName String

The name of the compliance profile.

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

wpInstanceId String

A unique ID for the instance of a Workload Protection.

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

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

wpInstanceName String

The name of the Workload Protection instance.

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

wpPolicyId String

The unique ID for the Workload Protection policy.

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

wpPolicyName String

The name of the Workload Protection policy.

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

wpZoneId String

A unique ID for the zone to a Workload Protection policy.

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

wpZoneName String

A unique ID for the zone to a Workload Protection policy.

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

attachmentId string

A unique ID for the attachment to a compliance profile.

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

id string

The unique ID for the compliance profile.

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

instanceId string

A unique ID for the instance of a compliance profile.

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

instanceLocation string

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

profileName string

The name of the compliance profile.

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

wpInstanceId string

A unique ID for the instance of a Workload Protection.

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

wpInstanceLocation string

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

wpInstanceName string

The name of the Workload Protection instance.

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

wpPolicyId string

The unique ID for the Workload Protection policy.

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

wpPolicyName string

The name of the Workload Protection policy.

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

wpZoneId string

A unique ID for the zone to a Workload Protection policy.

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

wpZoneName string

A unique ID for the zone to a Workload Protection policy.

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

attachment_id str

A unique ID for the attachment to a compliance profile.

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

id str

The unique ID for the compliance profile.

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

instance_id str

A unique ID for the instance of a compliance profile.

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

instance_location str

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

profile_name str

The name of the compliance profile.

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

wp_instance_id str

A unique ID for the instance of a Workload Protection.

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

wp_instance_location str

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

wp_instance_name str

The name of the Workload Protection instance.

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

wp_policy_id str

The unique ID for the Workload Protection policy.

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

wp_policy_name str

The name of the Workload Protection policy.

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

wp_zone_id str

A unique ID for the zone to a Workload Protection policy.

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

wp_zone_name str

A unique ID for the zone to a Workload Protection policy.

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

attachmentId String

A unique ID for the attachment to a compliance profile.

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

id String

The unique ID for the compliance profile.

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

instanceId String

A unique ID for the instance of a compliance profile.

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

instanceLocation String

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

profileName String

The name of the compliance profile.

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

wpInstanceId String

A unique ID for the instance of a Workload Protection.

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

Definitions List<ProjectConfigDeployedVersionDefinition>

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

wpInstanceName String

The name of the Workload Protection instance.

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

wpPolicyId String

The unique ID for the Workload Protection policy.

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

wpPolicyName String

The name of the Workload Protection policy.

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

wpZoneId String

A unique ID for the zone to a Workload Protection policy.

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

wpZoneName String

A unique ID for the zone to a Workload Protection policy.

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

ProjectConfigDefinitionMember, ProjectConfigDefinitionMemberArgs

ConfigId string

The unique ID.

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

Name string

The name matching the alias in the stack definition.

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

ConfigId string

The unique ID.

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

Name string

The name matching the alias in the stack definition.

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

configId String

The unique ID.

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

name String

The name matching the alias in the stack definition.

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

configId string

The unique ID.

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

name string

The name matching the alias in the stack definition.

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

config_id str

The unique ID.

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

name str

The name matching the alias in the stack definition.

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

configId String

The unique ID.

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

name String

The name matching the alias in the stack definition.

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

ProjectConfigDeployedVersion, ProjectConfigDeployedVersionArgs

Nested schema for definition:

Href string

(String) A Url.

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

State string

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

Version double

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

Definitions []ProjectConfigDeployedVersionDefinition

Nested schema for definition:

Href string

(String) A Url.

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

State string

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

Version float64

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

definitions List<ProjectConfigDeployedVersionDefinition>

Nested schema for definition:

href String

(String) A Url.

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

state String

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

version Double

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

definitions ProjectConfigDeployedVersionDefinition[]

Nested schema for definition:

href string

(String) A Url.

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

state string

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

version number

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

definitions Sequence[ProjectConfigDeployedVersionDefinition]

Nested schema for definition:

href str

(String) A Url.

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

state str

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

version float

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

Definitions List<ProjectConfigProjectDefinition>

Nested schema for definition:

href String

(String) A Url.

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

state String

(String) The state of the configuration.

Constraints: Allowable values are: approved, deleted, deleting, deleting_failed, discarded, draft, deployed, deploying_failed, deploying, superseded, undeploying, undeploying_failed, validated, validating, validating_failed, applied, apply_failed.

version Number

(Integer) The version of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

ProjectConfigDeployedVersionDefinition, ProjectConfigDeployedVersionDefinitionArgs

EnvironmentId string

The ID of the project environment.

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

LocatorId string

EnvironmentId string

The ID of the project environment.

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

LocatorId string

environmentId String

The ID of the project environment.

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

locatorId String

environmentId string

The ID of the project environment.

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

locatorId string

environment_id str

The ID of the project environment.

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

locator_id str

environmentId String

The ID of the project environment.

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

locatorId String

ProjectConfigProject, ProjectConfigProjectArgs

Crn string

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

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

Nested schema for definition:

Href string

(String) A Url.

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

Id string

(String) The unique ID.

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

Crn string

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

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

Definitions []ProjectConfigProjectDefinition

Nested schema for definition:

Href string

(String) A Url.

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

Id string

(String) The unique ID.

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

crn String

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

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

definitions List<ProjectConfigProjectDefinition>

Nested schema for definition:

href String

(String) A Url.

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

id String

(String) The unique ID.

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

crn string

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

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

definitions ProjectConfigProjectDefinition[]

Nested schema for definition:

href string

(String) A Url.

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

id string

(String) The unique ID.

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

crn str

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

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

definitions Sequence[ProjectConfigProjectDefinition]

Nested schema for definition:

href str

(String) A Url.

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

id str

(String) The unique ID.

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

crn String

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

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

Store ProjectDefinitionStore

Nested schema for definition:

href String

(String) A Url.

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

id String

(String) The unique ID.

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

ProjectConfigProjectDefinition, ProjectConfigProjectDefinitionArgs

Name string

The configuration name. It's unique within the account across projects and regions.

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

Name string

The configuration name. It's unique within the account across projects and regions.

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

name String

The configuration name. It's unique within the account across projects and regions.

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

name string

The configuration name. It's unique within the account across projects and regions.

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

name str

The configuration name. It's unique within the account across projects and regions.

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

name String

The configuration name. It's unique within the account across projects and regions.

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

ProjectCumulativeNeedsAttentionView, ProjectCumulativeNeedsAttentionViewArgs

ConfigId string

(String) A unique ID for the configuration.

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

ConfigVersion double

(Integer) The version number of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

Event string

(String) The event name.

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

EventId string

(String) A unique ID for this individual event.

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

ConfigId string

(String) A unique ID for the configuration.

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

ConfigVersion float64

(Integer) The version number of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

Event string

(String) The event name.

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

EventId string

(String) A unique ID for this individual event.

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

configId String

(String) A unique ID for the configuration.

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

configVersion Double

(Integer) The version number of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

event String

(String) The event name.

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

eventId String

(String) A unique ID for this individual event.

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

configId string

(String) A unique ID for the configuration.

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

configVersion number

(Integer) The version number of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

event string

(String) The event name.

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

eventId string

(String) A unique ID for this individual event.

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

config_id str

(String) A unique ID for the configuration.

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

config_version float

(Integer) The version number of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

event str

(String) The event name.

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

event_id str

(String) A unique ID for this individual event.

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

configId String

(String) A unique ID for the configuration.

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

configVersion Number

(Integer) The version number of the configuration.

Constraints: The maximum value is 10000. The minimum value is 0.

event String

(String) The event name.

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

eventId String

(String) A unique ID for this individual event.

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

ProjectDefinition, ProjectDefinitionArgs

AutoDeploy bool

A boolean flag to enable auto deploy.

Constraints: The default value is false.

Description string

A brief explanation of the project's use in the configuration of a deployable architecture. A project can be created without providing a description.

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

DestroyOnDelete bool

The policy that indicates whether the resources are undeployed or not when a project is deleted.

Constraints: The default value is true.

MonitoringEnabled bool

A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare the configurations to those deployed resources to detect any difference.

Constraints: The default value is false.

Name string

The name of the project. It's unique within the account across regions.

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

The details required to custom store project configs. Nested schema for store:

TerraformEngine ProjectDefinitionTerraformEngine

Experimental schema - this is for prototyping purposes.

AutoDeploy bool

A boolean flag to enable auto deploy.

Constraints: The default value is false.

Description string

A brief explanation of the project's use in the configuration of a deployable architecture. A project can be created without providing a description.

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

DestroyOnDelete bool

The policy that indicates whether the resources are undeployed or not when a project is deleted.

Constraints: The default value is true.

MonitoringEnabled bool

A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare the configurations to those deployed resources to detect any difference.

Constraints: The default value is false.

Name string

The name of the project. It's unique within the account across regions.

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

Store ProjectDefinitionStore

The details required to custom store project configs. Nested schema for store:

TerraformEngine ProjectDefinitionTerraformEngine

Experimental schema - this is for prototyping purposes.

autoDeploy Boolean

A boolean flag to enable auto deploy.

Constraints: The default value is false.

description String

A brief explanation of the project's use in the configuration of a deployable architecture. A project can be created without providing a description.

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

destroyOnDelete Boolean

The policy that indicates whether the resources are undeployed or not when a project is deleted.

Constraints: The default value is true.

monitoringEnabled Boolean

A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare the configurations to those deployed resources to detect any difference.

Constraints: The default value is false.

name String

The name of the project. It's unique within the account across regions.

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

store ProjectDefinitionStore

The details required to custom store project configs. Nested schema for store:

terraformEngine ProjectDefinitionTerraformEngine

Experimental schema - this is for prototyping purposes.

autoDeploy boolean

A boolean flag to enable auto deploy.

Constraints: The default value is false.

description string

A brief explanation of the project's use in the configuration of a deployable architecture. A project can be created without providing a description.

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

destroyOnDelete boolean

The policy that indicates whether the resources are undeployed or not when a project is deleted.

Constraints: The default value is true.

monitoringEnabled boolean

A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare the configurations to those deployed resources to detect any difference.

Constraints: The default value is false.

name string

The name of the project. It's unique within the account across regions.

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

store ProjectDefinitionStore

The details required to custom store project configs. Nested schema for store:

terraformEngine ProjectDefinitionTerraformEngine

Experimental schema - this is for prototyping purposes.

auto_deploy bool

A boolean flag to enable auto deploy.

Constraints: The default value is false.

description str

A brief explanation of the project's use in the configuration of a deployable architecture. A project can be created without providing a description.

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

destroy_on_delete bool

The policy that indicates whether the resources are undeployed or not when a project is deleted.

Constraints: The default value is true.

monitoring_enabled bool

A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare the configurations to those deployed resources to detect any difference.

Constraints: The default value is false.

name str

The name of the project. It's unique within the account across regions.

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

store ProjectDefinitionStore

The details required to custom store project configs. Nested schema for store:

terraform_engine ProjectDefinitionTerraformEngine

Experimental schema - this is for prototyping purposes.

autoDeploy Boolean

A boolean flag to enable auto deploy.

Constraints: The default value is false.

description String

A brief explanation of the project's use in the configuration of a deployable architecture. A project can be created without providing a description.

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

destroyOnDelete Boolean

The policy that indicates whether the resources are undeployed or not when a project is deleted.

Constraints: The default value is true.

monitoringEnabled Boolean

A boolean flag to enable automatic drift detection. Use this field to run a daily check to compare the configurations to those deployed resources to detect any difference.

Constraints: The default value is false.

name String

The name of the project. It's unique within the account across regions.

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

store Property Map

The details required to custom store project configs. Nested schema for store:

terraformEngine Property Map

Experimental schema - this is for prototyping purposes.

ProjectDefinitionStore, ProjectDefinitionStoreArgs

Type string

The type of store used for the project.

Constraints: The default value is gh. Allowable values are: gh, ghe, gitlab.

Url string

A Url.

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

ConfigDirectory string

The directory where project configs are stored.

Constraints: The default value is ''. The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /^\/?[^\/]*(?:\/[^\/]*)*\/?$/.

Token string

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

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

Type string

The type of store used for the project.

Constraints: The default value is gh. Allowable values are: gh, ghe, gitlab.

Url string

A Url.

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

ConfigDirectory string

The directory where project configs are stored.

Constraints: The default value is ''. The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /^\/?[^\/]*(?:\/[^\/]*)*\/?$/.

Token string

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

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

type String

The type of store used for the project.

Constraints: The default value is gh. Allowable values are: gh, ghe, gitlab.

url String

A Url.

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

configDirectory String

The directory where project configs are stored.

Constraints: The default value is ''. The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /^\/?[^\/]*(?:\/[^\/]*)*\/?$/.

token String

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

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

type string

The type of store used for the project.

Constraints: The default value is gh. Allowable values are: gh, ghe, gitlab.

url string

A Url.

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

configDirectory string

The directory where project configs are stored.

Constraints: The default value is ''. The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /^\/?[^\/]*(?:\/[^\/]*)*\/?$/.

token string

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

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

type str

The type of store used for the project.

Constraints: The default value is gh. Allowable values are: gh, ghe, gitlab.

url str

A Url.

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

config_directory str

The directory where project configs are stored.

Constraints: The default value is ''. The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /^\/?[^\/]*(?:\/[^\/]*)*\/?$/.

token str

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

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

type String

The type of store used for the project.

Constraints: The default value is gh. Allowable values are: gh, ghe, gitlab.

url String

A Url.

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

configDirectory String

The directory where project configs are stored.

Constraints: The default value is ''. The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /^\/?[^\/]*(?:\/[^\/]*)*\/?$/.

token String

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

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

ProjectDefinitionTerraformEngine, ProjectDefinitionTerraformEngineArgs

Id string
Type string: The type of the engine.

Id string
Type string: The type of the engine.

id String
type String: The type of the engine.

id string
type string: The type of the engine.

id str
type str: The type of the engine.

id String
type String: The type of the engine.

ProjectEnvironment, ProjectEnvironmentArgs

CreatedAt string

A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

Definitions List<ProjectEnvironmentDefinition>

The environment definition that is used in the project collection. Nested schema for definition:

Href string

A Url.

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

Id string

The environment ID as a friendly name.

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

Projects List<ProjectEnvironmentProject>

The project that is referenced by this resource. Nested schema for project:

CreatedAt 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 []ProjectEnvironmentDefinition

The environment definition that is used in the project collection. Nested schema for definition:

Href string

A Url.

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

Id string

The environment ID as a friendly name.

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

Projects []ProjectEnvironmentProject

The project that is referenced by this resource. Nested schema for project:

createdAt String

A date and time value in the format YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ to match the date and time format as specified by RFC 3339.

definitions List<ProjectEnvironmentDefinition>

The environment definition that is used in the project collection. Nested schema for definition:

href String

A Url.

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

id String

The environment ID as a friendly name.

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

projects List<ProjectEnvironmentProject>

The project that is referenced by this resource. Nested schema for project:

createdAt 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 ProjectEnvironmentDefinition[]

The environment definition that is used in the project collection. Nested schema for definition:

href string

A Url.

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

id string

The environment ID as a friendly name.

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

projects ProjectEnvironmentProject[]

The project that is referenced by this resource. Nested schema for project:

definitions Sequence[ProjectEnvironmentDefinition]

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.

The environment definition that is used in the project collection. Nested schema for definition:

href str

A Url.

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

id str

The environment ID as a friendly name.

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

projects Sequence[ProjectEnvironmentProject]

The project that is referenced by this resource. Nested schema for project:

createdAt 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 List<Property Map>

The environment definition that is used in the project collection. Nested schema for definition:

href String

A Url.

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

id String

The environment ID as a friendly name.

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

The project that is referenced by this resource. Nested schema for project:

ProjectEnvironmentDefinition, ProjectEnvironmentDefinitionArgs

Name string

The name of the environment. It's unique within the account across projects and regions.

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

Authorizations ProjectEnvironmentDefinitionAuthorizations

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

ComplianceProfile ProjectEnvironmentDefinitionComplianceProfile

The profile that is required for compliance. Nested schema for compliance_profile:

Description string

The description of the environment.

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

Inputs Dictionary<string, string>

The input variables that are used for configuration definition and environment.

Name string

The name of the environment. It's unique within the account across projects and regions.

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

Authorizations ProjectEnvironmentDefinitionAuthorizations

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

ComplianceProfile ProjectEnvironmentDefinitionComplianceProfile

The profile that is required for compliance. Nested schema for compliance_profile:

Description string

The description of the environment.

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

Inputs map[string]string

The input variables that are used for configuration definition and environment.

name String

The name of the environment. It's unique within the account across projects and regions.

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

authorizations ProjectEnvironmentDefinitionAuthorizations

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

complianceProfile ProjectEnvironmentDefinitionComplianceProfile

The profile that is required for compliance. Nested schema for compliance_profile:

description String

The description of the environment.

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

inputs Map<String,String>

The input variables that are used for configuration definition and environment.

name string

The name of the environment. It's unique within the account across projects and regions.

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

authorizations ProjectEnvironmentDefinitionAuthorizations

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

complianceProfile ProjectEnvironmentDefinitionComplianceProfile

The profile that is required for compliance. Nested schema for compliance_profile:

description string

The description of the environment.

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

inputs {[key: string]: string}

The input variables that are used for configuration definition and environment.

name str

The name of the environment. It's unique within the account across projects and regions.

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

authorizations ProjectEnvironmentDefinitionAuthorizations

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

compliance_profile ProjectEnvironmentDefinitionComplianceProfile

The profile that is required for compliance. Nested schema for compliance_profile:

description str

The description of the environment.

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

inputs Mapping[str, str]

The input variables that are used for configuration definition and environment.

name String

The name of the environment. It's unique within the account across projects and regions.

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

authorizations Property Map

The authorization details. It can authorize by using a trusted profile or an API key in Secrets Manager. Nested schema for authorizations:

complianceProfile Property Map

The profile that is required for compliance. Nested schema for compliance_profile:

description String

The description of the environment.

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

inputs Map<String>

The input variables that are used for configuration definition and environment.

ProjectEnvironmentDefinitionAuthorizations, ProjectEnvironmentDefinitionAuthorizationsArgs

ApiKey string

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

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

Method string

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

TrustedProfileId string

The trusted profile ID.

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

ApiKey string

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

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

Method string

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

TrustedProfileId string

The trusted profile ID.

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

apiKey String

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

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

method String

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

trustedProfileId String

The trusted profile ID.

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

apiKey string

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

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

method string

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

trustedProfileId string

The trusted profile ID.

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

api_key str

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

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

method str

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

trusted_profile_id str

The trusted profile ID.

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

apiKey String

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

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

method String

The authorization method. It can authorize by using a trusted profile or an API key in Secrets Manager.

Constraints: The maximum length is 256 characters. The minimum length is 7 characters. The value must match regular expression /^(ref:)[a-zA-Z0-9\\$\\-_\\.+%!\\*'\$\$,=&?\/ ]+(authorizations\/method)$|^(api_key)$|^(trusted_profile)$/.

trustedProfileId String

The trusted profile ID.

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

ProjectEnvironmentDefinitionComplianceProfile, ProjectEnvironmentDefinitionComplianceProfileArgs

AttachmentId string

A unique ID for the attachment to a compliance profile.

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

Id string

The unique ID for the compliance profile.

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

InstanceId string

A unique ID for the instance of a compliance profile.

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

InstanceLocation string

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

ProfileName string

The name of the compliance profile.

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

WpInstanceId string

A unique ID for the instance of a Workload Protection.

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

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

WpInstanceName string

The name of the Workload Protection instance.

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

WpPolicyId string

The unique ID for the Workload Protection policy.

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

WpPolicyName string

The name of the Workload Protection policy.

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

WpZoneId string

A unique ID for the zone to a Workload Protection policy.

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

WpZoneName string

A unique ID for the zone to a Workload Protection policy.

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

AttachmentId string

A unique ID for the attachment to a compliance profile.

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

Id string

The unique ID for the compliance profile.

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

InstanceId string

A unique ID for the instance of a compliance profile.

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

InstanceLocation string

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

ProfileName string

The name of the compliance profile.

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

WpInstanceId string

A unique ID for the instance of a Workload Protection.

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

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

WpInstanceName string

The name of the Workload Protection instance.

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

WpPolicyId string

The unique ID for the Workload Protection policy.

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

WpPolicyName string

The name of the Workload Protection policy.

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

WpZoneId string

A unique ID for the zone to a Workload Protection policy.

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

WpZoneName string

A unique ID for the zone to a Workload Protection policy.

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

attachmentId String

A unique ID for the attachment to a compliance profile.

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

id String

The unique ID for the compliance profile.

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

instanceId String

A unique ID for the instance of a compliance profile.

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

instanceLocation String

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

profileName String

The name of the compliance profile.

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

wpInstanceId String

A unique ID for the instance of a Workload Protection.

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

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

wpInstanceName String

The name of the Workload Protection instance.

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

wpPolicyId String

The unique ID for the Workload Protection policy.

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

wpPolicyName String

The name of the Workload Protection policy.

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

wpZoneId String

A unique ID for the zone to a Workload Protection policy.

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

wpZoneName String

A unique ID for the zone to a Workload Protection policy.

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

attachmentId string

A unique ID for the attachment to a compliance profile.

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

id string

The unique ID for the compliance profile.

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

instanceId string

A unique ID for the instance of a compliance profile.

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

instanceLocation string

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

profileName string

The name of the compliance profile.

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

wpInstanceId string

A unique ID for the instance of a Workload Protection.

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

wpInstanceLocation string

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

wpInstanceName string

The name of the Workload Protection instance.

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

wpPolicyId string

The unique ID for the Workload Protection policy.

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

wpPolicyName string

The name of the Workload Protection policy.

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

wpZoneId string

A unique ID for the zone to a Workload Protection policy.

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

wpZoneName string

A unique ID for the zone to a Workload Protection policy.

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

attachment_id str

A unique ID for the attachment to a compliance profile.

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

id str

The unique ID for the compliance profile.

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

instance_id str

A unique ID for the instance of a compliance profile.

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

instance_location str

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

profile_name str

The name of the compliance profile.

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

wp_instance_id str

A unique ID for the instance of a Workload Protection.

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

wp_instance_location str

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

wp_instance_name str

The name of the Workload Protection instance.

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

wp_policy_id str

The unique ID for the Workload Protection policy.

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

wp_policy_name str

The name of the Workload Protection policy.

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

wp_zone_id str

A unique ID for the zone to a Workload Protection policy.

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

wp_zone_name str

A unique ID for the zone to a Workload Protection policy.

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

attachmentId String

A unique ID for the attachment to a compliance profile.

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

id String

The unique ID for the compliance profile.

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

instanceId String

A unique ID for the instance of a compliance profile.

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

instanceLocation String

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

profileName String

The name of the compliance profile.

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

wpInstanceId String

A unique ID for the instance of a Workload Protection.

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

Definitions List<ProjectEnvironmentProjectDefinition>

The location of the compliance instance.

Constraints: Allowable values are: us-south, us-east, eu-gb, eu-de, ca-tor.

wpInstanceName String

The name of the Workload Protection instance.

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

wpPolicyId String

The unique ID for the Workload Protection policy.

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

wpPolicyName String

The name of the Workload Protection policy.

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

wpZoneId String

A unique ID for the zone to a Workload Protection policy.

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

wpZoneName String

A unique ID for the zone to a Workload Protection policy.

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

ProjectEnvironmentProject, ProjectEnvironmentProjectArgs

Crn string

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

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

The environment definition. Nested schema for definition:

Href string

(String) A Url.

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

Id string

(String) The unique ID.

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

Crn string

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

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

Definitions []ProjectEnvironmentProjectDefinition

The environment definition. Nested schema for definition:

Href string

(String) A Url.

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

Id string

(String) The unique ID.

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

crn String

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

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

definitions List<ProjectEnvironmentProjectDefinition>

The environment definition. Nested schema for definition:

href String

(String) A Url.

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

id String

(String) The unique ID.

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

crn string

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

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

definitions ProjectEnvironmentProjectDefinition[]

The environment definition. Nested schema for definition:

href string

(String) A Url.

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

id string

(String) The unique ID.

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

crn str

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

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

definitions Sequence[ProjectEnvironmentProjectDefinition]

The environment definition. Nested schema for definition:

href str

(String) A Url.

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

id str

(String) The unique ID.

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

crn String

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

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