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

get (all properties)

Name	Datatype	Description
certificate_arn	string
domain_name	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.
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 [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
domain_name	string
domain_name_arn	string	The amazon resource name (ARN) of the domain name resource.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	domain_name_v2s	INSERT	region
delete_resource	domain_name_v2s	DELETE	Identifier, region
update_resource	domain_name_v2s	UPDATE	Identifier, PatchDocument, region
list_resources	domain_name_v2s_list_only	SELECT	region
get_resource	domain_name_v2s	SELECT	Identifier, region

SELECT examples

get (all properties)

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 = '{{ region }}' AND
  Identifier = '{{ domain_name_arn }}';

list (identifiers only)

Lists all domain_name_v2s in a region.

SELECT
  region,
  domain_name_arn
FROM awscc.apigateway.domain_name_v2s_list_only
WHERE
  region = '{{ region }}';

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
  '{{ certificate_arn }}',
  '{{ domain_name }}',
  '{{ endpoint_configuration }}',
  '{{ security_policy }}',
  '{{ policy }}',
  '{{ routing_mode }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigateway.domain_name_v2s (
  CertificateArn,
  DomainName,
  EndpointConfiguration,
  SecurityPolicy,
  Policy,
  RoutingMode,
  Tags,
  region
)
SELECT
  '{{ certificate_arn }}',
  '{{ domain_name }}',
  '{{ endpoint_configuration }}',
  '{{ security_policy }}',
  '{{ 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_v2
  props:
    - name: certificate_arn
      value: '{{ certificate_arn }}'
    - 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: security_policy
      value: '{{ security_policy }}'
    - name: policy
      value: {}
    - 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_v2 resource, using stack-deploy.

/*+ update */
UPDATE awscc.apigateway.domain_name_v2s
SET PatchDocument = string('{{ {
    "CertificateArn": certificate_arn,
    "Policy": policy,
    "RoutingMode": routing_mode,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_name_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.domain_name_v2s
WHERE
  Identifier = '{{ domain_name_arn }}' 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_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