gcp.organizations.Project
Explore with Pulumi AI
Allows creation and management of a Google Cloud Platform project.
Projects created with this resource must be associated with an Organization. See the Organization documentation for more details.
The user or service account that is running this provider when creating a gcp.organizations.Project
resource must have roles/resourcemanager.projectCreator
on the specified organization. See the
Access Control for Organizations Using IAM
doc for more information.
This resource reads the specified billing account on every pulumi up and plan operation so you must have permissions on the specified billing account.
To get more information about projects, see:
- API documentation
- How-to Guides
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var myProject = new Gcp.Organizations.Project("myProject", new()
{
OrgId = "1234567",
ProjectId = "your-project-id",
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := organizations.NewProject(ctx, "myProject", &organizations.ProjectArgs{
OrgId: pulumi.String("1234567"),
ProjectId: pulumi.String("your-project-id"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Project;
import com.pulumi.gcp.organizations.ProjectArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myProject = new Project("myProject", ProjectArgs.builder()
.orgId("1234567")
.projectId("your-project-id")
.build());
}
}
import pulumi
import pulumi_gcp as gcp
my_project = gcp.organizations.Project("myProject",
org_id="1234567",
project_id="your-project-id")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const myProject = new gcp.organizations.Project("myProject", {
orgId: "1234567",
projectId: "your-project-id",
});
resources:
myProject:
type: gcp:organizations:Project
properties:
orgId: '1234567'
projectId: your-project-id
To create a project under a specific folder
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var department1 = new Gcp.Organizations.Folder("department1", new()
{
DisplayName = "Department 1",
Parent = "organizations/1234567",
});
var myProject_in_a_folder = new Gcp.Organizations.Project("myProject-in-a-folder", new()
{
ProjectId = "your-project-id",
FolderId = department1.Name,
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
department1, err := organizations.NewFolder(ctx, "department1", &organizations.FolderArgs{
DisplayName: pulumi.String("Department 1"),
Parent: pulumi.String("organizations/1234567"),
})
if err != nil {
return err
}
_, err = organizations.NewProject(ctx, "myProject-in-a-folder", &organizations.ProjectArgs{
ProjectId: pulumi.String("your-project-id"),
FolderId: department1.Name,
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Folder;
import com.pulumi.gcp.organizations.FolderArgs;
import com.pulumi.gcp.organizations.Project;
import com.pulumi.gcp.organizations.ProjectArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var department1 = new Folder("department1", FolderArgs.builder()
.displayName("Department 1")
.parent("organizations/1234567")
.build());
var myProject_in_a_folder = new Project("myProject-in-a-folder", ProjectArgs.builder()
.projectId("your-project-id")
.folderId(department1.name())
.build());
}
}
import pulumi
import pulumi_gcp as gcp
department1 = gcp.organizations.Folder("department1",
display_name="Department 1",
parent="organizations/1234567")
my_project_in_a_folder = gcp.organizations.Project("myProject-in-a-folder",
project_id="your-project-id",
folder_id=department1.name)
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const department1 = new gcp.organizations.Folder("department1", {
displayName: "Department 1",
parent: "organizations/1234567",
});
const myProject_in_a_folder = new gcp.organizations.Project("myProject-in-a-folder", {
projectId: "your-project-id",
folderId: department1.name,
});
resources:
myProject-in-a-folder:
type: gcp:organizations:Project
properties:
projectId: your-project-id
folderId: ${department1.name}
department1:
type: gcp:organizations:Folder
properties:
displayName: Department 1
parent: organizations/1234567
Create Project Resource
new Project(name: string, args: ProjectArgs, opts?: CustomResourceOptions);
@overload
def Project(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_create_network: Optional[bool] = None,
billing_account: Optional[str] = None,
folder_id: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
skip_delete: Optional[bool] = None)
@overload
def Project(resource_name: str,
args: ProjectArgs,
opts: Optional[ResourceOptions] = None)
func NewProject(ctx *Context, name string, args ProjectArgs, opts ...ResourceOption) (*Project, error)
public Project(string name, ProjectArgs args, CustomResourceOptions? opts = null)
public Project(String name, ProjectArgs args)
public Project(String name, ProjectArgs args, CustomResourceOptions options)
type: gcp:organizations:Project
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ProjectArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ProjectArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProjectArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Project Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Project resource accepts the following input properties:
- Project
Id string The project ID. Changing this forces a new project to be created.
- Auto
Create boolNetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- Billing
Account string The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- Folder
Id string The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- Labels Dictionary<string, string>
A set of key/value label pairs to assign to the project.
- Name string
The display name of the project.
- Org
Id string The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- Skip
Delete bool If true, the resource can be deleted without deleting the Project via the Google API.
- Project
Id string The project ID. Changing this forces a new project to be created.
- Auto
Create boolNetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- Billing
Account string The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- Folder
Id string The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- Labels map[string]string
A set of key/value label pairs to assign to the project.
- Name string
The display name of the project.
- Org
Id string The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- Skip
Delete bool If true, the resource can be deleted without deleting the Project via the Google API.
- project
Id String The project ID. Changing this forces a new project to be created.
- auto
Create BooleanNetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- billing
Account String The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- folder
Id String The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- labels Map<String,String>
A set of key/value label pairs to assign to the project.
- name String
The display name of the project.
- org
Id String The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- skip
Delete Boolean If true, the resource can be deleted without deleting the Project via the Google API.
- project
Id string The project ID. Changing this forces a new project to be created.
- auto
Create booleanNetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- billing
Account string The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- folder
Id string The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- labels {[key: string]: string}
A set of key/value label pairs to assign to the project.
- name string
The display name of the project.
- org
Id string The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- skip
Delete boolean If true, the resource can be deleted without deleting the Project via the Google API.
- project_
id str The project ID. Changing this forces a new project to be created.
- auto_
create_ boolnetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- billing_
account str The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- folder_
id str The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- labels Mapping[str, str]
A set of key/value label pairs to assign to the project.
- name str
The display name of the project.
- org_
id str The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- skip_
delete bool If true, the resource can be deleted without deleting the Project via the Google API.
- project
Id String The project ID. Changing this forces a new project to be created.
- auto
Create BooleanNetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- billing
Account String The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- folder
Id String The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- labels Map<String>
A set of key/value label pairs to assign to the project.
- name String
The display name of the project.
- org
Id String The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- skip
Delete Boolean If true, the resource can be deleted without deleting the Project via the Google API.
Outputs
All input properties are implicitly available as output properties. Additionally, the Project resource produces the following output properties:
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,
auto_create_network: Optional[bool] = None,
billing_account: Optional[str] = None,
folder_id: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
number: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None,
skip_delete: Optional[bool] = 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)
Resource lookup is not supported in YAML
- 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.
- Auto
Create boolNetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- Billing
Account string The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- Folder
Id string The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- Labels Dictionary<string, string>
A set of key/value label pairs to assign to the project.
- Name string
The display name of the project.
- Number string
The numeric identifier of the project.
- Org
Id string The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- Project
Id string The project ID. Changing this forces a new project to be created.
- Skip
Delete bool If true, the resource can be deleted without deleting the Project via the Google API.
- Auto
Create boolNetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- Billing
Account string The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- Folder
Id string The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- Labels map[string]string
A set of key/value label pairs to assign to the project.
- Name string
The display name of the project.
- Number string
The numeric identifier of the project.
- Org
Id string The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- Project
Id string The project ID. Changing this forces a new project to be created.
- Skip
Delete bool If true, the resource can be deleted without deleting the Project via the Google API.
- auto
Create BooleanNetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- billing
Account String The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- folder
Id String The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- labels Map<String,String>
A set of key/value label pairs to assign to the project.
- name String
The display name of the project.
- number String
The numeric identifier of the project.
- org
Id String The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- project
Id String The project ID. Changing this forces a new project to be created.
- skip
Delete Boolean If true, the resource can be deleted without deleting the Project via the Google API.
- auto
Create booleanNetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- billing
Account string The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- folder
Id string The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- labels {[key: string]: string}
A set of key/value label pairs to assign to the project.
- name string
The display name of the project.
- number string
The numeric identifier of the project.
- org
Id string The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- project
Id string The project ID. Changing this forces a new project to be created.
- skip
Delete boolean If true, the resource can be deleted without deleting the Project via the Google API.
- auto_
create_ boolnetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- billing_
account str The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- folder_
id str The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- labels Mapping[str, str]
A set of key/value label pairs to assign to the project.
- name str
The display name of the project.
- number str
The numeric identifier of the project.
- org_
id str The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- project_
id str The project ID. Changing this forces a new project to be created.
- skip_
delete bool If true, the resource can be deleted without deleting the Project via the Google API.
- auto
Create BooleanNetwork Create the 'default' network automatically. Default true. If set to false, the default network will be deleted. Note that, for quota purposes, you will still need to have 1 network slot available to create the project successfully, even if you set auto_create_network to false, since the network will exist momentarily.
- billing
Account String The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have at mininum Billing Account User privileges (
roles/billing.user
) on the billing account. See Google Cloud Billing API Access Control for more details.- folder
Id String The numeric ID of the folder this project should be created under. Only one of
org_id
orfolder_id
may be specified. If thefolder_id
is specified, then the project is created under the specified folder. Changing this forces the project to be migrated to the newly specified folder.- labels Map<String>
A set of key/value label pairs to assign to the project.
- name String
The display name of the project.
- number String
The numeric identifier of the project.
- org
Id String The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of
org_id
orfolder_id
may be specified. If theorg_id
is specified then the project is created at the top level. Changing this forces the project to be migrated to the newly specified organization.- project
Id String The project ID. Changing this forces a new project to be created.
- skip
Delete Boolean If true, the resource can be deleted without deleting the Project via the Google API.
Import
Projects can be imported using the project_id
, e.g.
$ pulumi import gcp:organizations/project:Project my_project your-project-id
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.