Environment class

Resource for managing an AWS DataZone Environment.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.datazone.Environment("example", {
    userParameters: [
        {
            name: "consumerGlueDbName",
            value: "consumer",
        },
        {
            name: "producerGlueDbName",
            value: "producer",
        },
        {
            name: "workgroupName",
            value: "workgroup",
        },
    ],
    name: "example",
    blueprintIdentifier: test.environmentBlueprintId,
    profileIdentifier: testAwsDatazoneEnvironmentProfile.id,
    projectIdentifier: testAwsDatazoneProject.id,
    domainIdentifier: testAwsDatazoneDomain.id,
});
import pulumi
import pulumi_aws as aws

example = aws.datazone.Environment("example",
    user_parameters=[
        {
            "name": "consumerGlueDbName",
            "value": "consumer",
        },
        {
            "name": "producerGlueDbName",
            "value": "producer",
        },
        {
            "name": "workgroupName",
            "value": "workgroup",
        },
    ],
    name="example",
    blueprint_identifier=test["environmentBlueprintId"],
    profile_identifier=test_aws_datazone_environment_profile["id"],
    project_identifier=test_aws_datazone_project["id"],
    domain_identifier=test_aws_datazone_domain["id"])
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()
    {
        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",
            },
        },
        Name = "example",
        BlueprintIdentifier = test.EnvironmentBlueprintId,
        ProfileIdentifier = testAwsDatazoneEnvironmentProfile.Id,
        ProjectIdentifier = testAwsDatazoneProject.Id,
        DomainIdentifier = testAwsDatazoneDomain.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			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"),
				},
			},
			Name:                pulumi.String("example"),
			BlueprintIdentifier: pulumi.Any(test.EnvironmentBlueprintId),
			ProfileIdentifier:   pulumi.Any(testAwsDatazoneEnvironmentProfile.Id),
			ProjectIdentifier:   pulumi.Any(testAwsDatazoneProject.Id),
			DomainIdentifier:    pulumi.Any(testAwsDatazoneDomain.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_datazone_environment" "example" {
  user_parameters {
    name  = "consumerGlueDbName"
    value = "consumer"
  }
  user_parameters {
    name  = "producerGlueDbName"
    value = "producer"
  }
  user_parameters {
    name  = "workgroupName"
    value = "workgroup"
  }
  name                 = "example"
  blueprint_identifier = test.environmentBlueprintId
  profile_identifier   = testAwsDatazoneEnvironmentProfile.id
  project_identifier   = testAwsDatazoneProject.id
  domain_identifier    = testAwsDatazoneDomain.id
}
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.ArrayList;
import java.util.Arrays;
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()
            .userParameters(
                EnvironmentUserParameterArgs.builder()
                    .name("consumerGlueDbName")
                    .value("consumer")
                    .build(),
                EnvironmentUserParameterArgs.builder()
                    .name("producerGlueDbName")
                    .value("producer")
                    .build(),
                EnvironmentUserParameterArgs.builder()
                    .name("workgroupName")
                    .value("workgroup")
                    .build())
            .name("example")
            .blueprintIdentifier(test.environmentBlueprintId())
            .profileIdentifier(testAwsDatazoneEnvironmentProfile.id())
            .projectIdentifier(testAwsDatazoneProject.id())
            .domainIdentifier(testAwsDatazoneDomain.id())
            .build());

    }
}
resources:
  example:
    type: aws:datazone:Environment
    properties:
      userParameters:
        - name: consumerGlueDbName
          value: consumer
        - name: producerGlueDbName
          value: producer
        - name: workgroupName
          value: workgroup
      name: example
      blueprintIdentifier: ${test.environmentBlueprintId}
      profileIdentifier: ${testAwsDatazoneEnvironmentProfile.id}
      projectIdentifier: ${testAwsDatazoneProject.id}
      domainIdentifier: ${testAwsDatazoneDomain.id}

Import

Identity Schema

Required

  • domainIdentifier - (String) Identifier of the DataZone domain.
  • id - (String) ID of the environment.

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import DataZone Environment using the domain_idntifier,id. For example:

$ pulumi import aws:datazone/environment:Environment example dzd_d2i7tzk3tnjjf4,5vpywijpwryec0

Constructors

Environment(String name, {EnvironmentArgs? args, CustomResourceOptions? options})
Creates a new Environment. name The Pulumi resource name. args Arguments used to configure this Environment. The set of arguments for Environment. options Resource options controlling this resource's behavior.
Environment.reference(String urn)
Creates a typed reference to an existing Environment resource.

Properties

accountIdentifier ↔ Output<String>
The ID of the Amazon Web Services account where the environment exists
latefinal
accountRegion ↔ Output<String>
The Amazon Web Services region where the environment exists.
latefinal
blueprintIdentifier ↔ Output<String>
The blueprint with which the environment is created.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdAt ↔ Output<String>
The time the environment was created.
latefinal
createdBy ↔ Output<String>
The user who created the environment.
latefinal
description ↔ Output<String?>
The description of the environment.
latefinal
domainIdentifier ↔ Output<String>
The ID of the domain where the environment exists.
latefinal
glossaryTerms ↔ Output<List<String>?>
The business glossary terms that can be used in this environment.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
lastDeployments ↔ Output<List<EnvironmentLastDeployment>>
The details of the last deployment of the environment.
latefinal
name ↔ Output<String>
The name of the environment.
latefinal
profileIdentifier ↔ Output<String>
The ID of the profile with which the environment is created.
latefinal
projectIdentifier ↔ Output<String>
The ID of the project where the environment exists.
latefinal
providerEnvironment ↔ Output<String>
The provider of the environment.
latefinal
provisionedResources ↔ Output<List<EnvironmentProvisionedResource>>
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timeouts ↔ Output<EnvironmentTimeouts?>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
userParameters ↔ Output<List<EnvironmentUserParameter>?>
The user parameters that are used in the environment. See User Parameters for more information. Changing these values recreates the resource.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {EnvironmentState? state, CustomResourceOptions? options}) → Environment
Gets an existing Environment resource's state with the given name and id.