Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. datazone
  5. EnvironmentBlueprintConfiguration
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.datazone.EnvironmentBlueprintConfiguration

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Resource for managing an AWS DataZone Environment Blueprint Configuration.

Example Usage

Basic Usage

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

const example = new aws.datazone.Domain("example", {
    name: "example_domain",
    domainExecutionRole: domainExecutionRole.arn,
});
const defaultDataLake = aws.datazone.getEnvironmentBlueprintOutput({
    domainId: example.id,
    name: "DefaultDataLake",
    managed: true,
});
const exampleEnvironmentBlueprintConfiguration = new aws.datazone.EnvironmentBlueprintConfiguration("example", {
    domainId: example.id,
    environmentBlueprintId: defaultDataLake.apply(defaultDataLake => defaultDataLake.id),
    enabledRegions: ["us-east-1"],
    regionalParameters: {
        "us-east-1": {
            s3Location: "s3://my-amazon-datazone-bucket",
        },
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.datazone.Domain("example",
    name="example_domain",
    domain_execution_role=domain_execution_role["arn"])
default_data_lake = aws.datazone.get_environment_blueprint_output(domain_id=example.id,
    name="DefaultDataLake",
    managed=True)
example_environment_blueprint_configuration = aws.datazone.EnvironmentBlueprintConfiguration("example",
    domain_id=example.id,
    environment_blueprint_id=default_data_lake.id,
    enabled_regions=["us-east-1"],
    regional_parameters={
        "us-east-1": {
            "s3Location": "s3://my-amazon-datazone-bucket",
        },
    })
Copy
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 {
		example, err := datazone.NewDomain(ctx, "example", &datazone.DomainArgs{
			Name:                pulumi.String("example_domain"),
			DomainExecutionRole: pulumi.Any(domainExecutionRole.Arn),
		})
		if err != nil {
			return err
		}
		defaultDataLake := datazone.GetEnvironmentBlueprintOutput(ctx, datazone.GetEnvironmentBlueprintOutputArgs{
			DomainId: example.ID(),
			Name:     pulumi.String("DefaultDataLake"),
			Managed:  pulumi.Bool(true),
		}, nil)
		_, err = datazone.NewEnvironmentBlueprintConfiguration(ctx, "example", &datazone.EnvironmentBlueprintConfigurationArgs{
			DomainId: example.ID(),
			EnvironmentBlueprintId: pulumi.String(defaultDataLake.ApplyT(func(defaultDataLake datazone.GetEnvironmentBlueprintResult) (*string, error) {
				return &defaultDataLake.Id, nil
			}).(pulumi.StringPtrOutput)),
			EnabledRegions: pulumi.StringArray{
				pulumi.String("us-east-1"),
			},
			RegionalParameters: pulumi.StringMapMap{
				"us-east-1": pulumi.StringMap{
					"s3Location": pulumi.String("s3://my-amazon-datazone-bucket"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DataZone.Domain("example", new()
    {
        Name = "example_domain",
        DomainExecutionRole = domainExecutionRole.Arn,
    });

    var defaultDataLake = Aws.DataZone.GetEnvironmentBlueprint.Invoke(new()
    {
        DomainId = example.Id,
        Name = "DefaultDataLake",
        Managed = true,
    });

    var exampleEnvironmentBlueprintConfiguration = new Aws.DataZone.EnvironmentBlueprintConfiguration("example", new()
    {
        DomainId = example.Id,
        EnvironmentBlueprintId = defaultDataLake.Apply(getEnvironmentBlueprintResult => getEnvironmentBlueprintResult.Id),
        EnabledRegions = new[]
        {
            "us-east-1",
        },
        RegionalParameters = 
        {
            { "us-east-1", 
            {
                { "s3Location", "s3://my-amazon-datazone-bucket" },
            } },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datazone.Domain;
import com.pulumi.aws.datazone.DomainArgs;
import com.pulumi.aws.datazone.DatazoneFunctions;
import com.pulumi.aws.datazone.inputs.GetEnvironmentBlueprintArgs;
import com.pulumi.aws.datazone.EnvironmentBlueprintConfiguration;
import com.pulumi.aws.datazone.EnvironmentBlueprintConfigurationArgs;
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 Domain("example", DomainArgs.builder()
            .name("example_domain")
            .domainExecutionRole(domainExecutionRole.arn())
            .build());

        final var defaultDataLake = DatazoneFunctions.getEnvironmentBlueprint(GetEnvironmentBlueprintArgs.builder()
            .domainId(example.id())
            .name("DefaultDataLake")
            .managed(true)
            .build());

        var exampleEnvironmentBlueprintConfiguration = new EnvironmentBlueprintConfiguration("exampleEnvironmentBlueprintConfiguration", EnvironmentBlueprintConfigurationArgs.builder()
            .domainId(example.id())
            .environmentBlueprintId(defaultDataLake.applyValue(_defaultDataLake -> _defaultDataLake.id()))
            .enabledRegions("us-east-1")
            .regionalParameters(Map.of("us-east-1", Map.of("s3Location", "s3://my-amazon-datazone-bucket")))
            .build());

    }
}
Copy
resources:
  example:
    type: aws:datazone:Domain
    properties:
      name: example_domain
      domainExecutionRole: ${domainExecutionRole.arn}
  exampleEnvironmentBlueprintConfiguration:
    type: aws:datazone:EnvironmentBlueprintConfiguration
    name: example
    properties:
      domainId: ${example.id}
      environmentBlueprintId: ${defaultDataLake.id}
      enabledRegions:
        - us-east-1
      regionalParameters:
        us-east-1:
          s3Location: s3://my-amazon-datazone-bucket
variables:
  defaultDataLake:
    fn::invoke:
      function: aws:datazone:getEnvironmentBlueprint
      arguments:
        domainId: ${example.id}
        name: DefaultDataLake
        managed: true
Copy

Create EnvironmentBlueprintConfiguration Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EnvironmentBlueprintConfiguration(name: string, args: EnvironmentBlueprintConfigurationArgs, opts?: CustomResourceOptions);
@overload
def EnvironmentBlueprintConfiguration(resource_name: str,
                                      args: EnvironmentBlueprintConfigurationArgs,
                                      opts: Optional[ResourceOptions] = None)

@overload
def EnvironmentBlueprintConfiguration(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      domain_id: Optional[str] = None,
                                      enabled_regions: Optional[Sequence[str]] = None,
                                      environment_blueprint_id: Optional[str] = None,
                                      manage_access_role_arn: Optional[str] = None,
                                      provisioning_role_arn: Optional[str] = None,
                                      regional_parameters: Optional[Mapping[str, Mapping[str, str]]] = None)
func NewEnvironmentBlueprintConfiguration(ctx *Context, name string, args EnvironmentBlueprintConfigurationArgs, opts ...ResourceOption) (*EnvironmentBlueprintConfiguration, error)
public EnvironmentBlueprintConfiguration(string name, EnvironmentBlueprintConfigurationArgs args, CustomResourceOptions? opts = null)
public EnvironmentBlueprintConfiguration(String name, EnvironmentBlueprintConfigurationArgs args)
public EnvironmentBlueprintConfiguration(String name, EnvironmentBlueprintConfigurationArgs args, CustomResourceOptions options)

type: aws:datazone:EnvironmentBlueprintConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentBlueprintConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EnvironmentBlueprintConfigurationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentBlueprintConfigurationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentBlueprintConfigurationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EnvironmentBlueprintConfigurationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var environmentBlueprintConfigurationResource = new Aws.DataZone.EnvironmentBlueprintConfiguration("environmentBlueprintConfigurationResource", new()
{
    DomainId = "string",
    EnabledRegions = new[]
    {
        "string",
    },
    EnvironmentBlueprintId = "string",
    ManageAccessRoleArn = "string",
    ProvisioningRoleArn = "string",
    RegionalParameters = 
    {
        { "string", 
        {
            { "string", "string" },
        } },
    },
});
Copy
example, err := datazone.NewEnvironmentBlueprintConfiguration(ctx, "environmentBlueprintConfigurationResource", &datazone.EnvironmentBlueprintConfigurationArgs{
	DomainId: pulumi.String("string"),
	EnabledRegions: pulumi.StringArray{
		pulumi.String("string"),
	},
	EnvironmentBlueprintId: pulumi.String("string"),
	ManageAccessRoleArn:    pulumi.String("string"),
	ProvisioningRoleArn:    pulumi.String("string"),
	RegionalParameters: pulumi.StringMapMap{
		"string": pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
})
Copy
var environmentBlueprintConfigurationResource = new EnvironmentBlueprintConfiguration("environmentBlueprintConfigurationResource", EnvironmentBlueprintConfigurationArgs.builder()
    .domainId("string")
    .enabledRegions("string")
    .environmentBlueprintId("string")
    .manageAccessRoleArn("string")
    .provisioningRoleArn("string")
    .regionalParameters(Map.of("string", Map.of("string", "string")))
    .build());
Copy
environment_blueprint_configuration_resource = aws.datazone.EnvironmentBlueprintConfiguration("environmentBlueprintConfigurationResource",
    domain_id="string",
    enabled_regions=["string"],
    environment_blueprint_id="string",
    manage_access_role_arn="string",
    provisioning_role_arn="string",
    regional_parameters={
        "string": {
            "string": "string",
        },
    })
Copy
const environmentBlueprintConfigurationResource = new aws.datazone.EnvironmentBlueprintConfiguration("environmentBlueprintConfigurationResource", {
    domainId: "string",
    enabledRegions: ["string"],
    environmentBlueprintId: "string",
    manageAccessRoleArn: "string",
    provisioningRoleArn: "string",
    regionalParameters: {
        string: {
            string: "string",
        },
    },
});
Copy
type: aws:datazone:EnvironmentBlueprintConfiguration
properties:
    domainId: string
    enabledRegions:
        - string
    environmentBlueprintId: string
    manageAccessRoleArn: string
    provisioningRoleArn: string
    regionalParameters:
        string:
            string: string
Copy

EnvironmentBlueprintConfiguration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EnvironmentBlueprintConfiguration resource accepts the following input properties:

DomainId This property is required. string
ID of the Domain.
EnabledRegions This property is required. List<string>

Regions in which the blueprint is enabled

The following arguments are optional:

EnvironmentBlueprintId This property is required. string
ID of the Environment Blueprint
ManageAccessRoleArn string
ARN of the manage access role with which this blueprint is created.
ProvisioningRoleArn string
ARN of the provisioning role with which this blueprint is created.
RegionalParameters Dictionary<string, ImmutableDictionary<string, string>>
Parameters for each region in which the blueprint is enabled
DomainId This property is required. string
ID of the Domain.
EnabledRegions This property is required. []string

Regions in which the blueprint is enabled

The following arguments are optional:

EnvironmentBlueprintId This property is required. string
ID of the Environment Blueprint
ManageAccessRoleArn string
ARN of the manage access role with which this blueprint is created.
ProvisioningRoleArn string
ARN of the provisioning role with which this blueprint is created.
RegionalParameters map[string]map[string]string
Parameters for each region in which the blueprint is enabled
domainId This property is required. String
ID of the Domain.
enabledRegions This property is required. List<String>

Regions in which the blueprint is enabled

The following arguments are optional:

environmentBlueprintId This property is required. String
ID of the Environment Blueprint
manageAccessRoleArn String
ARN of the manage access role with which this blueprint is created.
provisioningRoleArn String
ARN of the provisioning role with which this blueprint is created.
regionalParameters Map<String,Map<String,String>>
Parameters for each region in which the blueprint is enabled
domainId This property is required. string
ID of the Domain.
enabledRegions This property is required. string[]

Regions in which the blueprint is enabled

The following arguments are optional:

environmentBlueprintId This property is required. string
ID of the Environment Blueprint
manageAccessRoleArn string
ARN of the manage access role with which this blueprint is created.
provisioningRoleArn string
ARN of the provisioning role with which this blueprint is created.
regionalParameters {[key: string]: {[key: string]: string}}
Parameters for each region in which the blueprint is enabled
domain_id This property is required. str
ID of the Domain.
enabled_regions This property is required. Sequence[str]

Regions in which the blueprint is enabled

The following arguments are optional:

environment_blueprint_id This property is required. str
ID of the Environment Blueprint
manage_access_role_arn str
ARN of the manage access role with which this blueprint is created.
provisioning_role_arn str
ARN of the provisioning role with which this blueprint is created.
regional_parameters Mapping[str, Mapping[str, str]]
Parameters for each region in which the blueprint is enabled
domainId This property is required. String
ID of the Domain.
enabledRegions This property is required. List<String>

Regions in which the blueprint is enabled

The following arguments are optional:

environmentBlueprintId This property is required. String
ID of the Environment Blueprint
manageAccessRoleArn String
ARN of the manage access role with which this blueprint is created.
provisioningRoleArn String
ARN of the provisioning role with which this blueprint is created.
regionalParameters Map<Map<String>>
Parameters for each region in which the blueprint is enabled

Outputs

All input properties are implicitly available as output properties. Additionally, the EnvironmentBlueprintConfiguration resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing EnvironmentBlueprintConfiguration Resource

Get an existing EnvironmentBlueprintConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EnvironmentBlueprintConfigurationState, opts?: CustomResourceOptions): EnvironmentBlueprintConfiguration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        domain_id: Optional[str] = None,
        enabled_regions: Optional[Sequence[str]] = None,
        environment_blueprint_id: Optional[str] = None,
        manage_access_role_arn: Optional[str] = None,
        provisioning_role_arn: Optional[str] = None,
        regional_parameters: Optional[Mapping[str, Mapping[str, str]]] = None) -> EnvironmentBlueprintConfiguration
func GetEnvironmentBlueprintConfiguration(ctx *Context, name string, id IDInput, state *EnvironmentBlueprintConfigurationState, opts ...ResourceOption) (*EnvironmentBlueprintConfiguration, error)
public static EnvironmentBlueprintConfiguration Get(string name, Input<string> id, EnvironmentBlueprintConfigurationState? state, CustomResourceOptions? opts = null)
public static EnvironmentBlueprintConfiguration get(String name, Output<String> id, EnvironmentBlueprintConfigurationState state, CustomResourceOptions options)
resources:  _:    type: aws:datazone:EnvironmentBlueprintConfiguration    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DomainId string
ID of the Domain.
EnabledRegions List<string>

Regions in which the blueprint is enabled

The following arguments are optional:

EnvironmentBlueprintId string
ID of the Environment Blueprint
ManageAccessRoleArn string
ARN of the manage access role with which this blueprint is created.
ProvisioningRoleArn string
ARN of the provisioning role with which this blueprint is created.
RegionalParameters Dictionary<string, ImmutableDictionary<string, string>>
Parameters for each region in which the blueprint is enabled
DomainId string
ID of the Domain.
EnabledRegions []string

Regions in which the blueprint is enabled

The following arguments are optional:

EnvironmentBlueprintId string
ID of the Environment Blueprint
ManageAccessRoleArn string
ARN of the manage access role with which this blueprint is created.
ProvisioningRoleArn string
ARN of the provisioning role with which this blueprint is created.
RegionalParameters map[string]map[string]string
Parameters for each region in which the blueprint is enabled
domainId String
ID of the Domain.
enabledRegions List<String>

Regions in which the blueprint is enabled

The following arguments are optional:

environmentBlueprintId String
ID of the Environment Blueprint
manageAccessRoleArn String
ARN of the manage access role with which this blueprint is created.
provisioningRoleArn String
ARN of the provisioning role with which this blueprint is created.
regionalParameters Map<String,Map<String,String>>
Parameters for each region in which the blueprint is enabled
domainId string
ID of the Domain.
enabledRegions string[]

Regions in which the blueprint is enabled

The following arguments are optional:

environmentBlueprintId string
ID of the Environment Blueprint
manageAccessRoleArn string
ARN of the manage access role with which this blueprint is created.
provisioningRoleArn string
ARN of the provisioning role with which this blueprint is created.
regionalParameters {[key: string]: {[key: string]: string}}
Parameters for each region in which the blueprint is enabled
domain_id str
ID of the Domain.
enabled_regions Sequence[str]

Regions in which the blueprint is enabled

The following arguments are optional:

environment_blueprint_id str
ID of the Environment Blueprint
manage_access_role_arn str
ARN of the manage access role with which this blueprint is created.
provisioning_role_arn str
ARN of the provisioning role with which this blueprint is created.
regional_parameters Mapping[str, Mapping[str, str]]
Parameters for each region in which the blueprint is enabled
domainId String
ID of the Domain.
enabledRegions List<String>

Regions in which the blueprint is enabled

The following arguments are optional:

environmentBlueprintId String
ID of the Environment Blueprint
manageAccessRoleArn String
ARN of the manage access role with which this blueprint is created.
provisioningRoleArn String
ARN of the provisioning role with which this blueprint is created.
regionalParameters Map<Map<String>>
Parameters for each region in which the blueprint is enabled

Import

Using pulumi import, import DataZone Environment Blueprint Configuration using the domain_id and environment_blueprint_id, separated by a /. For example:

$ pulumi import aws:datazone/environmentBlueprintConfiguration:EnvironmentBlueprintConfiguration example domain-id-12345/environment-blueprint-id-54321
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws