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	aws.datazone.environment_blueprint_configurations

Fields

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DomainIdentifier, EnvironmentBlueprintIdentifier, EnabledRegions, 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 environment_blueprint_configurations in a region.

SELECT
region,
regional_parameters,
provisioning_role_arn,
domain_id,
created_at,
enabled_regions,
environment_blueprint_identifier,
environment_blueprint_id,
updated_at,
domain_identifier,
manage_access_role_arn
FROM aws.datazone.environment_blueprint_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual environment_blueprint_configuration.

SELECT
region,
regional_parameters,
provisioning_role_arn,
domain_id,
created_at,
enabled_regions,
environment_blueprint_identifier,
environment_blueprint_id,
updated_at,
domain_identifier,
manage_access_role_arn
FROM aws.datazone.environment_blueprint_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<DomainId>|<EnvironmentBlueprintId>';

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 aws.datazone.environment_blueprint_configurations (
 EnabledRegions,
 EnvironmentBlueprintIdentifier,
 DomainIdentifier,
 region
)
SELECT 
'{{ EnabledRegions }}',
 '{{ EnvironmentBlueprintIdentifier }}',
 '{{ DomainIdentifier }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.datazone.environment_blueprint_configurations (
 RegionalParameters,
 ProvisioningRoleArn,
 EnabledRegions,
 EnvironmentBlueprintIdentifier,
 DomainIdentifier,
 ManageAccessRoleArn,
 region
)
SELECT 
 '{{ RegionalParameters }}',
 '{{ ProvisioningRoleArn }}',
 '{{ EnabledRegions }}',
 '{{ EnvironmentBlueprintIdentifier }}',
 '{{ DomainIdentifier }}',
 '{{ ManageAccessRoleArn }}',
 '{{ region }}';

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: RegionalParameters
        value:
          - Parameters: {}
            Region: '{{ Region }}'
      - name: ProvisioningRoleArn
        value: '{{ ProvisioningRoleArn }}'
      - name: EnabledRegions
        value:
          - '{{ EnabledRegions[0] }}'
      - name: EnvironmentBlueprintIdentifier
        value: '{{ EnvironmentBlueprintIdentifier }}'
      - name: DomainIdentifier
        value: '{{ DomainIdentifier }}'
      - name: ManageAccessRoleArn
        value: '{{ ManageAccessRoleArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.datazone.environment_blueprint_configurations
WHERE data__Identifier = '<DomainId|EnvironmentBlueprintId>'
AND region = 'us-east-1';

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