You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EFS::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



251
252
253
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 251

def initialize(*args)
  super
end

Instance Method Details

#create_file_system(params = {}) ⇒ Types::FileSystemDescription

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.

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 also takes 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.

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.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

Examples:

Example: To create a new file system


# This operation creates a new file system with the default generalpurpose performance mode.

resp = client.create_file_system({
  creation_token: "tokenstring", 
  performance_mode: "generalPurpose", 
  tags: [
    {
      key: "Name", 
      value: "MyFileSystem", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  creation_time: Time.parse("1481841524.0"), 
  creation_token: "tokenstring", 
  file_system_id: "fs-01234567", 
  life_cycle_state: "creating", 
  number_of_mount_targets: 0, 
  owner_id: "012345678912", 
  performance_mode: "generalPurpose", 
  size_in_bytes: {
    value: 0, 
  }, 
  tags: [
    {
      key: "Name", 
      value: "MyFileSystem", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.create_file_system({
  creation_token: "CreationToken", # required
  performance_mode: "generalPurpose", # accepts generalPurpose, maxIO
  encrypted: false,
  kms_key_id: "KmsKeyId",
  throughput_mode: "bursting", # accepts bursting, provisioned
  provisioned_throughput_in_mibps: 1.0,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.owner_id #=> String
resp.creation_token #=> String
resp.file_system_id #=> String
resp.creation_time #=> Time
resp.life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
resp.name #=> String
resp.number_of_mount_targets #=> Integer
resp.size_in_bytes.value #=> Integer
resp.size_in_bytes.timestamp #=> Time
resp.size_in_bytes.value_in_ia #=> Integer
resp.size_in_bytes.value_in_standard #=> Integer
resp.performance_mode #=> String, one of "generalPurpose", "maxIO"
resp.encrypted #=> Boolean
resp.kms_key_id #=> String
resp.throughput_mode #=> String, one of "bursting", "provisioned"
resp.provisioned_throughput_in_mibps #=> Float
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :creation_token (required, String) —

    A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

  • :performance_mode (String) —

    The performance mode of the 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.

  • :encrypted (Boolean) —

    A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.

  • :kms_key_id (String) —

    The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats:

    • Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.

    • ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    • Key alias - A previously created display name for a key, for example alias/projectKey1.

    • Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

    If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true.

  • :throughput_mode (String) —

    The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change. For more, see Specifying Throughput with Provisioned Mode in the Amazon EFS User Guide.

  • :provisioned_throughput_in_mibps (Float) —

    The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The upper limit for throughput is 1024 MiB/s. You can get this limit increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.

  • :tags (Array<Types::Tag>) —

    A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"\{value\}" key-value pair.

Returns:

See Also:



488
489
490
491
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 488

def create_file_system(params = {}, options = {})
  req = build_request(:create_file_system, params)
  req.send_request(options)
end

#create_mount_target(params = {}) ⇒ Types::MountTargetDescription

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. For more information, see Amazon EFS: How it Works.

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, you also provide a subnet ID, which determines the following:

  • VPC in which Amazon EFS creates the mount target

  • Availability Zone in which Amazon EFS creates the mount target

  • 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.

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

Examples:

Example: To create a new mount target


# This operation creates a new mount target for an EFS file system.

resp = client.create_mount_target({
  file_system_id: "fs-01234567", 
  subnet_id: "subnet-1234abcd", 
})

resp.to_h outputs the following:
{
  file_system_id: "fs-01234567", 
  ip_address: "192.0.0.2", 
  life_cycle_state: "creating", 
  mount_target_id: "fsmt-12340abc", 
  network_interface_id: "eni-cedf6789", 
  owner_id: "012345678912", 
  subnet_id: "subnet-1234abcd", 
}

Request syntax with placeholder values


resp = client.create_mount_target({
  file_system_id: "FileSystemId", # required
  subnet_id: "SubnetId", # required
  ip_address: "IpAddress",
  security_groups: ["SecurityGroup"],
})

Response structure


resp.owner_id #=> String
resp.mount_target_id #=> String
resp.file_system_id #=> String
resp.subnet_id #=> String
resp.life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
resp.ip_address #=> String
resp.network_interface_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID of the file system for which to create the mount target.

  • :subnet_id (required, String) —

    The ID of the subnet to add the mount target in.

  • :ip_address (String) —

    Valid IPv4 address within the address range of the specified subnet.

  • :security_groups (Array<String>) —

    Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified.

Returns:

See Also:



675
676
677
678
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 675

def create_mount_target(params = {}, options = {})
  req = build_request(:create_mount_target, params)
  req.send_request(options)
end

#create_tags(params = {}) ⇒ Struct

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.

Examples:

Example: To create a new tag


# This operation creates a new tag for an EFS file system.

resp = client.create_tags({
  file_system_id: "fs-01234567", 
  tags: [
    {
      key: "Name", 
      value: "MyFileSystem", 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.create_tags({
  file_system_id: "FileSystemId", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.

  • :tags (required, Array<Types::Tag>) —

    An array of Tag objects to add. Each Tag object is a key-value pair.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



731
732
733
734
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 731

def create_tags(params = {}, options = {})
  req = build_request(:create_tags, params)
  req.send_request(options)
end

#delete_file_system(params = {}) ⇒ Struct

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.

Examples:

Example: To delete a file system


# This operation deletes an EFS file system.

resp = client.delete_file_system({
  file_system_id: "fs-01234567", 
})

Request syntax with placeholder values


resp = client.delete_file_system({
  file_system_id: "FileSystemId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID of the file system you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



780
781
782
783
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 780

def delete_file_system(params = {}, options = {})
  req = build_request(:delete_file_system, params)
  req.send_request(options)
end

#delete_mount_target(params = {}) ⇒ Struct

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

^

Examples:

Example: To delete a mount target


# This operation deletes a mount target.

resp = client.delete_mount_target({
  mount_target_id: "fsmt-12340abc", 
})

Request syntax with placeholder values


resp = client.delete_mount_target({
  mount_target_id: "MountTargetId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mount_target_id (required, String) —

    The ID of the mount target to delete (String).

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



842
843
844
845
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 842

def delete_mount_target(params = {}, options = {})
  req = build_request(:delete_mount_target, params)
  req.send_request(options)
end

#delete_tags(params = {}) ⇒ Struct

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 in the AWS Billing and Cost Management User Guide.

This operation requires permissions for the elasticfilesystem:DeleteTags action.

Examples:

Example: To delete tags for an EFS file system


# This operation deletes tags for an EFS file system.

resp = client.delete_tags({
  file_system_id: "fs-01234567", 
  tag_keys: [
    "Name", 
  ], 
})

Request syntax with placeholder values


resp = client.delete_tags({
  file_system_id: "FileSystemId", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID of the file system whose tags you want to delete (String).

  • :tag_keys (required, Array<String>) —

    A list of tag keys to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



891
892
893
894
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 891

def delete_tags(params = {}, options = {})
  req = build_request(:delete_tags, params)
  req.send_request(options)
end

#describe_file_systems(params = {}) ⇒ Types::DescribeFileSystemsResponse

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.

Examples:

Example: To describe an EFS file system


# This operation describes all of the EFS file systems in an account.

resp = client.describe_file_systems({
})

resp.to_h outputs the following:
{
  file_systems: [
    {
      creation_time: Time.parse("1481841524.0"), 
      creation_token: "tokenstring", 
      file_system_id: "fs-01234567", 
      life_cycle_state: "available", 
      name: "MyFileSystem", 
      number_of_mount_targets: 1, 
      owner_id: "012345678912", 
      performance_mode: "generalPurpose", 
      size_in_bytes: {
        value: 6144, 
      }, 
      tags: [
        {
          key: "Name", 
          value: "MyFileSystem", 
        }, 
      ], 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_file_systems({
  max_items: 1,
  marker: "Marker",
  creation_token: "CreationToken",
  file_system_id: "FileSystemId",
})

Response structure


resp.marker #=> String
resp.file_systems #=> Array
resp.file_systems[0].owner_id #=> String
resp.file_systems[0].creation_token #=> String
resp.file_systems[0].file_system_id #=> String
resp.file_systems[0].creation_time #=> Time
resp.file_systems[0].life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
resp.file_systems[0].name #=> String
resp.file_systems[0].number_of_mount_targets #=> Integer
resp.file_systems[0].size_in_bytes.value #=> Integer
resp.file_systems[0].size_in_bytes.timestamp #=> Time
resp.file_systems[0].size_in_bytes.value_in_ia #=> Integer
resp.file_systems[0].size_in_bytes.value_in_standard #=> Integer
resp.file_systems[0].performance_mode #=> String, one of "generalPurpose", "maxIO"
resp.file_systems[0].encrypted #=> Boolean
resp.file_systems[0].kms_key_id #=> String
resp.file_systems[0].throughput_mode #=> String, one of "bursting", "provisioned"
resp.file_systems[0].provisioned_throughput_in_mibps #=> Float
resp.file_systems[0].tags #=> Array
resp.file_systems[0].tags[0].key #=> String
resp.file_systems[0].tags[0].value #=> String
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_items (Integer) — default: Optional —

    Specifies the maximum number of file systems to return in the response (integer). Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 10 per page if you have more than 10 file systems.

  • :marker (String) — default: Optional —

    Opaque pagination token returned from a previous DescribeFileSystems operation (String). If present, specifies to continue the list from where the returning call had left off.

  • :creation_token (String) — default: Optional —

    Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.

  • :file_system_id (String) — default: Optional —

    ID of the file system whose description you want to retrieve (String).

Returns:

See Also:



1020
1021
1022
1023
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 1020

def describe_file_systems(params = {}, options = {})
  req = build_request(:describe_file_systems, params)
  req.send_request(options)
end

#describe_lifecycle_configuration(params = {}) ⇒ Types::LifecycleConfigurationDescription

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.

Examples:

Example: To describe the lifecycle configuration for a file system


# This operation describes a file system's LifecycleConfiguration. EFS lifecycle management uses the
# LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. 

resp = client.describe_lifecycle_configuration({
  file_system_id: "fs-01234567", 
})

resp.to_h outputs the following:
{
  lifecycle_policies: [
    {
      transition_to_ia: "AFTER_30_DAYS", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_lifecycle_configuration({
  file_system_id: "FileSystemId", # required
})

Response structure


resp.lifecycle_policies #=> Array
resp.lifecycle_policies[0].transition_to_ia #=> String, one of "AFTER_14_DAYS", "AFTER_30_DAYS", "AFTER_60_DAYS", "AFTER_90_DAYS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID of the file system whose LifecycleConfiguration object you want to retrieve (String).

Returns:

See Also:



1077
1078
1079
1080
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 1077

def describe_lifecycle_configuration(params = {}, options = {})
  req = build_request(:describe_lifecycle_configuration, params)
  req.send_request(options)
end

#describe_mount_target_security_groups(params = {}) ⇒ Types::DescribeMountTargetSecurityGroupsResponse

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.

Examples:

Example: To describe the security groups for a mount target


# This operation describes all of the security groups for a file system's mount target.

resp = client.describe_mount_target_security_groups({
  mount_target_id: "fsmt-12340abc", 
})

resp.to_h outputs the following:
{
  security_groups: [
    "sg-fghi4567", 
  ], 
}

Request syntax with placeholder values


resp = client.describe_mount_target_security_groups({
  mount_target_id: "MountTargetId", # required
})

Response structure


resp.security_groups #=> Array
resp.security_groups[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mount_target_id (required, String) —

    The ID of the mount target whose security groups you want to retrieve.

Returns:

See Also:



1133
1134
1135
1136
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 1133

def describe_mount_target_security_groups(params = {}, options = {})
  req = build_request(:describe_mount_target_security_groups, params)
  req.send_request(options)
end

#describe_mount_targets(params = {}) ⇒ Types::DescribeMountTargetsResponse

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.

Examples:

Example: To describe the mount targets for a file system


# This operation describes all of a file system's mount targets.

resp = client.describe_mount_targets({
  file_system_id: "fs-01234567", 
})

resp.to_h outputs the following:
{
  mount_targets: [
    {
      file_system_id: "fs-01234567", 
      ip_address: "192.0.0.2", 
      life_cycle_state: "available", 
      mount_target_id: "fsmt-12340abc", 
      network_interface_id: "eni-cedf6789", 
      owner_id: "012345678912", 
      subnet_id: "subnet-1234abcd", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_mount_targets({
  max_items: 1,
  marker: "Marker",
  file_system_id: "FileSystemId",
  mount_target_id: "MountTargetId",
})

Response structure


resp.marker #=> String
resp.mount_targets #=> Array
resp.mount_targets[0].owner_id #=> String
resp.mount_targets[0].mount_target_id #=> String
resp.mount_targets[0].file_system_id #=> String
resp.mount_targets[0].subnet_id #=> String
resp.mount_targets[0].life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
resp.mount_targets[0].ip_address #=> String
resp.mount_targets[0].network_interface_id #=> String
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_items (Integer) — default: Optional —

    Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 10 per page if you have more than 10 mount targets.

  • :marker (String) — default: Optional —

    Opaque pagination token returned from a previous DescribeMountTargets operation (String). If present, it specifies to continue the list from where the previous returning call left off.

  • :file_system_id (String) — default: Optional —

    ID of the file system whose mount targets you want to list (String). It must be included in your request if MountTargetId is not included.

  • :mount_target_id (String) — default: Optional —

    ID of the mount target that you want to have described (String). It must be included in your request if FileSystemId is not included.

Returns:

See Also:



1225
1226
1227
1228
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 1225

def describe_mount_targets(params = {}, options = {})
  req = build_request(:describe_mount_targets, params)
  req.send_request(options)
end

#describe_tags(params = {}) ⇒ Types::DescribeTagsResponse

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.

Examples:

Example: To describe the tags for a file system


# This operation describes all of a file system's tags.

resp = client.describe_tags({
  file_system_id: "fs-01234567", 
})

resp.to_h outputs the following:
{
  tags: [
    {
      key: "Name", 
      value: "MyFileSystem", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_tags({
  max_items: 1,
  marker: "Marker",
  file_system_id: "FileSystemId", # required
})

Response structure


resp.marker #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_items (Integer) — default: Optional —

    The maximum number of file system tags to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 10 per page if you have more than 10 tags.

  • :marker (String) — default: Optional —

    An opaque pagination token returned from a previous DescribeTags operation (String). If present, it specifies to continue the list from where the previous call left off.

  • :file_system_id (required, String) —

    The ID of the file system whose tag set you want to retrieve.

Returns:

See Also:



1297
1298
1299
1300
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 1297

def describe_tags(params = {}, options = {})
  req = build_request(:describe_tags, params)
  req.send_request(options)
end

#modify_mount_target_security_groups(params = {}) ⇒ Struct

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.

Examples:

Example: To modify the security groups associated with a mount target for a file system


# This operation modifies the security groups associated with a mount target for a file system.

resp = client.modify_mount_target_security_groups({
  mount_target_id: "fsmt-12340abc", 
  security_groups: [
    "sg-abcd1234", 
  ], 
})

Request syntax with placeholder values


resp = client.modify_mount_target_security_groups({
  mount_target_id: "MountTargetId", # required
  security_groups: ["SecurityGroup"],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :mount_target_id (required, String) —

    The ID of the mount target whose security groups you want to modify.

  • :security_groups (Array<String>) —

    An array of up to five VPC security group IDs.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1351
1352
1353
1354
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 1351

def modify_mount_target_security_groups(params = {}, options = {})
  req = build_request(:modify_mount_target_security_groups, params)
  req.send_request(options)
end

#put_lifecycle_configuration(params = {}) ⇒ Types::LifecycleConfigurationDescription

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.

Examples:

Example: Creates a new lifecycleconfiguration object for a file system


# This operation enables lifecycle management on a file system 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.

resp = client.put_lifecycle_configuration({
  file_system_id: "fs-01234567", 
  lifecycle_policies: [
    {
      transition_to_ia: "AFTER_30_DAYS", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  lifecycle_policies: [
    {
      transition_to_ia: "AFTER_30_DAYS", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.put_lifecycle_configuration({
  file_system_id: "FileSystemId", # required
  lifecycle_policies: [ # required
    {
      transition_to_ia: "AFTER_14_DAYS", # accepts AFTER_14_DAYS, AFTER_30_DAYS, AFTER_60_DAYS, AFTER_90_DAYS
    },
  ],
})

Response structure


resp.lifecycle_policies #=> Array
resp.lifecycle_policies[0].transition_to_ia #=> String, one of "AFTER_14_DAYS", "AFTER_30_DAYS", "AFTER_60_DAYS", "AFTER_90_DAYS"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID of the file system for which you are creating the LifecycleConfiguration object (String).

  • :lifecycle_policies (required, Array<Types::LifecyclePolicy>) —

    An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object tells lifecycle management when to transition files from the Standard storage class to the Infrequent Access storage class.

Returns:

See Also:



1446
1447
1448
1449
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 1446

def put_lifecycle_configuration(params = {}, options = {})
  req = build_request(:put_lifecycle_configuration, params)
  req.send_request(options)
end

#update_file_system(params = {}) ⇒ Types::FileSystemDescription

Updates the throughput mode or the amount of provisioned throughput of an existing file system.

Examples:

Request syntax with placeholder values


resp = client.update_file_system({
  file_system_id: "FileSystemId", # required
  throughput_mode: "bursting", # accepts bursting, provisioned
  provisioned_throughput_in_mibps: 1.0,
})

Response structure


resp.owner_id #=> String
resp.creation_token #=> String
resp.file_system_id #=> String
resp.creation_time #=> Time
resp.life_cycle_state #=> String, one of "creating", "available", "updating", "deleting", "deleted"
resp.name #=> String
resp.number_of_mount_targets #=> Integer
resp.size_in_bytes.value #=> Integer
resp.size_in_bytes.timestamp #=> Time
resp.size_in_bytes.value_in_ia #=> Integer
resp.size_in_bytes.value_in_standard #=> Integer
resp.performance_mode #=> String, one of "generalPurpose", "maxIO"
resp.encrypted #=> Boolean
resp.kms_key_id #=> String
resp.throughput_mode #=> String, one of "bursting", "provisioned"
resp.provisioned_throughput_in_mibps #=> Float
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :file_system_id (required, String) —

    The ID of the file system that you want to update.

  • :throughput_mode (String) — default: Optional —

    The throughput mode that you want your file system to use. If you're not updating your throughput mode, you don't need to provide this value in your request. If you are changing the ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps.

  • :provisioned_throughput_in_mibps (Float) — default: Optional —

    The amount of throughput, in MiB/s, that you want to provision for your file system. Valid values are 1-1024. Required if ThroughputMode is changed to provisioned on update. If you're not updating the amount of provisioned throughput for your file system, you don't need to provide this value in your request.

Returns:

See Also:



1522
1523
1524
1525
 
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/client.rb', line 1522

def update_file_system(params = {}, options = {})
  req = build_request(:update_file_system, params)
  req.send_request(options)
end