environment_profiles

Creates, updates, deletes or gets an environment_profile resource or lists environment_profiles in a region

Overview

Name	environment_profiles
Type	Resource
Description	AWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.
Id	awscc.datazone.environment_profiles

Fields

get (all properties)

Name	Datatype	Description
aws_account_id	string	The AWS account in which the Amazon DataZone environment is created.
aws_account_region	string	The AWS region in which this environment profile is created.
created_at	string	The timestamp of when this environment profile was created.
created_by	string	The Amazon DataZone user who created this environment profile.
description	string	The description of this Amazon DataZone environment profile.
domain_id	string	The ID of the Amazon DataZone domain in which this environment profile is created.
domain_identifier	string	The ID of the Amazon DataZone domain in which this environment profile is created.
environment_blueprint_id	string	The ID of the blueprint with which this environment profile is created.
environment_blueprint_identifier	string	The ID of the blueprint with which this environment profile is created.
id	string	The ID of this Amazon DataZone environment profile.
name	string	The name of this Amazon DataZone environment profile.
project_id	string	The identifier of the project in which to create the environment profile.
project_identifier	string	The identifier of the project in which to create the environment profile.
updated_at	string	The timestamp of when this environment profile was updated.
▶user_parameters	array	The user parameters of this Amazon DataZone environment profile.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
domain_id	string	The ID of the Amazon DataZone domain in which this environment profile is created.
id	string	The ID of this Amazon DataZone environment profile.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	environment_profiles	INSERT	EnvironmentBlueprintIdentifier, ProjectIdentifier, DomainIdentifier, AwsAccountId, AwsAccountRegion, Name, region
delete_resource	environment_profiles	DELETE	Identifier, region
update_resource	environment_profiles	UPDATE	Identifier, PatchDocument, region
list_resources	environment_profiles_list_only	SELECT	region
get_resource	environment_profiles	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual environment_profile.

SELECT
  region,
  aws_account_id,
  aws_account_region,
  created_at,
  created_by,
  description,
  domain_id,
  domain_identifier,
  environment_blueprint_id,
  environment_blueprint_identifier,
  id,
  name,
  project_id,
  project_identifier,
  updated_at,
  user_parameters
FROM awscc.datazone.environment_profiles
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_id }}|{{ id }}';

list (identifiers only)

Lists all environment_profiles in a region.

SELECT
  region,
  domain_id,
  id
FROM awscc.datazone.environment_profiles_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.datazone.environment_profiles (
  AwsAccountId,
  AwsAccountRegion,
  DomainIdentifier,
  EnvironmentBlueprintIdentifier,
  Name,
  ProjectIdentifier,
  region
)
SELECT
  '{{ aws_account_id }}',
  '{{ aws_account_region }}',
  '{{ domain_identifier }}',
  '{{ environment_blueprint_identifier }}',
  '{{ name }}',
  '{{ project_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.datazone.environment_profiles (
  AwsAccountId,
  AwsAccountRegion,
  Description,
  DomainIdentifier,
  EnvironmentBlueprintIdentifier,
  Name,
  ProjectIdentifier,
  UserParameters,
  region
)
SELECT
  '{{ aws_account_id }}',
  '{{ aws_account_region }}',
  '{{ description }}',
  '{{ domain_identifier }}',
  '{{ environment_blueprint_identifier }}',
  '{{ name }}',
  '{{ project_identifier }}',
  '{{ user_parameters }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: environment_profile
  props:
    - name: aws_account_id
      value: '{{ aws_account_id }}'
    - name: aws_account_region
      value: '{{ aws_account_region }}'
    - name: description
      value: '{{ description }}'
    - name: domain_identifier
      value: '{{ domain_identifier }}'
    - name: environment_blueprint_identifier
      value: '{{ environment_blueprint_identifier }}'
    - name: name
      value: '{{ name }}'
    - name: project_identifier
      value: '{{ project_identifier }}'
    - name: user_parameters
      value:
        - name: '{{ name }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.datazone.environment_profiles
SET PatchDocument = string('{{ {
    "AwsAccountId": aws_account_id,
    "AwsAccountRegion": aws_account_region,
    "Description": description,
    "Name": name,
    "UserParameters": user_parameters
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_id }}|{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.datazone.environment_profiles
WHERE
  Identifier = '{{ domain_id }}|{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

datazone:CreateEnvironmentProfile,
datazone:GetEnvironmentProfile

Read

datazone:GetEnvironmentProfile

Update

datazone:UpdateEnvironmentProfile,
datazone:GetEnvironmentProfile

Delete

datazone:DeleteEnvironmentProfile,
datazone:GetEnvironmentProfile

List

datazone:ListEnvironmentProfiles