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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-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: 6.15.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.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 [SyncGroup].
 */
@PulumiTagMarker
public class SyncGroupResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: SyncGroupArgs = SyncGroupArgs()

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

/**
 * Manages a Storage Sync Group.
 * ## 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 exampleSync = new azure.storage.Sync("example", {
 *     name: "example-ss",
 *     resourceGroupName: example.name,
 *     location: example.location,
 * });
 * const exampleSyncGroup = new azure.storage.SyncGroup("example", {
 *     name: "example-ss-group",
 *     storageSyncId: exampleSync.id,
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_azure as azure
 * example = azure.core.ResourceGroup("example",
 *     name="example-resources",
 *     location="West Europe")
 * example_sync = azure.storage.Sync("example",
 *     name="example-ss",
 *     resource_group_name=example.name,
 *     location=example.location)
 * example_sync_group = azure.storage.SyncGroup("example",
 *     name="example-ss-group",
 *     storage_sync_id=example_sync.id)
 * ```
 * ```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 exampleSync = new Azure.Storage.Sync("example", new()
 *     {
 *         Name = "example-ss",
 *         ResourceGroupName = example.Name,
 *         Location = example.Location,
 *     });
 *     var exampleSyncGroup = new Azure.Storage.SyncGroup("example", new()
 *     {
 *         Name = "example-ss-group",
 *         StorageSyncId = exampleSync.Id,
 *     });
 * });
 * ```
 * ```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
 * 		}
 * 		exampleSync, err := storage.NewSync(ctx, "example", &storage.SyncArgs{
 * 			Name:              pulumi.String("example-ss"),
 * 			ResourceGroupName: example.Name,
 * 			Location:          example.Location,
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = storage.NewSyncGroup(ctx, "example", &storage.SyncGroupArgs{
 * 			Name:          pulumi.String("example-ss-group"),
 * 			StorageSyncId: exampleSync.ID(),
 * 		})
 * 		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.Sync;
 * import com.pulumi.azure.storage.SyncArgs;
 * import com.pulumi.azure.storage.SyncGroup;
 * import com.pulumi.azure.storage.SyncGroupArgs;
 * 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 exampleSync = new Sync("exampleSync", SyncArgs.builder()
 *             .name("example-ss")
 *             .resourceGroupName(example.name())
 *             .location(example.location())
 *             .build());
 *         var exampleSyncGroup = new SyncGroup("exampleSyncGroup", SyncGroupArgs.builder()
 *             .name("example-ss-group")
 *             .storageSyncId(exampleSync.id())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: azure:core:ResourceGroup
 *     properties:
 *       name: example-resources
 *       location: West Europe
 *   exampleSync:
 *     type: azure:storage:Sync
 *     name: example
 *     properties:
 *       name: example-ss
 *       resourceGroupName: ${example.name}
 *       location: ${example.location}
 *   exampleSyncGroup:
 *     type: azure:storage:SyncGroup
 *     name: example
 *     properties:
 *       name: example-ss-group
 *       storageSyncId: ${exampleSync.id}
 * ```
 * 
 * ## Import
 * Storage Sync Groups can be imported using the `resource id`, e.g.
 * ```sh
 * $ pulumi import azure:storage/syncGroup:SyncGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.StorageSync/storageSyncServices/sync1/syncGroups/group1
 * ```
 */
public class SyncGroup internal constructor(
    override val javaResource: com.pulumi.azure.storage.SyncGroup,
) : KotlinCustomResource(javaResource, SyncGroupMapper) {
    /**
     * The name which should be used for this Storage Sync Group. Changing this forces a new Storage Sync Group to be created.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The resource ID of the Storage Sync where this Storage Sync Group is. Changing this forces a new Storage Sync Group to be created.
     */
    public val storageSyncId: Output
        get() = javaResource.storageSyncId().applyValue({ args0 -> args0 })
}

public object SyncGroupMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.azure.storage.SyncGroup::class == javaResource::class

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

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

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