ProjectSpecification

ProjectSpecification

The project to create.

JSON Example

{
    "name": "my-name",
    "description": "my-description",
    "administrators": [
        {
            "email": "[email protected]",
            "type": "user"
        }
    ],
    "members": [
        {
            "email": "[email protected]",
            "type": "user"
        }
    ],
    "viewers": [
        {
            "email": "[email protected]",
            "type": "user"
        }
    ],
    "supervisors": [
        {
            "email": "[email protected]",
            "type": "user"
        }
    ],
    "users": [
        {
            "email": "[email protected]",
            "type": "user"
        }
    ],
    "auditors": [
        {
            "email": "[email protected]",
            "type": "user"
        }
    ],
    "advancedUsers": [
        {
            "email": "[email protected]",
            "type": "user"
        }
    ],
    "constraints": {
        "network": {
            "conditions": [
                {
                    "type": "TAG",
                    "enforcement": "HARD",
                    "occurrence": "MUST_OCCUR",
                    "expression": {
                        "key": "key",
                        "value": "value"
                    }
                }
            ]
        }
    },
    "properties": {
        "myproperty": "enforcement",
        "__projectPlacementPolicy": "SPREAD",
        "__namingTemplate": "my-resource-template-${######}",
        "__allowTerraformCloudzoneMapping": "true"
    },
    "cost": {
        "cost": "number",
        "costSyncTime": "2011-12-03T10:15:30Z",
        "costUnit": "USD",
        "message": "string",
        "code": "string"
    },
    "operationTimeout": 0,
    "sharedResources": false
}

string

name

Required

Constraints: minLength: 0 maxLength: 255

A human-friendly name used as an identifier in APIs that support this option.

string

description

Optional

Constraints: minLength: 0 maxLength: 2000

A human-friendly description.

array of Principal

administrators

Optional

List of administrator users associated with the project. Only administrators can manage project's configuration.

array of Principal

members

Optional

List of member users associated with the project.

array of Principal

viewers

Optional

List of viewer users associated with the project.

array of Principal

supervisors

Optional

List of supervisor users associated with the project.

array of Principal

users

Optional

List of users associated with the project.

array of Principal

auditors

Optional

List of auditor users associated with the project.

array of Principal

advancedUsers

Optional

List of advanced user users associated with the project.

object

constraints

Optional

List of constraints of the project.

object

properties

Optional

List of properties of the project, to be applied to any resource provisioned within the project.

The project placement policy is set through the property with key: __projectPlacementPolicy, which can take 1 of only 2 possible values DEFAULT or SPREAD. If not specified, it is set as DEFAULT.

The naming template of resources provisioned in this project can be specified through the property with key: __namingTemplate. Hint: Avoid conflicting names by generating digits in names with ${######}

You can allow Terraform cloudzone mapping through the property with key: __allowTerraformCloudzoneMapping. It can be set to either true or false. By default, it is set to false.

ProjectCost

cost

Optional

A representation of a project cost.

integer As int64 As int64

operationTimeout

Optional

The timeout that should be used for Blueprint operations and Provisioning tasks. The timeout is in seconds.

boolean

sharedResources

Optional

Specifies whether the resources in this projects are shared or not. Only allowed for classic tenants.

Parameter To

Create