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

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
domain_name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	domain_names	INSERT	DomainName, CertificateArn, region
delete_resource	domain_names	DELETE	Identifier, region
update_resource	domain_names	UPDATE	Identifier, PatchDocument, region
list_resources	domain_names_list_only	SELECT	region
get_resource	domain_names	SELECT	Identifier, region

SELECT examples

get (all properties)

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
  Identifier = '{{ domain_name }}';

list (identifiers only)

Lists all domain_names in a region.

SELECT
  region,
  domain_name
FROM awscc.appsync.domain_names_list_only
WHERE
  region = 'us-east-1';

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
  '{{ domain_name }}',
  '{{ certificate_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.appsync.domain_names (
  DomainName,
  Description,
  CertificateArn,
  Tags,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ description }}',
  '{{ certificate_arn }}',
  '{{ 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: domain_name
        value: '{{ domain_name }}'
      - name: description
        value: '{{ description }}'
      - name: certificate_arn
        value: '{{ certificate_arn }}'
      - name: tags
        value:
          - value: '{{ value }}'
            key: '{{ key }}'

UPDATE example

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

/*+ update */
UPDATE awscc.appsync.domain_names
SET PatchDocument = string('{{ {
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.appsync.domain_names
WHERE
  Identifier = '{{ domain_name }}' 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