mount_targets

Creates, updates, deletes or gets a mount_target resource or lists mount_targets in a region

Overview

Name	mount_targets
Type	Resource
Description	The AWS::EFS::MountTarget resource is an Amazon EFS resource that creates a mount target for an EFS file system. You can then mount the file system on Amazon EC2 instances or other resources by using the mount target.
Id	aws.efs.mount_targets

Fields

Name	Datatype	Description
id	string
ip_address	string	Valid IPv4 address within the address range of the specified subnet.
file_system_id	string	The ID of the file system for which to create the mount target.
security_groups	array	Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified.
subnet_id	string	The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	FileSystemId, SecurityGroups, SubnetId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all mount_targets in a region.

SELECT
region,
id,
ip_address,
file_system_id,
security_groups,
subnet_id
FROM aws.efs.mount_targets
WHERE region = 'us-east-1';

Gets all properties from an individual mount_target.

SELECT
region,
id,
ip_address,
file_system_id,
security_groups,
subnet_id
FROM aws.efs.mount_targets
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new mount_target resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.efs.mount_targets (
 FileSystemId,
 SecurityGroups,
 SubnetId,
 region
)
SELECT 
'{{ FileSystemId }}',
 '{{ SecurityGroups }}',
 '{{ SubnetId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.efs.mount_targets (
 IpAddress,
 FileSystemId,
 SecurityGroups,
 SubnetId,
 region
)
SELECT 
 '{{ IpAddress }}',
 '{{ FileSystemId }}',
 '{{ SecurityGroups }}',
 '{{ SubnetId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: mount_target
    props:
      - name: IpAddress
        value: '{{ IpAddress }}'
      - name: FileSystemId
        value: '{{ FileSystemId }}'
      - name: SecurityGroups
        value:
          - '{{ SecurityGroups[0] }}'
      - name: SubnetId
        value: '{{ SubnetId }}'

DELETE example

/*+ delete */
DELETE FROM aws.efs.mount_targets
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the mount_targets resource, the following permissions are required:

Create

elasticfilesystem:CreateMountTarget,
elasticfilesystem:DescribeMountTargets

Read

elasticfilesystem:DescribeMountTargets,
elasticfilesystem:DescribeMountTargetSecurityGroups

Update

elasticfilesystem:DescribeMountTargets,
elasticfilesystem:DescribeMountTargetSecurityGroups,
elasticfilesystem:ModifyMountTargetSecurityGroups

Delete

elasticfilesystem:DescribeMountTargets,
elasticfilesystem:DeleteMountTarget

List

elasticfilesystem:DescribeMountTargets,
elasticfilesystem:DescribeMountTargetSecurityGroups