acme_external_account_bindings

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

Overview

Name	acme_external_account_bindings
Type	Resource
Id	aws.acm.acme_external_account_bindings

Fields

The following fields are returned by SELECT queries:

describe_acme_external_account_binding

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>)
acme_external_account_binding_arn	string	The Amazon Resource Name (ARN) of the ACME external account binding. (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>)
created_at	string (date-time)	The time at which the external account binding was created.
expires_at	string (date-time)	The time at which the external account binding expires.
last_used_at	string (date-time)	The time at which the external account binding was last used.
revoked_at	string (date-time)	The time at which the external account binding was revoked.
role_arn	string	The Amazon Resource Name (ARN) of the IAM role associated with the external account binding. (pattern: <code>arn:aws[a-z-]*:iam::[0-9]{12}:role/.+</code>)
updated_at	string (date-time)	The time at which the external account binding was last updated.

list_acme_external_account_bindings

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>)
acme_external_account_binding_arn	string	The Amazon Resource Name (ARN) of the ACME external account binding. (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>)
created_at	string (date-time)	The time at which the external account binding was created.
expires_at	string (date-time)	The time at which the external account binding expires.
last_used_at	string (date-time)	The time at which the external account binding was last used.
revoked_at	string (date-time)	The time at which the external account binding was revoked.
role_arn	string	The Amazon Resource Name (ARN) of the IAM role associated with the external account binding. (pattern: <code>arn:aws[a-z-]*:iam::[0-9]{12}:role/.+</code>)
updated_at	string (date-time)	The time at which the external account binding was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_acme_external_account_binding	select	region		Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history.
list_acme_external_account_bindings	select	region		Retrieves a list of external account bindings for the specified ACME endpoint.
create_acme_external_account_binding	insert	region, AcmeEndpointArn, RoleArn		Creates an external account binding (EAB) for an ACME endpoint. An EAB provides credentials that authorize an ACME client to register an account with the endpoint. Each EAB is associated with an IAM role that controls what certificate operations the ACME client can perform.
revoke_acme_external_account_binding	update	region, AcmeExternalAccountBindingArn		Revokes an external account binding, preventing new ACME accounts from being registered using this binding. Existing ACME accounts that were previously registered using the binding are not affected and must be revoked separately.
delete_acme_external_account_binding	delete	region		Deletes an external account binding. Previously fetched credentials for this binding will no longer be usable for account registration. A deleted binding cannot be recovered.

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_external_account_binding

Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history.

SELECT
acme_endpoint_arn,
acme_external_account_binding_arn,
created_at,
expires_at,
last_used_at,
revoked_at,
role_arn,
updated_at
FROM aws.acm.acme_external_account_bindings
WHERE region = '{{ region }}' -- required
;

list_acme_external_account_bindings

Retrieves a list of external account bindings for the specified ACME endpoint.

SELECT
acme_endpoint_arn,
acme_external_account_binding_arn,
created_at,
expires_at,
last_used_at,
revoked_at,
role_arn,
updated_at
FROM aws.acm.acme_external_account_bindings
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_acme_external_account_binding

Creates an external account binding (EAB) for an ACME endpoint. An EAB provides credentials that authorize an ACME client to register an account with the endpoint. Each EAB is associated with an IAM role that controls what certificate operations the ACME client can perform.

INSERT INTO aws.acm.acme_external_account_bindings (
IdempotencyToken,
AcmeEndpointArn,
RoleArn,
Expiration,
Tags,
region
)
SELECT 
'{{ IdempotencyToken }}',
'{{ AcmeEndpointArn }}' /* required */,
'{{ RoleArn }}' /* required */,
'{{ Expiration }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
external_account_binding
;

Manifest

# Description fields are for documentation purposes
- name: acme_external_account_bindings
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the acme_external_account_bindings 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: RoleArn
    value: "{{ RoleArn }}"
    description: |
      The Amazon Resource Name (ARN) of the IAM role to associate with the external account binding.
  - name: Expiration
    description: |
      The expiration configuration for the external account binding.
    value:
      Value: {{ Value }}
      Type: "{{ Type }}"
  - name: Tags
    description: |
      One or more tags to associate with the external account binding.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

revoke_acme_external_account_binding

Revokes an external account binding, preventing new ACME accounts from being registered using this binding. Existing ACME accounts that were previously registered using the binding are not affected and must be revoked separately.

UPDATE aws.acm.acme_external_account_bindings
SET 
AcmeExternalAccountBindingArn = '{{ AcmeExternalAccountBindingArn }}'
WHERE 
region = '{{ region }}' --required
AND AcmeExternalAccountBindingArn = '{{ AcmeExternalAccountBindingArn }}' --required;

DELETE examples

delete_acme_external_account_binding

Deletes an external account binding. Previously fetched credentials for this binding will no longer be usable for account registration. A deleted binding cannot be recovered.

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