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	aws.voiceid.domains

Fields

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, ServerSideEncryptionConfiguration, 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 domains in a region.

SELECT
region,
description,
domain_id,
name,
server_side_encryption_configuration,
tags
FROM aws.voiceid.domains
WHERE region = 'us-east-1';

Gets all properties from an individual domain.

SELECT
region,
description,
domain_id,
name,
server_side_encryption_configuration,
tags
FROM aws.voiceid.domains
WHERE region = 'us-east-1' AND data__Identifier = '<DomainId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.voiceid.domains (
 Name,
 ServerSideEncryptionConfiguration,
 region
)
SELECT 
'{{ Name }}',
 '{{ ServerSideEncryptionConfiguration }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.voiceid.domains (
 Description,
 Name,
 ServerSideEncryptionConfiguration,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Name }}',
 '{{ ServerSideEncryptionConfiguration }}',
 '{{ 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: ServerSideEncryptionConfiguration
        value:
          KmsKeyId: '{{ KmsKeyId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.voiceid.domains
WHERE data__Identifier = '<DomainId>'
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