com.pulumi.azure.storage.kotlin.Blob.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.storage.kotlin
import com.pulumi.asset.AssetOrArchive
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.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [Blob].
*/
@PulumiTagMarker
public class BlobResourceBuilder internal constructor() {
public var name: String? = null
public var args: BlobArgs = BlobArgs()
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 BlobArgsBuilder.() -> Unit) {
val builder = BlobArgsBuilder()
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(): Blob {
val builtJavaResource = com.pulumi.azure.storage.Blob(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Blob(builtJavaResource)
}
}
/**
* Manages a Blob within a Storage Container.
* ## 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: "examplestoracc",
* resourceGroupName: example.name,
* location: example.location,
* accountTier: "Standard",
* accountReplicationType: "LRS",
* });
* const exampleContainer = new azure.storage.Container("example", {
* name: "content",
* storageAccountName: exampleAccount.name,
* containerAccessType: "private",
* });
* const exampleBlob = new azure.storage.Blob("example", {
* name: "my-awesome-content.zip",
* storageAccountName: exampleAccount.name,
* storageContainerName: exampleContainer.name,
* type: "Block",
* source: new pulumi.asset.FileAsset("some-local-file.zip"),
* });
* ```
* ```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="examplestoracc",
* resource_group_name=example.name,
* location=example.location,
* account_tier="Standard",
* account_replication_type="LRS")
* example_container = azure.storage.Container("example",
* name="content",
* storage_account_name=example_account.name,
* container_access_type="private")
* example_blob = azure.storage.Blob("example",
* name="my-awesome-content.zip",
* storage_account_name=example_account.name,
* storage_container_name=example_container.name,
* type="Block",
* source=pulumi.FileAsset("some-local-file.zip"))
* ```
* ```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 = "examplestoracc",
* ResourceGroupName = example.Name,
* Location = example.Location,
* AccountTier = "Standard",
* AccountReplicationType = "LRS",
* });
* var exampleContainer = new Azure.Storage.Container("example", new()
* {
* Name = "content",
* StorageAccountName = exampleAccount.Name,
* ContainerAccessType = "private",
* });
* var exampleBlob = new Azure.Storage.Blob("example", new()
* {
* Name = "my-awesome-content.zip",
* StorageAccountName = exampleAccount.Name,
* StorageContainerName = exampleContainer.Name,
* Type = "Block",
* Source = new FileAsset("some-local-file.zip"),
* });
* });
* ```
* ```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("examplestoracc"),
* ResourceGroupName: example.Name,
* Location: example.Location,
* AccountTier: pulumi.String("Standard"),
* AccountReplicationType: pulumi.String("LRS"),
* })
* if err != nil {
* return err
* }
* exampleContainer, err := storage.NewContainer(ctx, "example", &storage.ContainerArgs{
* Name: pulumi.String("content"),
* StorageAccountName: exampleAccount.Name,
* ContainerAccessType: pulumi.String("private"),
* })
* if err != nil {
* return err
* }
* _, err = storage.NewBlob(ctx, "example", &storage.BlobArgs{
* Name: pulumi.String("my-awesome-content.zip"),
* StorageAccountName: exampleAccount.Name,
* StorageContainerName: exampleContainer.Name,
* Type: pulumi.String("Block"),
* Source: pulumi.NewFileAsset("some-local-file.zip"),
* })
* 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 com.pulumi.azure.storage.Blob;
* import com.pulumi.azure.storage.BlobArgs;
* import com.pulumi.asset.FileAsset;
* 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("examplestoracc")
* .resourceGroupName(example.name())
* .location(example.location())
* .accountTier("Standard")
* .accountReplicationType("LRS")
* .build());
* var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
* .name("content")
* .storageAccountName(exampleAccount.name())
* .containerAccessType("private")
* .build());
* var exampleBlob = new Blob("exampleBlob", BlobArgs.builder()
* .name("my-awesome-content.zip")
* .storageAccountName(exampleAccount.name())
* .storageContainerName(exampleContainer.name())
* .type("Block")
* .source(new FileAsset("some-local-file.zip"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleAccount:
* type: azure:storage:Account
* name: example
* properties:
* name: examplestoracc
* resourceGroupName: ${example.name}
* location: ${example.location}
* accountTier: Standard
* accountReplicationType: LRS
* exampleContainer:
* type: azure:storage:Container
* name: example
* properties:
* name: content
* storageAccountName: ${exampleAccount.name}
* containerAccessType: private
* exampleBlob:
* type: azure:storage:Blob
* name: example
* properties:
* name: my-awesome-content.zip
* storageAccountName: ${exampleAccount.name}
* storageContainerName: ${exampleContainer.name}
* type: Block
* source:
* fn::FileAsset: some-local-file.zip
* ```
*
* ## Import
* Storage Blob's can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:storage/blob:Blob blob1 https://example.blob.core.windows.net/container/blob.vhd
* ```
*/
public class Blob internal constructor(
override val javaResource: com.pulumi.azure.storage.Blob,
) : KotlinCustomResource(javaResource, BlobMapper) {
/**
* The access tier of the storage blob. Possible values are `Archive`, `Cool` and `Hot`.
*/
public val accessTier: Output
get() = javaResource.accessTier().applyValue({ args0 -> args0 })
/**
* Controls the [cache control header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control) content of the response when blob is requested .
*/
public val cacheControl: Output?
get() = javaResource.cacheControl().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The MD5 sum of the blob contents. Cannot be defined if `source_uri` is defined, or if blob type is Append or Page. Changing this forces a new resource to be created.
*/
public val contentMd5: Output?
get() = javaResource.contentMd5().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The content type of the storage blob. Cannot be defined if `source_uri` is defined. Defaults to `application/octet-stream`.
*/
public val contentType: Output?
get() = javaResource.contentType().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The encryption scope to use for this blob.
*/
public val encryptionScope: Output?
get() = javaResource.encryptionScope().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A map of custom blob metadata.
*/
public val metadata: Output>
get() = javaResource.metadata().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* The name of the storage blob. Must be unique within the storage container the blob is located. Changing this forces a new resource to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The number of workers per CPU core to run for concurrent uploads. Defaults to `8`. Changing this forces a new resource to be created.
* > **NOTE:** `parallelism` is only applicable for Page blobs - support for [Block Blobs is blocked on the upstream issue](https://github.com/tombuildsstuff/giovanni/issues/15).
*/
public val parallelism: Output?
get() = javaResource.parallelism().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Used only for `page` blobs to specify the size in bytes of the blob to be created. Must be a multiple of 512. Defaults to `0`. Changing this forces a new resource to be created.
* > **Note:** `size` is required if `source_uri` is not set.
*/
public val size: Output?
get() = javaResource.size().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* An absolute path to a file on the local system. This field cannot be specified for Append blobs and cannot be specified if `source_content` or `source_uri` is specified. Changing this forces a new resource to be created.
*/
public val source: Output?
get() = javaResource.source().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The content for this blob which should be defined inline. This field can only be specified for Block blobs and cannot be specified if `source` or `source_uri` is specified. Changing this forces a new resource to be created.
*/
public val sourceContent: Output?
get() = javaResource.sourceContent().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The URI of an existing blob, or a file in the Azure File service, to use as the source contents for the blob to be created. Changing this forces a new resource to be created. This field cannot be specified for Append blobs and cannot be specified if `source` or `source_content` is specified.
*/
public val sourceUri: Output?
get() = javaResource.sourceUri().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Specifies the storage account in which to create the storage container. Changing this forces a new resource to be created.
*/
public val storageAccountName: Output
get() = javaResource.storageAccountName().applyValue({ args0 -> args0 })
/**
* The name of the storage container in which this blob should be created. Changing this forces a new resource to be created.
*/
public val storageContainerName: Output
get() = javaResource.storageContainerName().applyValue({ args0 -> args0 })
/**
* The type of the storage blob to be created. Possible values are `Append`, `Block` or `Page`. Changing this forces a new resource to be created.
*/
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
/**
* The URL of the blob
*/
public val url: Output
get() = javaResource.url().applyValue({ args0 -> args0 })
}
public object BlobMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.storage.Blob::class == javaResource::class
override fun map(javaResource: Resource): Blob = Blob(
javaResource as
com.pulumi.azure.storage.Blob,
)
}
/**
* @see [Blob].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Blob].
*/
public suspend fun blob(name: String, block: suspend BlobResourceBuilder.() -> Unit): Blob {
val builder = BlobResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Blob].
* @param name The _unique_ name of the resulting resource.
*/
public fun blob(name: String): Blob {
val builder = BlobResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy