mount_targets

Creates, updates, deletes, gets or lists a mount_targets resource.

Overview

Name	mount_targets
Type	Resource
Id	aws.s3files.mount_targets

Fields

The following fields are returned by SELECT queries:

get_mount_target

Name	Datatype	Description
availability_zone_id	string	The Availability Zone ID where the mount target is located.
file_system_id	string	The ID of the file system. (pattern: <code>(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})</code>)
ipv_4_address	string	The IPv4 address of the mount target. (pattern: <code>[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}</code>)
ipv_6_address	string	The IPv6 address of the mount target.
mount_target_id	string	The ID of the mount target. (pattern: <code>fsmt-[0-9a-f]{17,40}</code>)
network_interface_id	string	The ID of the network interface associated with the mount target.
owner_id	string	The Amazon Web Services account ID of the mount target owner. (pattern: <code>(\d{12})|(\d{4}-{4}-\d{4})</code>)
security_groups	array	The security groups associated with the mount target.
status	string	The current status of the mount target. (available, creating, deleting, deleted, error, updating)
status_message	string	Additional information about the mount target status.
subnet_id	string	The ID of the subnet where the mount target is located. (pattern: <code>subnet-[0-9a-f]{8,40}</code>)
vpc_id	string	The ID of the VPC where the mount target is located.

list_mount_targets

Name	Datatype	Description
availability_zone_id	string	The Availability Zone ID where the mount target is located.
file_system_id	string	The ID of the S3 File System. (pattern: <code>(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})</code>)
ipv_4_address	string	The IPv4 address of the mount target. (pattern: <code>[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}</code>)
ipv_6_address	string	The IPv6 address of the mount target.
mount_target_id	string	The ID of the mount target. (pattern: <code>fsmt-[0-9a-f]{17,40}</code>)
network_interface_id	string	The ID of the network interface associated with the mount target.
owner_id	string	The Amazon Web Services account ID of the mount target owner. (pattern: <code>(\d{12})|(\d{4}-{4}-\d{4})</code>)
status	string	The current status of the mount target. (available, creating, deleting, deleted, error, updating)
status_message	string	Additional information about the mount target status.
subnet_id	string	The ID of the subnet where the mount target is located. (pattern: <code>subnet-[0-9a-f]{8,40}</code>)
vpc_id	string	The ID of the VPC where the mount target is located.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_mount_target	select	mount_target_id, region		Returns detailed resource information for the specified mount target including network configuration.
list_mount_targets	select	region	fileSystemId, accessPointId, maxResults, nextToken	Returns resource information for all mount targets with optional filtering by file system, access point, and VPC.
create_mount_target	insert	region, fileSystemId, subnetId		Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in a specific Availability Zone and VPC. Mount targets provide network access to the file system.
update_mount_target	update	mount_target_id, region, securityGroups		Updates the mount target resource, specifically security group configurations.
delete_mount_target	delete	mount_target_id, region		Deletes the specified mount target. This operation is irreversible.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
mount_target_id	string	The ID of the mount target to delete.
region	string	AWS region (default: us-east-1)
accessPointId	string	Optional filter to list only mount targets associated with the specified access point ID or Amazon Resource Name (ARN).
fileSystemId	string	Optional filter to list only mount targets associated with the specified S3 File System ID or Amazon Resource Name (ARN). If provided, only mount targets for this file system will be returned in the response.
maxResults	integer	The maximum number of mount targets to return in a single response.
nextToken	string	A pagination token returned from a previous call to continue listing mount targets.

SELECT examples

get_mount_target

Returns detailed resource information for the specified mount target including network configuration.

SELECT
availability_zone_id,
file_system_id,
ipv_4_address,
ipv_6_address,
mount_target_id,
network_interface_id,
owner_id,
security_groups,
status,
status_message,
subnet_id,
vpc_id
FROM aws.s3files.mount_targets
WHERE mount_target_id = '{{ mount_target_id }}' -- required
AND region = '{{ region }}' -- required
;

list_mount_targets

Returns resource information for all mount targets with optional filtering by file system, access point, and VPC.

SELECT
availability_zone_id,
file_system_id,
ipv_4_address,
ipv_6_address,
mount_target_id,
network_interface_id,
owner_id,
status,
status_message,
subnet_id,
vpc_id
FROM aws.s3files.mount_targets
WHERE region = '{{ region }}' -- required
AND fileSystemId = '{{ fileSystemId }}'
AND accessPointId = '{{ accessPointId }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_mount_target

Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in a specific Availability Zone and VPC. Mount targets provide network access to the file system.

INSERT INTO aws.s3files.mount_targets (
fileSystemId,
subnetId,
ipv4Address,
ipv6Address,
ipAddressType,
securityGroups,
region
)
SELECT 
'{{ fileSystemId }}' /* required */,
'{{ subnetId }}' /* required */,
'{{ ipv4Address }}',
'{{ ipv6Address }}',
'{{ ipAddressType }}',
'{{ securityGroups }}',
'{{ region }}'
RETURNING
availability_zone_id,
file_system_id,
ipv_4_address,
ipv_6_address,
mount_target_id,
network_interface_id,
owner_id,
security_groups,
status,
status_message,
subnet_id,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: mount_targets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the mount_targets resource.
  - name: fileSystemId
    value: "{{ fileSystemId }}"
  - name: subnetId
    value: "{{ subnetId }}"
  - name: ipv4Address
    value: "{{ ipv4Address }}"
  - name: ipv6Address
    value: "{{ ipv6Address }}"
  - name: ipAddressType
    value: "{{ ipAddressType }}"
    valid_values: ['IPV4_ONLY', 'IPV6_ONLY', 'DUAL_STACK']
  - name: securityGroups
    value:
      - "{{ securityGroups }}"

UPDATE examples

update_mount_target

Updates the mount target resource, specifically security group configurations.

UPDATE aws.s3files.mount_targets
SET 
securityGroups = '{{ securityGroups }}'
WHERE 
mount_target_id = '{{ mount_target_id }}' --required
AND region = '{{ region }}' --required
AND securityGroups = '{{ securityGroups }}' --required
RETURNING
availability_zone_id,
file_system_id,
ipv_4_address,
ipv_6_address,
mount_target_id,
network_interface_id,
owner_id,
security_groups,
status,
status_message,
subnet_id,
vpc_id;

DELETE examples

delete_mount_target

Deletes the specified mount target. This operation is irreversible.

DELETE FROM aws.s3files.mount_targets
WHERE mount_target_id = '{{ mount_target_id }}' --required
AND region = '{{ region }}' --required
;