community / community.aws / 5.1.0 / module / efs create and maintain EFS file systems | "added in version" 1.0.0 of community.aws" Authors: Ryan Sydnor (@ryansydnor), Artem Kazakov (@akazakov)community.aws.efs (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Module allows create, search and destroy Amazon EFS file systems.
- name: EFS provisioning community.aws.efs: state: present name: myTestEFS tags: Name: myTestNameTag purpose: file-storage targets: - subnet_id: subnet-748c5d03 security_groups: [ "sg-1a2b3c4d" ]
- name: Modifying EFS data community.aws.efs: state: present name: myTestEFS tags: name: myAnotherTestTag targets: - subnet_id: subnet-7654fdca security_groups: [ "sg-4c5d6f7a" ]
- name: Set a lifecycle policy community.aws.efs: state: present name: myTestEFS transition_to_ia: 7 targets: - subnet_id: subnet-7654fdca security_groups: [ "sg-4c5d6f7a" ]
- name: Remove a lifecycle policy community.aws.efs: state: present name: myTestEFS transition_to_ia: None targets: - subnet_id: subnet-7654fdca security_groups: [ "sg-4c5d6f7a" ]
- name: Deleting EFS community.aws.efs: state: absent name: myTestEFS
id: description: - ID of Amazon EFS. Either name or ID required for delete. type: str name: description: - Creation Token of Amazon EFS file system. Required for create and update. Either name or ID required for delete. type: str tags: aliases: - resource_tags description: - 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. required: false type: dict wait: default: false description: - 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 type: bool state: choices: - present - absent default: present description: - Allows to create, search and destroy Amazon EFS file system. type: str region: aliases: - aws_region - ec2_region description: - The AWS region to use. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str encrypt: default: false description: - If I(encrypt=true) creates an encrypted file system. This can not be modified after the file system is created. type: bool profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str targets: default: [] description: - 'List of mounted targets. It should be a list of dictionaries, every dictionary should include next attributes: This data may be modified for existing EFS using state ''present'' and new list of mount targets.' elements: dict suboptions: ip_address: description: A valid IPv4 address within the address range of the specified subnet. type: str security_groups: description: List of security group IDs, of the form 'sg-xxxxxxxx'. These must be for the same VPC as subnet specified elements: str type: list subnet_id: description: The ID of the subnet to add the mount target in. required: true type: list access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict kms_key_id: description: - 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. type: str purge_tags: default: true description: - If I(purge_tags=true) and I(tags) is set, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. - If the I(tags) parameter is not set then tags will not be modified, even if I(purge_tags=True). - Tag keys beginning with C(aws:) are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the I(purge_tags) parameter. See the Amazon documentation for more information U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions). required: false type: bool secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. - The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str wait_timeout: default: 0 description: - How long the module should wait (in seconds) for desired state before returning. Zero means wait as long as necessary. type: int aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool throughput_mode: choices: - bursting - provisioned description: - The throughput_mode for the file system to be created. type: str performance_mode: choices: - general_purpose - max_io default: general_purpose description: - File system's performance mode to use. Only takes effect during creation. type: str transition_to_ia: choices: - None - '7' - '14' - '30' - '60' - '90' description: - How many days before objects transition to the lower-cost EFS Infrequent Access (IA) storage class. - If set to the string C(None), any existing lifecyle policy will be removed, and objects will not transition to an IA storage class. - If this parameter is absent, any existing lifecycle policy will not be affected. type: str version_added: 2.1.0 version_added_collection: community.aws debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used. type: bool provisioned_throughput_in_mibps: description: - If the throughput_mode is provisioned, select the amount of throughput to provisioned in Mibps. type: float
creation_time: description: timestamp of creation date returned: always sample: '2015-11-16 07:30:57-05:00' type: str creation_token: description: EFS creation token returned: always sample: console-88609e04-9a0e-4a2e-912c-feaa99509961 type: str file_system_id: description: ID of the file system returned: always sample: fs-xxxxxxxx type: str filesystem_address: description: url of file system valid for use with mount returned: always sample: fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/ type: str life_cycle_state: description: state of the EFS file system returned: always sample: creating, available, deleting, deleted type: str mount_point: description: url of file system with leading dot from the time when AWS EFS required to add a region suffix to the address returned: always sample: .fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/ type: str mount_targets: description: list of mount targets returned: always 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: '123456789012' security_groups: - sg-a30b22c6 subnet_id: subnet-e265c895 - '...' type: list name: description: name of the file system returned: always sample: my-efs type: str number_of_mount_targets: description: the number of targets mounted returned: always sample: 3 type: int owner_id: description: AWS account ID of EFS owner returned: always sample: XXXXXXXXXXXX type: str performance_mode: description: performance mode of the file system returned: always sample: generalPurpose type: str size_in_bytes: description: size of the file system in bytes as of a timestamp returned: always sample: timestamp: '2015-12-21 13:59:59-05:00' value: 12288 type: dict tags: description: tags on the efs instance returned: always sample: key: Value name: my-efs type: dict