com.pulumi.gcp.storage.kotlin.DefaultObjectACL.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
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 8.10.0.0
Show newest version
@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
import kotlin.collections.List

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

    public var args: DefaultObjectACLArgs = DefaultObjectACLArgs()

    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 DefaultObjectACLArgsBuilder.() -> Unit) {
        val builder = DefaultObjectACLArgsBuilder()
        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(): DefaultObjectACL {
        val builtJavaResource = com.pulumi.gcp.storage.DefaultObjectACL(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return DefaultObjectACL(builtJavaResource)
    }
}

/**
 * Authoritatively manages the default object ACLs for a Google Cloud Storage bucket
 * without managing the bucket itself.
 * > Note that for each object, its creator will have the `"OWNER"` role in addition
 * to the default ACL that has been defined.
 * For more information see
 * [the official documentation](https://cloud.google.com/storage/docs/access-control/lists)
 * and
 * [API](https://cloud.google.com/storage/docs/json_api/v1/defaultObjectAccessControls).
 * > Want fine-grained control over default object ACLs? Use `gcp.storage.DefaultObjectAccessControl`
 * to control individual role entity pairs.
 * ## Example Usage
 * Example creating a default object ACL on a bucket with one owner, and one reader.
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const image_store = new gcp.storage.Bucket("image-store", {
 *     name: "image-store-bucket",
 *     location: "EU",
 * });
 * const image_store_default_acl = new gcp.storage.DefaultObjectACL("image-store-default-acl", {
 *     bucket: image_store.name,
 *     roleEntities: [
 *         "OWNER:[email protected]",
 *         "READER:group-mygroup",
 *     ],
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * image_store = gcp.storage.Bucket("image-store",
 *     name="image-store-bucket",
 *     location="EU")
 * image_store_default_acl = gcp.storage.DefaultObjectACL("image-store-default-acl",
 *     bucket=image_store.name,
 *     role_entities=[
 *         "OWNER:[email protected]",
 *         "READER:group-mygroup",
 *     ])
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var image_store = new Gcp.Storage.Bucket("image-store", new()
 *     {
 *         Name = "image-store-bucket",
 *         Location = "EU",
 *     });
 *     var image_store_default_acl = new Gcp.Storage.DefaultObjectACL("image-store-default-acl", new()
 *     {
 *         Bucket = image_store.Name,
 *         RoleEntities = new[]
 *         {
 *             "OWNER:[email protected]",
 *             "READER:group-mygroup",
 *         },
 *     });
 * });
 * ```
 * ```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 {
 * 		_, err := storage.NewBucket(ctx, "image-store", &storage.BucketArgs{
 * 			Name:     pulumi.String("image-store-bucket"),
 * 			Location: pulumi.String("EU"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = storage.NewDefaultObjectACL(ctx, "image-store-default-acl", &storage.DefaultObjectACLArgs{
 * 			Bucket: image_store.Name,
 * 			RoleEntities: pulumi.StringArray{
 * 				pulumi.String("OWNER:[email protected]"),
 * 				pulumi.String("READER:group-mygroup"),
 * 			},
 * 		})
 * 		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.DefaultObjectACL;
 * import com.pulumi.gcp.storage.DefaultObjectACLArgs;
 * 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 image_store = new Bucket("image-store", BucketArgs.builder()
 *             .name("image-store-bucket")
 *             .location("EU")
 *             .build());
 *         var image_store_default_acl = new DefaultObjectACL("image-store-default-acl", DefaultObjectACLArgs.builder()
 *             .bucket(image_store.name())
 *             .roleEntities(
 *                 "OWNER:[email protected]",
 *                 "READER:group-mygroup")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   image-store:
 *     type: gcp:storage:Bucket
 *     properties:
 *       name: image-store-bucket
 *       location: EU
 *   image-store-default-acl:
 *     type: gcp:storage:DefaultObjectACL
 *     properties:
 *       bucket: ${["image-store"].name}
 *       roleEntities:
 *         - OWNER:[email protected]
 *         - READER:group-mygroup
 * ```
 * 
 * ## Import
 * This resource does not support import.
 */
public class DefaultObjectACL internal constructor(
    override val javaResource: com.pulumi.gcp.storage.DefaultObjectACL,
) : KotlinCustomResource(javaResource, DefaultObjectACLMapper) {
    /**
     * The name of the bucket it applies to.
     */
    public val bucket: Output
        get() = javaResource.bucket().applyValue({ args0 -> args0 })

    /**
     * List of role/entity pairs in the form `ROLE:entity`.
     * See [GCS Object ACL documentation](https://cloud.google.com/storage/docs/json_api/v1/objectAccessControls) for more details.
     * Omitting the field is the same as providing an empty list.
     */
    public val roleEntities: Output>
        get() = javaResource.roleEntities().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
}

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

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

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

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