All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azure.storage.kotlin.ContainerArgs.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.storage.kotlin

import com.pulumi.azure.storage.ContainerArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
import kotlin.jvm.JvmName

/**
 * Manages a Container within an Azure Storage Account.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as azure from "@pulumi/azure";
 * const example = new azure.core.ResourceGroup("example", {
 *     name: "example-resources",
 *     location: "West Europe",
 * });
 * const exampleAccount = new azure.storage.Account("example", {
 *     name: "examplestoraccount",
 *     resourceGroupName: example.name,
 *     location: example.location,
 *     accountTier: "Standard",
 *     accountReplicationType: "LRS",
 *     tags: {
 *         environment: "staging",
 *     },
 * });
 * const exampleContainer = new azure.storage.Container("example", {
 *     name: "vhds",
 *     storageAccountName: exampleAccount.name,
 *     containerAccessType: "private",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_account = azure.storage.Account("example",
 *     name="examplestoraccount",
 *     resource_group_name=example.name,
 *     location=example.location,
 *     account_tier="Standard",
 *     account_replication_type="LRS",
 *     tags={
 *         "environment": "staging",
 *     })
 * example_container = azure.storage.Container("example",
 *     name="vhds",
 *     storage_account_name=example_account.name,
 *     container_access_type="private")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Azure = Pulumi.Azure;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Azure.Core.ResourceGroup("example", new()
 *     {
 *         Name = "example-resources",
 *         Location = "West Europe",
 *     });
 *     var exampleAccount = new Azure.Storage.Account("example", new()
 *     {
 *         Name = "examplestoraccount",
 *         ResourceGroupName = example.Name,
 *         Location = example.Location,
 *         AccountTier = "Standard",
 *         AccountReplicationType = "LRS",
 *         Tags =
 *         {
 *             { "environment", "staging" },
 *         },
 *     });
 *     var exampleContainer = new Azure.Storage.Container("example", new()
 *     {
 *         Name = "vhds",
 *         StorageAccountName = exampleAccount.Name,
 *         ContainerAccessType = "private",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
 * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
 * 			Name:     pulumi.String("example-resources"),
 * 			Location: pulumi.String("West Europe"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
 * 			Name:                   pulumi.String("examplestoraccount"),
 * 			ResourceGroupName:      example.Name,
 * 			Location:               example.Location,
 * 			AccountTier:            pulumi.String("Standard"),
 * 			AccountReplicationType: pulumi.String("LRS"),
 * 			Tags: pulumi.StringMap{
 * 				"environment": pulumi.String("staging"),
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = storage.NewContainer(ctx, "example", &storage.ContainerArgs{
 * 			Name:                pulumi.String("vhds"),
 * 			StorageAccountName:  exampleAccount.Name,
 * 			ContainerAccessType: pulumi.String("private"),
 * 		})
 * 		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.azure.core.ResourceGroup;
 * import com.pulumi.azure.core.ResourceGroupArgs;
 * import com.pulumi.azure.storage.Account;
 * import com.pulumi.azure.storage.AccountArgs;
 * import com.pulumi.azure.storage.Container;
 * import com.pulumi.azure.storage.ContainerArgs;
 * 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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
 *             .name("example-resources")
 *             .location("West Europe")
 *             .build());
 *         var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
 *             .name("examplestoraccount")
 *             .resourceGroupName(example.name())
 *             .location(example.location())
 *             .accountTier("Standard")
 *             .accountReplicationType("LRS")
 *             .tags(Map.of("environment", "staging"))
 *             .build());
 *         var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
 *             .name("vhds")
 *             .storageAccountName(exampleAccount.name())
 *             .containerAccessType("private")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleAccount:
 *     type: azure:storage:Account
 *     name: example
 *     properties:
 *       name: examplestoraccount
 *       resourceGroupName: ${example.name}
 *       location: ${example.location}
 *       accountTier: Standard
 *       accountReplicationType: LRS
 *       tags:
 *         environment: staging
 *   exampleContainer:
 *     type: azure:storage:Container
 *     name: example
 *     properties:
 *       name: vhds
 *       storageAccountName: ${exampleAccount.name}
 *       containerAccessType: private
 * ```
 * 
 * ## Import
 * Storage Containers can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:storage/container:Container container1 https://example.blob.core.windows.net/container
 * ```
 * @property containerAccessType The Access Level configured for this Container. Possible values are `blob`, `container` or `private`. Defaults to `private`.
 * > **Note** When updating `container_access_type` for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.
 * @property defaultEncryptionScope The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
 * @property encryptionScopeOverrideEnabled Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying `default_encryption_scope`. Defaults to `true`. Changing this forces a new resource to be created.
 * @property metadata A mapping of MetaData for this Container. All metadata keys should be lowercase.
 * @property name The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
 * @property storageAccountName The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
 */
