domain_names

Creates, updates, deletes or gets a domain_name resource or lists domain_names in a region

Overview

Name	domain_names
Type	Resource
Description	Resource Type definition for AWS::AppSync::DomainName
Id	awscc.appsync.domain_names

Fields

Name	Datatype	Description
domain_name	string
description	string
certificate_arn	string
app_sync_domain_name	string
hosted_zone_id	string
domain_name_arn	string	The Amazon Resource Name (ARN) for the Domain Name.
▶tags	array	An arbitrary set of tags (key-value pairs) for this Domain Name.
region	string	AWS region.

For more information, see AWS::AppSync::DomainName.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DomainName, CertificateArn, 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 properties from an individual domain_name.

SELECT
region,
domain_name,
description,
certificate_arn,
app_sync_domain_name,
hosted_zone_id,
domain_name_arn,
tags
FROM awscc.appsync.domain_names
WHERE region = 'us-east-1' AND data__Identifier = '<DomainName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.appsync.domain_names (
 DomainName,
 CertificateArn,
 region
)
SELECT 
'{{ DomainName }}',
 '{{ CertificateArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.appsync.domain_names (
 DomainName,
 Description,
 CertificateArn,
 Tags,
 region
)
SELECT 
 '{{ DomainName }}',
 '{{ Description }}',
 '{{ CertificateArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: domain_name
    props:
      - name: DomainName
        value: '{{ DomainName }}'
      - name: Description
        value: '{{ Description }}'
      - name: CertificateArn
        value: '{{ CertificateArn }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM awscc.appsync.domain_names
WHERE data__Identifier = '<DomainName>'
AND region = 'us-east-1';

Permissions

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

Create

appsync:CreateDomainName,
appsync:GetDomainName,
acm:DescribeCertificate,
cloudfront:UpdateDistribution,
appsync:TagResource

Delete

appsync:GetDomainName,
appsync:DeleteDomainName,
appsync:UntagResource

Update

appsync:UpdateDomainName,
appsync:TagResource,
appsync:UntagResource,
appsync:GetDomainName

Read

appsync:GetDomainName

List

appsync:ListDomainNames