project_profiles

Creates, updates, deletes, gets or lists a project_profiles resource.

Overview

Name	project_profiles
Type	Resource
Id	aws.datazone.project_profiles

Fields

The following fields are returned by SELECT queries:

get_project_profile

Name	Datatype	Description
id	string	The ID of the project profile. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
name	string	The name of the project profile. (pattern: <code>[\w -]+</code>)
allow_custom_project_resource_tags	boolean	Specifies whether custom project resource tags are supported.
created_at	string (date-time)	The timestamp of when the project profile was created.
created_by	string	The user who created the project profile.
description	string	The description of the project profile.
domain_id	string	The ID of the domain of the project profile. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
domain_unit_id	string	The ID of the domain unit of the project profile. (pattern: <code>[a-z0-9_-]+</code>)
environment_configurations	array	The environment configurations of the project profile.
last_updated_at	string (date-time)	The timestamp of when project profile was last updated.
project_resource_tags	array	The resource tags of the project profile.
project_resource_tags_description	string	Field viewable through the UI that provides a project user with the allowed resource tag specifications.
status	string	The status of the project profile. (ENABLED, DISABLED)

list_project_profiles

Name	Datatype	Description
id	string	The ID of the project profile. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
name	string	The name of a project profile. (pattern: <code>[\w -]+</code>)
created_at	string (date-time)	The timestamp of when the project profile was created.
created_by	string	The user who created the project profile.
description	string	The description of the project profile.
domain_id	string	The domain ID of the project profile. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
domain_unit_id	string	The domain unit ID of the project profile. (pattern: <code>[a-z0-9_-]+</code>)
last_updated_at	string (date-time)	The timestamp at which a project profile was last updated.
status	string	The status of a project profile. (ENABLED, DISABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_project_profile	select	domain_identifier, identifier, region		The details of the project profile.
list_project_profiles	select	domain_identifier, region	name, sortBy, sortOrder, nextToken, maxResults	Lists project profiles.
create_project_profile	insert	domain_identifier, region, name		Creates a project profile.
update_project_profile	update	domain_identifier, identifier, region		Updates a project profile.
delete_project_profile	delete	domain_identifier, identifier, region		Deletes a project profile.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_identifier	string	The ID of the domain where a project profile is deleted.
identifier	string	The ID of the project profile that is deleted.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of project profiles to return in a single call to ListProjectProfiles. When the number of project profiles to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjectProfiles to list the next set of project profiles.
name	string	The name of a project profile.
nextToken	string	When the number of project profiles is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles.
sortBy	string	Specifies by what to sort project profiles.
sortOrder	string	Specifies the sort order of the project profiles.

SELECT examples

get_project_profile

The details of the project profile.

SELECT
id,
name,
allow_custom_project_resource_tags,
created_at,
created_by,
description,
domain_id,
domain_unit_id,
environment_configurations,
last_updated_at,
project_resource_tags,
project_resource_tags_description,
status
FROM aws.datazone.project_profiles
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_project_profiles

Lists project profiles.

SELECT
id,
name,
created_at,
created_by,
description,
domain_id,
domain_unit_id,
last_updated_at,
status
FROM aws.datazone.project_profiles
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
AND name = '{{ name }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_project_profile

Creates a project profile.

INSERT INTO aws.datazone.project_profiles (
name,
description,
status,
projectResourceTags,
allowCustomProjectResourceTags,
projectResourceTagsDescription,
environmentConfigurations,
domainUnitIdentifier,
domain_identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ status }}',
'{{ projectResourceTags }}',
{{ allowCustomProjectResourceTags }},
'{{ projectResourceTagsDescription }}',
'{{ environmentConfigurations }}',
'{{ domainUnitIdentifier }}',
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
id,
name,
allow_custom_project_resource_tags,
created_at,
created_by,
description,
domain_id,
domain_unit_id,
environment_configurations,
last_updated_at,
project_resource_tags,
project_resource_tags_description,
status
;

Manifest

# Description fields are for documentation purposes
- name: project_profiles
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the project_profiles resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the project_profiles resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: status
    value: "{{ status }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: projectResourceTags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
        isValueEditable: {{ isValueEditable }}
  - name: allowCustomProjectResourceTags
    value: {{ allowCustomProjectResourceTags }}
  - name: projectResourceTagsDescription
    value: "{{ projectResourceTagsDescription }}"
  - name: environmentConfigurations
    value:
      - name: "{{ name }}"
        id: "{{ id }}"
        environmentBlueprintId: "{{ environmentBlueprintId }}"
        description: "{{ description }}"
        deploymentMode: "{{ deploymentMode }}"
        configurationParameters:
          ssmPath: "{{ ssmPath }}"
          parameterOverrides:
            - name: "{{ name }}"
              value: "{{ value }}"
              isEditable: {{ isEditable }}
          resolvedParameters:
            - name: "{{ name }}"
              value: "{{ value }}"
              isEditable: {{ isEditable }}
        awsAccount:
          awsAccountId: "{{ awsAccountId }}"
          awsAccountIdPath: "{{ awsAccountIdPath }}"
        accountPools: "{{ accountPools }}"
        awsRegion:
          regionName: "{{ regionName }}"
          regionNamePath: "{{ regionNamePath }}"
        deploymentOrder: {{ deploymentOrder }}
  - name: domainUnitIdentifier
    value: "{{ domainUnitIdentifier }}"

UPDATE examples

update_project_profile

Updates a project profile.

UPDATE aws.datazone.project_profiles
SET 
name = '{{ name }}',
description = '{{ description }}',
status = '{{ status }}',
projectResourceTags = '{{ projectResourceTags }}',
allowCustomProjectResourceTags = {{ allowCustomProjectResourceTags }},
projectResourceTagsDescription = '{{ projectResourceTagsDescription }}',
environmentConfigurations = '{{ environmentConfigurations }}',
domainUnitIdentifier = '{{ domainUnitIdentifier }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
allow_custom_project_resource_tags,
created_at,
created_by,
description,
domain_id,
domain_unit_id,
environment_configurations,
last_updated_at,
project_resource_tags,
project_resource_tags_description,
status;

DELETE examples

delete_project_profile

Deletes a project profile.

DELETE FROM aws.datazone.project_profiles
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;