community.aws.acm_certificate_info module – Retrieve certificate information from AWS Certificate Manager service
Note
This module is part of the community.aws collection (version 8.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.aws
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.acm_certificate_info
.
New in community.aws 1.0.0
Synopsis
Retrieve information for ACM certificates.
Note that this will not return information about uploaded keys of size 4096 bits, due to a limitation of the ACM API.
Prior to release 5.0.0 this module was called
community.aws.aws_acm_info
. The usage did not change.
Aliases: aws_acm_info
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
If provided, the results will be filtered to show only the certificate with this ARN. If no certificate with this ARN exists, this task will fail. If a certificate with this ARN exists in a different region, this task will fail. |
|
Use a The Choices:
|
|
The domain name of an ACM certificate to limit the search to. |
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Status to filter the certificate results. Choices:
|
|
Filter results to show only certificates with tags that match all the tags specified here. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
- name: obtain all ACM certificates
community.aws.acm_certificate_info:
- name: obtain all information for a single ACM certificate
community.aws.acm_certificate_info:
domain_name: "*.example_com"
- name: obtain all certificates pending validation
community.aws.acm_certificate_info:
statuses:
- PENDING_VALIDATION
- name: obtain all certificates with tag Name=foo and myTag=bar
community.aws.acm_certificate_info:
tags:
Name: foo
myTag: bar
# The output is still a list of certificates, just one item long.
- name: obtain information about a certificate with a particular ARN
community.aws.acm_certificate_info:
certificate_arn: "arn:aws:acm:ap-southeast-2:123456789012:certificate/abcdeabc-abcd-1234-4321-abcdeabcde12"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A list of certificates Returned: always |
|
The ACM Certificate body Returned: when certificate creation is complete Sample: |
|
Certificate ARN Returned: always Sample: |
|
Full certificate chain for the certificate Returned: when certificate creation is complete Sample: |
|
Date certificate was created Returned: always Sample: |
|
Domain name for the certificate Returned: always Sample: |
|
Options used by ACM to validate the certificate Returned: when certificate type is AMAZON_ISSUED |
|
Fully qualified domain name of the certificate Returned: always Sample: |
|
The domain name ACM used to send validation emails Returned: always Sample: |
|
A list of email addresses that ACM used to send domain validation emails Returned: always Sample: |
|
Validation status of the domain Returned: always Sample: |
|
Reason certificate request failed Returned: only when certificate issuing failed Sample: |
|
A list of ARNs for the AWS resources that are using the certificate. Returned: always Sample: |
|
Date certificate was issued Returned: always Sample: |
|
Issuer of the certificate Returned: always Sample: |
|
Algorithm used to generate the certificate Returned: always Sample: |
|
Date after which the certificate is not valid Returned: always Sample: |
|
Date before which the certificate is not valid Returned: always Sample: |
|
Information about managed renewal process Returned: when certificate is issued by Amazon and a renewal has been started |
|
Options used by ACM to validate the certificate Returned: when certificate type is AMAZON_ISSUED |
|
Fully qualified domain name of the certificate Returned: always Sample: |
|
The domain name ACM used to send validation emails Returned: always Sample: |
|
A list of email addresses that ACM used to send domain validation emails Returned: always Sample: |
|
Validation status of the domain Returned: always Sample: |
|
Status of the domain renewal Returned: always Sample: |
|
Reason for certificate revocation Returned: when the certificate has been revoked Sample: |
|
Date certificate was revoked Returned: when the certificate has been revoked Sample: |
|
The serial number of the certificate Returned: always Sample: |
|
Algorithm used to sign the certificate Returned: always Sample: |
|
Status of the certificate in ACM Returned: always Sample: |
|
The name of the entity that is associated with the public key contained in the certificate Returned: always Sample: |
|
Subject Alternative Names for the certificate Returned: always Sample: |
|
Tags associated with the certificate Returned: always Sample: |
|
The source of the certificate Returned: always Sample: |