com.pulumi.aws.datazone.kotlin.Environment.kt Maven / Gradle / Ivy

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

package com.pulumi.aws.datazone.kotlin

import com.pulumi.aws.datazone.kotlin.outputs.EnvironmentLastDeployment
import com.pulumi.aws.datazone.kotlin.outputs.EnvironmentProvisionedResource
import com.pulumi.aws.datazone.kotlin.outputs.EnvironmentTimeouts
import com.pulumi.aws.datazone.kotlin.outputs.EnvironmentUserParameter
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
import com.pulumi.aws.datazone.kotlin.outputs.EnvironmentLastDeployment.Companion.toKotlin as environmentLastDeploymentToKotlin
import com.pulumi.aws.datazone.kotlin.outputs.EnvironmentProvisionedResource.Companion.toKotlin as environmentProvisionedResourceToKotlin
import com.pulumi.aws.datazone.kotlin.outputs.EnvironmentTimeouts.Companion.toKotlin as environmentTimeoutsToKotlin
import com.pulumi.aws.datazone.kotlin.outputs.EnvironmentUserParameter.Companion.toKotlin as environmentUserParameterToKotlin

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

    public var args: EnvironmentArgs = EnvironmentArgs()

    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 EnvironmentArgsBuilder.() -> Unit) {
        val builder = EnvironmentArgsBuilder()
        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(): Environment {
        val builtJavaResource = com.pulumi.aws.datazone.Environment(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return Environment(builtJavaResource)
    }
}

/**
 * Resource for managing an AWS DataZone Environment.
 * ## Example Usage
 * ### Basic Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 * const example = new aws.datazone.Environment("example", {
 *     name: "example",
 *     accountIdentifier: test.accountId,
 *     accountRegion: testAwsRegion.name,
 *     blueprintIdentifier: testAwsDatazoneEnvironmentBlueprintConfiguration.environmentBlueprintId,
 *     profileIdentifier: testAwsDatazoneEnvironmentProfile.id,
 *     projectIdentifier: testAwsDatazoneProject.id,
 *     domainIdentifier: testAwsDatazoneDomain.id,
 *     userParameters: [
 *         {
 *             name: "consumerGlueDbName",
 *             value: "consumer",
 *         },
 *         {
 *             name: "producerGlueDbName",
 *             value: "producer",
 *         },
 *         {
 *             name: "workgroupName",
 *             value: "workgroup",
 *         },
 *     ],
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_aws as aws
 * example = aws.datazone.Environment("example",
 *     name="example",
 *     account_identifier=test["accountId"],
 *     account_region=test_aws_region["name"],
 *     blueprint_identifier=test_aws_datazone_environment_blueprint_configuration["environmentBlueprintId"],
 *     profile_identifier=test_aws_datazone_environment_profile["id"],
 *     project_identifier=test_aws_datazone_project["id"],
 *     domain_identifier=test_aws_datazone_domain["id"],
 *     user_parameters=[
 *         {
 *             "name": "consumerGlueDbName",
 *             "value": "consumer",
 *         },
 *         {
 *             "name": "producerGlueDbName",
 *             "value": "producer",
 *         },
 *         {
 *             "name": "workgroupName",
 *             "value": "workgroup",
 *         },
 *     ])
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Aws = Pulumi.Aws;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Aws.DataZone.Environment("example", new()
 *     {
 *         Name = "example",
 *         AccountIdentifier = test.AccountId,
 *         AccountRegion = testAwsRegion.Name,
 *         BlueprintIdentifier = testAwsDatazoneEnvironmentBlueprintConfiguration.EnvironmentBlueprintId,
 *         ProfileIdentifier = testAwsDatazoneEnvironmentProfile.Id,
 *         ProjectIdentifier = testAwsDatazoneProject.Id,
 *         DomainIdentifier = testAwsDatazoneDomain.Id,
 *         UserParameters = new[]
 *         {
 *             new Aws.DataZone.Inputs.EnvironmentUserParameterArgs
 *             {
 *                 Name = "consumerGlueDbName",
 *                 Value = "consumer",
 *             },
 *             new Aws.DataZone.Inputs.EnvironmentUserParameterArgs
 *             {
 *                 Name = "producerGlueDbName",
 *                 Value = "producer",
 *             },
 *             new Aws.DataZone.Inputs.EnvironmentUserParameterArgs
 *             {
 *                 Name = "workgroupName",
 *                 Value = "workgroup",
 *             },
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datazone"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := datazone.NewEnvironment(ctx, "example", &datazone.EnvironmentArgs{
 * 			Name:                pulumi.String("example"),
 * 			AccountIdentifier:   pulumi.Any(test.AccountId),
 * 			AccountRegion:       pulumi.Any(testAwsRegion.Name),
 * 			BlueprintIdentifier: pulumi.Any(testAwsDatazoneEnvironmentBlueprintConfiguration.EnvironmentBlueprintId),
 * 			ProfileIdentifier:   pulumi.Any(testAwsDatazoneEnvironmentProfile.Id),
 * 			ProjectIdentifier:   pulumi.Any(testAwsDatazoneProject.Id),
 * 			DomainIdentifier:    pulumi.Any(testAwsDatazoneDomain.Id),
 * 			UserParameters: datazone.EnvironmentUserParameterArray{
 * 				&datazone.EnvironmentUserParameterArgs{
 * 					Name:  pulumi.String("consumerGlueDbName"),
 * 					Value: pulumi.String("consumer"),
 * 				},
 * 				&datazone.EnvironmentUserParameterArgs{
 * 					Name:  pulumi.String("producerGlueDbName"),
 * 					Value: pulumi.String("producer"),
 * 				},
 * 				&datazone.EnvironmentUserParameterArgs{
 * 					Name:  pulumi.String("workgroupName"),
 * 					Value: pulumi.String("workgroup"),
 * 				},
 * 			},
 * 		})
 * 		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.aws.datazone.Environment;
 * import com.pulumi.aws.datazone.EnvironmentArgs;
 * import com.pulumi.aws.datazone.inputs.EnvironmentUserParameterArgs;
 * 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 Environment("example", EnvironmentArgs.builder()
 *             .name("example")
 *             .accountIdentifier(test.accountId())
 *             .accountRegion(testAwsRegion.name())
 *             .blueprintIdentifier(testAwsDatazoneEnvironmentBlueprintConfiguration.environmentBlueprintId())
 *             .profileIdentifier(testAwsDatazoneEnvironmentProfile.id())
 *             .projectIdentifier(testAwsDatazoneProject.id())
 *             .domainIdentifier(testAwsDatazoneDomain.id())
 *             .userParameters(
 *                 EnvironmentUserParameterArgs.builder()
 *                     .name("consumerGlueDbName")
 *                     .value("consumer")
 *                     .build(),
 *                 EnvironmentUserParameterArgs.builder()
 *                     .name("producerGlueDbName")
 *                     .value("producer")
 *                     .build(),
 *                 EnvironmentUserParameterArgs.builder()
 *                     .name("workgroupName")
 *                     .value("workgroup")
 *                     .build())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: aws:datazone:Environment
 *     properties:
 *       name: example
 *       accountIdentifier: ${test.accountId}
 *       accountRegion: ${testAwsRegion.name}
 *       blueprintIdentifier: ${testAwsDatazoneEnvironmentBlueprintConfiguration.environmentBlueprintId}
 *       profileIdentifier: ${testAwsDatazoneEnvironmentProfile.id}
 *       projectIdentifier: ${testAwsDatazoneProject.id}
 *       domainIdentifier: ${testAwsDatazoneDomain.id}
 *       userParameters:
 *         - name: consumerGlueDbName
 *           value: consumer
 *         - name: producerGlueDbName
 *           value: producer
 *         - name: workgroupName
 *           value: workgroup
 * ```
 * 
 * ## Import
 * Using `pulumi import`, import DataZone Environment using the `domain_idntifier,id`. For example:
 * ```sh
 * $ pulumi import aws:datazone/environment:Environment example dzd_d2i7tzk3tnjjf4,5vpywijpwryec0
 * ```
 */
public class Environment internal constructor(
    override val javaResource: com.pulumi.aws.datazone.Environment,
) : KotlinCustomResource(javaResource, EnvironmentMapper) {
    /**
     * The ID of the Amazon Web Services account where the environment exists
     */
    public val accountIdentifier: Output
        get() = javaResource.accountIdentifier().applyValue({ args0 -> args0 })

    /**
     * The Amazon Web Services region where the environment exists.
     */
    public val accountRegion: Output
        get() = javaResource.accountRegion().applyValue({ args0 -> args0 })

    /**
     * The blueprint with which the environment is created.
     */
    public val blueprintIdentifier: Output
        get() = javaResource.blueprintIdentifier().applyValue({ args0 -> args0 })

    /**
     * The time the environment was created.
     */
    public val createdAt: Output
        get() = javaResource.createdAt().applyValue({ args0 -> args0 })

    /**
     * The user who created the environment.
     */
    public val createdBy: Output
        get() = javaResource.createdBy().applyValue({ args0 -> args0 })

    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The ID of the domain where the environment exists.
     */
    public val domainIdentifier: Output
        get() = javaResource.domainIdentifier().applyValue({ args0 -> args0 })

    /**
     * The business glossary terms that can be used in this environment.
     */
    public val glossaryTerms: Output>?
        get() = javaResource.glossaryTerms().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 -> args0 })
            }).orElse(null)
        })

    /**
     * The details of the last deployment of the environment.
     */
    public val lastDeployments: Output>
        get() = javaResource.lastDeployments().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 -> environmentLastDeploymentToKotlin(args0) })
            })
        })

    /**
     * The name of the environment.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The ID of the profile with which the environment is created.
     */
    public val profileIdentifier: Output
        get() = javaResource.profileIdentifier().applyValue({ args0 -> args0 })

    /**
     * The ID of the project where the environment exists.
     * The following arguments are optional:
     */
    public val projectIdentifier: Output
        get() = javaResource.projectIdentifier().applyValue({ args0 -> args0 })

    /**
     * The provider of the environment.
     */
    public val providerEnvironment: Output
        get() = javaResource.providerEnvironment().applyValue({ args0 -> args0 })

    public val provisionedResources: Output>
        get() = javaResource.provisionedResources().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 -> environmentProvisionedResourceToKotlin(args0) })
            })
        })

    public val timeouts: Output?
        get() = javaResource.timeouts().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    environmentTimeoutsToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * The user parameters that are used in the environment. See User Parameters for more information.
     */
    public val userParameters: Output>?
        get() = javaResource.userParameters().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 ->
                        environmentUserParameterToKotlin(args0)
                    })
                })
            }).orElse(null)
        })
}

public object EnvironmentMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.aws.datazone.Environment::class == javaResource::class

    override fun map(javaResource: Resource): Environment = Environment(
        javaResource as
            com.pulumi.aws.datazone.Environment,
    )
}

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

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