domain_name_v2s

Creates, updates, deletes or gets a domain_name_v2 resource or lists domain_name_v2s in a region

Overview

Name	domain_name_v2s
Type	Resource
Description	Resource Type definition for AWS::ApiGateway::DomainNameV2.
Id	awscc.apigateway.domain_name_v2s

Fields

Name	Datatype	Description
certificate_arn	string
domain_name	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.
security_policy	string
policy	object
domain_name_id	string
domain_name_arn	string	The amazon resource name (ARN) of the domain name resource.
routing_mode	string	The valid routing modes are &#91;BASE&#95;PATH&#95;MAPPING&#95;ONLY&#93;, &#91;ROUTING&#95;RULE&#95;THEN&#95;BASE&#95;PATH&#95;MAPPING&#93; and &#91;ROUTING&#95;RULE&#95;ONLY&#93;. All other inputs are invalid.
▶tags	array
region	string	AWS region.

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

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_v2.

SELECT
region,
certificate_arn,
domain_name,
endpoint_configuration,
security_policy,
policy,
domain_name_id,
domain_name_arn,
routing_mode,
tags
FROM awscc.apigateway.domain_name_v2s
WHERE region = 'us-east-1' AND data__Identifier = '<DomainNameArn>';

INSERT example

Use the following StackQL query and manifest file to create a new domain_name_v2 resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.apigateway.domain_name_v2s (
 CertificateArn,
 DomainName,
 EndpointConfiguration,
 SecurityPolicy,
 Policy,
 RoutingMode,
 Tags,
 region
)
SELECT 
'{{ CertificateArn }}',
 '{{ DomainName }}',
 '{{ EndpointConfiguration }}',
 '{{ SecurityPolicy }}',
 '{{ Policy }}',
 '{{ RoutingMode }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

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

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.domain_name_v2s
WHERE data__Identifier = '<DomainNameArn>'
AND region = 'us-east-1';

Permissions

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

Create

apigateway:POST,
apigateway:GET,
apigateway:UpdateDomainNamePolicy

Read

apigateway:GET

Update

apigateway:GET,
apigateway:PUT,
apigateway:PATCH,
apigateway:UpdateDomainNamePolicy

Delete

apigateway:DELETE,
apigateway:GET,
apigateway:UpdateDomainNamePolicy

List

apigateway:GET