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	The AWS::ApiGateway::DomainName resource specifies a custom domain name for your API in API Gateway. You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide.
Id	awscc.apigateway.domain_names

Fields

get (all properties)

Name	Datatype	Description
domain_name	string
domain_name_arn	string
distribution_domain_name	string
distribution_hosted_zone_id	string
▶endpoint_configuration	object	The EndpointConfiguration property type specifies the endpoint types of a REST API. EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.
▶mutual_tls_authentication	object
regional_domain_name	string
regional_hosted_zone_id	string
certificate_arn	string
regional_certificate_arn	string
ownership_verification_certificate_arn	string	The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
security_policy	string
routing_mode	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
domain_name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	domain_names	INSERT	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,
  domain_name_arn,
  distribution_domain_name,
  distribution_hosted_zone_id,
  endpoint_configuration,
  mutual_tls_authentication,
  regional_domain_name,
  regional_hosted_zone_id,
  certificate_arn,
  regional_certificate_arn,
  ownership_verification_certificate_arn,
  security_policy,
  routing_mode,
  tags
FROM awscc.apigateway.domain_names
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_name }}';

list (identifiers only)

Lists all domain_names in a region.

SELECT
  region,
  domain_name
FROM awscc.apigateway.domain_names_list_only
WHERE
  region = '{{ region }}';

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.apigateway.domain_names (
  DomainName,
  EndpointConfiguration,
  MutualTlsAuthentication,
  CertificateArn,
  RegionalCertificateArn,
  OwnershipVerificationCertificateArn,
  SecurityPolicy,
  RoutingMode,
  Tags,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ endpoint_configuration }}',
  '{{ mutual_tls_authentication }}',
  '{{ certificate_arn }}',
  '{{ regional_certificate_arn }}',
  '{{ ownership_verification_certificate_arn }}',
  '{{ security_policy }}',
  '{{ routing_mode }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigateway.domain_names (
  DomainName,
  EndpointConfiguration,
  MutualTlsAuthentication,
  CertificateArn,
  RegionalCertificateArn,
  OwnershipVerificationCertificateArn,
  SecurityPolicy,
  RoutingMode,
  Tags,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ endpoint_configuration }}',
  '{{ mutual_tls_authentication }}',
  '{{ certificate_arn }}',
  '{{ regional_certificate_arn }}',
  '{{ ownership_verification_certificate_arn }}',
  '{{ security_policy }}',
  '{{ routing_mode }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: endpoint_configuration
      value:
        ip_address_type: '{{ ip_address_type }}'
        types:
          - '{{ types[0] }}'
        vpc_endpoint_ids:
          - '{{ vpc_endpoint_ids[0] }}'
    - name: mutual_tls_authentication
      value:
        truststore_uri: '{{ truststore_uri }}'
        truststore_version: '{{ truststore_version }}'
    - name: certificate_arn
      value: '{{ certificate_arn }}'
    - name: regional_certificate_arn
      value: '{{ regional_certificate_arn }}'
    - name: ownership_verification_certificate_arn
      value: '{{ ownership_verification_certificate_arn }}'
    - name: security_policy
      value: '{{ security_policy }}'
    - name: routing_mode
      value: '{{ routing_mode }}'
    - 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.apigateway.domain_names
SET PatchDocument = string('{{ {
    "EndpointConfiguration": endpoint_configuration,
    "MutualTlsAuthentication": mutual_tls_authentication,
    "CertificateArn": certificate_arn,
    "RegionalCertificateArn": regional_certificate_arn,
    "OwnershipVerificationCertificateArn": ownership_verification_certificate_arn,
    "SecurityPolicy": security_policy,
    "RoutingMode": routing_mode,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.domain_names
WHERE
  Identifier = '{{ domain_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

apigateway:POST,
apigateway:PUT,
apigateway:GET

Read

apigateway:GET

Update

apigateway:GET,
apigateway:PUT,
apigateway:PATCH

Delete

apigateway:GET,
apigateway:DELETE

List

apigateway:GET