Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. cloudresourcemanager
  5. cloudresourcemanager/v3
  6. Folder

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.cloudresourcemanager/v3.Folder

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success, the Operation.response field will be populated with the created Folder. In order to succeed, the addition of this new folder must not violate the folder naming, height, or fanout constraints. + The folder’s display_name must be distinct from all other folders that share its parent. + The addition of the folder must not cause the active folder hierarchy to exceed a height of 10. Note, the full active + deleted folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders. + The addition of the folder must not cause the total number of folders under its parent to exceed 300. If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned in the details list in the Operation.error field. The caller must have resourcemanager.folders.create permission on the identified parent. Auto-naming is currently not supported for this resource.

    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,
           parent: Optional[str] = None,
           display_name: Optional[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: google-native:cloudresourcemanager/v3: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 examplefolderResourceResourceFromCloudresourcemanagerv3 = new GoogleNative.CloudResourceManager.V3.Folder("examplefolderResourceResourceFromCloudresourcemanagerv3", new()
{
    Parent = "string",
    DisplayName = "string",
});

    example, err := cloudresourcemanagerv3.NewFolder(ctx, "examplefolderResourceResourceFromCloudresourcemanagerv3", &cloudresourcemanagerv3.FolderArgs{
	Parent:      pulumi.String("string"),
	DisplayName: pulumi.String("string"),
})

    var examplefolderResourceResourceFromCloudresourcemanagerv3 = new Folder("examplefolderResourceResourceFromCloudresourcemanagerv3", FolderArgs.builder()
    .parent("string")
    .displayName("string")
    .build());

    examplefolder_resource_resource_from_cloudresourcemanagerv3 = google_native.cloudresourcemanager.v3.Folder("examplefolderResourceResourceFromCloudresourcemanagerv3",
    parent="string",
    display_name="string")

    const examplefolderResourceResourceFromCloudresourcemanagerv3 = new google_native.cloudresourcemanager.v3.Folder("examplefolderResourceResourceFromCloudresourcemanagerv3", {
    parent: "string",
    displayName: "string",
});

    type: google-native:cloudresourcemanager/v3:Folder
properties:
    displayName: string
    parent: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Folder resource accepts the following input properties:

    Parent string
    The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.
    DisplayName string
    The folder's display name. A folder's display name must be unique amongst its siblings. For example, 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. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
    Parent string
    The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.
    DisplayName string
    The folder's display name. A folder's display name must be unique amongst its siblings. For example, 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. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
    parent String
    The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.
    displayName String
    The folder's display name. A folder's display name must be unique amongst its siblings. For example, 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. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
    parent string
    The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.
    displayName string
    The folder's display name. A folder's display name must be unique amongst its siblings. For example, 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. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
    parent str
    The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.
    display_name str
    The folder's display name. A folder's display name must be unique amongst its siblings. For example, 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. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
    parent String
    The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.
    displayName String
    The folder's display name. A folder's display name must be unique amongst its siblings. For example, 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. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

    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.
    DeleteTime string
    Timestamp when the folder was requested to be deleted.
    Etag string
    A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".
    State string
    The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.
    UpdateTime string
    Timestamp when the folder was last modified.
    CreateTime string
    Timestamp when the folder was created.
    DeleteTime string
    Timestamp when the folder was requested to be deleted.
    Etag string
    A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".
    State string
    The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.
    UpdateTime string
    Timestamp when the folder was last modified.
    createTime String
    Timestamp when the folder was created.
    deleteTime String
    Timestamp when the folder was requested to be deleted.
    etag String
    A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".
    state String
    The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.
    updateTime String
    Timestamp when the folder was last modified.
    createTime string
    Timestamp when the folder was created.
    deleteTime string
    Timestamp when the folder was requested to be deleted.
    etag string
    A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".
    state string
    The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.
    updateTime string
    Timestamp when the folder was last modified.
    create_time str
    Timestamp when the folder was created.
    delete_time str
    Timestamp when the folder was requested to be deleted.
    etag str
    A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".
    state str
    The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.
    update_time str
    Timestamp when the folder was last modified.
    createTime String
    Timestamp when the folder was created.
    deleteTime String
    Timestamp when the folder was requested to be deleted.
    etag String
    A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".
    state String
    The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.
    updateTime String
    Timestamp when the folder was last modified.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native