Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. organizations
  5. Folder
Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-gcp

gcp.organizations.Folder

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-gcp

    Allows management of a Google Cloud Platform folder. For more information see the official documentation and API.

    A folder can contain projects, other folders, or a combination of both. You can use folders to group projects under an organization in a hierarchy. For example, your organization might contain multiple departments, each with its own set of Cloud Platform resources. Folders allows you to group these resources on a per-department basis. Folders are used to group resources that share common IAM policies.

    Folders created live inside an Organization. See the Organization documentation for more details.

    The service account used to run the provider when creating a gcp.organizations.Folder resource must have roles/resourcemanager.folderCreator. See the Access Control for Folders Using IAM doc for more information.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    // Top-level folder under an organization.
    var department1 = new Gcp.Organizations.Folder("department1", new()
    {
        DisplayName = "Department 1",
        Parent = "organizations/1234567",
    });

    // Folder nested under another folder.
    var team_abc = new Gcp.Organizations.Folder("team-abc", new()
    {
        DisplayName = "Team ABC",
        Parent = 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.NewFolder(ctx, "team-abc", &organizations.FolderArgs{
			DisplayName: pulumi.String("Team ABC"),
			Parent:      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 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 team_abc = new Folder("team-abc", FolderArgs.builder()        
            .displayName("Team ABC")
            .parent(department1.name())
            .build());

    }
}

    import pulumi
import pulumi_gcp as gcp

# Top-level folder under an organization.
department1 = gcp.organizations.Folder("department1",
    display_name="Department 1",
    parent="organizations/1234567")
# Folder nested under another folder.
team_abc = gcp.organizations.Folder("team-abc",
    display_name="Team ABC",
    parent=department1.name)

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

// Top-level folder under an organization.
const department1 = new gcp.organizations.Folder("department1", {
    displayName: "Department 1",
    parent: "organizations/1234567",
});
// Folder nested under another folder.
const team_abc = new gcp.organizations.Folder("team-abc", {
    displayName: "Team ABC",
    parent: department1.name,
});

    resources:
  # Top-level folder under an organization.
  department1:
    type: gcp:organizations:Folder
    properties:
      displayName: Department 1
      parent: organizations/1234567
  # Folder nested under another folder.
  team-abc:
    type: gcp:organizations:Folder
    properties:
      displayName: Team ABC
      parent: ${department1.name}

    Create Folder Resource

    new Folder(name: string, args: FolderArgs, opts?: CustomResourceOptions);
    @overload
def Folder(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           display_name: Optional[str] = None,
           parent: Optional[str] = None)
@overload
def Folder(resource_name: str,
           args: FolderArgs,
           opts: Optional[ResourceOptions] = None)
    func NewFolder(ctx *Context, name string, args FolderArgs, opts ...ResourceOption) (*Folder, error)
    public Folder(string name, FolderArgs args, CustomResourceOptions? opts = null)
    public Folder(String name, FolderArgs args)
public Folder(String name, FolderArgs args, CustomResourceOptions options)

    type: gcp:organizations:Folder
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FolderArgs
    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 FolderArgs
    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 FolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Folder 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 Folder resource accepts the following input properties:

    DisplayName string

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    Parent string

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    DisplayName string

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    Parent string

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    displayName String

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    parent String

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    displayName string

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    parent string

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    display_name str

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    parent str

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    displayName String

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    parent String

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    Outputs

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

    CreateTime string

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    FolderId string

    The folder id from the name "folders/{folder_id}"

    Id string

    The provider-assigned unique ID for this managed resource.

    LifecycleState string

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    Name string

    The resource name of the Folder. Its format is folders/{folder_id}.

    CreateTime string

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    FolderId string

    The folder id from the name "folders/{folder_id}"

    Id string

    The provider-assigned unique ID for this managed resource.

    LifecycleState string

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    Name string

    The resource name of the Folder. Its format is folders/{folder_id}.

    createTime String

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    folderId String

    The folder id from the name "folders/{folder_id}"

    id String

    The provider-assigned unique ID for this managed resource.

    lifecycleState String

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    name String

    The resource name of the Folder. Its format is folders/{folder_id}.

    createTime string

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    folderId string

    The folder id from the name "folders/{folder_id}"

    id string

    The provider-assigned unique ID for this managed resource.

    lifecycleState string

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    name string

    The resource name of the Folder. Its format is folders/{folder_id}.

    create_time str

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    folder_id str

    The folder id from the name "folders/{folder_id}"

    id str

    The provider-assigned unique ID for this managed resource.

    lifecycle_state str

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    name str

    The resource name of the Folder. Its format is folders/{folder_id}.

    createTime String

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    folderId String

    The folder id from the name "folders/{folder_id}"

    id String

    The provider-assigned unique ID for this managed resource.

    lifecycleState String

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    name String

    The resource name of the Folder. Its format is folders/{folder_id}.

    Look up Existing Folder Resource

    Get an existing Folder 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?: FolderState, opts?: CustomResourceOptions): Folder
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        display_name: Optional[str] = None,
        folder_id: Optional[str] = None,
        lifecycle_state: Optional[str] = None,
        name: Optional[str] = None,
        parent: Optional[str] = None) -> Folder
    func GetFolder(ctx *Context, name string, id IDInput, state *FolderState, opts ...ResourceOption) (*Folder, error)
    public static Folder Get(string name, Input<string> id, FolderState? state, CustomResourceOptions? opts = null)
    public static Folder get(String name, Output<String> id, FolderState 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.
    The following state arguments are supported:
    CreateTime string

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    DisplayName string

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    FolderId string

    The folder id from the name "folders/{folder_id}"

    LifecycleState string

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    Name string

    The resource name of the Folder. Its format is folders/{folder_id}.

    Parent string

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    CreateTime string

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    DisplayName string

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    FolderId string

    The folder id from the name "folders/{folder_id}"

    LifecycleState string

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    Name string

    The resource name of the Folder. Its format is folders/{folder_id}.

    Parent string

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    createTime String

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    displayName String

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    folderId String

    The folder id from the name "folders/{folder_id}"

    lifecycleState String

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    name String

    The resource name of the Folder. Its format is folders/{folder_id}.

    parent String

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    createTime string

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    displayName string

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    folderId string

    The folder id from the name "folders/{folder_id}"

    lifecycleState string

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    name string

    The resource name of the Folder. Its format is folders/{folder_id}.

    parent string

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    create_time str

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    display_name str

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    folder_id str

    The folder id from the name "folders/{folder_id}"

    lifecycle_state str

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    name str

    The resource name of the Folder. Its format is folders/{folder_id}.

    parent str

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    createTime String

    Timestamp when the Folder was created. Assigned by the server. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

    displayName String

    The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters.

    folderId String

    The folder id from the name "folders/{folder_id}"

    lifecycleState String

    The lifecycle state of the folder such as ACTIVE or DELETE_REQUESTED.

    name String

    The resource name of the Folder. Its format is folders/{folder_id}.

    parent String

    The resource name of the parent Folder or Organization. Must be of the form folders/{folder_id} or organizations/{org_id}.

    Import

    Folders can be imported using the folder’s id, e.g. Both syntaxes are valid

     $ pulumi import gcp:organizations/folder:Folder department1 1234567

     $ pulumi import gcp:organizations/folder:Folder department1 folders/1234567

    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.

    gcp logo
    Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi
    pulumi/pulumi-gcp