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

Documentation

# efs – create and maintain EFS file systems

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Module allows create, search and destroy Amazon EFS file systems

## Requirements

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

- boto
- boto3
- 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
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.
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.
encrypt boolean added in 2.5 | Choices: no ← yes | A boolean value that, if true, creates an encrypted file system. This can not be modified after the file system is created.
id - |  | ID of Amazon EFS. Either name or ID required for delete.
kms_key_id - added in 2.5 |  | The id of the AWS KMS CMK that will be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. The key id can be Key ID, Key ID ARN, Key Alias or Key Alias ARN.
name - |  | Creation Token of Amazon EFS file system. Required for create and update. Either name or ID required for delete.
performance_mode - | Choices: general_purpose ← max_io | File system's performance mode to use. Only takes effect during creation.
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
provisioned_throughput_in_mibps float added in 2.8 |  | If the throughput_mode is provisioned, select the amount of throughput to provisioned in Mibps. Requires botocore >= 1.10.57
purge_tags boolean added in 2.5 | Choices: no yes ← | If yes, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified.
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 - | Choices: present ← absent | Allows to create, search and destroy Amazon EFS file system
tags - |  | List of tags of Amazon EFS. Should be defined as dictionary In case of 'present' state with list of tags and existing EFS (matched by 'name'), tags of EFS will be replaced with provided data.
targets - |  | List of mounted targets. It should be a list of dictionaries, every dictionary should include next attributes: - subnet_id - Mandatory. The ID of the subnet to add the mount target in. - ip_address - Optional. A valid IPv4 address within the address range of the specified subnet. - security_groups - Optional. List of security group IDs, of the form 'sg-xxxxxxxx'. These must be for the same VPC as subnet specified This data may be modified for existing EFS using state 'present' and new list of mount targets.
throughput_mode - added in 2.8 | Choices: bursting provisioned | The throughput_mode for the file system to be created. Requires botocore >= 1.10.57
validate_certs boolean | Choices: no yes ← | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
wait boolean | Choices: no ← yes | In case of 'present' state should wait for EFS 'available' life cycle state (of course, if current state not 'deleting' or 'deleted') In case of 'absent' state should wait for EFS 'deleted' life cycle state
wait_timeout - | Default: 0 | How long the module should wait (in seconds) for desired state before returning. Zero means wait as long as necessary.

## 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

    # EFS provisioning
    - efs:
        state: present
        name: myTestEFS
        tags:
            name: myTestNameTag
            purpose: file-storage
        targets:
            - subnet_id: subnet-748c5d03
              security_groups: [ "sg-1a2b3c4d" ]

    # Modifying EFS data
    - efs:
        state: present
        name: myTestEFS
        tags:
            name: myAnotherTestTag
        targets:
            - subnet_id: subnet-7654fdca
              security_groups: [ "sg-4c5d6f7a" ]

    # Deleting EFS
    - efs:
        state: absent
        name: myTestEFS

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
creation_time string | always | timestamp of creation date Sample: 2015-11-16 07:30:57-05:00
creation_token string | always | EFS creation token Sample: console-88609e04-9a0e-4a2e-912c-feaa99509961
file_system_id string | always | ID of the file system Sample: fs-xxxxxxxx
filesystem_address string | always | url of file system valid for use with mount Sample: fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/
life_cycle_state string | always | state of the EFS file system Sample: creating, available, deleting, deleted
mount_point string | always | url of file system with leading dot from the time when AWS EFS required to add a region suffix to the address Sample: .fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/
mount_targets list | always | list of mount targets Sample: [{'file_system_id': 'fs-a7ad440e', 'ip_address': '172.31.17.173', 'life_cycle_state': 'available', 'mount_target_id': 'fsmt-d8907871', 'network_interface_id': 'eni-6e387e26', 'owner_id': '740748460359', 'security_groups': ['sg-a30b22c6'], 'subnet_id': 'subnet-e265c895'}, '...']
name string | always | name of the file system Sample: my-efs
number_of_mount_targets integer | always | the number of targets mounted Sample: 3
owner_id string | always | AWS account ID of EFS owner Sample: XXXXXXXXXXXX
performance_mode string | always | performance mode of the file system Sample: generalPurpose
size_in_bytes dictionary | always | size of the file system in bytes as of a timestamp Sample: {'timestamp': '2015-12-21 13:59:59-05:00', 'value': 12288}
tags dictionary | always | tags on the efs instance Sample: {'name': 'my-efs', 'key': 'Value'}

## Status

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

### Authors

- Ryan Sydnor (@ryansydnor)
- Artem Kazakov (@akazakov)

Hint

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