acme_accounts

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

Overview

Name	acme_accounts
Type	Resource
Id	aws.acm.acme_accounts

Fields

The following fields are returned by SELECT queries:

describe_acme_account

Name	Datatype	Description
account_url	string	The URL of the ACME account.
acme_external_account_binding_arn	string	The Amazon Resource Name (ARN) of the external account binding associated with this ACME account. (pattern: <code>arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+/acme-external-account-binding/[a-zA-Z0-9-]+</code>)
contacts	array	The contact information for the ACME account.
created_at	string (date-time)	The time at which the ACME account was created.
public_key_thumbprint	string	The thumbprint of the public key associated with the ACME account.
status	string	The status of the ACME account. (VALID, DEACTIVATED, REVOKED)

list_acme_accounts

Name	Datatype	Description
account_url	string	The URL of the ACME account.
acme_external_account_binding_arn	string	The Amazon Resource Name (ARN) of the external account binding associated with this ACME account. (pattern: <code>arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+/acme-external-account-binding/[a-zA-Z0-9-]+</code>)
contacts	array	The contact information for the ACME account.
created_at	string (date-time)	The time at which the ACME account was created.
public_key_thumbprint	string	The thumbprint of the public key associated with the ACME account.
status	string	The status of the ACME account. (VALID, DEACTIVATED, REVOKED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_acme_account	select	region		Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding.
list_acme_accounts	select	region		Retrieves a list of ACME accounts registered with the specified ACME endpoint. ACME accounts are created when clients use external account binding credentials to register.
revoke_acme_account	update	region, AcmeEndpointArn, AccountUrl		Revokes an ACME account, preventing it from requesting or revoking certificates. This operation is irreversible.

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_account

Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding.

SELECT
account_url,
acme_external_account_binding_arn,
contacts,
created_at,
public_key_thumbprint,
status
FROM aws.acm.acme_accounts
WHERE region = '{{ region }}' -- required
;

list_acme_accounts

Retrieves a list of ACME accounts registered with the specified ACME endpoint. ACME accounts are created when clients use external account binding credentials to register.

SELECT
account_url,
acme_external_account_binding_arn,
contacts,
created_at,
public_key_thumbprint,
status
FROM aws.acm.acme_accounts
WHERE region = '{{ region }}' -- required
;

UPDATE examples

revoke_acme_account

Revokes an ACME account, preventing it from requesting or revoking certificates. This operation is irreversible.

UPDATE aws.acm.acme_accounts
SET 
AcmeEndpointArn = '{{ AcmeEndpointArn }}',
AccountUrl = '{{ AccountUrl }}'
WHERE 
region = '{{ region }}' --required
AND AcmeEndpointArn = '{{ AcmeEndpointArn }}' --required
AND AccountUrl = '{{ AccountUrl }}' --required;