com.pulumi.gcp.storage.kotlin.ManagedFolder.kt Maven / Gradle / Ivy

Go to download
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.storage.kotlin

import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit

/**
 * Builder for [ManagedFolder].
 */
@PulumiTagMarker
public class ManagedFolderResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: ManagedFolderArgs = ManagedFolderArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend ManagedFolderArgsBuilder.() -> Unit) {
        val builder = ManagedFolderArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): ManagedFolder {
        val builtJavaResource = com.pulumi.gcp.storage.ManagedFolder(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return ManagedFolder(builtJavaResource)
    }
}

/**
 * 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/v8/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}}
 * ```
 */
public class ManagedFolder internal constructor(
    override val javaResource: com.pulumi.gcp.storage.ManagedFolder,
) : KotlinCustomResource(javaResource, ManagedFolderMapper) {
    /**
     * The name of the bucket that contains the managed folder.
     */
    public val bucket: Output
        get() = javaResource.bucket().applyValue({ args0 -> args0 })

    /**
     * The timestamp at which this managed folder was created.
     */
    public val createTime: Output
        get() = javaResource.createTime().applyValue({ args0 -> args0 })

    /**
     * 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.
     */
    public val forceDestroy: Output?
        get() = javaResource.forceDestroy().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The metadata generation of the managed folder.
     */
    public val metageneration: Output
        get() = javaResource.metageneration().applyValue({ args0 -> args0 })

    /**
     * The name of the managed folder expressed as a path. Must include
     * trailing '/'. For example, `example_dir/example_dir2/`.
     * - - -
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The URI of the created resource.
     */
    public val selfLink: Output
        get() = javaResource.selfLink().applyValue({ args0 -> args0 })

    /**
     * The timestamp at which this managed folder was most recently updated.
     */
    public val updateTime: Output
        get() = javaResource.updateTime().applyValue({ args0 -> args0 })
}

public object ManagedFolderMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.storage.ManagedFolder::class == javaResource::class

    override fun map(javaResource: Resource): ManagedFolder = ManagedFolder(
        javaResource as
            com.pulumi.gcp.storage.ManagedFolder,
    )
}

/**
 * @see [ManagedFolder].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [ManagedFolder].
 */
public suspend fun managedFolder(
    name: String,
    block: suspend ManagedFolderResourceBuilder.() -> Unit,
): ManagedFolder {
    val builder = ManagedFolderResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [ManagedFolder].
 * @param name The _unique_ name of the resulting resource.
 */
public fun managedFolder(name: String): ManagedFolder {
    val builder = ManagedFolderResourceBuilder()
    builder.name(name)
    return builder.build()
}