iam_cert – Manage server certificates for use on ELBs and CloudFront — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# iam_cert – Manage server certificates for use on ELBs and CloudFront

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## Synopsis

- Allows for the management of server certificates

## Requirements

The below requirements are needed on the host that executes this module.

- boto
- 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. aliases: ec2_access_key, access_key
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. aliases: ec2_secret_key, secret_key
cert string |  | The path to, or content of the certificate body in PEM encoded format. As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content.
cert_chain string |  | The path to, or content of the CA certificate chain in PEM encoded format. As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content.
debug_botocore_endpoint_logs boolean added in 2.8 | 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.
dup_ok boolean | Choices: no ← yes | By default the module will not upload a certificate that is already uploaded into AWS. If set to True, it will upload the certificate as long as the name is unique.
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.
key string |  | The path to, or content of the private key in PEM encoded format. As of 2.4 content is accepted. If the parameter is not a file, it is assumed to be content.
name string / required |  | Name of certificate to add, update or remove.
new_name string |  | When state is present, this will update the name of the cert. The cert, key and cert_chain parameters will be ignored if this is defined.
new_path string |  | When state is present, this will update the path of the cert. The cert, key and cert_chain parameters will be ignored if this is defined.
path string | Default: "/" | When creating or updating, specify the desired path of the certificate.
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
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. aliases: access_token
state string / required | Choices: present absent | Whether to create(or update) or delete certificate. If new_path or new_name is defined, specifying present will attempt to make an update these.
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_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`
- 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

    # Basic server certificate upload from local file
    - iam_cert:
        name: very_ssl
        state: present
        cert: "{{ lookup('file', 'path/to/cert') }}"
        key: "{{ lookup('file', 'path/to/key') }}"
        cert_chain: "{{ lookup('file', 'path/to/certchain') }}"

    # Basic server certificate upload
    - iam_cert:
        name: very_ssl
        state: present
        cert: path/to/cert
        key: path/to/key
        cert_chain: path/to/certchain

    # Server certificate upload using key string
    - iam_cert:
        name: very_ssl
        state: present
        path: "/a/cert/path/"
        cert: body_of_somecert
        key: vault_body_of_privcertkey
        cert_chain: body_of_myverytrustedchain

    # Basic rename of existing certificate
    - iam_cert:
        name: very_ssl
        new_name: new_very_ssl
        state: present

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Jonathan I. Davila (@defionscode)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.