paws.storage (version 0.1.12)

efs: Amazon Elastic File System

Description

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

Usage

efs(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- efs(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_access_point	Creates an EFS access point
create_file_system	Creates a new, empty file system
create_mount_target	Creates a mount target for a file system
create_tags	Creates or overwrites tags associated with a file system
delete_access_point	Deletes the specified access point
delete_file_system	Deletes a file system, permanently severing access to its contents
delete_file_system_policy	Deletes the FileSystemPolicy for the specified file system
delete_mount_target	Deletes the specified mount target
delete_tags	Deletes the specified tags from a file system
describe_access_points	Returns the description of a specific Amazon EFS access point if the AccessPointId is provided
describe_backup_policy	Returns the backup policy for the specified EFS file system
describe_file_system_policy	Returns the FileSystemPolicy for the specified EFS file system
describe_file_systems	Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided
describe_lifecycle_configuration	Returns the current LifecycleConfiguration object for the specified Amazon EFS file system
describe_mount_targets	Returns the descriptions of all the current mount targets, or a specific mount target, for a file system
describe_mount_target_security_groups	Returns the security groups currently in effect for a mount target
describe_tags	Returns the tags associated with a file system
list_tags_for_resource	Lists all tags for a top-level EFS resource
modify_mount_target_security_groups	Modifies the set of security groups in effect for a mount target
put_backup_policy	Updates the file system's backup policy
put_file_system_policy	Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system
put_lifecycle_configuration	Enables lifecycle management by creating a new LifecycleConfiguration object
tag_resource	Creates a tag for an EFS resource
untag_resource	Removes tags from an EFS resource
update_file_system	Updates the throughput mode or the amount of provisioned throughput of an existing file system

Examples

if (FALSE) {
svc <- efs()
# This operation creates a new file system with the default generalpurpose
# performance mode.
svc$create_file_system(
  CreationToken = "tokenstring",
  PerformanceMode = "generalPurpose",
  Tags = list(
    list(
      Key = "Name",
      Value = "MyFileSystem"
    )
  )
)
}