Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file systen can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.
The system response shows 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.
" + "documentation":"Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.
The system response shows 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.
" }, "CancelDataRepositoryTask":{ "name":"CancelDataRepositoryTask", @@ -67,7 +67,7 @@ {"shape":"SourceBackupUnavailable"}, {"shape":"IncompatibleRegionForMultiAZ"} ], - "documentation":"Copies an existing backup within the same AWS account to another Region (cross-Region copy) or within the same Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.
You can use cross-Region backup copies for cross-region disaster recovery. You periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your AWS partition.
You can also use backup copies to clone your file data set to another Region or within the same Region.
You can use the SourceRegion parameter to specify the AWS Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).
For more information on creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide and Copying backups in the Amazon FSx for Lustre User Guide.
", + "documentation":"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). You can have up to five backup copy requests in progress to a single destination Region per account.
You can use cross-Region backup copies for cross-region disaster recovery. You periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition.
You can also use backup copies to clone your file data set to another Region or within the same Region.
You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).
For more information on creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide and Copying backups in the Amazon FSx for Lustre User Guide.
", "idempotent":true }, "CreateBackup":{ @@ -82,12 +82,13 @@ {"shape":"BadRequest"}, {"shape":"UnsupportedOperation"}, {"shape":"FileSystemNotFound"}, + {"shape":"VolumeNotFound"}, {"shape":"BackupInProgress"}, {"shape":"IncompatibleParameterError"}, {"shape":"ServiceLimitExceeded"}, {"shape":"InternalServerError"} ], - "documentation":"Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system.
For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:
a Persistent deployment type
is not linked to a data respository.
For more information about backing up Amazon FSx for Lustre file systems, see Working with FSx for Lustre backups.
For more information about backing up Amazon FSx for Windows file systems, see Working with FSx for Windows backups.
If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the backup.
By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.
The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.
Creates a backup of an existing Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume. Creating regular backups is a best practice, enabling you to restore a file system or volume from a backup if an issue arises with the original file system or volume.
For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:
a Persistent deployment type
is not linked to a data repository.
For more information about backups, see the following:
For Amazon FSx for Lustre, see Working with FSx for Lustre backups.
For Amazon FSx for Windows, see Working with FSx for Windows backups.
For Amazon FSx for NetApp ONTAP, see Working with FSx for NetApp ONTAP backups.
If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:
Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the backup.
By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.
The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.
Creates a new Amazon FSx file system from an existing Amazon FSx backup.
If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.
Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
Creates a new Amazon FSx for Lustre or Amazon FSx for Windows File Server file system from an existing Amazon FSx backup.
If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.
Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
" + }, + "CreateVolume":{ + "name":"CreateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVolumeRequest"}, + "output":{"shape":"CreateVolumeResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"FileSystemNotFound"}, + {"shape":"IncompatibleParameterError"}, + {"shape":"InternalServerError"}, + {"shape":"MissingVolumeConfiguration"}, + {"shape":"ServiceLimitExceeded"}, + {"shape":"StorageVirtualMachineNotFound"}, + {"shape":"UnsupportedOperation"} + ], + "documentation":"Creates an Amazon FSx for NetApp ONTAP storage volume.
" + }, + "CreateVolumeFromBackup":{ + "name":"CreateVolumeFromBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVolumeFromBackupRequest"}, + "output":{"shape":"CreateVolumeFromBackupResponse"}, + "errors":[ + {"shape":"BackupNotFound"}, + {"shape":"BadRequest"}, + {"shape":"FileSystemNotFound"}, + {"shape":"IncompatibleParameterError"}, + {"shape":"InternalServerError"}, + {"shape":"MissingVolumeConfiguration"}, + {"shape":"ServiceLimitExceeded"}, + {"shape":"StorageVirtualMachineNotFound"} + ], + "documentation":"Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
" }, "DeleteBackup":{ "name":"DeleteBackup", @@ -188,9 +248,41 @@ {"shape":"ServiceLimitExceeded"}, {"shape":"InternalServerError"} ], - "documentation":"Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.
By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.
The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.
Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a PENDING or EXECUTING state.
The data in a deleted file system is also deleted and can't be recovered by any means.
Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.
To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and SVMs on the file system. Then provide a FileSystemId value to the DeleFileSystem operation.
By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.
The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.
Deleting an Amazon FSx for Lustre file system will fail with a 400 BadRequest if a data repository task is in a PENDING or EXECUTING state.
The data in a deleted file system is also deleted and can't be recovered by any means.
Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
" + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVolumeRequest"}, + "output":{"shape":"DeleteVolumeResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"IncompatibleParameterError"}, + {"shape":"InternalServerError"}, + {"shape":"VolumeNotFound"} + ], + "documentation":"Deletes an Amazon FSx for NetApp ONTAP volume. When deleting a volume, you have the option of creating a final backup. If you create a final backup, you have the option to apply Tags to the backup. You need to have fsx:TagResource permission in order to apply tags to the backup.
Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.
Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults backup descriptions while still including a NextToken value.
The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.
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. You can use filters to narrow the response to include just tasks for specific file systems, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
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. You can use filters to narrow the response to include just tasks for specific file systems, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this action, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
" + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{"shape":"DescribeVolumesResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"VolumeNotFound"} + ], + "documentation":"Describes one or more Amazon FSx for NetApp ONTAP volumes.
" }, "DisassociateFileSystemAliases":{ "name":"DisassociateFileSystemAliases", @@ -338,13 +461,47 @@ {"shape":"MissingFileSystemConfiguration"}, {"shape":"ServiceLimitExceeded"} ], - "documentation":"Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For Amazon FSx for Windows File Server file systems, you can update the following properties:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
StorageCapacity
WeeklyMaintenanceStartTime
Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For Amazon FSx for Windows File Server file systems, you can update the following properties:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
StorageCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for NetApp ONTAP file systems, you can update the following properties:
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
FsxAdminPassword
WeeklyMaintenanceStartTime
Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
" + }, + "UpdateVolume":{ + "name":"UpdateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateVolumeRequest"}, + "output":{"shape":"UpdateVolumeResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"IncompatibleParameterError"}, + {"shape":"InternalServerError"}, + {"shape":"MissingVolumeConfiguration"}, + {"shape":"VolumeNotFound"} + ], + "documentation":"Updates an Amazon FSx for NetApp ONTAP volume's configuration.
" } }, "shapes":{ "AWSAccountId":{ "type":"string", - "documentation":"An AWS account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
", + "documentation":"An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
", "max":12, "min":12, "pattern":"^\\d{12}$" @@ -358,7 +515,7 @@ }, "ActiveDirectoryId":{ "shape":"DirectoryId", - "documentation":"The ID of the AWS Managed Microsoft Active Directory instance to which the file system is joined.
" + "documentation":"The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.
" }, "ResourceARN":{"shape":"ResourceARN"} }, @@ -397,6 +554,13 @@ "min":1, "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$" }, + "AdminPassword":{ + "type":"string", + "max":50, + "min":8, + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{8,50}$", + "sensitive":true + }, "AdministrativeAction":{ "type":"structure", "members":{ @@ -417,7 +581,8 @@ "shape":"FileSystem", "documentation":"Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.
" }, @@ -455,7 +620,7 @@ }, "Lifecycle":{ "shape":"AliasLifecycle", - "documentation":"Describes the state of the DNS alias.
AVAILABLE - The DNS alias is associated with an Amazon FSx file system.
CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.
CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.
DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.
DELETE_FAILED - Amazon FSx was unable to disassocate the DNS alias from the file system.
Describes the state of the DNS alias.
AVAILABLE - The DNS alias is associated with an Amazon FSx file system.
CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.
CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.
DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.
DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.
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.
" @@ -572,7 +737,7 @@ }, "KmsKeyId":{ "shape":"KmsKeyId", - "documentation":"The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
" + "documentation":"The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
" }, "ResourceARN":{ "shape":"ResourceARN", @@ -595,9 +760,14 @@ "SourceBackupRegion":{ "shape":"Region", "documentation":"The source Region of the backup. Specifies the Region from where this backup is copied.
" - } + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"Specifies the resource type that is backed up.
" + }, + "Volume":{"shape":"Volume"} }, - "documentation":"A backup of an Amazon FSx file system.
" + "documentation":"A backup of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp ONTAP volume.
" }, "BackupBeingCopied":{ "type":"structure", @@ -721,7 +891,7 @@ }, "ClientRequestToken":{ "type":"string", - "documentation":"(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.
", + "documentation":"(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 Command Line Interface (CLI) or an Amazon Web Services SDK.
", "max":63, "min":1, "pattern":"[A-za-z0-9_.-]{0,63}$" @@ -749,6 +919,11 @@ }, "documentation":"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.
The source AWS Region of the backup. Specifies the AWS Region from which the backup is being copied. The source and destination Regions must be in the same AWS partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy).
" + "documentation":"The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, it defaults to the Region where the request is sent from (in-Region copy).
" }, "KmsKeyId":{"shape":"KmsKeyId"}, "CopyTags":{ @@ -781,7 +956,6 @@ }, "CreateBackupRequest":{ "type":"structure", - "required":["FileSystemId"], "members":{ "FileSystemId":{ "shape":"FileSystemId", @@ -789,12 +963,16 @@ }, "ClientRequestToken":{ "shape":"ClientRequestToken", - "documentation":"(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
", + "documentation":"(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "idempotencyToken":true }, "Tags":{ "shape":"Tags", "documentation":"(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup action, no existing file system tags are copied from the file system to the backup.
The ID of he FSx for NetApp ONTAP volume to back up.
" } }, "documentation":"The request object for the CreateBackup operation.
A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
", + "documentation":"A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "idempotencyToken":true }, "SubnetIds":{ @@ -915,7 +1093,7 @@ }, "DeploymentType":{ "shape":"LustreDeploymentType", - "documentation":" Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.
Choose PERSISTENT_1 deployment type for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options.
Encryption of data in-transit is automatically enabled when you access a SCRATCH_2 or PERSISTENT_1 file system from Amazon EC2 instances that support this feature. (Default = SCRATCH_1)
Encryption of data in-transit for SCRATCH_2 and PERSISTENT_1 deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, Encrypting Data in Transit.
Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.
Choose PERSISTENT_1 deployment type for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options.
Encryption of data in-transit is automatically enabled when you access a SCRATCH_2 or PERSISTENT_1 file system from Amazon EC2 instances that support this feature. (Default = SCRATCH_1)
Encryption of data in-transit for SCRATCH_2 and PERSISTENT_1 deployment types is supported when accessed from supported instance types in supported Amazon Web Services Regions. To learn more, Encrypting Data in Transit.
The Lustre configuration for the file system being created.
" }, + "CreateFileSystemOntapConfiguration":{ + "type":"structure", + "required":[ + "DeploymentType", + "ThroughputCapacity" + ], + "members":{ + "AutomaticBackupRetentionDays":{"shape":"AutomaticBackupRetentionDays"}, + "DailyAutomaticBackupStartTime":{"shape":"DailyTime"}, + "DeploymentType":{ + "shape":"OntapDeploymentType", + "documentation":"Specifies the ONTAP file system deployment type to use in creating the file system.
" + }, + "EndpointIpAddressRange":{ + "shape":"IpAddressRange", + "documentation":"Specifies the IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range.
" + }, + "FsxAdminPassword":{ + "shape":"AdminPassword", + "documentation":"The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system.
" + }, + "PreferredSubnetId":{"shape":"SubnetId"}, + "RouteTableIds":{ + "shape":"RouteTableIds", + "documentation":"Specifies the VPC route tables in which your file system's endpoints will be created. You should specify all VPC route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
" + }, + "ThroughputCapacity":{"shape":"MegabytesPerSecond"}, + "WeeklyMaintenanceStartTime":{"shape":"WeeklyTime"} + }, + "documentation":"The ONTAP configuration properties of the FSx for NetApp ONTAP file system that you are creating.
" + }, "CreateFileSystemRequest":{ "type":"structure", "required":[ @@ -952,24 +1165,24 @@ "members":{ "ClientRequestToken":{ "shape":"ClientRequestToken", - "documentation":"A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
", + "documentation":"A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "idempotencyToken":true }, "FileSystemType":{ "shape":"FileSystemType", - "documentation":"The type of Amazon FSx file system to create, either WINDOWS or LUSTRE.
The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, and ONTAP.
Sets the storage capacity of the file system that you're creating.
For Lustre file systems:
For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
For Windows file systems:
If StorageType=SSD, valid values are 32 GiB - 65,536 GiB (64 TiB).
If StorageType=HDD, valid values are 2000 GiB - 65,536 GiB (64 TiB).
Sets the storage capacity of the file system that you're creating.
For Lustre file systems:
For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
For PERSISTENT HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
For Windows file systems:
If StorageType=SSD, valid values are 32 GiB - 65,536 GiB (64 TiB).
If StorageType=HDD, valid values are 2000 GiB - 65,536 GiB (64 TiB).
For ONTAP file systems:
Valid values are 1024 GiB - 196,608 GiB (192 TiB).
Sets the storage type for the file system you're creating. Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows and Lustre deployment types.
Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT Lustre file system deployment types.
Default value is SSD. For more information, see Storage Type Options in the Amazon FSx for Windows User Guide and Multiple Storage Options in the Amazon FSx for Lustre User Guide.
Sets the storage type for the file system you're creating. Valid values are SSD and HDD.
Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, and ONTAP deployment types.
Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT Lustre file system deployment types.
Default value is SSD. For more information, see Storage Type Options in the Amazon FSx for Windows User Guide and Multiple Storage Options in the Amazon FSx for Lustre User Guide.
Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID or OntapConfiguration > PreferredSubnetID properties. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide.
For Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
The Microsoft Windows configuration for the file system being created.
" }, - "LustreConfiguration":{"shape":"CreateFileSystemLustreConfiguration"} + "LustreConfiguration":{"shape":"CreateFileSystemLustreConfiguration"}, + "OntapConfiguration":{"shape":"CreateFileSystemOntapConfiguration"} }, "documentation":"The request object used to create a new Amazon FSx file system.
" }, @@ -1004,16 +1218,16 @@ "members":{ "ActiveDirectoryId":{ "shape":"DirectoryId", - "documentation":"The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
" + "documentation":"The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.
" }, "SelfManagedActiveDirectoryConfiguration":{"shape":"SelfManagedActiveDirectoryConfiguration"}, "DeploymentType":{ "shape":"WindowsDeploymentType", - "documentation":"Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage type
SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.
SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.
For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.
" + "documentation":"Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in Amazon Web Services Regions that have a minimum of three Availability Zones. Also supports HDD storage type
SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.
SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.
For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.
" }, "PreferredSubnetId":{ "shape":"SubnetId", - "documentation":"Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-AWS applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.
Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-Amazon Web Services applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.
The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.
Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.
The security style for the volume. Specify one of the following values:
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. UNIX is the default.
NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.
Specifies the size of the volume, in megabytes (MB), that you are creating.
" + }, + "StorageEfficiencyEnabled":{ + "shape":"Flag", + "documentation":"Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
" + }, + "StorageVirtualMachineId":{ + "shape":"StorageVirtualMachineId", + "documentation":"Specifies the ONTAP SVM in which to create the volume.
" + }, + "TieringPolicy":{"shape":"TieringPolicy"} + }, + "documentation":"Specifies the configuration of the ONTAP volume that you are creating.
" + }, + "CreateStorageVirtualMachineRequest":{ + "type":"structure", + "required":[ + "FileSystemId", + "Name" + ], + "members":{ + "ActiveDirectoryConfiguration":{ + "shape":"CreateSvmActiveDirectoryConfiguration", + "documentation":"Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS client accessing the file system.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "FileSystemId":{"shape":"FileSystemId"}, + "Name":{ + "shape":"StorageVirtualMachineName", + "documentation":"The name of the SVM.
" + }, + "SvmAdminPassword":{ + "shape":"AdminPassword", + "documentation":"The password to use when managing the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's fsxadmin user to manage the SVM.
The security style of the root volume of the SVM. Specify one of the following values:
UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
NTFS if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.
MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.
Returned after a successful CreateStorageVirtualMachine operation; describes the SVM just created.
The NetBIOS name of the Active Directory computer object that will be created for your SVM.
" + }, + "SelfManagedActiveDirectoryConfiguration":{"shape":"SelfManagedActiveDirectoryConfiguration"} + }, + "documentation":"The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.
" + }, + "CreateVolumeFromBackupRequest":{ + "type":"structure", + "required":[ + "BackupId", + "Name" + ], + "members":{ + "BackupId":{"shape":"BackupId"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "Name":{ + "shape":"VolumeName", + "documentation":"The name of the new volume you're creating.
" + }, + "OntapConfiguration":{ + "shape":"CreateOntapVolumeConfiguration", + "documentation":"Specifies the configuration of the ONTAP volume that you are creating.
" + }, + "Tags":{"shape":"Tags"} + } + }, + "CreateVolumeFromBackupResponse":{ + "type":"structure", + "members":{ + "Volume":{ + "shape":"Volume", + "documentation":"Returned after a successful CreateVolumeFromBackup API operation, describing the volume just created.
Specifies the type of volume to create; ONTAP is the only valid volume type.
Specifies the name of the volume you're creating.
" + }, + "OntapConfiguration":{ + "shape":"CreateOntapVolumeConfiguration", + "documentation":"Specifies the ONTAP configuration to use in creating the volume.
Returned after a successful CreateVolume API operation, describing the volume just created.
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
" @@ -1296,7 +1662,7 @@ }, "ClientRequestToken":{ "shape":"ClientRequestToken", - "documentation":"A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.
", + "documentation":"A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the CLI or SDK.
", "idempotencyToken":true } }, @@ -1354,7 +1720,7 @@ }, "ClientRequestToken":{ "shape":"ClientRequestToken", - "documentation":"A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.
", + "documentation":"A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "idempotencyToken":true }, "WindowsConfiguration":{"shape":"DeleteFileSystemWindowsConfiguration"}, @@ -1406,6 +1772,87 @@ }, "documentation":"The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.
The ID of the SVM that you want to delete.
" + } + } + }, + "DeleteStorageVirtualMachineResponse":{ + "type":"structure", + "members":{ + "StorageVirtualMachineId":{ + "shape":"StorageVirtualMachineId", + "documentation":"The ID of the SVM Amazon FSx is deleting.
" + }, + "Lifecycle":{ + "shape":"StorageVirtualMachineLifecycle", + "documentation":"Describes the lifecycle state of the SVM being deleted.
" + } + } + }, + "DeleteVolumeOntapConfiguration":{ + "type":"structure", + "members":{ + "SkipFinalBackup":{ + "shape":"Flag", + "documentation":"Set to true if you want to skip taking a final backup of the volume you are deleting.
" + }, + "FinalBackupTags":{"shape":"Tags"} + }, + "documentation":"Use to specify skipping a final backup, or to add tags to a final backup.
" + }, + "DeleteVolumeOntapResponse":{ + "type":"structure", + "members":{ + "FinalBackupId":{"shape":"BackupId"}, + "FinalBackupTags":{"shape":"Tags"} + }, + "documentation":"The response object for the Amazon FSx for NetApp ONTAP volume being deleted in the DeleteVolume operation.
The ID of the volume you are deleting.
" + }, + "OntapConfiguration":{ + "shape":"DeleteVolumeOntapConfiguration", + "documentation":"For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume, and apply tags to the backup.
" + } + } + }, + "DeleteVolumeResponse":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"VolumeId", + "documentation":"The ID of the volume being deleted.
" + }, + "Lifecycle":{ + "shape":"VolumeLifecycle", + "documentation":"Describes the lifecycle state of the volume being deleted.
" + }, + "OntapResponse":{ + "shape":"DeleteVolumeOntapResponse", + "documentation":"Returned after a DeleteVolume request, showing the status of the delete request.
Filters structure. Supported names are file-system-id and backup-type.
" + "documentation":"Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.
The response object for DescribeFileSystems operation.
Enter the ID of one or more SVMs that you want to view.
" + }, + "Filters":{ + "shape":"StorageVirtualMachineFilters", + "documentation":"Enter a filter name:value pair to view a select set of SVMs.
" + }, + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"NextToken"} + } + }, + "DescribeStorageVirtualMachinesResponse":{ + "type":"structure", + "members":{ + "StorageVirtualMachines":{ + "shape":"StorageVirtualMachines", + "documentation":"Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.
IDs of the volumes whose descriptions you want to retrieve.
" + }, + "Filters":{ + "shape":"VolumeFilters", + "documentation":"Enter a filter name:value pair to view a select set of volumes.
" + }, + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"NextToken"} + } + }, + "DescribeVolumesResponse":{ + "type":"structure", + "members":{ + "Volumes":{ + "shape":"Volumes", + "documentation":"Returned after a successful DescribeVolumes operation, describing each volume.
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.
" }, + "DiskIopsConfiguration":{ + "type":"structure", + "members":{ + "Mode":{ + "shape":"DiskIopsConfigurationMode", + "documentation":"Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC) or was provisioned by the customer (USER_PROVISIONED).
The total number of SSD IOPS provisioned for the file system.
" + } + }, + "documentation":"The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how the amount was provisioned (by the customer or by the system).
" + }, + "DiskIopsConfigurationMode":{ + "type":"string", + "enum":[ + "AUTOMATIC", + "USER_PROVISIONED" + ] + }, "DnsIps":{ "type":"list", "member":{"shape":"IpAddress"}, - "max":2, + "max":3, "min":1 }, "DriveCacheType":{ @@ -1613,7 +2131,7 @@ "members":{ "OwnerId":{ "shape":"AWSAccountId", - "documentation":"The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs is the owner.
" + "documentation":"The Amazon Web Services account that created the file system. If the file system was created by an Identity and Access Management (IAM) user, the Amazon Web Services account to which the IAM user belongs is the owner.
" }, "CreationTime":{ "shape":"CreationTime", @@ -1625,7 +2143,7 @@ }, "FileSystemType":{ "shape":"FileSystemType", - "documentation":"The type of Amazon FSx file system, either LUSTRE or WINDOWS.
The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, or ONTAP.
Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.
For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows file systems, the endpoint for the file system is available in the PreferredSubnetID.
Specifies the IDs of the subnets that the file system is accessible from. For Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.
For Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the endpoint for the file system. For MULTI_AZ_1 Windows and ONTAP file systems, the endpoint for the file system is available in the PreferredSubnetID.
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 persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre 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.
" + "documentation":"The ID of the Key Management Service (KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and persistent Amazon FSx for Lustre file systems at rest. If not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see Encrypt in the Key Management Service API Reference.
" }, "ResourceARN":{ "shape":"ResourceARN", @@ -1675,7 +2193,11 @@ "LustreConfiguration":{"shape":"LustreFileSystemConfiguration"}, "AdministrativeActions":{ "shape":"AdministrativeActions", - "documentation":"A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem action.
A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx file system that you have initiated using the UpdateFileSystem action.
The configuration for this FSx for NetApp ONTAP file system.
" } }, "documentation":"A description of a specific Amazon FSx file system.
" @@ -1686,6 +2208,31 @@ "min":1, "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$" }, + "FileSystemEndpoint":{ + "type":"structure", + "members":{ + "DNSName":{"shape":"DNSName"}, + "IpAddresses":{ + "shape":"OntapEndpointIpAddresses", + "documentation":"IP addresses of the file system endpoint.
" + } + }, + "documentation":"An Amazon FSx for NetApp ONTAP file system has two endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. They are the Management and Intercluster endpoints.
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
" + }, + "Management":{ + "shape":"FileSystemEndpoint", + "documentation":"An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
" + } + }, + "documentation":"An Amazon FSx for NetApp ONTAP file system has the following endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
" + }, "FileSystemFailureDetails":{ "type":"structure", "members":{ @@ -1748,7 +2295,8 @@ "documentation":"The type of file system.
", "enum":[ "WINDOWS", - "LUSTRE" + "LUSTRE", + "ONTAP" ] }, "FileSystems":{ @@ -1777,7 +2325,8 @@ "enum":[ "file-system-id", "backup-type", - "file-system-type" + "file-system-type", + "volume-id" ] }, "FilterValue":{ @@ -1800,6 +2349,14 @@ "max":10 }, "Flag":{"type":"boolean"}, + "FlexCacheEndpointType":{ + "type":"string", + "enum":[ + "NONE", + "ORIGIN", + "CACHE" + ] + }, "GeneralARN":{ "type":"string", "max":1024, @@ -1841,7 +2398,7 @@ "members":{ "Message":{"shape":"ErrorMessage"} }, - "documentation":"The AWS Key Management Service (AWS KMS) key of the destination backup is invalid.
", + "documentation":"The Key Management Service (KMS) key of the destination backup is invalid.
", "exception":true }, "InvalidExportPath":{ @@ -1863,11 +2420,24 @@ "InvalidNetworkSettings":{ "type":"structure", "members":{ - "Message":{"shape":"ErrorMessage"}, - "InvalidSubnetId":{"shape":"SubnetId"}, - "InvalidSecurityGroupId":{"shape":"SecurityGroupId"} + "Message":{ + "shape":"ErrorMessage", + "documentation":"Error message explaining what's wrong with network settings.
" + }, + "InvalidSubnetId":{ + "shape":"SubnetId", + "documentation":"The subnet ID that is either invalid or not part of the VPC specified.
" + }, + "InvalidSecurityGroupId":{ + "shape":"SecurityGroupId", + "documentation":"The security group ID is either invalid or not part of the VPC specified.
" + }, + "InvalidRouteTableId":{ + "shape":"RouteTableId", + "documentation":"The route table ID is either invalid or not part of the VPC specified.
" + } }, - "documentation":"One or more network settings specified in the request are invalid. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.
One or more network settings specified in the request are invalid.
", "exception":true }, "InvalidPerUnitStorageThroughput":{ @@ -1883,7 +2453,7 @@ "members":{ "Message":{"shape":"ErrorMessage"} }, - "documentation":"The Region provided for Source Region is invalid or is in a different AWS partition.
The Region provided for Source Region is invalid or is in a different Amazon Web Services partition.
The AWS Key Management Service (AWS KMS) key of the source backup is invalid.
", + "documentation":"The Key Management Service (KMS) key of the source backup is invalid.
", "exception":true }, + "Iops":{ + "type":"long", + "max":80000, + "min":0 + }, "IpAddress":{ "type":"string", "max":15, "min":7, "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" }, + "IpAddressRange":{ + "type":"string", + "max":17, + "min":9, + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{9,17}$" + }, + "JunctionPath":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$" + }, "KmsKeyId":{ "type":"string", - "documentation":"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.
The ID of the Key Management Service (KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx for Lustre PERSISTENT_1 file systems at rest. 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 Key Management Service API Reference.
Describes why a resource lifecycle state changed.
" + }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceARN"], @@ -1967,7 +2561,7 @@ }, "MountName":{ "shape":"LustreFileSystemMountName", - "documentation":"You use the MountName value when mounting the file system.
For the SCRATCH_1 deployment type, this value is always \"fsx\". For SCRATCH_2 and PERSISTENT_1 deployment types, this value is a string that is unique within an AWS Region.
You use the MountName value when mounting the file system.
For the SCRATCH_1 deployment type, this value is always \"fsx\". For SCRATCH_2 and PERSISTENT_1 deployment types, this value is a string that is unique within an Amazon Web Services Region.
A file system configuration is required for this operation.
", "exception":true }, + "MissingVolumeConfiguration":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"A volume configuration is required for this operation.
", + "exception":true + }, + "NetBiosAlias":{ + "type":"string", + "max":15, + "min":1, + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$" + }, "NetworkInterfaceId":{ "type":"string", "documentation":"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.
", @@ -2050,6 +2658,101 @@ "documentation":"The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.
", "exception":true }, + "OntapDeploymentType":{ + "type":"string", + "enum":["MULTI_AZ_1"] + }, + "OntapEndpointIpAddresses":{ + "type":"list", + "member":{"shape":"IpAddress"}, + "max":2, + "min":1 + }, + "OntapFileSystemConfiguration":{ + "type":"structure", + "members":{ + "AutomaticBackupRetentionDays":{"shape":"AutomaticBackupRetentionDays"}, + "DailyAutomaticBackupStartTime":{"shape":"DailyTime"}, + "DeploymentType":{ + "shape":"OntapDeploymentType", + "documentation":"The ONTAP file system deployment type.
" + }, + "EndpointIpAddressRange":{ + "shape":"IpAddressRange", + "documentation":"The IP address range in which the endpoints to access your file system are created.
" + }, + "Endpoints":{ + "shape":"FileSystemEndpoints", + "documentation":"The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
" + }, + "PreferredSubnetId":{"shape":"SubnetId"}, + "RouteTableIds":{ + "shape":"RouteTableIds", + "documentation":"The VPC route tables in which your file system's endpoints are created.
" + }, + "ThroughputCapacity":{"shape":"MegabytesPerSecond"}, + "WeeklyMaintenanceStartTime":{"shape":"WeeklyTime"} + }, + "documentation":"Configuration for the FSx for NetApp ONTAP file system.
" + }, + "OntapVolumeConfiguration":{ + "type":"structure", + "members":{ + "FlexCacheEndpointType":{ + "shape":"FlexCacheEndpointType", + "documentation":"Specifies the FlexCache endpoint type of the volume. Valid values are the following:
NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.
ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
CACHE specifies that the volume is a FlexCache volume.
Specifies the directory that NAS clients use to mount the volume, along with the SVM DNS name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3..
The security style for the volume, which can be UNIX, NTFS, or MIXED.
The configured size of the volume, in megabytes (MBs).
" + }, + "StorageEfficiencyEnabled":{ + "shape":"Flag", + "documentation":"The volume's storage efficiency setting.
" + }, + "StorageVirtualMachineId":{ + "shape":"StorageVirtualMachineId", + "documentation":"The ID of the volume's storage virtual machine.
" + }, + "StorageVirtualMachineRoot":{ + "shape":"Flag", + "documentation":"A boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
" + }, + "TieringPolicy":{ + "shape":"TieringPolicy", + "documentation":"The volume's TieringPolicy setting.
The volume's UUID (universally unique identifier).
" + }, + "OntapVolumeType":{ + "shape":"OntapVolumeType", + "documentation":"Specifies the type of volume. Valid values are the following:
RW specifies a read-write volume. RW is the default.
DP specifies a data protection volume. You can protect data by replicating it to data protection mirror copies and use data protection mirror copies to recover data when a disaster occurs.
LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
The configuration of an Amazon FSx for NetApp ONTAP volume
" + }, + "OntapVolumeType":{ + "type":"string", + "enum":[ + "RW", + "DP", + "LS" + ] + }, "OrganizationalUnitDistinguishedName":{ "type":"string", "max":2000, @@ -2089,7 +2792,7 @@ "RequestTime":{"type":"timestamp"}, "ResourceARN":{ "type":"string", - "documentation":"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.
", + "documentation":"The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", "max":512, "min":8, "pattern":"^arn:(?=[^:]+:fsx:[^:]+:\\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\\d{1,3}(\\.\\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\\.)(?![^:]*\\.-)[a-z0-9].*(?The resource specified by the Amazon Resource Name (ARN) can't be found.", "exception":true }, + "ResourceType":{ + "type":"string", + "enum":[ + "FILE_SYSTEM", + "VOLUME" + ] + }, + "RouteTableId":{ + "type":"string", + "max":21, + "min":12, + "pattern":"^(rtb-[0-9a-f]{8,})$" + }, + "RouteTableIds":{ + "type":"list", + "member":{"shape":"RouteTableId"}, + "max":50 + }, "SecurityGroupId":{ "type":"string", "documentation":"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.
", @@ -2133,6 +2854,14 @@ "documentation":"A list of security group IDs.
", "max":50 }, + "SecurityStyle":{ + "type":"string", + "enum":[ + "UNIX", + "NTFS", + "MIXED" + ] + }, "SelfManagedActiveDirectoryAttributes":{ "type":"structure", "members":{ @@ -2142,7 +2871,7 @@ }, "OrganizationalUnitDistinguishedName":{ "shape":"OrganizationalUnitDistinguishedName", - "documentation":"The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server instance is joined.
" + "documentation":"The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.
" }, "FileSystemAdministratorsGroup":{ "shape":"FileSystemAdministratorsGroupName", @@ -2157,7 +2886,7 @@ "documentation":"A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
" } }, - "documentation":"The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.
" + "documentation":"The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.
" }, "SelfManagedActiveDirectoryConfiguration":{ "type":"structure", @@ -2174,7 +2903,7 @@ }, "OrganizationalUnitDistinguishedName":{ "shape":"OrganizationalUnitDistinguishedName", - "documentation":"(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory.
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory.
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
" } }, - "documentation":"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. For more information, see Using Amazon FSx with your self-managed Microsoft Active Directory.
" + "documentation":"The configuration that Amazon FSx uses to join a Amazon FSx for Windows File Server file system or an ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx with your self-managed Microsoft Active Directory or Managing SVMs.
" }, "SelfManagedActiveDirectoryConfigurationUpdates":{ "type":"structure", @@ -2215,14 +2944,17 @@ }, "ServiceLimit":{ "type":"string", - "documentation":"The types of limits on your service utilization. Limits include file system count, total throughput capacity, total storage, and total user-initiated backups. These limits apply for a specific account in a specific AWS Region. You can increase some of them by contacting AWS Support.
", + "documentation":"The types of limits on your service utilization. Limits include file system count, total throughput capacity, total storage, and total user-initiated backups. These limits apply for a specific account in a specific Amazon Web Services Region. You can increase some of them by contacting Amazon Web Services Support.
", "enum":[ "FILE_SYSTEM_COUNT", "TOTAL_THROUGHPUT_CAPACITY", "TOTAL_STORAGE", "TOTAL_USER_INITIATED_BACKUPS", "TOTAL_USER_TAGS", - "TOTAL_IN_PROGRESS_COPY_BACKUPS" + "TOTAL_IN_PROGRESS_COPY_BACKUPS", + "STORAGE_VIRTUAL_MACHINES_PER_FILE_SYSTEM", + "VOLUMES_PER_FILE_SYSTEM", + "TOTAL_SSD_IOPS" ] }, "ServiceLimitExceeded":{ @@ -2235,7 +2967,7 @@ }, "Message":{"shape":"ErrorMessage"} }, - "documentation":"An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.
", + "documentation":"An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.
", "exception":true }, "SourceBackupId":{ @@ -2278,6 +3010,144 @@ "HDD" ] }, + "StorageVirtualMachine":{ + "type":"structure", + "members":{ + "ActiveDirectoryConfiguration":{ + "shape":"SvmActiveDirectoryConfiguration", + "documentation":"Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
" + }, + "CreationTime":{"shape":"CreationTime"}, + "Endpoints":{ + "shape":"SvmEndpoints", + "documentation":"The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.
Describes the SVM's lifecycle status.
CREATED - The SVM is fully available for use.
CREATING - Amazon FSx is creating the new SVM.
DELETING - Amazon FSx is deleting an existing SVM.
FAILED - Amazon FSx was unable to create the SVM.
MISCONFIGURED - The SVM is in a failed but recoverable state.
PENDING - Amazon FSx has not started creating the SVM.
The name of the SVM, if provisioned.
" + }, + "ResourceARN":{"shape":"ResourceARN"}, + "StorageVirtualMachineId":{ + "shape":"StorageVirtualMachineId", + "documentation":"The SVM's system generated unique ID.
" + }, + "Subtype":{ + "shape":"StorageVirtualMachineSubtype", + "documentation":"Describes the SVM's subtype.
" + }, + "UUID":{ + "shape":"UUID", + "documentation":"The SVM's UUID (universally unique identifier).
" + }, + "Tags":{"shape":"Tags"}, + "LifecycleTransitionReason":{ + "shape":"LifecycleTransitionReason", + "documentation":"Describes why the SVM lifecycle state changed.
" + }, + "RootVolumeSecurityStyle":{ + "shape":"StorageVirtualMachineRootVolumeSecurityStyle", + "documentation":"The security style of the root volume of the SVM.
" + } + }, + "documentation":"Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuraton.
" + }, + "StorageVirtualMachineFilter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"StorageVirtualMachineFilterName", + "documentation":"The name for this filter.
" + }, + "Values":{ + "shape":"StorageVirtualMachineFilterValues", + "documentation":"The values of the filter. These are all the values for any of the applied filters.
" + } + }, + "documentation":"A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). You can use multiple filters to return results that meet all applied filter requirements.
" + }, + "StorageVirtualMachineFilterName":{ + "type":"string", + "enum":["file-system-id"] + }, + "StorageVirtualMachineFilterValue":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[0-9a-zA-Z\\*\\.\\\\/\\?\\-\\_]*$" + }, + "StorageVirtualMachineFilterValues":{ + "type":"list", + "member":{"shape":"StorageVirtualMachineFilterValue"}, + "max":20 + }, + "StorageVirtualMachineFilters":{ + "type":"list", + "member":{"shape":"StorageVirtualMachineFilter"}, + "max":1 + }, + "StorageVirtualMachineId":{ + "type":"string", + "max":21, + "min":21, + "pattern":"^(svm-[0-9a-f]{17,})$" + }, + "StorageVirtualMachineIds":{ + "type":"list", + "member":{"shape":"StorageVirtualMachineId"}, + "max":50 + }, + "StorageVirtualMachineLifecycle":{ + "type":"string", + "enum":[ + "CREATED", + "CREATING", + "DELETING", + "FAILED", + "MISCONFIGURED", + "PENDING" + ] + }, + "StorageVirtualMachineName":{ + "type":"string", + "max":47, + "min":1, + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,47}$" + }, + "StorageVirtualMachineNotFound":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied parameters.
", + "exception":true + }, + "StorageVirtualMachineRootVolumeSecurityStyle":{ + "type":"string", + "enum":[ + "UNIX", + "NTFS", + "MIXED" + ] + }, + "StorageVirtualMachineSubtype":{ + "type":"string", + "enum":[ + "DEFAULT", + "DP_DESTINATION", + "SYNC_DESTINATION", + "SYNC_SOURCE" + ] + }, + "StorageVirtualMachines":{ + "type":"list", + "member":{"shape":"StorageVirtualMachine"}, + "max":50 + }, "SubnetId":{ "type":"string", "documentation":"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.
", @@ -2292,6 +3162,50 @@ "max":50 }, "SucceededCount":{"type":"long"}, + "SvmActiveDirectoryConfiguration":{ + "type":"structure", + "members":{ + "NetBiosName":{ + "shape":"NetBiosAlias", + "documentation":"The NetBIOS name of the Active Directory computer object that is joined to your SVM.
" + }, + "SelfManagedActiveDirectoryConfiguration":{"shape":"SelfManagedActiveDirectoryAttributes"} + }, + "documentation":"Describes the configuration of the Microsoft Active Directory (AD) directory to which the Amazon FSx for ONTAP storage virtual machine (SVM) is joined. Pleae note, account credentials are not returned in the response payload.
" + }, + "SvmEndpoint":{ + "type":"structure", + "members":{ + "DNSName":{"shape":"DNSName"}, + "IpAddresses":{ + "shape":"OntapEndpointIpAddresses", + "documentation":"The SVM endpoint's IP addresses.
" + } + }, + "documentation":"An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has four endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.
An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol.
" + }, + "Management":{ + "shape":"SvmEndpoint", + "documentation":"An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager.
" + }, + "Nfs":{ + "shape":"SvmEndpoint", + "documentation":"An endpoint for connecting using the Network File System (NFS) protocol.
" + }, + "Smb":{ + "shape":"SvmEndpoint", + "documentation":"An endpoint for connecting using the Server Message Block (SMB) protocol.
" + } + }, + "documentation":"An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has the following endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager.
" + }, "Tag":{ "type":"structure", "required":[ @@ -2373,7 +3287,35 @@ "member":{"shape":"TaskId"}, "max":50 }, + "TieringPolicy":{ + "type":"structure", + "members":{ + "CoolingPeriod":{ + "shape":"CoolingPeriod", + "documentation":"Specifies the number of days that user data in a volume must remain inactive before it is considered \"cold\" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.
" + }, + "TieringPolicyName":{ + "type":"string", + "enum":[ + "SNAPSHOT_ONLY", + "AUTO", + "ALL", + "NONE" + ] + }, "TotalCount":{"type":"long"}, + "UUID":{ + "type":"string", + "max":36, + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,36}$" + }, "UnsupportedOperation":{ "type":"structure", "members":{ @@ -2426,6 +3368,19 @@ }, "documentation":"The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.
The ONTAP administrative password for the fsxadmin user.
The configuration updates for an Amazon FSx for NetApp ONTAP file system.
" + }, "UpdateFileSystemRequest":{ "type":"structure", "required":["FileSystemId"], @@ -2436,18 +3391,19 @@ }, "ClientRequestToken":{ "shape":"ClientRequestToken", - "documentation":"A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
", + "documentation":"A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
", "idempotencyToken":true }, "StorageCapacity":{ "shape":"StorageCapacity", - "documentation":"Use this parameter to increase the storage capacity of an Amazon FSx file system. Specifies the storage capacity target value, GiB, to increase the storage capacity for the file system that you're updating. You cannot make a storage capacity increase request if there is an existing storage capacity increase request in progress.
For Windows file systems, the storage capacity target value must be at least 10 percent (%) greater than the current storage capacity value. In order to increase storage capacity, the file system must have at least 16 MB/s of throughput capacity.
For Lustre file systems, the storage capacity target value can be the following:
For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12 MB/s/TiB file systems and multiples of 1800 GiB for 40 MB/s/TiB file systems. The values must be greater than the current storage capacity.
For SCRATCH_1 file systems, you cannot increase the storage capacity.
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.
" + "documentation":"Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system. Specifies the storage capacity target value, GiB, to increase the storage capacity for the file system that you're updating. You cannot make a storage capacity increase request if there is an existing storage capacity increase request in progress.
For Windows file systems, the storage capacity target value must be at least 10 percent (%) greater than the current storage capacity value. In order to increase storage capacity, the file system must have at least 16 MB/s of throughput capacity.
For Lustre file systems, the storage capacity target value can be the following:
For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12 MB/s/TiB file systems and multiples of 1800 GiB for 40 MB/s/TiB file systems. The values must be greater than the current storage capacity.
For SCRATCH_1 file systems, you cannot increase the storage capacity.
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.
" }, "WindowsConfiguration":{ "shape":"UpdateFileSystemWindowsConfiguration", "documentation":"The configuration updates for an Amazon FSx for Windows File Server file system.
" }, - "LustreConfiguration":{"shape":"UpdateFileSystemLustreConfiguration"} + "LustreConfiguration":{"shape":"UpdateFileSystemLustreConfiguration"}, + "OntapConfiguration":{"shape":"UpdateFileSystemOntapConfiguration"} }, "documentation":"The request object for the UpdateFileSystem operation.
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.
" }, + "UpdateOntapVolumeConfiguration":{ + "type":"structure", + "members":{ + "JunctionPath":{ + "shape":"JunctionPath", + "documentation":"Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3.
The security style for the volume, which can be UNIX. NTFS, or MIXED.
Specifies the size of the volume in megabytes.
" + }, + "StorageEfficiencyEnabled":{ + "shape":"Flag", + "documentation":"Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
Update the volume's data tiering policy.
" + } + }, + "documentation":"Used to specify changes to the ONTAP configuration for the volume you are updating.
" + }, + "UpdateStorageVirtualMachineRequest":{ + "type":"structure", + "required":["StorageVirtualMachineId"], + "members":{ + "ActiveDirectoryConfiguration":{ + "shape":"UpdateSvmActiveDirectoryConfiguration", + "documentation":"Updates the Microsoft Active Directory (AD) configuration for an SVM that is joined to an AD.
" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "StorageVirtualMachineId":{ + "shape":"StorageVirtualMachineId", + "documentation":"The ID of the SVM that you want to update, in the format svm-0123456789abcdef0.
Enter a new SvmAdminPassword if you are updating it.
" + } + } + }, + "UpdateStorageVirtualMachineResponse":{ + "type":"structure", + "members":{ + "StorageVirtualMachine":{"shape":"StorageVirtualMachine"} + } + }, + "UpdateSvmActiveDirectoryConfiguration":{ + "type":"structure", + "members":{ + "SelfManagedActiveDirectoryConfiguration":{"shape":"SelfManagedActiveDirectoryConfigurationUpdates"} + }, + "documentation":"Updates the Microsoft Active Directory (AD) configuration of an SVM joined to an AD. Pleae note, account credentials are not returned in the response payload.
" + }, + "UpdateVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "VolumeId":{ + "shape":"VolumeId", + "documentation":"Specifies the volume that you want to update, formatted fsvol-0123456789abcdef0.
The ONTAP configuration of the volume you are updating.
Returned after a successful UpdateVolume API operation, describing the volume just updated.
The lifecycle status of the volume.
CREATED - The volume is fully available for use.
CREATING - Amazon FSx is creating the new volume.
DELETING - Amazon FSx is deleting an existing volume.
FAILED - Amazon FSx was unable to create the volume.
MISCONFIGURED - The volume is in a failed but recoverable state.
PENDING - Amazon FSx has not started creating the volume.
The name of the volume.
" + }, + "OntapConfiguration":{"shape":"OntapVolumeConfiguration"}, + "ResourceARN":{"shape":"ResourceARN"}, + "Tags":{"shape":"Tags"}, + "VolumeId":{ + "shape":"VolumeId", + "documentation":"The system-generated, unique ID of the volume.
" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"The type of volume; ONTAP is the only valid volume type.
Describes why the volume lifecycle state changed.
" + } + }, + "documentation":"Describes an Amazon FSx for NetApp ONTAP volume.
" + }, + "VolumeCapacity":{ + "type":"integer", + "max":2147483647, + "min":0 + }, + "VolumeFilter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"VolumeFilterName", + "documentation":"The name for this filter.
" + }, + "Values":{ + "shape":"VolumeFilterValues", + "documentation":"The values of the filter. These are all the values for any of the applied filters.
" + } + }, + "documentation":"A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP volumes. You can use multiple filters to return results that meet all applied filter requirements.
" + }, + "VolumeFilterName":{ + "type":"string", + "enum":[ + "file-system-id", + "storage-virtual-machine-id" + ] + }, + "VolumeFilterValue":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[0-9a-zA-Z\\*\\.\\\\/\\?\\-\\_]*$" + }, + "VolumeFilterValues":{ + "type":"list", + "member":{"shape":"VolumeFilterValue"}, + "max":20 + }, + "VolumeFilters":{ + "type":"list", + "member":{"shape":"VolumeFilter"}, + "max":2 + }, + "VolumeId":{ + "type":"string", + "max":23, + "min":23, + "pattern":"^(fsvol-[0-9a-f]{17,})$" + }, + "VolumeIds":{ + "type":"list", + "member":{"shape":"VolumeId"}, + "max":50 + }, + "VolumeLifecycle":{ + "type":"string", + "enum":[ + "CREATING", + "CREATED", + "DELETING", + "FAILED", + "MISCONFIGURED", + "PENDING" + ] + }, + "VolumeName":{ + "type":"string", + "max":203, + "min":1, + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,203}$" + }, + "VolumeNotFound":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied parameters.
", + "exception":true + }, + "VolumeType":{ + "type":"string", + "enum":["ONTAP"] + }, + "Volumes":{ + "type":"list", + "member":{"shape":"Volume"}, + "max":50 + }, "VpcId":{ "type":"string", "documentation":"The ID of your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
", @@ -2531,7 +3693,7 @@ }, "AuditLogDestination":{ "shape":"GeneralARN", - "documentation":"The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.
The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix.
The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same AWS partition, AWS region, and AWS account as your Amazon FSx file system.
" + "documentation":"The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.
The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix.
The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
" } }, "documentation":"The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. For more information, see File access auditing.
" @@ -2553,7 +3715,7 @@ }, "AuditLogDestination":{ "shape":"GeneralARN", - "documentation":"The Amazon Resource Name (ARN) that specifies the destination of the audit logs.
The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN, with the following requirements:
The destination ARN that you provide (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same AWS partition, AWS region, and AWS account as your Amazon FSx file system.
The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix.
If you do not provide a destination in AuditLogDestination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.
If AuditLogDestination is provided and the resource does not exist, the request will fail with a BadRequest error.
If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel are both set to DISABLED, you cannot specify a destination in AuditLogDestination.
The Amazon Resource Name (ARN) that specifies the destination of the audit logs.
The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN, with the following requirements:
The destination ARN that you provide (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehouse delivery stream must begin with the aws-fsx prefix.
If you do not provide a destination in AuditLogDestination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.
If AuditLogDestination is provided and the resource does not exist, the request will fail with a BadRequest error.
If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel are both set to DISABLED, you cannot specify a destination in AuditLogDestination.
The Windows file access auditing configuration used when creating or updating an Amazon FSx for Windows File Server file system.
" @@ -2571,7 +3733,7 @@ "members":{ "ActiveDirectoryId":{ "shape":"DirectoryId", - "documentation":"The ID for an existing AWS Managed Microsoft Active Directory instance that the file system is joined to.
" + "documentation":"The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
" }, "SelfManagedActiveDirectoryConfiguration":{"shape":"SelfManagedActiveDirectoryAttributes"}, "DeploymentType":{