Current section

Files

Jump to
aws lib aws generated efs.ex
Raw

lib/aws/generated/efs.ex

# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.EFS do
@moduledoc """
Amazon Elastic File System
Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage
for use with Amazon EC2 instances in the AWS Cloud.
With Amazon EFS, storage capacity is elastic, growing and shrinking
automatically as you add and remove files, so your applications have the storage
they need, when they need it. For more information, see the [Amazon Elastic File System API
Reference](https://docs.aws.amazon.com/efs/latest/ug/api-reference.html) and the
[Amazon Elastic File System User Guide](https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html).
"""
alias AWS.Client
alias AWS.Request
def metadata do
%AWS.ServiceMetadata{
abbreviation: nil,
api_version: "2015-02-01",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "elasticfilesystem",
global?: false,
protocol: "rest-json",
service_id: "EFS",
signature_version: "v4",
signing_name: "elasticfilesystem",
target_prefix: nil
}
end
@doc """
Creates an EFS access point.
An access point is an application-specific view into an EFS file system that
applies an operating system user and group, and a file system path, to any file
system request made through the access point. The operating system user and
group override any identity information provided by the NFS client. The file
system path is exposed as the access point's root directory. Applications using
the access point can only access data in its own directory and below. To learn
more, see [Mounting a file system using EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html).
This operation requires permissions for the
`elasticfilesystem:CreateAccessPoint` action.
"""
def create_access_point(%Client{} = client, input, options \\ []) do
url_path = "/2015-02-01/access-points"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Creates a new, empty file system.
The operation requires a creation token in the request that Amazon EFS uses to
ensure idempotent creation (calling the operation with same creation token has
no effect). If a file system does not currently exist that is owned by the
caller's AWS account with the specified creation token, this operation does the
following:
* Creates a new, empty file system. The file system will have an
Amazon EFS assigned ID, and an initial lifecycle state `creating`.
* Returns with the description of the created file system.
Otherwise, this operation returns a `FileSystemAlreadyExists` error with the ID
of the existing file system.
For basic use cases, you can use a randomly generated UUID for the creation
token.
The idempotent operation allows you to retry a `CreateFileSystem` call without
risk of creating an extra file system. This can happen when an initial call
fails in a way that leaves it uncertain whether or not a file system was
actually created. An example might be that a transport level timeout occurred or
your connection was reset. As long as you use the same creation token, if the
initial call had succeeded in creating a file system, the client can learn of
its existence from the `FileSystemAlreadyExists` error.
For more information, see [Creating a file system](https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1)
in the *Amazon EFS User Guide*.
The `CreateFileSystem` call returns while the file system's lifecycle state is
still `creating`. You can check the file system creation status by calling the
`DescribeFileSystems` operation, which among other things returns the file
system state.
This operation accepts an optional `PerformanceMode` parameter that you choose
for your file system. We recommend `generalPurpose` performance mode for most
file systems. File systems using the `maxIO` performance mode can scale to
higher levels of aggregate throughput and operations per second with a tradeoff
of slightly higher latencies for most file operations. The performance mode
can't be changed after the file system has been created. For more information,
see [Amazon EFS performance modes](https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html).
You can set the throughput mode for the file system using the `ThroughputMode`
parameter.
After the file system is fully created, Amazon EFS sets its lifecycle state to
`available`, at which point you can create one or more mount targets for the
file system in your VPC. For more information, see `CreateMountTarget`. You
mount your Amazon EFS file system on an EC2 instances in your VPC by using the
mount target. For more information, see [Amazon EFS: How it Works](https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).
This operation requires permissions for the `elasticfilesystem:CreateFileSystem`
action.
"""
def create_file_system(%Client{} = client, input, options \\ []) do
url_path = "/2015-02-01/file-systems"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:post,
url_path,
query_params,
headers,
input,
options,
201
)
end
@doc """
Creates a mount target for a file system.
You can then mount the file system on EC2 instances by using the mount target.
You can create one mount target in each Availability Zone in your VPC. All EC2
instances in a VPC within a given Availability Zone share a single mount target
for a given file system. If you have multiple subnets in an Availability Zone,
you create a mount target in one of the subnets. EC2 instances do not need to be
in the same subnet as the mount target in order to access their file system.
You can create only one mount target for an EFS file system using One Zone
storage classes. You must create that mount target in the same Availability Zone
in which the file system is located. Use the `AvailabilityZoneName` and
`AvailabiltyZoneId` properties in the `DescribeFileSystems` response object to
get this information. Use the `subnetId` associated with the file system's
Availability Zone when creating the mount target.
For more information, see [Amazon EFS: How it Works](https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html).
To create a mount target for a file system, the file system's lifecycle state
must be `available`. For more information, see `DescribeFileSystems`.
In the request, provide the following:
* The file system ID for which you are creating the mount target.
* A subnet ID, which determines the following:
* The VPC in which Amazon EFS creates the mount target
* The Availability Zone in which Amazon EFS creates the
mount target
* The IP address range from which Amazon EFS selects the
IP address of the mount target (if you don't specify an IP address in the
request)
After creating the mount target, Amazon EFS returns a response that includes, a
`MountTargetId` and an `IpAddress`. You use this IP address when mounting the
file system in an EC2 instance. You can also use the mount target's DNS name
when mounting the file system. The EC2 instance on which you mount the file
system by using the mount target can resolve the mount target's DNS name to its
IP address. For more information, see [How it Works: Implementation Overview](https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation).
Note that you can create mount targets for a file system in only one VPC, and
there can be only one mount target per Availability Zone. That is, if the file
system already has one or more mount targets created for it, the subnet
specified in the request to add another mount target must meet the following
requirements:
* Must belong to the same VPC as the subnets of the existing mount
targets
* Must not be in the same Availability Zone as any of the subnets of
the existing mount targets
If the request satisfies the requirements, Amazon EFS does the following:
* Creates a new mount target in the specified subnet.
* Also creates a new network interface in the subnet as follows:
* If the request provides an `IpAddress`, Amazon EFS
assigns that IP address to the network interface. Otherwise, Amazon EFS assigns
a free address in the subnet (in the same way that the Amazon EC2
`CreateNetworkInterface` call does when a request does not specify a primary
private IP address).
* If the request provides `SecurityGroups`, this network
interface is associated with those security groups. Otherwise, it belongs to the
default security group for the subnet's VPC.
* Assigns the description `Mount target *fsmt-id* for
file system *fs-id* ` where ` *fsmt-id* ` is the mount target ID, and ` *fs-id*
` is the `FileSystemId`.
* Sets the `requesterManaged` property of the network
interface to `true`, and the `requesterId` value to `EFS`.
Each Amazon EFS mount target has one corresponding requester-managed EC2 network
interface. After the network interface is created, Amazon EFS sets the
`NetworkInterfaceId` field in the mount target's description to the network
interface ID, and the `IpAddress` field to its address. If network interface
creation fails, the entire `CreateMountTarget` operation fails.
The `CreateMountTarget` call returns only after creating the network interface,
but while the mount target state is still `creating`, you can check the mount
target creation status by calling the `DescribeMountTargets` operation, which
among other things returns the mount target state.
We recommend that you create a mount target in each of the Availability Zones.
There are cost considerations for using a file system in an Availability Zone
through a mount target created in another Availability Zone. For more
information, see [Amazon EFS](http://aws.amazon.com/efs/). In addition, by
always using a mount target local to the instance's Availability Zone, you
eliminate a partial failure scenario. If the Availability Zone in which your
mount target is created goes down, then you can't access your file system
through that mount target.
This operation requires permissions for the following action on the file system:
* `elasticfilesystem:CreateMountTarget`
This operation also requires permissions for the following Amazon EC2 actions:
* `ec2:DescribeSubnets`
* `ec2:DescribeNetworkInterfaces`
* `ec2:CreateNetworkInterface`
"""
def create_mount_target(%Client{} = client, input, options \\ []) do
url_path = "/2015-02-01/mount-targets"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
DEPRECATED - CreateTags is deprecated and not maintained.
Please use the API action to create tags for EFS resources.
Creates or overwrites tags associated with a file system. Each tag is a
key-value pair. If a tag key specified in the request already exists on the file
system, this operation overwrites its value with the value provided in the
request. If you add the `Name` tag to your file system, Amazon EFS returns it in
the response to the `DescribeFileSystems` operation.
This operation requires permission for the `elasticfilesystem:CreateTags`
action.
"""
def create_tags(%Client{} = client, file_system_id, input, options \\ []) do
url_path = "/2015-02-01/create-tags/#{AWS.Util.encode_uri(file_system_id)}"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:post,
url_path,
query_params,
headers,
input,
options,
204
)
end
@doc """
Deletes the specified access point.
After deletion is complete, new clients can no longer connect to the access
points. Clients connected to the access point at the time of deletion will
continue to function until they terminate their connection.
This operation requires permissions for the
`elasticfilesystem:DeleteAccessPoint` action.
"""
def delete_access_point(%Client{} = client, access_point_id, input, options \\ []) do
url_path = "/2015-02-01/access-points/#{AWS.Util.encode_uri(access_point_id)}"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:delete,
url_path,
query_params,
headers,
input,
options,
204
)
end
@doc """
Deletes a file system, permanently severing access to its contents.
Upon return, the file system no longer exists and you can't access any contents
of the deleted file system.
You can't delete a file system that is in use. That is, if the file system has
any mount targets, you must first delete them. For more information, see
`DescribeMountTargets` and `DeleteMountTarget`.
The `DeleteFileSystem` call returns while the file system state is still
`deleting`. You can check the file system deletion status by calling the
`DescribeFileSystems` operation, which returns a list of file systems in your
account. If you pass file system ID or creation token for the deleted file
system, the `DescribeFileSystems` returns a `404 FileSystemNotFound` error.
This operation requires permissions for the `elasticfilesystem:DeleteFileSystem`
action.
"""
def delete_file_system(%Client{} = client, file_system_id, input, options \\ []) do
url_path = "/2015-02-01/file-systems/#{AWS.Util.encode_uri(file_system_id)}"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:delete,
url_path,
query_params,
headers,
input,
options,
204
)
end
@doc """
Deletes the `FileSystemPolicy` for the specified file system.
The default `FileSystemPolicy` goes into effect once the existing policy is
deleted. For more information about the default file system policy, see [Using Resource-based Policies with
EFS](https://docs.aws.amazon.com/efs/latest/ug/res-based-policies-efs.html).
This operation requires permissions for the
`elasticfilesystem:DeleteFileSystemPolicy` action.
"""
def delete_file_system_policy(%Client{} = client, file_system_id, input, options \\ []) do
url_path = "/2015-02-01/file-systems/#{AWS.Util.encode_uri(file_system_id)}/policy"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:delete,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Deletes the specified mount target.
This operation forcibly breaks any mounts of the file system by using the mount
target that is being deleted, which might disrupt instances or applications
using those mounts. To avoid applications getting cut off abruptly, you might
consider unmounting any mounts of the mount target, if feasible. The operation
also deletes the associated network interface. Uncommitted writes might be lost,
but breaking a mount target using this operation does not corrupt the file
system itself. The file system you created remains. You can mount an EC2
instance in your VPC by using another mount target.
This operation requires permissions for the following action on the file system:
* `elasticfilesystem:DeleteMountTarget`
The `DeleteMountTarget` call returns while the mount target state is still
`deleting`. You can check the mount target deletion by calling the
`DescribeMountTargets` operation, which returns a list of mount target
descriptions for the given file system.
The operation also requires permissions for the following Amazon EC2 action on
the mount target's network interface:
* `ec2:DeleteNetworkInterface`
"""
def delete_mount_target(%Client{} = client, mount_target_id, input, options \\ []) do
url_path = "/2015-02-01/mount-targets/#{AWS.Util.encode_uri(mount_target_id)}"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:delete,
url_path,
query_params,
headers,
input,
options,
204
)
end
@doc """
DEPRECATED - DeleteTags is deprecated and not maintained.
Please use the API action to remove tags from EFS resources.
Deletes the specified tags from a file system. If the `DeleteTags` request
includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause
an error. For more information about tags and related restrictions, see [Tag Restrictions](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
in the *AWS Billing and Cost Management User Guide*.
This operation requires permissions for the `elasticfilesystem:DeleteTags`
action.
"""
def delete_tags(%Client{} = client, file_system_id, input, options \\ []) do
url_path = "/2015-02-01/delete-tags/#{AWS.Util.encode_uri(file_system_id)}"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:post,
url_path,
query_params,
headers,
input,
options,
204
)
end
@doc """
Returns the description of a specific Amazon EFS access point if the
`AccessPointId` is provided.
If you provide an EFS `FileSystemId`, it returns descriptions of all access
points for that file system. You can provide either an `AccessPointId` or a
`FileSystemId` in the request, but not both.
This operation requires permissions for the
`elasticfilesystem:DescribeAccessPoints` action.
"""
def describe_access_points(
%Client{} = client,
access_point_id \\ nil,
file_system_id \\ nil,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/2015-02-01/access-points"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"MaxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(file_system_id) do
[{"FileSystemId", file_system_id} | query_params]
else
query_params
end
query_params =
if !is_nil(access_point_id) do
[{"AccessPointId", access_point_id} | query_params]
else
query_params
end
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
200
)
end
def describe_account_preferences(%Client{} = client, options \\ []) do
url_path = "/2015-02-01/account-preferences"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
200
)
end
@doc """
Returns the backup policy for the specified EFS file system.
"""
def describe_backup_policy(%Client{} = client, file_system_id, options \\ []) do
url_path = "/2015-02-01/file-systems/#{AWS.Util.encode_uri(file_system_id)}/backup-policy"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
200
)
end
@doc """
Returns the `FileSystemPolicy` for the specified EFS file system.
This operation requires permissions for the
`elasticfilesystem:DescribeFileSystemPolicy` action.
"""
def describe_file_system_policy(%Client{} = client, file_system_id, options \\ []) do
url_path = "/2015-02-01/file-systems/#{AWS.Util.encode_uri(file_system_id)}/policy"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
200
)
end
@doc """
Returns the description of a specific Amazon EFS file system if either the file
system `CreationToken` or the `FileSystemId` is provided.
Otherwise, it returns descriptions of all file systems owned by the caller's AWS
account in the AWS Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the
`MaxItems` parameter to limit the number of descriptions in a response.
Currently, this number is automatically set to 10. If more file system
descriptions remain, Amazon EFS returns a `NextMarker`, an opaque token, in the
response. In this case, you should send a subsequent request with the `Marker`
request parameter set to the value of `NextMarker`.
To retrieve a list of your file system descriptions, this operation is used in
an iterative process, where `DescribeFileSystems` is called first without the
`Marker` and then the operation continues to call it with the `Marker` parameter
set to the value of the `NextMarker` from the previous response until the
response has no `NextMarker`.
The order of file systems returned in the response of one `DescribeFileSystems`
call and the order of file systems returned across the responses of a multi-call
iteration is unspecified.
This operation requires permissions for the
`elasticfilesystem:DescribeFileSystems` action.
"""
def describe_file_systems(
%Client{} = client,
creation_token \\ nil,
file_system_id \\ nil,
marker \\ nil,
max_items \\ nil,
options \\ []
) do
url_path = "/2015-02-01/file-systems"
headers = []
query_params = []
query_params =
if !is_nil(max_items) do
[{"MaxItems", max_items} | query_params]
else
query_params
end
query_params =
if !is_nil(marker) do
[{"Marker", marker} | query_params]
else
query_params
end
query_params =
if !is_nil(file_system_id) do
[{"FileSystemId", file_system_id} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_token) do
[{"CreationToken", creation_token} | query_params]
else
query_params
end
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
200
)
end
@doc """
Returns the current `LifecycleConfiguration` object for the specified Amazon EFS
file system.
EFS lifecycle management uses the `LifecycleConfiguration` object to identify
which files to move to the EFS Infrequent Access (IA) storage class. For a file
system without a `LifecycleConfiguration` object, the call returns an empty
array in the response.
This operation requires permissions for the
`elasticfilesystem:DescribeLifecycleConfiguration` operation.
"""
def describe_lifecycle_configuration(%Client{} = client, file_system_id, options \\ []) do
url_path =
"/2015-02-01/file-systems/#{AWS.Util.encode_uri(file_system_id)}/lifecycle-configuration"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
200
)
end
@doc """
Returns the security groups currently in effect for a mount target.
This operation requires that the network interface of the mount target has been
created and the lifecycle state of the mount target is not `deleted`.
This operation requires permissions for the following actions:
* `elasticfilesystem:DescribeMountTargetSecurityGroups` action on
the mount target's file system.
* `ec2:DescribeNetworkInterfaceAttribute` action on the mount
target's network interface.
"""
def describe_mount_target_security_groups(%Client{} = client, mount_target_id, options \\ []) do
url_path = "/2015-02-01/mount-targets/#{AWS.Util.encode_uri(mount_target_id)}/security-groups"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
200
)
end
@doc """
Returns the descriptions of all the current mount targets, or a specific mount
target, for a file system.
When requesting all of the current mount targets, the order of mount targets
returned in the response is unspecified.
This operation requires permissions for the
`elasticfilesystem:DescribeMountTargets` action, on either the file system ID
that you specify in `FileSystemId`, or on the file system of the mount target
that you specify in `MountTargetId`.
"""
def describe_mount_targets(
%Client{} = client,
access_point_id \\ nil,
file_system_id \\ nil,
marker \\ nil,
max_items \\ nil,
mount_target_id \\ nil,
options \\ []
) do
url_path = "/2015-02-01/mount-targets"
headers = []
query_params = []
query_params =
if !is_nil(mount_target_id) do
[{"MountTargetId", mount_target_id} | query_params]
else
query_params
end
query_params =
if !is_nil(max_items) do
[{"MaxItems", max_items} | query_params]
else
query_params
end
query_params =
if !is_nil(marker) do
[{"Marker", marker} | query_params]
else
query_params
end
query_params =
if !is_nil(file_system_id) do
[{"FileSystemId", file_system_id} | query_params]
else
query_params
end
query_params =
if !is_nil(access_point_id) do
[{"AccessPointId", access_point_id} | query_params]
else
query_params
end
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
200
)
end
@doc """
DEPRECATED - The DeleteTags action is deprecated and not maintained.
Please use the API action to remove tags from EFS resources.
Returns the tags associated with a file system. The order of tags returned in
the response of one `DescribeTags` call and the order of tags returned across
the responses of a multiple-call iteration (when using pagination) is
unspecified.
This operation requires permissions for the `elasticfilesystem:DescribeTags`
action.
"""
def describe_tags(
%Client{} = client,
file_system_id,
marker \\ nil,
max_items \\ nil,
options \\ []
) do
url_path = "/2015-02-01/tags/#{AWS.Util.encode_uri(file_system_id)}/"
headers = []
query_params = []
query_params =
if !is_nil(max_items) do
[{"MaxItems", max_items} | query_params]
else
query_params
end
query_params =
if !is_nil(marker) do
[{"Marker", marker} | query_params]
else
query_params
end
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
200
)
end
@doc """
Lists all tags for a top-level EFS resource.
You must provide the ID of the resource that you want to retrieve the tags for.
This operation requires permissions for the
`elasticfilesystem:DescribeAccessPoints` action.
"""
def list_tags_for_resource(
%Client{} = client,
resource_id,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/2015-02-01/resource-tags/#{AWS.Util.encode_uri(resource_id)}"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"MaxResults", max_results} | query_params]
else
query_params
end
Request.request_rest(
client,
metadata(),
:get,
url_path,
query_params,
headers,
nil,
options,
200
)
end
@doc """
Modifies the set of security groups in effect for a mount target.
When you create a mount target, Amazon EFS also creates a new network interface.
For more information, see `CreateMountTarget`. This operation replaces the
security groups in effect for the network interface associated with a mount
target, with the `SecurityGroups` provided in the request. This operation
requires that the network interface of the mount target has been created and the
lifecycle state of the mount target is not `deleted`.
The operation requires permissions for the following actions:
* `elasticfilesystem:ModifyMountTargetSecurityGroups` action on the
mount target's file system.
* `ec2:ModifyNetworkInterfaceAttribute` action on the mount target's
network interface.
"""
def modify_mount_target_security_groups(
%Client{} = client,
mount_target_id,
input,
options \\ []
) do
url_path = "/2015-02-01/mount-targets/#{AWS.Util.encode_uri(mount_target_id)}/security-groups"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:put,
url_path,
query_params,
headers,
input,
options,
204
)
end
def put_account_preferences(%Client{} = client, input, options \\ []) do
url_path = "/2015-02-01/account-preferences"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:put,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Updates the file system's backup policy.
Use this action to start or stop automatic backups of the file system.
"""
def put_backup_policy(%Client{} = client, file_system_id, input, options \\ []) do
url_path = "/2015-02-01/file-systems/#{AWS.Util.encode_uri(file_system_id)}/backup-policy"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:put,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Applies an Amazon EFS `FileSystemPolicy` to an Amazon EFS file system.
A file system policy is an IAM resource-based policy and can contain multiple
policy statements. A file system always has exactly one file system policy,
which can be the default policy or an explicit policy set or updated using this
API operation. EFS file system policies have a 20,000 character limit. When an
explicit policy is set, it overrides the default policy. For more information
about the default file system policy, see [Default EFS File System Policy](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy).
EFS file system policies have a 20,000 character limit.
This operation requires permissions for the
`elasticfilesystem:PutFileSystemPolicy` action.
"""
def put_file_system_policy(%Client{} = client, file_system_id, input, options \\ []) do
url_path = "/2015-02-01/file-systems/#{AWS.Util.encode_uri(file_system_id)}/policy"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:put,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Enables lifecycle management by creating a new `LifecycleConfiguration` object.
A `LifecycleConfiguration` object defines when files in an Amazon EFS file
system are automatically transitioned to the lower-cost EFS Infrequent Access
(IA) storage class. A `LifecycleConfiguration` applies to all files in a file
system.
Each Amazon EFS file system supports one lifecycle configuration, which applies
to all files in the file system. If a `LifecycleConfiguration` object already
exists for the specified file system, a `PutLifecycleConfiguration` call
modifies the existing configuration. A `PutLifecycleConfiguration` call with an
empty `LifecyclePolicies` array in the request body deletes any existing
`LifecycleConfiguration` and disables lifecycle management.
In the request, specify the following:
* The ID for the file system for which you are enabling, disabling,
or modifying lifecycle management.
* A `LifecyclePolicies` array of `LifecyclePolicy` objects that
define when files are moved to the IA storage class. The array can contain only
one `LifecyclePolicy` item.
This operation requires permissions for the
`elasticfilesystem:PutLifecycleConfiguration` operation.
To apply a `LifecycleConfiguration` object to an encrypted file system, you need
the same AWS Key Management Service (AWS KMS) permissions as when you created
the encrypted file system.
"""
def put_lifecycle_configuration(%Client{} = client, file_system_id, input, options \\ []) do
url_path =
"/2015-02-01/file-systems/#{AWS.Util.encode_uri(file_system_id)}/lifecycle-configuration"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:put,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Creates a tag for an EFS resource.
You can create tags for EFS file systems and access points using this API
operation.
This operation requires permissions for the `elasticfilesystem:TagResource`
action.
"""
def tag_resource(%Client{} = client, resource_id, input, options \\ []) do
url_path = "/2015-02-01/resource-tags/#{AWS.Util.encode_uri(resource_id)}"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Removes tags from an EFS resource.
You can remove tags from EFS file systems and access points using this API
operation.
This operation requires permissions for the `elasticfilesystem:UntagResource`
action.
"""
def untag_resource(%Client{} = client, resource_id, input, options \\ []) do
url_path = "/2015-02-01/resource-tags/#{AWS.Util.encode_uri(resource_id)}"
headers = []
{query_params, input} =
[
{"TagKeys", "tagKeys"}
]
|> Request.build_params(input)
Request.request_rest(
client,
metadata(),
:delete,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Updates the throughput mode or the amount of provisioned throughput of an
existing file system.
"""
def update_file_system(%Client{} = client, file_system_id, input, options \\ []) do
url_path = "/2015-02-01/file-systems/#{AWS.Util.encode_uri(file_system_id)}"
headers = []
query_params = []
Request.request_rest(
client,
metadata(),
:put,
url_path,
query_params,
headers,
input,
options,
202
)
end
end