Package software.amazon.awscdk.cfnpropertymixins.services.datazone

Interface CfnEnvironmentMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.949Z")
@Stability(Stable)
public interface CfnEnvironmentMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnEnvironmentPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.datazone.*;
 CfnEnvironmentMixinProps cfnEnvironmentMixinProps = CfnEnvironmentMixinProps.builder()
         .deploymentOrder(123)
         .description("description")
         .domainIdentifier("domainIdentifier")
         .environmentAccountIdentifier("environmentAccountIdentifier")
         .environmentAccountRegion("environmentAccountRegion")
         .environmentBlueprintIdentifier("environmentBlueprintIdentifier")
         .environmentConfigurationId("environmentConfigurationId")
         .environmentProfileIdentifier("environmentProfileIdentifier")
         .environmentRoleArn("environmentRoleArn")
         .glossaryTerms(List.of("glossaryTerms"))
         .name("name")
         .projectIdentifier("projectIdentifier")
         .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	CfnEnvironmentMixinProps.Builder	A builder for CfnEnvironmentMixinProps
static final class	CfnEnvironmentMixinProps.Jsii$Proxy	An implementation for CfnEnvironmentMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnEnvironmentMixinProps.Builder	builder()
default Number	getDeploymentOrder()	The deployment order for the environment.
default String	getDescription()	The description of the environment.
default 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	getEnvironmentBlueprintIdentifier()	The identifier of the environment blueprint.
default String	getEnvironmentConfigurationId()	The identifier of the environment configuration.
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.
default String	getName()	The name of the Amazon DataZone environment.
default 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

getDeploymentOrder

@Stability(Stable)
@Nullable
default Number getDeploymentOrder()

The deployment order for the environment.

See Also:

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

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

getDomainIdentifier

@Stability(Stable)
@Nullable
default 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

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

getEnvironmentBlueprintIdentifier

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

The identifier of the environment blueprint.

See Also:

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

getEnvironmentConfigurationId

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

The identifier of the environment configuration.

See Also:

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

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

getName

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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

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 CfnEnvironmentPropsMixin.EnvironmentParameterProperty>

See Also:

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

builder

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

Returns:

a CfnEnvironmentMixinProps.Builder of CfnEnvironmentMixinProps