Skip to content

Files

Latest commit

rbrenrbren
full refresh of integrations
Dec 21, 2020
df3de93 · Dec 21, 2020

History

History

amazonaws_fsx

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
Dec 21, 2020
index.js
index.js
Dec 21, 2020
openapi.json
openapi.json
Dec 21, 2020
package.json
package.json
Dec 21, 2020

README.md

@datafire/amazonaws_fsx

Client library for Amazon FSx

Installation and Usage

npm install --save @datafire/amazonaws_fsx
let amazonaws_fsx = require('@datafire/amazonaws_fsx').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

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

Actions

AssociateFileSystemAliases

amazonaws_fsx.AssociateFileSystemAliases({
  "FileSystemId": null,
  "Aliases": null
}, context)

Input

Output

CancelDataRepositoryTask

amazonaws_fsx.CancelDataRepositoryTask({
  "TaskId": null
}, context)

Input

  • input object
    • TaskId required

Output

CreateBackup

amazonaws_fsx.CreateBackup({
  "FileSystemId": null
}, context)

Input

  • input object
    • ClientRequestToken
    • FileSystemId required
    • Tags

Output

CreateDataRepositoryTask

amazonaws_fsx.CreateDataRepositoryTask({
  "Type": null,
  "FileSystemId": "",
  "Report": null
}, context)

Input

Output

CreateFileSystem

amazonaws_fsx.CreateFileSystem({
  "FileSystemType": null,
  "StorageCapacity": null,
  "SubnetIds": null
}, context)

Input

Output

CreateFileSystemFromBackup

amazonaws_fsx.CreateFileSystemFromBackup({
  "BackupId": "",
  "SubnetIds": null
}, context)

Input

Output

DeleteBackup

amazonaws_fsx.DeleteBackup({
  "BackupId": null
}, context)

Input

  • input object
    • BackupId required
    • ClientRequestToken

Output

DeleteFileSystem

amazonaws_fsx.DeleteFileSystem({
  "FileSystemId": null
}, context)

Input

Output

DescribeBackups

