domains

Creates, updates, deletes or gets a domain resource or lists domains in a region

Overview

Name	domains
Type	Resource
Description	A domain is an organizing entity for connecting together assets, users, and their projects
Id	awscc.datazone.domains

Fields

get (all properties)

Name	Datatype	Description
root_domain_unit_id	string	The ID of the root domain in Amazon Datazone.
arn	string	The ARN of the Amazon DataZone domain.
created_at	string	The timestamp of when the Amazon DataZone domain was last updated.
description	string	The description of the Amazon DataZone domain.
domain_execution_role	string	The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
service_role	string	The service role of the domain that is created.
domain_version	string	The version of the domain.
id	string	The id of the Amazon DataZone domain.
kms_key_identifier	string	The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
last_updated_at	string	The timestamp of when the Amazon DataZone domain was last updated.
managed_account_id	string	The identifier of the AWS account that manages the domain.
name	string	The name of the Amazon DataZone domain.
portal_url	string	The URL of the data portal for this Amazon DataZone domain.
▶single_sign_on	object	The single-sign on configuration of the Amazon DataZone domain.
status	string	The status of the Amazon DataZone domain.
▶tags	array	The tags specified for the Amazon DataZone domain.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	The id of the Amazon DataZone domain.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	domains	INSERT	DomainExecutionRole, Name, region
delete_resource	domains	DELETE	Identifier, region
update_resource	domains	UPDATE	Identifier, PatchDocument, region
list_resources	domains_list_only	SELECT	region
get_resource	domains	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual domain.

SELECT
  region,
  root_domain_unit_id,
  arn,
  created_at,
  description,
  domain_execution_role,
  service_role,
  domain_version,
  id,
  kms_key_identifier,
  last_updated_at,
  managed_account_id,
  name,
  portal_url,
  single_sign_on,
  status,
  tags
FROM awscc.datazone.domains
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all domains in a region.

SELECT
  region,
  id
FROM awscc.datazone.domains_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.datazone.domains (
  DomainExecutionRole,
  Name,
  region
)
SELECT
  '{{ domain_execution_role }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.datazone.domains (
  Description,
  DomainExecutionRole,
  ServiceRole,
  DomainVersion,
  KmsKeyIdentifier,
  Name,
  SingleSignOn,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ domain_execution_role }}',
  '{{ service_role }}',
  '{{ domain_version }}',
  '{{ kms_key_identifier }}',
  '{{ name }}',
  '{{ single_sign_on }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: domain
    props:
      - name: description
        value: '{{ description }}'
      - name: domain_execution_role
        value: '{{ domain_execution_role }}'
      - name: service_role
        value: '{{ service_role }}'
      - name: domain_version
        value: '{{ domain_version }}'
      - name: kms_key_identifier
        value: '{{ kms_key_identifier }}'
      - name: name
        value: '{{ name }}'
      - name: single_sign_on
        value:
          type: '{{ type }}'
          user_assignment: '{{ user_assignment }}'
          idc_instance_arn: '{{ idc_instance_arn }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.datazone.domains
SET PatchDocument = string('{{ {
    "Description": description,
    "DomainExecutionRole": domain_execution_role,
    "ServiceRole": service_role,
    "Name": name,
    "SingleSignOn": single_sign_on,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.datazone.domains
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions

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

Create

datazone:CreateDomain,
datazone:UpdateDomain,
datazone:GetDomain,
datazone:TagResource,
sso:CreateManagedApplicationInstance,
sso:DeleteManagedApplicationInstance,
sso:PutApplicationAssignmentConfiguration,
sso:ListInstances,
sso:PutApplicationAccessScope,
sso:PutApplicationGrant,
sso:PutApplicationAuthenticationMethod,
sso:PutApplicationAccessScope,
sso:CreateApplication,
sso:DeleteApplication,
sso:CreateApplicationAssignment,
sso:DeleteApplicationAssignment,
iam:PassRole

Read

datazone:GetDomain

Update

datazone:UpdateDomain,
datazone:GetDomain,
datazone:TagResource,
datazone:UntagResource,
sso:CreateManagedApplicationInstance,
sso:DeleteManagedApplicationInstance,
sso:PutApplicationAssignmentConfiguration,
sso:ListInstances,
sso:PutApplicationAccessScope,
iam:PassRole

Delete

datazone:DeleteDomain,
datazone:GetDomain,
sso:DeleteManagedApplicationInstance,
sso:PutApplicationAssignmentConfiguration,
sso:DeleteApplication,
sso:DeleteApplicationAssignment,
sso:ListInstances

List

datazone:ListDomains