projects

Creates, updates, deletes or gets a project resource or lists projects in a region

Overview

Name	projects
Type	Resource
Description	Amazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.
Id	awscc.datazone.projects

Fields

get (all properties)

Name	Datatype	Description
created_at	string	The timestamp of when the project was created.
created_by	string	The Amazon DataZone user who created the project.
description	string	The description of the Amazon DataZone project.
domain_id	string	The identifier of the Amazon DataZone domain in which the project was created.
domain_identifier	string	The ID of the Amazon DataZone domain in which this project is created.
domain_unit_id	string	The ID of the domain unit.
glossary_terms	array	The glossary terms that can be used in this Amazon DataZone project.
id	string	The ID of the Amazon DataZone project.
last_updated_at	string	The timestamp of when the project was last updated.
name	string	The name of the Amazon DataZone project.
project_profile_id	string	The project profile ID.
project_profile_version	string	The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.
project_status	string	The status of the project.
▶user_parameters	array	The user parameters of the project.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
domain_id	string	The identifier of the Amazon DataZone domain in which the project was created.
id	string	The ID of the Amazon DataZone project.
region	string	AWS region.

For more information, see AWS::DataZone::Project.

Methods

Name	Resource	Accessible by	Required Params
create_resource	projects	INSERT	DomainIdentifier, Name, region
delete_resource	projects	DELETE	Identifier, region
update_resource	projects	UPDATE	Identifier, PatchDocument, region
list_resources	projects_list_only	SELECT	region
get_resource	projects	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual project.

SELECT
  region,
  created_at,
  created_by,
  description,
  domain_id,
  domain_identifier,
  domain_unit_id,
  glossary_terms,
  id,
  last_updated_at,
  name,
  project_profile_id,
  project_profile_version,
  project_status,
  user_parameters
FROM awscc.datazone.projects
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ domain_id }}|{{ id }}';

list (identifiers only)

Lists all projects in a region.

SELECT
  region,
  domain_id,
  id
FROM awscc.datazone.projects_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new project resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.datazone.projects (
  DomainIdentifier,
  Name,
  region
)
SELECT
  '{{ domain_identifier }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.datazone.projects (
  Description,
  DomainIdentifier,
  DomainUnitId,
  GlossaryTerms,
  Name,
  ProjectProfileId,
  ProjectProfileVersion,
  UserParameters,
  region
)
SELECT
  '{{ description }}',
  '{{ domain_identifier }}',
  '{{ domain_unit_id }}',
  '{{ glossary_terms }}',
  '{{ name }}',
  '{{ project_profile_id }}',
  '{{ project_profile_version }}',
  '{{ user_parameters }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: project
    props:
      - name: description
        value: '{{ description }}'
      - name: domain_identifier
        value: '{{ domain_identifier }}'
      - name: domain_unit_id
        value: '{{ domain_unit_id }}'
      - name: glossary_terms
        value:
          - '{{ glossary_terms[0] }}'
      - name: name
        value: '{{ name }}'
      - name: project_profile_id
        value: '{{ project_profile_id }}'
      - name: project_profile_version
        value: '{{ project_profile_version }}'
      - name: user_parameters
        value:
          - environment_id: '{{ environment_id }}'
            environment_configuration_name: '{{ environment_configuration_name }}'
            environment_parameters:
              - name: '{{ name }}'
                value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a project resource, using stack-deploy.

/*+ update */
UPDATE awscc.datazone.projects
SET PatchDocument = string('{{ {
    "Description": description,
    "DomainUnitId": domain_unit_id,
    "GlossaryTerms": glossary_terms,
    "Name": name,
    "ProjectProfileVersion": project_profile_version,
    "UserParameters": user_parameters
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_id }}|{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.datazone.projects
WHERE
  Identifier = '{{ domain_id }}|{{ id }}' AND
  region = 'us-east-1';

Permissions

To operate on the projects resource, the following permissions are required:

Create

datazone:CreateProject,
datazone:GetProject

Read

datazone:GetProject

Update

datazone:UpdateProject,
datazone:GetProject

Delete

datazone:DeleteProject,
datazone:GetProject

List

datazone:ListProjects