domain_names

Creates, updates, deletes, gets or lists a domain_names resource.

Overview

Name	domain_names
Type	Resource
Id	aws.appsync.domain_names

Fields

The following fields are returned by SELECT queries:

get_domain_name

Name	Datatype	Description
appsync_domain_name	string	The domain name that AppSync provides.
certificate_arn	string	The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. (pattern: <code>^arn:[a-z-]:(acm|iam):[a-z0-9-]:\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$</code>)
description	string	A description of the DomainName configuration. (pattern: <code>^.*$</code>)
domain_name	string	The domain name. (pattern: <code>^(*[\w\d-]*.)?([\w\d-]+.)+[\w\d-]+$</code>)
domain_name_arn	string	The Amazon Resource Name (ARN) of the domain name.
hosted_zone_id	string	The ID of your Amazon Route 53 hosted zone.
tags	object

list_domain_names

Name	Datatype	Description
appsync_domain_name	string	The domain name that AppSync provides.
certificate_arn	string	The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. (pattern: <code>^arn:[a-z-]:(acm|iam):[a-z0-9-]:\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$</code>)
description	string	A description of the DomainName configuration. (pattern: <code>^.*$</code>)
domain_name	string	The domain name. (pattern: <code>^(*[\w\d-]*.)?([\w\d-]+.)+[\w\d-]+$</code>)
domain_name_arn	string	The Amazon Resource Name (ARN) of the domain name.
hosted_zone_id	string	The ID of your Amazon Route 53 hosted zone.
tags	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_domain_name	select	domain_name, region		Retrieves a custom DomainName object.
list_domain_names	select	region	nextToken, maxResults	Lists multiple custom domain names.
create_domain_name	insert	region, domainName, certificateArn		Creates a custom DomainName object.
update_domain_name	update	domain_name, region		Updates a custom DomainName object.
delete_domain_name	delete	domain_name, region		Deletes a custom DomainName object.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name	string	The domain name.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that you want the request to return.
nextToken	string	An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

SELECT examples

get_domain_name

Retrieves a custom DomainName object.

SELECT
appsync_domain_name,
certificate_arn,
description,
domain_name,
domain_name_arn,
hosted_zone_id,
tags
FROM aws.appsync.domain_names
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
;

list_domain_names

Lists multiple custom domain names.

SELECT
appsync_domain_name,
certificate_arn,
description,
domain_name,
domain_name_arn,
hosted_zone_id,
tags
FROM aws.appsync.domain_names
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_domain_name

Creates a custom DomainName object.

INSERT INTO aws.appsync.domain_names (
domainName,
certificateArn,
description,
tags,
region
)
SELECT 
'{{ domainName }}' /* required */,
'{{ certificateArn }}' /* required */,
'{{ description }}',
'{{ tags }}',
'{{ region }}'
RETURNING
domain_name_config
;

Manifest

# Description fields are for documentation purposes
- name: domain_names
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the domain_names resource.
  - name: domainName
    value: "{{ domainName }}"
  - name: certificateArn
    value: "{{ certificateArn }}"
  - name: description
    value: "{{ description }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      A map with keys of TagKey objects and values of TagValue objects.

UPDATE examples

update_domain_name

Updates a custom DomainName object.

UPDATE aws.appsync.domain_names
SET 
description = '{{ description }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --required
RETURNING
domain_name_config;

DELETE examples

delete_domain_name

Deletes a custom DomainName object.

DELETE FROM aws.appsync.domain_names
WHERE domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --required
;