Documentation

ec2_key - maintain an ec2 key pair.

New in version 1.5.

Synopsis

maintains ec2 key pairs. This module has a dependency on python-boto >= 2.5

Requirements (on host that executes module)

  • python >= 2.6
  • boto

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
      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_material
        no
          Public key material.
          name
          yes
            Name of the key pair.
            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
                  no present
                    create or delete keypair
                    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.
                    wait
                    (added in 1.6)
                    no
                      Wait for the specified action to complete before returning.
                      wait_timeout
                      (added in 1.6)
                      no 300
                        How long before wait gives up, in seconds

                        Examples

                        # Note: None of these examples set aws_access_key, aws_secret_key, or region.
                        # It is assumed that their matching environment variables are set.
                        
                        # Creates a new ec2 key pair named `example` if not present, returns generated
                        # private key
                        - name: example ec2 key
                          ec2_key:
                            name: example
                        
                        # Creates a new ec2 key pair named `example` if not present using provided key
                        # material.  This could use the 'file' lookup plugin to pull this off disk.
                        - name: example2 ec2 key
                          ec2_key:
                            name: example2
                            key_material: 'ssh-rsa AAAAxyz...== me@example.com'
                            state: present
                        
                        # Creates a new ec2 key pair named `example` if not present using provided key
                        # material
                        - name: example3 ec2 key
                          ec2_key:
                            name: example3
                            key_material: "{{ item }}"
                          with_file: /path/to/public_key.id_rsa.pub
                        
                        # Removes ec2 key pair by name
                        - name: remove example key
                          ec2_key:
                            name: example
                            state: absent
                        

                        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.