public data class ContainerArgs(
    public val containerAccessType: Output? = null,
    public val defaultEncryptionScope: Output? = null,
    public val encryptionScopeOverrideEnabled: Output? = null,
    public val metadata: Output>? = null,
    public val name: Output? = null,
    public val storageAccountName: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.azure.storage.ContainerArgs =
        com.pulumi.azure.storage.ContainerArgs.builder()
            .containerAccessType(containerAccessType?.applyValue({ args0 -> args0 }))
            .defaultEncryptionScope(defaultEncryptionScope?.applyValue({ args0 -> args0 }))
            .encryptionScopeOverrideEnabled(encryptionScopeOverrideEnabled?.applyValue({ args0 -> args0 }))
            .metadata(
                metadata?.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.key.to(args0.value)
                    }).toMap()
                }),
            )
            .name(name?.applyValue({ args0 -> args0 }))
            .storageAccountName(storageAccountName?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [ContainerArgs].
 */
@PulumiTagMarker
public class ContainerArgsBuilder internal constructor() {
    private var containerAccessType: Output? = null

    private var defaultEncryptionScope: Output? = null

    private var encryptionScopeOverrideEnabled: Output? = null

    private var metadata: Output>? = null

    private var name: Output? = null

    private var storageAccountName: Output? = null

    /**
     * @param value The Access Level configured for this Container. Possible values are `blob`, `container` or `private`. Defaults to `private`.
     * > **Note** When updating `container_access_type` for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.
     */
    @JvmName("egvwdmjtxugudadf")
    public suspend fun containerAccessType(`value`: Output) {
        this.containerAccessType = value
    }

    /**
     * @param value The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
     */
    @JvmName("nxbkntnjfgbrjnoe")
    public suspend fun defaultEncryptionScope(`value`: Output) {
        this.defaultEncryptionScope = value
    }

    /**
     * @param value Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying `default_encryption_scope`. Defaults to `true`. Changing this forces a new resource to be created.
     */
    @JvmName("ufasfqqscdndgbuh")
    public suspend fun encryptionScopeOverrideEnabled(`value`: Output) {
        this.encryptionScopeOverrideEnabled = value
    }

    /**
     * @param value A mapping of MetaData for this Container. All metadata keys should be lowercase.
     */
    @JvmName("mqqnmlgyppkenndb")
    public suspend fun metadata(`value`: Output>) {
        this.metadata = value
    }

    /**
     * @param value The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
     */
    @JvmName("pfygpmtpunuqcwiq")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
     */
    @JvmName("aoqamprmbwhgapui")
    public suspend fun storageAccountName(`value`: Output) {
        this.storageAccountName = value
    }

    /**
     * @param value The Access Level configured for this Container. Possible values are `blob`, `container` or `private`. Defaults to `private`.
     * > **Note** When updating `container_access_type` for an existing storage container resource, Shared Key authentication will always be used, as AzureAD authentication is not supported.
     */
    @JvmName("adfiueqfxivbuppe")
    public suspend fun containerAccessType(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.containerAccessType = mapped
    }

    /**
     * @param value The default encryption scope to use for blobs uploaded to this container. Changing this forces a new resource to be created.
     */
    @JvmName("ahessssaqvuawufb")
    public suspend fun defaultEncryptionScope(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.defaultEncryptionScope = mapped
    }

    /**
     * @param value Whether to allow blobs to override the default encryption scope for this container. Can only be set when specifying `default_encryption_scope`. Defaults to `true`. Changing this forces a new resource to be created.
     */
    @JvmName("ipvtbrirhpvshjyu")
    public suspend fun encryptionScopeOverrideEnabled(`value`: Boolean?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.encryptionScopeOverrideEnabled = mapped
    }

    /**
     * @param value A mapping of MetaData for this Container. All metadata keys should be lowercase.
     */
    @JvmName("hxfntiekvyiaxctf")
    public suspend fun metadata(`value`: Map?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.metadata = mapped
    }

    /**
     * @param values A mapping of MetaData for this Container. All metadata keys should be lowercase.
     */
    @JvmName("iwuvljpkkdcqthou")
    public fun metadata(vararg values: Pair) {
        val toBeMapped = values.toMap()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.metadata = mapped
    }

    /**
     * @param value The name of the Container which should be created within the Storage Account. Changing this forces a new resource to be created.
     */
    @JvmName("ydgofhftfpcryubk")
    public suspend fun name(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.name = mapped
    }

    /**
     * @param value The name of the Storage Account where the Container should be created. Changing this forces a new resource to be created.
     */
    @JvmName("fidqujdmbhxvmcmo")
    public suspend fun storageAccountName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.storageAccountName = mapped
    }

    internal fun build(): ContainerArgs = ContainerArgs(
        containerAccessType = containerAccessType,
        defaultEncryptionScope = defaultEncryptionScope,
        encryptionScopeOverrideEnabled = encryptionScopeOverrideEnabled,
        metadata = metadata,
        name = name,
        storageAccountName = storageAccountName,
    )
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy