AWS::DataZone::Project - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::DataZone::Project

The AWS::DataZone::Projectresource 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataZone::Project",
  "Properties" : {
      "Description" : String,
      "DomainIdentifier" : String,
      "DomainUnitId" : String,
      "GlossaryTerms" : [ String, ... ],
      "Name" : String,
      "ProjectProfileId" : String,
      "ProjectProfileVersion" : String,
      "UserParameters" : [ EnvironmentConfigurationUserParameter, ... ]
    }
}

YAML

Type: AWS::DataZone::Project
Properties:
  Description: String
  DomainIdentifier: String
  DomainUnitId: String
  GlossaryTerms: 
    - String
  Name: String
  ProjectProfileId: String
  ProjectProfileVersion: String
  UserParameters: 
    - EnvironmentConfigurationUserParameter

Properties

Description

The description of a project.

Required: No

Type: String

Maximum: 2048

Update requires: No interruption

DomainIdentifier

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

Required: Yes

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Update requires: Replacement

DomainUnitId

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.

Required: No

Type: String

Pattern: ^[a-z0-9_\-]+$

Update requires: Replacement

GlossaryTerms

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

Required: No

Type: Array of String

Minimum: 1

Maximum: 20

Update requires: No interruption

Name

The name of a project.

Required: Yes

Type: String

Pattern: ^[\w -]+$

Minimum: 1

Maximum: 64

Update requires: No interruption

ProjectProfileId

The ID of the project profile.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Update requires: Replacement

ProjectProfileVersion

The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.

Required: No

Type: String

Update requires: No interruption

UserParameters

The user parameters of the project.

Required: No

Type: Array of EnvironmentConfigurationUserParameter

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a string containing pipe-separated DomainId and the ProjectId that uniquely identify the project. For example: { "Ref": "MyProject" } for the resource with the logical ID MyProject, Ref returns DomainId|ProjectId.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The timestamp of when a project was created.

CreatedBy

The Amazon DataZone user who created the project.

DomainId

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

Id

The identifier of a project.

LastUpdatedAt

The timestamp of when the project was last updated.

ProjectStatus

The status of the project.