fsx: Amazon FSx

Description Usage Arguments Value Service syntax Operations Examples

View source: R/paws.R

Description

Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.

Usage

1
fsx(config = list())

Arguments

config

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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- fsx(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_file_system_aliases Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system
cancel_data_repository_task Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state
create_backup Creates a backup of an existing Amazon FSx file system
create_data_repository_task Creates an Amazon FSx for Lustre data repository task
create_file_system Creates a new, empty Amazon FSx file system
create_file_system_from_backup Creates a new Amazon FSx file system from an existing Amazon FSx backup
delete_backup Deletes an Amazon FSx backup, deleting its contents
delete_file_system Deletes a file system, deleting its contents
describe_backups Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup
describe_data_repository_tasks Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request
describe_file_system_aliases Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system
describe_file_systems Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system
disassociate_file_system_aliases Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system
list_tags_for_resource Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server
tag_resource Tags an Amazon FSx resource
untag_resource This action removes a tag from an Amazon FSx resource
update_file_system Use this operation to update the configuration of an existing Amazon FSx file system

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 
svc <- fsx()
# This operation creates a new backup.
svc$create_backup(
  FileSystemId = "fs-0498eed5fe91001ec",
  Tags = list(
    list(
      Key = "Name",
      Value = "MyBackup"
    )
  )
)

## End(Not run)

paws documentation built on Sept. 5, 2021, 5:19 p.m.

Related to fsx in paws...