Package software.amazon.awscdk.services.datazone

Class CfnEnvironment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.datazone.CfnEnvironment
All Implemented Interfaces:
IInspectable, IEnvironmentRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:10.877Z") @Stability(Stable) public class CfnEnvironment extends CfnResource implements IInspectable, IEnvironmentRef
The AWS::DataZone::Environment resource specifies an Amazon DataZone environment, which is a collection of zero or more configured resources with a given set of IAM principals who can operate on those resources.

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.*;
 CfnEnvironment cfnEnvironment = CfnEnvironment.Builder.create(this, "MyCfnEnvironment")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEnvironment

      protected CfnEnvironment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEnvironment

      protected CfnEnvironment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEnvironment

      @Stability(Stable) public CfnEnvironment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEnvironmentProps props)
      Create a new AWS::DataZone::Environment.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForEnvironment

      @Stability(Stable) @NotNull public static String arnForEnvironment(@NotNull IEnvironmentRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnEnvironment

      @Stability(Stable) @NotNull public static Boolean isCfnEnvironment(@NotNull Object x)
      Checks whether the given object is a CfnEnvironment.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAwsAccountId

      @Stability(Stable) @NotNull public String getAttrAwsAccountId()
      The identifier of the AWS account in which an environment exists.

    • getAttrAwsAccountRegion

      @Stability(Stable) @NotNull public String getAttrAwsAccountRegion()
      The AWS Region in which an environment exists.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp of when the environment was created.

    • getAttrCreatedBy

      @Stability(Stable) @NotNull public String getAttrCreatedBy()
      The Amazon DataZone user who created the environment.

    • getAttrDomainId

      @Stability(Stable) @NotNull public String getAttrDomainId()
      The identifier of the Amazon DataZone domain in which the environment exists.

    • getAttrEnvironmentBlueprintId

      @Stability(Stable) @NotNull public String getAttrEnvironmentBlueprintId()
      The identifier of a blueprint with which an environment profile is created.

    • getAttrEnvironmentProfileId

      @Stability(Stable) @NotNull public String getAttrEnvironmentProfileId()
      The identifier of the environment profile with which the environment was created.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The identifier of the environment.

    • getAttrProjectId

      @Stability(Stable) @NotNull public String getAttrProjectId()
      The identifier of the project in which the environment exists.

    • getAttrProvider

      @Stability(Stable) @NotNull public String getAttrProvider()
      The provider of the environment.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the environment.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The timestamp of when the environment was updated.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEnvironmentRef

      @Stability(Stable) @NotNull public EnvironmentReference getEnvironmentRef()
      A reference to a Environment resource.
      Specified by:
      getEnvironmentRef in interface IEnvironmentRef

    • getDomainIdentifier

      @Stability(Stable) @NotNull public String getDomainIdentifier()
      The identifier of the Amazon DataZone domain in which the environment is created.

    • setDomainIdentifier

      @Stability(Stable) public void setDomainIdentifier(@NotNull String value)
      The identifier of the Amazon DataZone domain in which the environment is created.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the Amazon DataZone environment.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the Amazon DataZone environment.

    • getProjectIdentifier

      @Stability(Stable) @NotNull public String getProjectIdentifier()
      The identifier of the Amazon DataZone project in which this environment is created.

    • setProjectIdentifier

      @Stability(Stable) public void setProjectIdentifier(@NotNull String value)
      The identifier of the Amazon DataZone project in which this environment is created.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the environment.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the environment.

    • getEnvironmentAccountIdentifier

      @Stability(Stable) @Nullable public String getEnvironmentAccountIdentifier()
      The identifier of the AWS account in which an environment exists.

    • setEnvironmentAccountIdentifier

      @Stability(Stable) public void setEnvironmentAccountIdentifier(@Nullable String value)
      The identifier of the AWS account in which an environment exists.

    • getEnvironmentAccountRegion

      @Stability(Stable) @Nullable public String getEnvironmentAccountRegion()
      The AWS Region in which an environment exists.

    • setEnvironmentAccountRegion

      @Stability(Stable) public void setEnvironmentAccountRegion(@Nullable String value)
      The AWS Region in which an environment exists.

    • getEnvironmentProfileIdentifier

      @Stability(Stable) @Nullable public String getEnvironmentProfileIdentifier()
      The identifier of the environment profile that is used to create this Amazon DataZone environment.

    • setEnvironmentProfileIdentifier

      @Stability(Stable) public void setEnvironmentProfileIdentifier(@Nullable String value)
      The identifier of the environment profile that is used to create this Amazon DataZone environment.

    • getEnvironmentRoleArn

      @Stability(Stable) @Nullable public String getEnvironmentRoleArn()
      The ARN of the environment role.

    • setEnvironmentRoleArn

      @Stability(Stable) public void setEnvironmentRoleArn(@Nullable String value)
      The ARN of the environment role.

    • getGlossaryTerms

      @Stability(Stable) @Nullable public List<String> getGlossaryTerms()
      The glossary terms that can be used in this Amazon DataZone environment.

    • setGlossaryTerms

      @Stability(Stable) public void setGlossaryTerms(@Nullable List<String> value)
      The glossary terms that can be used in this Amazon DataZone environment.

    • getUserParameters

      @Stability(Stable) @Nullable public Object getUserParameters()
      The user parameters of this Amazon DataZone environment.

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

    • setUserParameters

      @Stability(Stable) public void setUserParameters(@Nullable IResolvable value)
      The user parameters of this Amazon DataZone environment.

    • setUserParameters

      @Stability(Stable) public void setUserParameters(@Nullable List<Object> value)
      The user parameters of this Amazon DataZone environment.