Folder

class Folder : KotlinCustomResource

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.

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}}

Properties

Link copied to clipboard
val createTime: Output<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".

Link copied to clipboard
Link copied to clipboard
val displayName: Output<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.

Link copied to clipboard
val folderId: Output<String>

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

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val lifecycleState: Output<String>

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

Link copied to clipboard
val name: Output<String>

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

Link copied to clipboard
val parent: Output<String>

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val tags: Output<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. This field is only set at create time and modifying this field after creation will trigger recreation. To apply tags to an existing resource, see the gcp.tags.TagValue resource.

Link copied to clipboard
val urn: Output<String>