community.aws.aws_acm – Upload and delete certificates in the AWS Certificate Manager service¶

Note

This plugin is part of the community.aws collection (version 1.4.0).

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.aws_acm.

New in version 1.0.0: of community.aws

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Import and delete certificates in Amazon Web Service’s Certificate Manager (AWS ACM).
This module does not currently interact with AWS-provided certificates. It currently only manages certificates provided to AWS by the user.
The ACM API allows users to upload multiple certificates for the same domain name, and even multiple identical certificates. This module attempts to restrict such freedoms, to be idempotent, as per the Ansible philosophy. It does this through applying AWS resource “Name” tags to ACM certificates.
When state=present, if there is one certificate in ACM with a Name tag equal to the name_tag parameter, and an identical body and chain, this task will succeed without effect.
When state=present, if there is one certificate in ACM a Name tag equal to the name_tag parameter, and a different body, this task will overwrite that certificate.
When state=present, if there are multiple certificates in ACM with a Name tag equal to the name_tag parameter, this task will fail.
When state=absent and certificate_arn is defined, this module will delete the ACM resource with that ARN if it exists in this region, and succeed without effect if it doesn’t exist.
When state=absent and domain_name is defined, this module will delete all ACM resources in this AWS region with a corresponding domain name. If there are none, it will succeed without effect.
When state=absent and certificate_arn is not defined, and domain_name is not defined, this module will delete all ACM resources in this AWS region with a corresponding Name tag. If there are none, it will succeed without effect.
Note that this may not work properly with 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.

boto
boto3
python >= 2.6

Parameters ¶

Parameter	Choices/Defaults	Comments
aws_access_key string		AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. 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. aliases: ec2_access_key, access_key
aws_ca_bundle path		The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config dictionary		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.
aws_secret_key string		AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. 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. aliases: ec2_secret_key, secret_key
certificate string		The body of the PEM encoded public certificate. Required when state is not `absent`. If your certificate is in a file, use `lookup('file', 'path/to/cert.pem'`).
certificate_arn string		The ARN of a certificate in ACM to delete Ignored when state=present. If state=absent, you must provide one of certificate_arn, domain_name or name_tag. If state=absent and no resource exists with this ARN in this region, the task will succeed with no effect. If state=absent and the corresponding resource exists in a different region, this task may report success without deleting that resource. aliases: arn
certificate_chain string		The body of the PEM encoded chain for your certificate. If your certificate chain is in a file, use `lookup('file', 'path/to/chain.pem'`). Ignored when state=absent
debug_botocore_endpoint_logs boolean	Choices: no ← yes	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.
domain_name string		The domain name of the certificate. If state=absent and domain_name is specified, this task will delete all ACM certificates with this domain. Exactly one of domain_name, name_tag and certificate_arn must be provided. If state=present this must not be specified. (Since the domain name is encoded within the public certificate's body.) aliases: domain
ec2_url string		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. aliases: aws_endpoint_url, endpoint_url
name_tag string		The unique identifier for tagging resources using AWS tags, with key Name. This can be any set of characters accepted by AWS for tag values. This is to ensure Ansible can treat certificates idempotently, even though the ACM API allows duplicate certificates. If state=preset, this must be specified. If state=absent, you must provide exactly one of certificate_arn, domain_name or name_tag. aliases: name
private_key string		The body of the PEM encoded private key. Required when state=present. Ignored when state=absent. If your private key is in a file, use `lookup('file', 'path/to/key.pem'`).
profile string		Uses a boto profile. Only works with boto >= 2.24.0. 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. aliases: aws_profile
region string		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 aliases: aws_region, ec2_region
security_token string		AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. 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_security_token, access_token
state string	Choices: present ← absent	If state=present, the specified public certificate and private key will be uploaded, with Name tag equal to name_tag. If state=absent, any certificates in this region with a corresponding domain_name, name_tag or certificate_arn will be deleted.
validate_certs boolean	Choices: no yes ←	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes ¶

Note

If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples ¶

- name: upload a self-signed certificate
  community.aws.aws_acm:
    certificate: "{{ lookup('file', 'cert.pem' ) }}"
    privateKey: "{{ lookup('file', 'key.pem' ) }}"
    name_tag: my_cert # to be applied through an AWS tag as  "Name":"my_cert"
    region: ap-southeast-2 # AWS region

- name: create/update a certificate with a chain
  community.aws.aws_acm:
    certificate: "{{ lookup('file', 'cert.pem' ) }}"
    privateKey: "{{ lookup('file', 'key.pem' ) }}"
    name_tag: my_cert
    certificate_chain: "{{ lookup('file', 'chain.pem' ) }}"
    state: present
    region: ap-southeast-2
  register: cert_create

- name: print ARN of cert we just created
  ansible.builtin.debug:
    var: cert_create.certificate.arn

- name: delete the cert we just created
  community.aws.aws_acm:
    name_tag: my_cert
    state: absent
    region: ap-southeast-2

- name: delete a certificate with a particular ARN
  community.aws.aws_acm:
    certificate_arn: "arn:aws:acm:ap-southeast-2:123456789012:certificate/01234567-abcd-abcd-abcd-012345678901"
    state: absent
    region: ap-southeast-2

- name: delete all certificates with a particular domain name
  community.aws.aws_acm:
    domain_name: acm.ansible.com
    state: absent
    region: ap-southeast-2

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
arns list / elements=string		when state=absent	A list of the ARNs of the certificates in ACM which were deleted Sample: ['arn:aws:acm:ap-southeast-2:123456789012:certificate/01234567-abcd-abcd-abcd-012345678901']
certificate complex		when state=present	Information about the certificate which was uploaded
	arn string	when state=present	The ARN of the certificate in ACM Sample: arn:aws:acm:ap-southeast-2:123456789012:certificate/01234567-abcd-abcd-abcd-012345678901
	domain_name string	when state=present	The domain name encoded within the public certificate Sample: acm.ansible.com

Authors¶

Matthew Davis (@matt-telstra) on behalf of Telstra Corporation Limited

community.aws.aws_acm – Upload and delete certificates in the AWS Certificate Manager service¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