acme_domain_validations

Creates, updates, deletes, gets or lists an acme_domain_validations resource.

Overview

Name	acme_domain_validations
Type	Resource
Id	aws.acm.acme_domain_validations

Fields

The following fields are returned by SELECT queries:

describe_acme_domain_validation

Name	Datatype	Description
acme_domain_validation_arn	string	The Amazon Resource Name (ARN) of the ACME domain validation. (pattern: <code>arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+/acme-domain-validation/[a-zA-Z0-9-]+</code>)
acme_endpoint_arn	string	The Amazon Resource Name (ARN) of the ACME endpoint. (pattern: <code>arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+</code>)
created_at	string (date-time)	The time at which the domain validation was created.
domain_name	string	The domain name being validated. (pattern: <code>([a-z0-9]([a-z0-9-][a-z0-9])?.)[a-z0-9]([a-z0-9-]*[a-z0-9])?</code>)
failure_details	object	Details about the failure, if the validation failed.
prevalidation_details	object	Details about the prevalidation configuration.
prevalidation_type	string	The type of prevalidation used. (DNS_PREVALIDATION)
status	string	The status of the domain validation. (VALIDATING, VALID, INVALID, DELETING)
updated_at	string (date-time)	The time at which the domain validation was last updated.

list_acme_domain_validations

Name	Datatype	Description
acme_domain_validation_arn	string	The Amazon Resource Name (ARN) of the ACME domain validation. (pattern: <code>arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+/acme-domain-validation/[a-zA-Z0-9-]+</code>)
acme_endpoint_arn	string	The Amazon Resource Name (ARN) of the ACME endpoint. (pattern: <code>arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+</code>)
created_at	string (date-time)	The time at which the domain validation was created.
domain_name	string	The domain name being validated. (pattern: <code>([a-z0-9]([a-z0-9-][a-z0-9])?.)[a-z0-9]([a-z0-9-]*[a-z0-9])?</code>)
failure_details	object	Details about the failure, if the validation failed.
prevalidation_details	object	Details about the prevalidation configuration.
prevalidation_type	string	The type of prevalidation used. (DNS_PREVALIDATION)
status	string	The status of the domain validation. (VALIDATING, VALID, INVALID, DELETING)
updated_at	string (date-time)	The time at which the domain validation was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_acme_domain_validation	select	region		Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation.
list_acme_domain_validations	select	region		Retrieves a list of domain validations for the specified ACME endpoint.
create_acme_domain_validation	insert	region, AcmeEndpointArn, DomainName, PrevalidationOptions		Creates a domain validation for an ACME endpoint. Domain validations authorize the endpoint to issue certificates for specified domain names. You configure prevalidation to prove domain ownership.
update_acme_domain_validation	update	region, AcmeDomainValidationArn		Updates the prevalidation configuration of an existing domain validation.
delete_acme_domain_validation	delete	region		Deletes a domain validation. After deletion, the ACME endpoint can no longer issue certificates for the associated domain.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_acme_domain_validation

Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation.

SELECT
acme_domain_validation_arn,
acme_endpoint_arn,
created_at,
domain_name,
failure_details,
prevalidation_details,
prevalidation_type,
status,
updated_at
FROM aws.acm.acme_domain_validations
WHERE region = '{{ region }}' -- required
;

list_acme_domain_validations

Retrieves a list of domain validations for the specified ACME endpoint.

SELECT
acme_domain_validation_arn,
acme_endpoint_arn,
created_at,
domain_name,
failure_details,
prevalidation_details,
prevalidation_type,
status,
updated_at
FROM aws.acm.acme_domain_validations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_acme_domain_validation

Creates a domain validation for an ACME endpoint. Domain validations authorize the endpoint to issue certificates for specified domain names. You configure prevalidation to prove domain ownership.

INSERT INTO aws.acm.acme_domain_validations (
IdempotencyToken,
AcmeEndpointArn,
DomainName,
PrevalidationOptions,
Tags,
region
)
SELECT 
'{{ IdempotencyToken }}',
'{{ AcmeEndpointArn }}' /* required */,
'{{ DomainName }}' /* required */,
'{{ PrevalidationOptions }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
acme_domain_validation_arn
;

Manifest

# Description fields are for documentation purposes
- name: acme_domain_validations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the acme_domain_validations resource.
  - name: IdempotencyToken
    value: "{{ IdempotencyToken }}"
    description: |
      A unique, case-sensitive identifier to ensure idempotency of the request.
  - name: AcmeEndpointArn
    value: "{{ AcmeEndpointArn }}"
    description: |
      The Amazon Resource Name (ARN) of the ACME endpoint.
  - name: DomainName
    value: "{{ DomainName }}"
    description: |
      The domain name to validate.
  - name: PrevalidationOptions
    description: |
      The prevalidation options for the domain.
    value:
      DnsPrevalidation:
        DomainScope:
          ExactDomain: "{{ ExactDomain }}"
          Subdomains: "{{ Subdomains }}"
          Wildcards: "{{ Wildcards }}"
        HostedZoneId: "{{ HostedZoneId }}"
  - name: Tags
    description: |
      One or more tags to associate with the domain validation.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_acme_domain_validation

Updates the prevalidation configuration of an existing domain validation.

UPDATE aws.acm.acme_domain_validations
SET 
AcmeDomainValidationArn = '{{ AcmeDomainValidationArn }}',
PrevalidationOptions = '{{ PrevalidationOptions }}'
WHERE 
region = '{{ region }}' --required
AND AcmeDomainValidationArn = '{{ AcmeDomainValidationArn }}' --required;

DELETE examples

delete_acme_domain_validation

Deletes a domain validation. After deletion, the ACME endpoint can no longer issue certificates for the associated domain.

DELETE FROM aws.acm.acme_domain_validations
WHERE region = '{{ region }}' --required
;