amazonaws_fsx.DescribeBackups({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • BackupIds
    • Filters
    • MaxResults
    • NextToken

Output

DescribeDataRepositoryTasks

amazonaws_fsx.DescribeDataRepositoryTasks({}, context)

Input

Output

DescribeFileSystemAliases

amazonaws_fsx.DescribeFileSystemAliases({
  "FileSystemId": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • ClientRequestToken ClientRequestToken
    • FileSystemId required
    • MaxResults
    • NextToken

Output

DescribeFileSystems

amazonaws_fsx.DescribeFileSystems({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • FileSystemIds
    • MaxResults
    • NextToken

Output

DisassociateFileSystemAliases

amazonaws_fsx.DisassociateFileSystemAliases({
  "FileSystemId": null,
  "Aliases": null
}, context)

Input

Output

ListTagsForResource

amazonaws_fsx.ListTagsForResource({
  "ResourceARN": null
}, context)

Input

  • input object
    • MaxResults
    • NextToken
    • ResourceARN required

Output

TagResource

amazonaws_fsx.TagResource({
  "ResourceARN": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceARN required
    • Tags required

Output

UntagResource

amazonaws_fsx.UntagResource({
  "ResourceARN": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceARN required
    • TagKeys required

Output

UpdateFileSystem

amazonaws_fsx.UpdateFileSystem({
  "FileSystemId": null
}, context)

Input

  • input object
    • ClientRequestToken
    • FileSystemId required
    • LustreConfiguration UpdateFileSystemLustreConfiguration
    • StorageCapacity
    • WindowsConfiguration
      • AutomaticBackupRetentionDays
      • DailyAutomaticBackupStartTime
      • SelfManagedActiveDirectoryConfiguration
      • ThroughputCapacity
      • WeeklyMaintenanceStartTime

Output

Definitions

AWSAccountId

  • AWSAccountId string: An AWS account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.

ActiveDirectoryBackupAttributes

  • ActiveDirectoryBackupAttributes object: The Microsoft AD attributes of the Amazon FSx for Windows File Server file system.
    • ActiveDirectoryId
    • DomainName

ActiveDirectoryError

ActiveDirectoryFullyQualifiedName

  • ActiveDirectoryFullyQualifiedName string

AdministrativeAction

AdministrativeActionFailureDetails

  • AdministrativeActionFailureDetails object: Provides information about a failed administrative action.
    • Message

AdministrativeActionType

  • AdministrativeActionType string (values: FILE_SYSTEM_UPDATE, STORAGE_OPTIMIZATION, FILE_SYSTEM_ALIAS_ASSOCIATION, FILE_SYSTEM_ALIAS_DISASSOCIATION):

    Describes the type of administrative action, as follows:

    • FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

    • STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.

      • For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.

      • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

      You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

    • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .

    • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .

AdministrativeActions

Alias

  • Alias object: A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide.
    • Lifecycle
    • Name

AliasLifecycle

  • AliasLifecycle string (values: AVAILABLE, CREATING, DELETING, CREATE_FAILED, DELETE_FAILED)

Aliases

  • Aliases array: An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

AlternateDNSName

  • AlternateDNSName string

AlternateDNSNames

ArchivePath

  • ArchivePath string

AssociateFileSystemAliasesRequest

  • AssociateFileSystemAliasesRequest object: The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.

AssociateFileSystemAliasesResponse

  • AssociateFileSystemAliasesResponse object: The system generated response showing the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system. It can take up to 2.5 minutes for the alias status to change from CREATING to AVAILABLE.

AutoImportPolicyType

  • AutoImportPolicyType string (values: NONE, NEW, NEW_CHANGED)

AutomaticBackupRetentionDays

  • AutomaticBackupRetentionDays integer: The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.

Backup

BackupFailureDetails

  • BackupFailureDetails object: If backup creation fails, this structure contains the details of that failure.
    • Message

BackupId

  • BackupId string: The ID of the backup. Specifies the backup to use if you're creating a file system from an existing backup.

BackupIds

  • BackupIds array: A list of backup IDs.

BackupInProgress

BackupLifecycle

  • BackupLifecycle string (values: AVAILABLE, CREATING, TRANSFERRING, DELETED, FAILED, PENDING):

    The lifecycle status of the backup.

    • AVAILABLE - The backup is fully available.

    • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.

    • CREATING - Amazon FSx is creating the new user-intiated backup

    • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is backing up the file system.

    • DELETED - Amazon FSx deleted the backup and it is no longer available.

    • FAILED - Amazon FSx could not complete the backup.

BackupNotFound

BackupRestoring

BackupType

  • BackupType string (values: AUTOMATIC, USER_INITIATED, AWS_BACKUP): The type of the backup.

Backups

  • Backups array: A list of file system backups.

BadRequest

CancelDataRepositoryTaskRequest

  • CancelDataRepositoryTaskRequest object: Cancels a data repository task.
    • TaskId required

CancelDataRepositoryTaskResponse

  • CancelDataRepositoryTaskResponse object
    • Lifecycle
    • TaskId

ClientRequestToken

  • ClientRequestToken string: (Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

CompletionReport

  • CompletionReport object: Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.
    • Enabled required
    • Format
    • Path
    • Scope

CreateBackupRequest

  • CreateBackupRequest object: The request object for the CreateBackup operation.
    • ClientRequestToken
    • FileSystemId required
    • Tags

CreateBackupResponse

  • CreateBackupResponse object: The response object for the CreateBackup operation.
    • Backup
      • BackupId required
      • CreationTime required
      • DirectoryInformation
        • ActiveDirectoryId
        • DomainName
      • FailureDetails
        • Message
      • FileSystem required
      • KmsKeyId
      • Lifecycle required
      • ProgressPercent ProgressPercent
      • ResourceARN
      • Tags
      • Type required

CreateDataRepositoryTaskRequest

CreateDataRepositoryTaskResponse

CreateFileSystemFromBackupRequest

  • CreateFileSystemFromBackupRequest object: The request object for the CreateFileSystemFromBackup operation.

CreateFileSystemFromBackupResponse

  • CreateFileSystemFromBackupResponse object: The response object for the CreateFileSystemFromBackup operation.

CreateFileSystemLustreConfiguration

  • CreateFileSystemLustreConfiguration object: The Lustre configuration for the file system being created.
    • AutoImportPolicy
    • AutomaticBackupRetentionDays AutomaticBackupRetentionDays
    • CopyTagsToBackups
    • DailyAutomaticBackupStartTime DailyTime
    • DeploymentType
    • DriveCacheType
    • ExportPath
    • ImportPath
    • ImportedFileChunkSize
    • PerUnitStorageThroughput
    • WeeklyMaintenanceStartTime

CreateFileSystemRequest

  • CreateFileSystemRequest object: The request object used to create a new Amazon FSx file system.

CreateFileSystemResponse

CreateFileSystemWindowsConfiguration

  • CreateFileSystemWindowsConfiguration object: The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.
    • ActiveDirectoryId
    • Aliases
    • AutomaticBackupRetentionDays
    • CopyTagsToBackups
    • DailyAutomaticBackupStartTime
    • DeploymentType
    • PreferredSubnetId
    • SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryConfiguration
    • ThroughputCapacity required
    • WeeklyMaintenanceStartTime

CreationTime

  • CreationTime string: The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

DNSName

  • DNSName string: The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

DailyTime

  • DailyTime string: A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

DataRepositoryConfiguration

  • DataRepositoryConfiguration object: The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

DataRepositoryFailureDetails

  • DataRepositoryFailureDetails object: Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED.

DataRepositoryLifecycle

  • DataRepositoryLifecycle string (values: CREATING, AVAILABLE, MISCONFIGURED, UPDATING, DELETING)

DataRepositoryTask

  • DataRepositoryTask object: A description of the data repository task. You use data repository tasks to perform bulk transfer operations between your Amazon FSx file system and its linked data repository.

DataRepositoryTaskEnded

DataRepositoryTaskExecuting

DataRepositoryTaskFailureDetails

  • DataRepositoryTaskFailureDetails object: Provides information about why a data repository task failed. Only populated when the task Lifecycle is set to FAILED.

DataRepositoryTaskFilter

  • DataRepositoryTaskFilter object: (Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter Name, and one or more Values for the filter.

DataRepositoryTaskFilterName

  • DataRepositoryTaskFilterName string (values: file-system-id, task-lifecycle)

DataRepositoryTaskFilterValue

  • DataRepositoryTaskFilterValue string

DataRepositoryTaskFilterValues

DataRepositoryTaskFilters

DataRepositoryTaskLifecycle

  • DataRepositoryTaskLifecycle string (values: PENDING, EXECUTING, FAILED, SUCCEEDED, CANCELED, CANCELING)

DataRepositoryTaskNotFound

DataRepositoryTaskPath

  • DataRepositoryTaskPath string

DataRepositoryTaskPaths

DataRepositoryTaskStatus

  • DataRepositoryTaskStatus object: Provides the task status showing a running total of the total number of files to be processed, the number successfully processed, and the number of files the task failed to process.
    • FailedCount
    • LastUpdatedTime
    • SucceededCount
    • TotalCount

DataRepositoryTaskType

  • DataRepositoryTaskType string (values: EXPORT_TO_REPOSITORY)

DataRepositoryTasks

DeleteBackupRequest

  • DeleteBackupRequest object: The request object for DeleteBackup operation.
    • BackupId required
    • ClientRequestToken

DeleteBackupResponse

  • DeleteBackupResponse object: The response object for DeleteBackup operation.
    • BackupId
    • Lifecycle

DeleteFileSystemLustreConfiguration

  • DeleteFileSystemLustreConfiguration object: The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.
    • FinalBackupTags
    • SkipFinalBackup

DeleteFileSystemLustreResponse

  • DeleteFileSystemLustreResponse object: The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.
    • FinalBackupId
    • FinalBackupTags

DeleteFileSystemRequest

DeleteFileSystemResponse

DeleteFileSystemWindowsConfiguration

  • DeleteFileSystemWindowsConfiguration object: The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.
    • FinalBackupTags
    • SkipFinalBackup

DeleteFileSystemWindowsResponse

  • DeleteFileSystemWindowsResponse object: The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.
    • FinalBackupId
    • FinalBackupTags

DescribeBackupsRequest

  • DescribeBackupsRequest object: The request object for DescribeBackups operation.

DescribeBackupsResponse

  • DescribeBackupsResponse object: Response object for DescribeBackups operation.
    • Backups
    • NextToken

DescribeDataRepositoryTasksRequest

DescribeDataRepositoryTasksResponse

DescribeFileSystemAliasesRequest

  • DescribeFileSystemAliasesRequest object: The request object for DescribeFileSystemAliases operation.

DescribeFileSystemAliasesResponse

  • DescribeFileSystemAliasesResponse object: The response object for DescribeFileSystemAliases operation.
    • Aliases
    • NextToken

DescribeFileSystemsRequest

  • DescribeFileSystemsRequest object: The request object for DescribeFileSystems operation.

DescribeFileSystemsResponse

  • DescribeFileSystemsResponse object: The response object for DescribeFileSystems operation.

DirectoryId

  • DirectoryId string

DirectoryPassword

  • DirectoryPassword string

DirectoryUserName

  • DirectoryUserName string

DisassociateFileSystemAliasesRequest

  • DisassociateFileSystemAliasesRequest object: The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.

DisassociateFileSystemAliasesResponse

  • DisassociateFileSystemAliasesResponse object: The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is removing from the file system.

DnsIps

DriveCacheType

  • DriveCacheType string (values: NONE, READ)

EndTime

  • EndTime string

ErrorMessage

  • ErrorMessage string: A detailed error message.

FailedCount

  • FailedCount integer

FileSystem

FileSystemAdministratorsGroupName

  • FileSystemAdministratorsGroupName string

FileSystemFailureDetails

  • FileSystemFailureDetails object: A structure providing details of any failures that occur when creating the file system has failed.
    • Message

FileSystemId

  • FileSystemId string: The globally unique ID of the file system, assigned by Amazon FSx.

FileSystemIds

  • FileSystemIds array: A list of FileSystemIds.

FileSystemLifecycle

  • FileSystemLifecycle string (values: AVAILABLE, CREATING, FAILED, DELETING, MISCONFIGURED, UPDATING): The lifecycle status of the file system.

FileSystemMaintenanceOperation

  • FileSystemMaintenanceOperation string (values: PATCHING, BACKING_UP): An enumeration specifying the currently ongoing maintenance operation.

FileSystemMaintenanceOperations

FileSystemNotFound

FileSystemType

  • FileSystemType string (values: WINDOWS, LUSTRE): The type of file system.

FileSystems

  • FileSystems array: A list of file systems.

Filter

  • Filter object: A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.

FilterName

  • FilterName string (values: file-system-id, backup-type, file-system-type): The name for a filter.

FilterValue

  • FilterValue string: The value for a filter.

FilterValues

  • FilterValues array: A list of filter values.

Filters

  • Filters array: A list of Filter elements.

Flag

  • Flag boolean

IncompatibleParameterError

InternalServerError

InvalidExportPath

InvalidImportPath

InvalidNetworkSettings

InvalidPerUnitStorageThroughput

IpAddress

  • IpAddress string

KmsKeyId

  • KmsKeyId string: The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and Amazon FSx for Lustre PERSISTENT_1 file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The Amazon FSx for Lustre SCRATCH_1 and SCRATCH_2 file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the AWS Key Management Service API Reference.

LastUpdatedTime

  • LastUpdatedTime string

ListTagsForResourceRequest

  • ListTagsForResourceRequest object: The request object for ListTagsForResource operation.
    • MaxResults
    • NextToken
    • ResourceARN required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object: The response object for ListTagsForResource operation.
    • NextToken
    • Tags

LustreDeploymentType

  • LustreDeploymentType string (values: SCRATCH_1, SCRATCH_2, PERSISTENT_1)

LustreFileSystemConfiguration

  • LustreFileSystemConfiguration object: The configuration for the Amazon FSx for Lustre file system.

LustreFileSystemMountName

  • LustreFileSystemMountName string

MaxResults

  • MaxResults integer: The maximum number of resources to return in the response. This value must be an integer greater than zero.

Megabytes

  • Megabytes integer

MegabytesPerSecond

  • MegabytesPerSecond integer: Sustained throughput of an Amazon FSx file system in MBps.

MissingFileSystemConfiguration

NetworkInterfaceId

  • NetworkInterfaceId string: An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances.

NetworkInterfaceIds

NextToken

  • NextToken string: (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

NotServiceResourceError

OrganizationalUnitDistinguishedName

  • OrganizationalUnitDistinguishedName string

PerUnitStorageThroughput

  • PerUnitStorageThroughput integer

ProgressPercent

  • ProgressPercent integer: The current percent of progress of an asynchronous task.

ReportFormat

  • ReportFormat string (values: REPORT_CSV_20191124)

ReportScope

  • ReportScope string (values: FAILED_FILES_ONLY)

RequestTime

  • RequestTime string

ResourceARN

  • ResourceARN string: The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS resources. We require an ARN when you need to specify a resource unambiguously across all of AWS. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

ResourceDoesNotSupportTagging

ResourceNotFound

SecurityGroupId

  • SecurityGroupId string: The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see Amazon EC2 Security Groups for Linux Instances in the Amazon EC2 User Guide.

SecurityGroupIds

  • SecurityGroupIds array: A list of security group IDs.

SelfManagedActiveDirectoryAttributes

  • SelfManagedActiveDirectoryAttributes object: The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.
    • DnsIps
    • DomainName
    • FileSystemAdministratorsGroup
    • OrganizationalUnitDistinguishedName
    • UserName

SelfManagedActiveDirectoryConfiguration

  • SelfManagedActiveDirectoryConfiguration object: The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.
    • DnsIps required
    • DomainName required
    • FileSystemAdministratorsGroup
    • OrganizationalUnitDistinguishedName
    • Password required
    • UserName required

SelfManagedActiveDirectoryConfigurationUpdates

  • SelfManagedActiveDirectoryConfigurationUpdates object: The configuration that Amazon FSx uses to join the Windows File Server instance to a self-managed Microsoft Active Directory (AD) directory.

ServiceLimitExceeded

StartTime

  • StartTime string

Status

  • Status string (values: FAILED, IN_PROGRESS, PENDING, COMPLETED, UPDATED_OPTIMIZING)

StorageCapacity

  • StorageCapacity integer: The storage capacity for your Amazon FSx file system, in gibibytes.

StorageType

  • StorageType string (values: SSD, HDD): The storage type for your Amazon FSx file system.

SubnetId

  • SubnetId string: The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

SubnetIds

  • SubnetIds array: A list of subnet IDs. Currently, you can specify only one subnet ID in a call to the CreateFileSystem operation.

SucceededCount

  • SucceededCount integer

Tag

  • Tag object: Specifies a key-value pair for a resource tag.
    • Key required
    • Value required

TagKey

  • TagKey string: A string of 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the resource to which they are attached.

TagKeys

  • TagKeys array: A list of TagKey values, with a maximum of 50 elements.

TagResourceRequest

  • TagResourceRequest object: The request object for the TagResource operation.
    • ResourceARN required
    • Tags required

TagResourceResponse

  • TagResourceResponse object: The response object for the TagResource operation.

TagValue

  • TagValue string: A string of 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.

Tags

  • Tags array: A list of Tag values, with a maximum of 50 elements.

TaskId

  • TaskId string

TaskIds

TotalCount

  • TotalCount integer

UnsupportedOperation

UntagResourceRequest

  • UntagResourceRequest object: The request object for UntagResource action.
    • ResourceARN required
    • TagKeys required

UntagResourceResponse

  • UntagResourceResponse object: The response object for UntagResource action.

UpdateFileSystemLustreConfiguration

  • UpdateFileSystemLustreConfiguration object: The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.

UpdateFileSystemRequest

  • UpdateFileSystemRequest object: The request object for the UpdateFileSystem operation.
    • ClientRequestToken
    • FileSystemId required
    • LustreConfiguration UpdateFileSystemLustreConfiguration
    • StorageCapacity
    • WindowsConfiguration
      • AutomaticBackupRetentionDays
      • DailyAutomaticBackupStartTime
      • SelfManagedActiveDirectoryConfiguration
      • ThroughputCapacity
      • WeeklyMaintenanceStartTime

UpdateFileSystemResponse

UpdateFileSystemWindowsConfiguration

  • UpdateFileSystemWindowsConfiguration object: Updates the configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx only overwrites existing properties with non-null values provided in the request.
    • AutomaticBackupRetentionDays
    • DailyAutomaticBackupStartTime
    • SelfManagedActiveDirectoryConfiguration
    • ThroughputCapacity
    • WeeklyMaintenanceStartTime

VpcId

  • VpcId string: The ID of your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

WeeklyTime

  • WeeklyTime string:

    A recurring weekly time, in the format D:HH:MM.

    D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

    HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

    For example, 1:05:00 specifies maintenance at 5 AM Monday.

WindowsDeploymentType

  • WindowsDeploymentType string (values: MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2)

WindowsFileSystemConfiguration

  • WindowsFileSystemConfiguration object: The configuration for this Microsoft Windows file system.
    • ActiveDirectoryId
    • Aliases Aliases
    • AutomaticBackupRetentionDays
    • CopyTagsToBackups
    • DailyAutomaticBackupStartTime
    • DeploymentType
    • MaintenanceOperationsInProgress
    • PreferredFileServerIp
    • PreferredSubnetId
    • RemoteAdministrationEndpoint
    • SelfManagedActiveDirectoryConfiguration SelfManagedActiveDirectoryAttributes
    • ThroughputCapacity
    • WeeklyMaintenanceStartTime