environment_blueprint_configurations

Creates, updates, deletes or gets an environment_blueprint_configuration resource or lists environment_blueprint_configurations in a region

Overview

Name	environment_blueprint_configurations
Type	Resource
Description	Definition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type
Id	awscc.datazone.environment_blueprint_configurations

Fields

get (all properties)

Name	Datatype	Description
created_at	string
enabled_regions	array
environment_blueprint_identifier	string
environment_blueprint_id	string
updated_at	string
▶regional_parameters	array
provisioning_role_arn	string
domain_id	string
provisioning_configurations	array
domain_identifier	string
environment_role_permission_boundary	string
manage_access_role_arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
environment_blueprint_id	string
domain_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	environment_blueprint_configurations	INSERT	DomainIdentifier, EnvironmentBlueprintIdentifier, EnabledRegions, region
delete_resource	environment_blueprint_configurations	DELETE	Identifier, region
update_resource	environment_blueprint_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	environment_blueprint_configurations_list_only	SELECT	region
get_resource	environment_blueprint_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual environment_blueprint_configuration.

SELECT
  region,
  created_at,
  enabled_regions,
  environment_blueprint_identifier,
  environment_blueprint_id,
  updated_at,
  regional_parameters,
  provisioning_role_arn,
  domain_id,
  provisioning_configurations,
  domain_identifier,
  environment_role_permission_boundary,
  manage_access_role_arn
FROM awscc.datazone.environment_blueprint_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_id }}|{{ environment_blueprint_id }}';

list (identifiers only)

Lists all environment_blueprint_configurations in a region.

SELECT
  region,
  domain_id,
  environment_blueprint_id
FROM awscc.datazone.environment_blueprint_configurations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.datazone.environment_blueprint_configurations (
  EnabledRegions,
  EnvironmentBlueprintIdentifier,
  DomainIdentifier,
  region
)
SELECT
  '{{ enabled_regions }}',
  '{{ environment_blueprint_identifier }}',
  '{{ domain_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.datazone.environment_blueprint_configurations (
  EnabledRegions,
  EnvironmentBlueprintIdentifier,
  RegionalParameters,
  ProvisioningRoleArn,
  ProvisioningConfigurations,
  DomainIdentifier,
  EnvironmentRolePermissionBoundary,
  ManageAccessRoleArn,
  region
)
SELECT
  '{{ enabled_regions }}',
  '{{ environment_blueprint_identifier }}',
  '{{ regional_parameters }}',
  '{{ provisioning_role_arn }}',
  '{{ provisioning_configurations }}',
  '{{ domain_identifier }}',
  '{{ environment_role_permission_boundary }}',
  '{{ manage_access_role_arn }}',
  '{{ 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_blueprint_configuration
  props:
    - name: enabled_regions
      value:
        - '{{ enabled_regions[0] }}'
    - name: environment_blueprint_identifier
      value: '{{ environment_blueprint_identifier }}'
    - name: regional_parameters
      value:
        - parameters: {}
          region: '{{ region }}'
    - name: provisioning_role_arn
      value: '{{ provisioning_role_arn }}'
    - name: provisioning_configurations
      value:
        - null
    - name: domain_identifier
      value: '{{ domain_identifier }}'
    - name: environment_role_permission_boundary
      value: '{{ environment_role_permission_boundary }}'
    - name: manage_access_role_arn
      value: '{{ manage_access_role_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.datazone.environment_blueprint_configurations
SET PatchDocument = string('{{ {
    "EnabledRegions": enabled_regions,
    "RegionalParameters": regional_parameters,
    "ProvisioningRoleArn": provisioning_role_arn,
    "ProvisioningConfigurations": provisioning_configurations,
    "EnvironmentRolePermissionBoundary": environment_role_permission_boundary,
    "ManageAccessRoleArn": manage_access_role_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_id }}|{{ environment_blueprint_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.datazone.environment_blueprint_configurations
WHERE
  Identifier = '{{ domain_id }}|{{ environment_blueprint_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_blueprint_configurations resource, the following permissions are required:

Read

datazone:GetEnvironmentBlueprintConfiguration

Create

datazone:ListEnvironmentBlueprints,
iam:PassRole,
datazone:GetEnvironmentBlueprintConfiguration,
datazone:PutEnvironmentBlueprintConfiguration

Update

datazone:DeleteEnvironmentBlueprintConfiguration,
iam:PassRole,
datazone:GetEnvironmentBlueprintConfiguration,
datazone:PutEnvironmentBlueprintConfiguration

List

datazone:ListEnvironmentBlueprintConfigurations

Delete

datazone:GetEnvironmentBlueprintConfiguration,
datazone:DeleteEnvironmentBlueprintConfiguration