acme_endpoints

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

Overview

Name	acme_endpoints
Type	Resource
Id	aws.acm.acme_endpoints

Fields

The following fields are returned by SELECT queries:

describe_acme_endpoint

Name	Datatype	Description
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>)
authorization_behavior	string	The authorization behavior of the ACME endpoint. (PRE_APPROVED)
certificate_authority	object	The certificate authority configuration for the ACME endpoint.
certificate_tags	array	Tags applied to certificates issued through this ACME endpoint.
contact	string	Whether ACME clients must provide contact information during account registration. (REQUIRED, NOT_REQUIRED)
created_at	string (date-time)	The time at which the ACME endpoint was created.
endpoint_url	string	The URL of the ACME endpoint.
failure_reason	string	The reason the ACME endpoint failed, if applicable.
status	string	The status of the ACME endpoint. (CREATING, ACTIVE, DELETING, FAILED)
updated_at	string (date-time)	The time at which the ACME endpoint was last updated.

list_acme_endpoints

Name	Datatype	Description
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>)
authorization_behavior	string	The authorization behavior of the ACME endpoint. (PRE_APPROVED)
certificate_authority	object	The certificate authority configuration for the ACME endpoint.
certificate_tags	array	Tags applied to certificates issued through this ACME endpoint.
contact	string	Whether ACME clients must provide contact information during account registration. (REQUIRED, NOT_REQUIRED)
created_at	string (date-time)	The time at which the ACME endpoint was created.
endpoint_url	string	The URL of the ACME endpoint.
failure_reason	string	The reason the ACME endpoint failed, if applicable.
status	string	The status of the ACME endpoint. (CREATING, ACTIVE, DELETING, FAILED)
updated_at	string (date-time)	The time at which the ACME endpoint was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_acme_endpoint	select	region		Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.
list_acme_endpoints	select	region		Retrieves a list of ACME endpoints in your account. Use this operation to view all configured ACME endpoints and their current status.
create_acme_endpoint	insert	region, AuthorizationBehavior, CertificateAuthority		Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL. After creation, ACME clients can use the endpoint URL to automate certificate issuance using the ACME protocol.
update_acme_endpoint	update	region, AcmeEndpointArn		Updates the configuration of an existing ACME endpoint. You can change the authorization behavior, contact requirement, or certificate authority settings.
delete_acme_endpoint	delete	region		Deletes an ACME endpoint. After deletion, the endpoint URL is no longer accessible and ACME clients cannot issue certificates through it. Any existing external account bindings and domain validations associated with the endpoint are also deleted.

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_endpoint

Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.

SELECT
acme_endpoint_arn,
authorization_behavior,
certificate_authority,
certificate_tags,
contact,
created_at,
endpoint_url,
failure_reason,
status,
updated_at
FROM aws.acm.acme_endpoints
WHERE region = '{{ region }}' -- required
;

list_acme_endpoints

Retrieves a list of ACME endpoints in your account. Use this operation to view all configured ACME endpoints and their current status.

SELECT
acme_endpoint_arn,
authorization_behavior,
certificate_authority,
certificate_tags,
contact,
created_at,
endpoint_url,
failure_reason,
status,
updated_at
FROM aws.acm.acme_endpoints
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_acme_endpoint

Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL. After creation, ACME clients can use the endpoint URL to automate certificate issuance using the ACME protocol.

INSERT INTO aws.acm.acme_endpoints (
IdempotencyToken,
AuthorizationBehavior,
Contact,
CertificateAuthority,
Tags,
CertificateTags,
region
)
SELECT 
'{{ IdempotencyToken }}',
'{{ AuthorizationBehavior }}' /* required */,
'{{ Contact }}',
'{{ CertificateAuthority }}' /* required */,
'{{ Tags }}',
'{{ CertificateTags }}',
'{{ region }}'
RETURNING
acme_endpoint_arn
;

Manifest

# Description fields are for documentation purposes
- name: acme_endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the acme_endpoints resource.
  - name: IdempotencyToken
    value: "{{ IdempotencyToken }}"
    description: |
      A unique, case-sensitive identifier to ensure idempotency of the request.
  - name: AuthorizationBehavior
    value: "{{ AuthorizationBehavior }}"
    description: |
      The authorization behavior for the ACME endpoint.
    valid_values: ['PRE_APPROVED']
  - name: Contact
    value: "{{ Contact }}"
    description: |
      Specifies whether ACME clients must provide contact information during account registration.
    valid_values: ['REQUIRED', 'NOT_REQUIRED']
  - name: CertificateAuthority
    description: |
      The type of certificate authority to use for issuing certificates through this ACME endpoint.
    value:
      PublicCertificateAuthority:
        AllowedKeyAlgorithms:
          - "{{ AllowedKeyAlgorithms }}"
  - name: Tags
    description: |
      One or more tags to associate with the ACME endpoint.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: CertificateTags
    description: |
      Tags to apply to certificates issued through this ACME endpoint.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_acme_endpoint

Updates the configuration of an existing ACME endpoint. You can change the authorization behavior, contact requirement, or certificate authority settings.

UPDATE aws.acm.acme_endpoints
SET 
AcmeEndpointArn = '{{ AcmeEndpointArn }}',
AuthorizationBehavior = '{{ AuthorizationBehavior }}',
Contact = '{{ Contact }}',
CertificateAuthority = '{{ CertificateAuthority }}'
WHERE 
region = '{{ region }}' --required
AND AcmeEndpointArn = '{{ AcmeEndpointArn }}' --required;

DELETE examples

delete_acme_endpoint

Deletes an ACME endpoint. After deletion, the endpoint URL is no longer accessible and ACME clients cannot issue certificates through it. Any existing external account bindings and domain validations associated with the endpoint are also deleted.

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