Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. organizations
  5. Folder
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.organizations.Folder

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 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.

    It may take a while for the attached tag bindings to be deleted after the folder is scheduled to be deleted.

    Create Folder Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Folder(name: string, args: FolderArgs, opts?: CustomResourceOptions);
    @overload
def Folder(resource_name: str,
           args: FolderArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Folder(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           display_name: Optional[str] = None,
           parent: Optional[str] = None,
           deletion_protection: Optional[bool] = None,
           tags: Optional[Mapping[str, str]] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var folderResource = new Gcp.Organizations.Folder("folderResource", new()
{
    DisplayName = "string",
    Parent = "string",
    DeletionProtection = false,
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := organizations.NewFolder(ctx, "folderResource", &organizations.FolderArgs{
	DisplayName:        pulumi.String("string"),
	Parent:             pulumi.String("string"),
	DeletionProtection: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var folderResource = new Folder("folderResource", FolderArgs.builder()
    .displayName("string")
    .parent("string")
    .deletionProtection(false)
    .tags(Map.of("string", "string"))
    .build());

    folder_resource = gcp.organizations.Folder("folderResource",
    display_name="string",
    parent="string",
    deletion_protection=False,
    tags={
        "string": "string",
    })

    const folderResource = new gcp.organizations.Folder("folderResource", {
    displayName: "string",
    parent: "string",
    deletionProtection: false,
    tags: {
        string: "string",
    },
});

    type: gcp:organizations:Folder
properties:
    deletionProtection: false
    displayName: string
    parent: string
    tags:
        string: string

    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}.
    DeletionProtection bool
    Tags Dictionary<string, string>
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.
    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}.
    DeletionProtection bool
    Tags map[string]string
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.
    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}.
    deletionProtection Boolean
    tags Map<String,String>
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.
    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}.
    deletionProtection boolean
    tags {[key: string]: string}
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.
    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}.
    deletion_protection bool
    tags Mapping[str, str]
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.
    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}.
    deletionProtection Boolean
    tags Map<String>
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.

    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,
        deletion_protection: Optional[bool] = None,
        display_name: Optional[str] = None,
        folder_id: Optional[str] = None,
        lifecycle_state: Optional[str] = None,
        name: Optional[str] = None,
        parent: Optional[str] = None,
        tags: Optional[Mapping[str, 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".
    DeletionProtection bool
    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}.
    Tags Dictionary<string, string>
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.
    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".
    DeletionProtection bool
    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}.
    Tags map[string]string
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.
    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".
    deletionProtection Boolean
    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}.
    tags Map<String,String>
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.
    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".
    deletionProtection boolean
    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}.
    tags {[key: string]: string}
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.
    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".
    deletion_protection bool
    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}.
    tags Mapping[str, str]
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.
    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".
    deletionProtection Boolean
    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}.
    tags Map<String>
    A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated.

    Import

    Folders can be imported using the folder’s id, e.g.

    • folders/{{folder_id}}

    • {{folder_id}}

    When using the pulumi import command, Folders can be imported using one of the formats above. For example:

    $ pulumi import gcp:organizations/folder:Folder default {{folder_id}}

    $ pulumi import gcp:organizations/folder:Folder default folders/{{folder_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    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 v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
    pulumi/pulumi-gcp