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
ec2_access_key no
    EC2 access key
    ec2_secret_key no
      EC2 secret key
      ec2_url no
        Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints)
        key_material no
          Public key material.
          name yes
            Name of the key pair.
            region no
              the EC2 region to use
              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)

                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
                

                Table Of Contents

                Previous topic

                ec2_group - maintain an ec2 VPC security group.

                Next topic

                ec2_snapshot - creates a snapshot from an existing volume