Amazon Elastic File System¶

Description¶

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so that your applications have the storage they need, when they need it. For more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.

Usage¶

efs(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

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.

Service syntax¶

svc <- efs(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  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_replication_configuration`	Creates a replication configuration to either a new or existing EFS file system
`create_tags`	DEPRECATED - CreateTags is deprecated and not maintained
`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_replication_configuration`	Deletes a replication configuration
`delete_tags`	DEPRECATED - DeleteTags is deprecated and not maintained
`describe_access_points`	Returns the description of a specific Amazon EFS access point if the AccessPointId is provided
`describe_account_preferences`	Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region
`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 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_replication_configurations`	Retrieves the replication configuration for a specific file system
`describe_tags`	DEPRECATED - The DescribeTags action is deprecated and not maintained
`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_account_preferences`	Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources
`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`	Use this action to manage storage for your file system
`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
`update_file_system_protection`	Updates protection on the file system

Examples¶

svc <- efs()
# This operation creates a new, encrypted file system with automatic
# backups enabled, and the default generalpurpose performance mode.
svc$create_file_system(
  Backup = TRUE,
  CreationToken = "tokenstring",
  Encrypted = TRUE,
  PerformanceMode = "generalPurpose",
  Tags = list(
    list(
      Key = "Name",
      Value = "MyFileSystem"
    )
  )
)