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](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide*.
Id	awscc.apigateway.domain_names

Fields

Name	Datatype	Description
domain_name	string
domain_name_arn	string
distribution_domain_name	string
distribution_hosted_zone_id	string
▶endpoint_configuration	object	The &#96;&#96;EndpointConfiguration&#96;&#96; property type specifies the endpoint types of a REST API.<br />&#96;&#96;EndpointConfiguration&#96;&#96; is a property of the &#91;AWS::ApiGateway::RestApi&#93;(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) 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.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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,
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 = '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.apigateway.domain_names (
 DomainName,
 EndpointConfiguration,
 MutualTlsAuthentication,
 CertificateArn,
 RegionalCertificateArn,
 OwnershipVerificationCertificateArn,
 SecurityPolicy,
 RoutingMode,
 Tags,
 region
)
SELECT 
'{{ DomainName }}',
 '{{ EndpointConfiguration }}',
 '{{ MutualTlsAuthentication }}',
 '{{ CertificateArn }}',
 '{{ RegionalCertificateArn }}',
 '{{ OwnershipVerificationCertificateArn }}',
 '{{ SecurityPolicy }}',
 '{{ RoutingMode }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.apigateway.domain_names (
 DomainName,
 EndpointConfiguration,
 MutualTlsAuthentication,
 CertificateArn,
 RegionalCertificateArn,
 OwnershipVerificationCertificateArn,
 SecurityPolicy,
 RoutingMode,
 Tags,
 region
)
SELECT 
 '{{ DomainName }}',
 '{{ EndpointConfiguration }}',
 '{{ MutualTlsAuthentication }}',
 '{{ CertificateArn }}',
 '{{ RegionalCertificateArn }}',
 '{{ OwnershipVerificationCertificateArn }}',
 '{{ SecurityPolicy }}',
 '{{ RoutingMode }}',
 '{{ 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: EndpointConfiguration
        value:
          IpAddressType: '{{ IpAddressType }}'
          Types:
            - '{{ Types[0] }}'
          VpcEndpointIds:
            - '{{ VpcEndpointIds[0] }}'
      - name: MutualTlsAuthentication
        value:
          TruststoreUri: '{{ TruststoreUri }}'
          TruststoreVersion: '{{ TruststoreVersion }}'
      - name: CertificateArn
        value: '{{ CertificateArn }}'
      - name: RegionalCertificateArn
        value: '{{ RegionalCertificateArn }}'
      - name: OwnershipVerificationCertificateArn
        value: '{{ OwnershipVerificationCertificateArn }}'
      - name: SecurityPolicy
        value: '{{ SecurityPolicy }}'
      - name: RoutingMode
        value: '{{ RoutingMode }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.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

apigateway:POST,
apigateway:PUT,
apigateway:GET

Read

apigateway:GET

Update

apigateway:GET,
apigateway:PUT,
apigateway:PATCH

Delete

apigateway:GET,
apigateway:DELETE

List

apigateway:GET