Package software.amazon.awscdk.services.datazone

Class CfnProject

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.CfnProject
All Implemented Interfaces:
IInspectable, IProjectRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:08.132Z") @Stability(Stable) public class CfnProject extends CfnResource implements IInspectable, IProjectRef
The AWS::DataZone::Project resource specifies an Amazon DataZone project.

Projects enable a group of users to collaborate on various business use cases that involve publishing, discovering, subscribing to, and consuming data in the Amazon DataZone catalog. Project members consume assets from the Amazon DataZone catalog and produce new assets using one or more analytical workflows.

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.*;
 CfnProject cfnProject = CfnProject.Builder.create(this, "MyCfnProject")
         .domainIdentifier("domainIdentifier")
         .name("name")
         // the properties below are optional
         .description("description")
         .domainUnitId("domainUnitId")
         .glossaryTerms(List.of("glossaryTerms"))
         .projectProfileId("projectProfileId")
         .projectProfileVersion("projectProfileVersion")
         .userParameters(List.of(EnvironmentConfigurationUserParameterProperty.builder()
                 .environmentConfigurationName("environmentConfigurationName")
                 .environmentId("environmentId")
                 .environmentParameters(List.of(EnvironmentParameterProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .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

    • CfnProject

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

    • CfnProject

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

    • CfnProject

      @Stability(Stable) public CfnProject(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnProjectProps props)
      Create a new AWS::DataZone::Project.

      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

    • isCfnProject

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

      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.

    • getAttrCreatedAt

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

    • getAttrCreatedBy

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

    • getAttrDomainId

      @Stability(Stable) @NotNull public String getAttrDomainId()
      The identifier of a Amazon DataZone domain where the project exists.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The identifier of a project.

    • getAttrLastUpdatedAt

      @Stability(Stable) @NotNull public String getAttrLastUpdatedAt()
      The timestamp of when the project was last updated.

    • getAttrProjectStatus

      @Stability(Stable) @NotNull public String getAttrProjectStatus()
      The status of the project.

    • getCfnProperties

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

    • getProjectRef

      @Stability(Stable) @NotNull public ProjectReference getProjectRef()
      A reference to a Project resource.
      Specified by:
      getProjectRef in interface IProjectRef

    • getDomainIdentifier

      @Stability(Stable) @NotNull public String getDomainIdentifier()
      The identifier of a Amazon DataZone domain where the project exists.

    • setDomainIdentifier

      @Stability(Stable) public void setDomainIdentifier(@NotNull String value)
      The identifier of a Amazon DataZone domain where the project exists.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of a project.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of a project.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of a project.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of a project.

    • getDomainUnitId

      @Stability(Stable) @Nullable public String getDomainUnitId()
      The ID of the domain unit.

    • setDomainUnitId

      @Stability(Stable) public void setDomainUnitId(@Nullable String value)
      The ID of the domain unit.

    • getGlossaryTerms

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

    • setGlossaryTerms

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

    • getProjectProfileId

      @Stability(Stable) @Nullable public String getProjectProfileId()
      The ID of the project profile.

    • setProjectProfileId

      @Stability(Stable) public void setProjectProfileId(@Nullable String value)
      The ID of the project profile.

    • getProjectProfileVersion

      @Stability(Stable) @Nullable public String getProjectProfileVersion()
      The project profile version to which the project should be updated.

    • setProjectProfileVersion

      @Stability(Stable) public void setProjectProfileVersion(@Nullable String value)
      The project profile version to which the project should be updated.

    • getUserParameters

      @Stability(Stable) @Nullable public Object getUserParameters()
      The user parameters of the project.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProject.EnvironmentConfigurationUserParameterProperty>

    • setUserParameters

      @Stability(Stable) public void setUserParameters(@Nullable IResolvable value)
      The user parameters of the project.

    • setUserParameters

      @Stability(Stable) public void setUserParameters(@Nullable List<Object> value)
      The user parameters of the project.