Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.
fsx(config = list(), credentials = list(), endpoint = NULL, region = NULL)
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.
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
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.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- fsx(
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"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
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 |
copy_backup | Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy) |
copy_snapshot_and_update_volume | Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system |
create_backup | Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system |
create_data_repository_association | Creates an Amazon FSx for Lustre data repository association (DRA) |
create_data_repository_task | Creates an Amazon FSx for Lustre data repository task |
create_file_cache | Creates a new Amazon File Cache resource |
create_file_system | Creates a new, empty Amazon FSx file system |
create_file_system_from_backup | Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup |
create_snapshot | Creates a snapshot of an existing Amazon FSx for OpenZFS volume |
create_storage_virtual_machine | Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system |
create_volume | Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume |
create_volume_from_backup | Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup |
delete_backup | Deletes an Amazon FSx backup |
delete_data_repository_association | Deletes a data repository association on an Amazon FSx for Lustre file system |
delete_file_cache | Deletes an Amazon File Cache resource |
delete_file_system | Deletes a file system |
delete_snapshot | Deletes an Amazon FSx for OpenZFS snapshot |
delete_storage_virtual_machine | Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM) |
delete_volume | Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume |
describe_backups | Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup |
describe_data_repository_associations | Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request |
describe_data_repository_tasks | Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request |
describe_file_caches | Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache |
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 |
describe_shared_vpc_configuration | Indicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner |
describe_snapshots | Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided |
describe_storage_virtual_machines | Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs) |
describe_volumes | Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes |
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 Amazon FSx resources |
release_file_system_nfs_v3_locks | Releases the file system lock from an Amazon FSx for OpenZFS file system |
restore_volume_from_snapshot | Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot |
start_misconfigured_state_recovery | After performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system |
tag_resource | Tags an Amazon FSx resource |
untag_resource | This action removes a tag from an Amazon FSx resource |
update_data_repository_association | Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system |
update_file_cache | Updates the configuration of an existing Amazon File Cache resource |
update_file_system | Use this operation to update the configuration of an existing Amazon FSx file system |
update_shared_vpc_configuration | Configures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud (VPC) owner |
update_snapshot | Updates the name of an Amazon FSx for OpenZFS snapshot |
update_storage_virtual_machine | Updates an FSx for ONTAP storage virtual machine (SVM) |
update_volume | Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume |
if (FALSE) {
svc <- fsx()
# This operation copies an Amazon FSx backup.
svc$copy_backup(
SourceBackupId = "backup-03e3c82e0183b7b6b",
SourceRegion = "us-east-2"
)
}
Run the code above in your browser using DataLab