Documentation

iam_cert - Manage server certificates for use on ELBs and CloudFront

New in version 2.0.

Synopsis

Allows for the management of server certificates

Requirements (on host that executes module)

  • boto
  • python >= 2.6

Options

parameter required default choices comments
aws_access_key
 no
    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
    		 no
      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
      		 no
        The path to the certificate body in PEM encoded format.
        cert_chain
        		 no
          The path to the CA certificate chain in PEM encoded format.
          dup_ok
          		 no
            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
            		 no
              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
              		 no
                The path to the private key of the certificate in PEM encoded format.
                name
                		 yes
                  Name of certificate to add, update or remove.
                  new_name
                  		 no
                    When present, this will update the name of the cert with the value passed here.
                    new_path
                    		 no
                      When present, this will update the path of the cert with the value passed here.
                      path
                      		 no /
                        When creating or updating, specify the desired path of the certificate
                        profile
                        (added in 1.6)
                        		 no
                          uses a boto profile. Only works with boto >= 2.24.0
                          region
                          		 no
                            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
                            (added in 1.6)
                            		 no
                              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
                              		 yes
                              • present
                              • absent
                              Whether to create, delete certificate. When present is specified it will attempt to make an update if new_path or new_name is specified.
                              validate_certs
                              (added in 1.5)
                              		 no yes
                              • yes
                              • no
                              When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

                              Examples

                              # Basic server certificate upload
tasks:
- name: Upload Certificate
  iam_cert:
    name: very_ssl
    state: present
    cert: somecert.pem
    key: privcertkey
    cert_chain: myverytrustedchain

                              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

                              Note

                              Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html

                              Note

                              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

                              This is a Core Module

                              For more information on what this means please read Core Modules

                              For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.