Show / Hide Table of Contents

Class Project

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 service account used to run this provider when creating a gcp.organizations.Project resource must have roles/resourcemanager.projectCreator. See the Access Control for Organizations Using IAM doc for more information.

Example Usage

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var myProject = new Gcp.Organizations.Project("myProject", new Gcp.Organizations.ProjectArgs
    {
        OrgId = "1234567",
        ProjectId = "your-project-id",
    });
}

}
Inheritance
System.Object
Resource
CustomResource
Project
Inherited Members
CustomResource.Id
Resource.GetResourceType()
Resource.GetResourceName()
Resource.Urn
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Gcp.Organizations
Assembly: Pulumi.Gcp.dll
Syntax
public class Project : CustomResource

Constructors

View Source

Project(String, ProjectArgs, CustomResourceOptions)

Create a Project resource with the given unique name, arguments, and options.

Declaration
public Project(string name, ProjectArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource

ProjectArgs args

The arguments used to populate this resource's properties

CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AutoCreateNetwork

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.

Declaration
public Output<bool?> AutoCreateNetwork { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

BillingAccount

The alphanumeric ID of the billing account this project belongs to. The user or service account performing this operation with the provider must have Billing Account Administrator privileges (roles/billing.admin) in the organization. See Google Cloud Billing API Access Control for more details.

Declaration
public Output<string> BillingAccount { get; }
Property Value
Type Description
Output<System.String>
View Source

FolderId

The numeric ID of the folder this project should be created under. Only one of org_id or folder_id may be specified. If the folder_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.

Declaration
public Output<string> FolderId { get; }
Property Value
Type Description
Output<System.String>
View Source

Labels

A set of key/value label pairs to assign to the project.

Declaration
public Output<ImmutableDictionary<string, string>> Labels { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>
View Source

Name

The display name of the project.

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

Number

The numeric identifier of the project.

Declaration
public Output<string> Number { get; }
Property Value
Type Description
Output<System.String>
View Source

OrgId

The numeric ID of the organization this project belongs to. Changing this forces a new project to be created. Only one of org_id or folder_id may be specified. If the org_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.

Declaration
public Output<string> OrgId { get; }
Property Value
Type Description
Output<System.String>
View Source

ProjectId

The project ID. Changing this forces a new project to be created.

Declaration
public Output<string> ProjectId { get; }
Property Value
Type Description
Output<System.String>
View Source

SkipDelete

If true, the resource can be deleted without deleting the Project via the Google API.

Declaration
public Output<bool> SkipDelete { get; }
Property Value
Type Description
Output<System.Boolean>

Methods

View Source

Get(String, Input<String>, ProjectState, CustomResourceOptions)

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

Declaration
public static Project Get(string name, Input<string> id, ProjectState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.

Input<System.String> id

The unique provider ID of the resource to lookup.

ProjectState state

Any extra arguments used during the lookup.

CustomResourceOptions options

A bag of options that control this resource's behavior

Returns
Type Description
Project
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.