community.aws.aws_acm_info module – Retrieve certificate information from AWS Certificate Manager service
Note
This module is part of the community.aws collection (version 3.6.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.aws_acm_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.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.16.0
botocore >= 1.19.0
Parameters
Parameter |
Comments |
---|---|
If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the ‘user_agent’ key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. |
|
If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
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 botocore.endpoint logger to parse the unique (rather than total) “resource:action” API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. Choices:
|
|
The domain name of an ACM certificate to limit the search to |
|
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. |
|
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. |
|
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region |
|
If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. Aliases aws_session_token and session_token have been added in version 3.2.0. |
|
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 “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
Examples
- name: obtain all ACM certificates
community.aws.aws_acm_info:
- name: obtain all information for a single ACM certificate
community.aws.aws_acm_info:
domain_name: "*.example_com"
- name: obtain all certificates pending validation
community.aws.aws_acm_info:
statuses:
- PENDING_VALIDATION
- name: obtain all certificates with tag Name=foo and myTag=bar
community.aws.aws_acm_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.aws_acm_info:
certificate_arn: "arn:aws:acm:ap-southeast-2:123456789876: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: |