com.pulumi.gcp.storage.kotlin.ManagedFolderArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.storage.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.storage.ManagedFolderArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* A Google Cloud Storage Managed Folder.
* You can apply Identity and Access Management (IAM) policies to
* managed folders to grant principals access only to the objects
* within the managed folder, which lets you more finely control access
* for specific data sets and tables within a bucket. You can nest
* managed folders up to 15 levels deep, including the parent managed
* folder.
* Managed folders can only be created in buckets that have uniform
* bucket-level access enabled.
* To get more information about ManagedFolder, see:
* * [API documentation](https://cloud.google.com/storage/docs/json_api/v1/managedFolder)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/storage/docs/managed-folders)
* ## Example Usage
* ### Storage Managed Folder Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const bucket = new gcp.storage.Bucket("bucket", {
* name: "my-bucket",
* location: "EU",
* uniformBucketLevelAccess: true,
* });
* const folder = new gcp.storage.ManagedFolder("folder", {
* bucket: bucket.name,
* name: "managed/folder/name/",
* forceDestroy: true,
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* bucket = gcp.storage.Bucket("bucket",
* name="my-bucket",
* location="EU",
* uniform_bucket_level_access=True)
* folder = gcp.storage.ManagedFolder("folder",
* bucket=bucket.name,
* name="managed/folder/name/",
* force_destroy=True)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var bucket = new Gcp.Storage.Bucket("bucket", new()
* {
* Name = "my-bucket",
* Location = "EU",
* UniformBucketLevelAccess = true,
* });
* var folder = new Gcp.Storage.ManagedFolder("folder", new()
* {
* Bucket = bucket.Name,
* Name = "managed/folder/name/",
* ForceDestroy = true,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/storage"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* bucket, err := storage.NewBucket(ctx, "bucket", &storage.BucketArgs{
* Name: pulumi.String("my-bucket"),
* Location: pulumi.String("EU"),
* UniformBucketLevelAccess: pulumi.Bool(true),
* })
* if err != nil {
* return err
* }
* _, err = storage.NewManagedFolder(ctx, "folder", &storage.ManagedFolderArgs{
* Bucket: bucket.Name,
* Name: pulumi.String("managed/folder/name/"),
* ForceDestroy: pulumi.Bool(true),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gcp.storage.Bucket;
* import com.pulumi.gcp.storage.BucketArgs;
* import com.pulumi.gcp.storage.ManagedFolder;
* import com.pulumi.gcp.storage.ManagedFolderArgs;
* 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 bucket = new Bucket("bucket", BucketArgs.builder()
* .name("my-bucket")
* .location("EU")
* .uniformBucketLevelAccess(true)
* .build());
* var folder = new ManagedFolder("folder", ManagedFolderArgs.builder()
* .bucket(bucket.name())
* .name("managed/folder/name/")
* .forceDestroy(true)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* bucket:
* type: gcp:storage:Bucket
* properties:
* name: my-bucket
* location: EU
* uniformBucketLevelAccess: true
* folder:
* type: gcp:storage:ManagedFolder
* properties:
* bucket: ${bucket.name}
* name: managed/folder/name/
* forceDestroy: true
* ```
*
* ## Import
* ManagedFolder can be imported using any of these accepted formats:
* * `{{bucket}}/managedFolders/{{name}}`
* * `{{bucket}}/{{name}}`
* When using the `pulumi import` command, ManagedFolder can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:storage/managedFolder:ManagedFolder default {{bucket}}/managedFolders/{{name}}
* ```
* ```sh
* $ pulumi import gcp:storage/managedFolder:ManagedFolder default {{bucket}}/{{name}}
* ```
* @property bucket The name of the bucket that contains the managed folder.
* @property forceDestroy Allows the deletion of a managed folder even if contains
* objects. If a non-empty managed folder is deleted, any objects
* within the folder will remain in a simulated folder with the
* same name.
* @property name The name of the managed folder expressed as a path. Must include
* trailing '/'. For example, `example_dir/example_dir2/`.
* - - -
*/
public data class ManagedFolderArgs(
public val bucket: Output? = null,
public val forceDestroy: Output? = null,
public val name: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.storage.ManagedFolderArgs =
com.pulumi.gcp.storage.ManagedFolderArgs.builder()
.bucket(bucket?.applyValue({ args0 -> args0 }))
.forceDestroy(forceDestroy?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ManagedFolderArgs].
*/
@PulumiTagMarker
public class ManagedFolderArgsBuilder internal constructor() {
private var bucket: Output? = null
private var forceDestroy: Output? = null
private var name: Output? = null
/**
* @param value The name of the bucket that contains the managed folder.
*/
@JvmName("shasbkjhgslpbomw")
public suspend fun bucket(`value`: Output) {
this.bucket = value
}
/**
* @param value Allows the deletion of a managed folder even if contains
* objects. If a non-empty managed folder is deleted, any objects
* within the folder will remain in a simulated folder with the
* same name.
*/
@JvmName("tqlmkwmvvauhlgsg")
public suspend fun forceDestroy(`value`: Output) {
this.forceDestroy = value
}
/**
* @param value The name of the managed folder expressed as a path. Must include
* trailing '/'. For example, `example_dir/example_dir2/`.
* - - -
*/
@JvmName("xhepthkphvemvqok")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The name of the bucket that contains the managed folder.
*/
@JvmName("swisulgcxlsexppm")
public suspend fun bucket(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.bucket = mapped
}
/**
* @param value Allows the deletion of a managed folder even if contains
* objects. If a non-empty managed folder is deleted, any objects
* within the folder will remain in a simulated folder with the
* same name.
*/
@JvmName("tqsobvlmpxfdvcbw")
public suspend fun forceDestroy(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.forceDestroy = mapped
}
/**
* @param value The name of the managed folder expressed as a path. Must include
* trailing '/'. For example, `example_dir/example_dir2/`.
* - - -
*/
@JvmName("wuqyayrqqouioepa")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
internal fun build(): ManagedFolderArgs = ManagedFolderArgs(
bucket = bucket,
forceDestroy = forceDestroy,
name = name,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy