project_profiles

Creates, updates, deletes or gets a project_profile resource or lists project_profiles in a region

Overview

Name	project_profiles
Type	Resource
Description	Definition of AWS::DataZone::ProjectProfile Resource Type
Id	awscc.datazone.project_profiles

Fields

get (all properties)

Name	Datatype	Description
created_at	string
created_by	string
description	string
domain_id	string
domain_identifier	string
domain_unit_id	string
domain_unit_identifier	string
▶environment_configurations	array
id	string
identifier	string
last_updated_at	string
name	string
status	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
domain_id	string
domain_identifier	string
id	string
identifier	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	project_profiles	INSERT	Name, region
delete_resource	project_profiles	DELETE	Identifier, region
update_resource	project_profiles	UPDATE	Identifier, PatchDocument, region
list_resources	project_profiles_list_only	SELECT	region
get_resource	project_profiles	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual project_profile.

SELECT
  region,
  created_at,
  created_by,
  description,
  domain_id,
  domain_identifier,
  domain_unit_id,
  domain_unit_identifier,
  environment_configurations,
  id,
  identifier,
  last_updated_at,
  name,
  status
FROM awscc.datazone.project_profiles
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ domain_identifier }}|{{ identifier }}';

list (identifiers only)

Lists all project_profiles in a region.

SELECT
  region,
  domain_identifier,
  identifier
FROM awscc.datazone.project_profiles_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.datazone.project_profiles (
  Description,
  DomainIdentifier,
  DomainUnitIdentifier,
  EnvironmentConfigurations,
  Name,
  Status,
  region
)
SELECT
  '{{ description }}',
  '{{ domain_identifier }}',
  '{{ domain_unit_identifier }}',
  '{{ environment_configurations }}',
  '{{ name }}',
  '{{ status }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: project_profile
    props:
      - name: description
        value: '{{ description }}'
      - name: domain_identifier
        value: '{{ domain_identifier }}'
      - name: domain_unit_identifier
        value: '{{ domain_unit_identifier }}'
      - name: environment_configurations
        value:
          - name: '{{ name }}'
            id: '{{ id }}'
            environment_blueprint_id: '{{ environment_blueprint_id }}'
            description: '{{ description }}'
            deployment_mode: '{{ deployment_mode }}'
            configuration_parameters:
              ssm_path: '{{ ssm_path }}'
              parameter_overrides:
                - name: '{{ name }}'
                  value: '{{ value }}'
                  is_editable: '{{ is_editable }}'
              resolved_parameters:
                - null
            aws_account:
              aws_account_id: '{{ aws_account_id }}'
            aws_region:
              region_name: '{{ region_name }}'
            deployment_order: null
      - name: name
        value: '{{ name }}'
      - name: status
        value: '{{ status }}'

UPDATE example

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

/*+ update */
UPDATE awscc.datazone.project_profiles
SET PatchDocument = string('{{ {
    "Description": description,
    "DomainUnitIdentifier": domain_unit_identifier,
    "Name": name,
    "Status": status
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_identifier }}|{{ identifier }}';

DELETE example

/*+ delete */
DELETE FROM awscc.datazone.project_profiles
WHERE
  Identifier = '{{ domain_identifier }}|{{ identifier }}' AND
  region = 'us-east-1';

Permissions

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

Create

datazone:CreateProjectProfile,
datazone:GetProjectProfile,
ssm:GetParameter

Read

datazone:GetProjectProfile,
ssm:GetParameter

Update

datazone:UpdateProjectProfile,
datazone:GetProjectProfile,
ssm:GetParameter

Delete

datazone:DeleteProjectProfile,
datazone:GetProjectProfile

List

datazone:ListProjectProfiles