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

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.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

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 data__Identifier = '<DomainIdentifier>|<Identifier>';

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 }}',
 '{{ DomainIdentifier }}',
 '{{ DomainUnitIdentifier }}',
 '{{ EnvironmentConfigurations }}',
 '{{ 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: DomainIdentifier
        value: '{{ DomainIdentifier }}'
      - name: DomainUnitIdentifier
        value: '{{ DomainUnitIdentifier }}'
      - name: EnvironmentConfigurations
        value:
          - Name: '{{ Name }}'
            Id: '{{ Id }}'
            EnvironmentBlueprintId: '{{ EnvironmentBlueprintId }}'
            Description: '{{ Description }}'
            DeploymentMode: '{{ DeploymentMode }}'
            ConfigurationParameters:
              SsmPath: '{{ SsmPath }}'
              ParameterOverrides:
                - Name: '{{ Name }}'
                  Value: '{{ Value }}'
                  IsEditable: '{{ IsEditable }}'
              ResolvedParameters:
                - null
            AwsAccount:
              AwsAccountId: '{{ AwsAccountId }}'
            AwsRegion:
              RegionName: '{{ RegionName }}'
            DeploymentOrder: null
      - name: Name
        value: '{{ Name }}'
      - name: Status
        value: '{{ Status }}'

DELETE example

/*+ delete */
DELETE FROM awscc.datazone.project_profiles
WHERE data__Identifier = '<DomainIdentifier|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