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::ApiGateway::DomainName.
Id	aws.apigateway.domain_names

Fields

Name	Datatype	Description
domain_name	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](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
security_policy	string
tags	array
region	string	AWS region.

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 domain_names in a region.

SELECT
region,
domain_name,
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,
tags
FROM aws.apigateway.domain_names
WHERE region = 'us-east-1';

Gets all properties from an individual domain_name.

SELECT
region,
domain_name,
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,
tags
FROM aws.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 aws.apigateway.domain_names (
 DomainName,
 EndpointConfiguration,
 MutualTlsAuthentication,
 CertificateArn,
 RegionalCertificateArn,
 OwnershipVerificationCertificateArn,
 SecurityPolicy,
 Tags,
 region
)
SELECT 
'{{ DomainName }}',
 '{{ EndpointConfiguration }}',
 '{{ MutualTlsAuthentication }}',
 '{{ CertificateArn }}',
 '{{ RegionalCertificateArn }}',
 '{{ OwnershipVerificationCertificateArn }}',
 '{{ SecurityPolicy }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.apigateway.domain_names (
 DomainName,
 EndpointConfiguration,
 MutualTlsAuthentication,
 CertificateArn,
 RegionalCertificateArn,
 OwnershipVerificationCertificateArn,
 SecurityPolicy,
 Tags,
 region
)
SELECT 
 '{{ DomainName }}',
 '{{ EndpointConfiguration }}',
 '{{ MutualTlsAuthentication }}',
 '{{ CertificateArn }}',
 '{{ RegionalCertificateArn }}',
 '{{ OwnershipVerificationCertificateArn }}',
 '{{ SecurityPolicy }}',
 '{{ 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:
          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: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.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:*

Read

apigateway:*

Update

apigateway:*

Delete

apigateway:*

List

apigateway:*