api_gateway_domain

Manage AWS API Gateway custom domains

Collection: community.aws

Full Name: community.aws.api_gateway_domain

Synopsis

Manage AWS API Gateway custom domains

Parameters

Name	Type	Required	Default
access_key	str
aws_ca_bundle	path
aws_config	dict
certificate_arn	str	yes
debug_botocore_endpoint_logs	bool		`false`
domain_mappings	list	yes
domain_name	str	yes
endpoint_type	str		`EDGE`
endpoint_url	str
profile	str
region	str
secret_key	str
security_policy	str		`TLS_1_2`
session_token	str
state	str		`present`
validate_certs	bool		`true`

Example

yaml

- name: Setup endpoint for a custom domain for your API Gateway HTTP API
  community.aws.api_gateway_domain:
    domain_name: myapi.foobar.com
    certificate_arn: 'arn:aws:acm:us-east-1:1231123123:certificate/8bd89412-abc123-xxxxx'
    security_policy: TLS_1_2
    endpoint_type: EDGE
    domain_mappings:
        - rest_api_id: abc123
          stage: production
    state: present
  register: api_gw_domain_result