Package software.amazon.awscdk.services.datazone

Interface CfnProjectProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProjectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:29.432Z")
@Stability(Stable)
public interface CfnProjectProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnProject.

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.*;
 CfnProjectProps cfnProjectProps = CfnProjectProps.builder()
         .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:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnProjectProps.Builder	builder()
default String	getDescription()	The description of a project.
String	getDomainIdentifier()	The identifier of a Amazon DataZone domain where the project exists.
default String	getDomainUnitId()	The ID of the domain unit.
default List<String>	getGlossaryTerms()	The glossary terms that can be used in this Amazon DataZone project.
String	getName()	The name of a project.
default String	getProjectProfileId()	The ID of the project profile.
default String	getProjectProfileVersion()	The project profile version to which the project should be updated.
default Object	getUserParameters()	The user parameters of the project.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainIdentifier

@Stability(Stable)
@NotNull
String getDomainIdentifier()

The identifier of a Amazon DataZone domain where the project exists.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of a project.

See Also:

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

getDescription

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

The description of a project.

See Also:

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

getDomainUnitId

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

The ID of the domain unit.

This parameter is not required and if it is not specified, then the project is created at the root domain unit level.

See Also:

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

getGlossaryTerms

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

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

See Also:

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

getProjectProfileId

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

The ID of the project profile.

See Also:

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

getProjectProfileVersion

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

The project profile version to which the project should be updated.

You can only specify the following string for this parameter: latest .

See Also:

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

getUserParameters

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

The user parameters of the project.

See Also:

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

builder

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

Returns:

a CfnProjectProps.Builder of CfnProjectProps