Package software.amazon.awscdk.services.datazone

Interface CfnEnvironmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:10.901Z")
@Stability(Stable)
public interface CfnEnvironmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEnvironment.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datazone.*;
 CfnEnvironmentProps cfnEnvironmentProps = CfnEnvironmentProps.builder()
         .domainIdentifier("domainIdentifier")
         .name("name")
         .projectIdentifier("projectIdentifier")
         // the properties below are optional
         .description("description")
         .environmentAccountIdentifier("environmentAccountIdentifier")
         .environmentAccountRegion("environmentAccountRegion")
         .environmentProfileIdentifier("environmentProfileIdentifier")
         .environmentRoleArn("environmentRoleArn")
         .glossaryTerms(List.of("glossaryTerms"))
         .userParameters(List.of(EnvironmentParameterProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEnvironmentProps.Builder	A builder for CfnEnvironmentProps
static final class	CfnEnvironmentProps.Jsii$Proxy	An implementation for CfnEnvironmentProps

Method Summary

Modifier and Type	Method	Description
static CfnEnvironmentProps.Builder	builder()
default String	getDescription()	The description of the environment.
String	getDomainIdentifier()	The identifier of the Amazon DataZone domain in which the environment is created.
default String	getEnvironmentAccountIdentifier()	The identifier of the AWS account in which an environment exists.
default String	getEnvironmentAccountRegion()	The AWS Region in which an environment exists.
default String	getEnvironmentProfileIdentifier()	The identifier of the environment profile that is used to create this Amazon DataZone environment.
default String	getEnvironmentRoleArn()	The ARN of the environment role.
default List<String>	getGlossaryTerms()	The glossary terms that can be used in this Amazon DataZone environment.
String	getName()	The name of the Amazon DataZone environment.
String	getProjectIdentifier()	The identifier of the Amazon DataZone project in which this environment is created.
default Object	getUserParameters()	The user parameters of this Amazon DataZone environment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainIdentifier

@Stability(Stable)
@NotNull
String getDomainIdentifier()

The identifier of the Amazon DataZone domain in which the environment is created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-domainidentifier

getName

@Stability(Stable)
@NotNull
String getName()

The name of the Amazon DataZone environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-name

getProjectIdentifier

@Stability(Stable)
@NotNull
String getProjectIdentifier()

The identifier of the Amazon DataZone project in which this environment is created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-projectidentifier

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-description

getEnvironmentAccountIdentifier

@Stability(Stable)
@Nullable
default String getEnvironmentAccountIdentifier()

The identifier of the AWS account in which an environment exists.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentaccountidentifier

getEnvironmentAccountRegion

@Stability(Stable)
@Nullable
default String getEnvironmentAccountRegion()

The AWS Region in which an environment exists.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentaccountregion

getEnvironmentProfileIdentifier

@Stability(Stable)
@Nullable
default String getEnvironmentProfileIdentifier()

The identifier of the environment profile that is used to create this Amazon DataZone environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentprofileidentifier

getEnvironmentRoleArn

@Stability(Stable)
@Nullable
default String getEnvironmentRoleArn()

The ARN of the environment role.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentrolearn

getGlossaryTerms

@Stability(Stable)
@Nullable
default List<String> getGlossaryTerms()

The glossary terms that can be used in this Amazon DataZone environment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-glossaryterms

getUserParameters

@Stability(Stable)
@Nullable
default Object getUserParameters()

The user parameters of this Amazon DataZone environment.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEnvironment.EnvironmentParameterProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-userparameters

builder

@Stability(Stable)
static CfnEnvironmentProps.Builder builder()

Returns:

a CfnEnvironmentProps.Builder of CfnEnvironmentProps