ec2_key - maintain an ec2 key pair.

Author:Vincent Viallet

Synopsis

New in version 1.5.

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

Options

parameter required default choices comments
aws_access_key no
    AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used.
    aws_secret_key no
      AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used.
      ec2_url no
        Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Must be specified 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 no
              uses a boto profile. Only works with boto >= 2.24.0 (added in Ansible 1.6)
              region no
                the EC2 region to use
                security_token no
                  security token to authenticate against AWS (added in Ansible 1.6)
                  state no present
                    create or delete keypair
                    validate_certs no yes
                    • yes
                    • no
                    When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. (added in Ansible 1.5)
                    wait no
                      Wait for the specified action to complete before returning. (added in Ansible 1.6)
                      wait_timeout no 300
                        How long before wait gives up, in seconds (added in Ansible 1.6)

                        Note

                        Requires boto

                        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
                          local_action:
                            module: ec2_key
                            name: example
                        
                        # Creates a new ec2 key pair named `example` if not present using provided key
                        # material
                        - name: example2 ec2 key
                          local_action:
                            module: 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
                          local_action:
                            module: 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
                          local_action:
                            module: ec2_key
                            name: example
                            state: absent

                        Note

                        The following environment variables can be used AWS_ACCESS_KEY or EC2_ACCESS_KEY or AWS_ACCESS_KEY_ID, AWS_SECRET_KEY or EC2_SECRET_KEY or AWS_SECRET_ACCESS_KEY, AWS_REGION or EC2_REGION, AWS_SECURITY_TOKEN

                        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

                        Table Of Contents

                        Previous topic

                        ec2_group - maintain an ec2 VPC security group.

                        Next topic

                        ec2_lc - Create or delete AWS Autoscaling Launch Configurations