domains

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

Overview

Name	domains
Type	Resource
Description	The AWS::VoiceID::Domain resource specifies an Amazon VoiceID Domain.
Id	awscc.voiceid.domains

Fields

get (all properties)

Name	Datatype	Description
description	string
domain_id	string
name	string
▶server_side_encryption_configuration	object
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
domain_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	domains	INSERT	Name, ServerSideEncryptionConfiguration, 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,
  description,
  domain_id,
  name,
  server_side_encryption_configuration,
  tags
FROM awscc.voiceid.domains
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ domain_id }}';

list (identifiers only)

Lists all domains in a region.

SELECT
  region,
  domain_id
FROM awscc.voiceid.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.voiceid.domains (
  Name,
  ServerSideEncryptionConfiguration,
  region
)
SELECT
  '{{ name }}',
  '{{ server_side_encryption_configuration }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.voiceid.domains (
  Description,
  Name,
  ServerSideEncryptionConfiguration,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ server_side_encryption_configuration }}',
  '{{ 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: name
        value: '{{ name }}'
      - name: server_side_encryption_configuration
        value:
          kms_key_id: '{{ kms_key_id }}'
      - 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.voiceid.domains
SET PatchDocument = string('{{ {
    "Description": description,
    "Name": name,
    "ServerSideEncryptionConfiguration": server_side_encryption_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_id }}';

DELETE example

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

Permissions

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

Create

voiceid:CreateDomain,
voiceid:DescribeDomain,
voiceid:TagResource,
voiceid:ListTagsForResource,
kms:CreateGrant,
kms:DescribeKey,
kms:Decrypt

Read

voiceid:DescribeDomain,
voiceid:ListTagsForResource,
kms:Decrypt

Update

voiceid:DescribeDomain,
voiceid:UpdateDomain,
voiceid:TagResource,
voiceid:UntagResource,
voiceid:ListTagsForResource,
kms:CreateGrant,
kms:Decrypt,
kms:DescribeKey

Delete

voiceid:DeleteDomain,
voiceid:DescribeDomain,
kms:Decrypt

List

voiceid:ListDomains,
kms:Decrypt