2021/09/02 - Amazon FSx - 9 new 7 updated api methods
Changes Announcing Amazon FSx for NetApp ONTAP, a new service that provides fully managed shared storage in the AWS Cloud with the data access and management capabilities of ONTAP.
Describes one or more Amazon FSx for NetApp ONTAP volumes.
See also: AWS API Documentation
Request Syntax
client.describe_volumes(
VolumeIds=[
'string',
],
Filters=[
{
'Name': 'file-system-id'|'storage-virtual-machine-id',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
list
IDs of the volumes whose descriptions you want to retrieve.
(string) --
list
Enter a filter name:value pair to view a select set of volumes.
(dict) --
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.
Name (string) --
The name for this filter.
Values (list) --
The values of the filter. These are all the values for any of the applied filters.
(string) --
integer
The maximum number of resources to return in the response. This value must be an integer greater than zero.
string
(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.
dict
Response Syntax
{
'Volumes': [
{
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Volumes (list) --
Returned after a successful DescribeVolumes operation, describing each volume.
(dict) --
Describes an Amazon FSx for NetApp ONTAP volume.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
NextToken (string) --
(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.
Creates an Amazon FSx for NetApp ONTAP storage volume.
See also: AWS API Documentation
Request Syntax
client.create_volume(
ClientRequestToken='string',
VolumeType='ONTAP',
Name='string',
OntapConfiguration={
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
This field is autopopulated if not provided.
string
[REQUIRED]
Specifies the type of volume to create; ONTAP is the only valid volume type.
string
[REQUIRED]
Specifies the name of the volume you're creating.
dict
Specifies the ONTAP configuration to use in creating the volume.
JunctionPath (string) -- [REQUIRED]
Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3 .
SecurityStyle (string) --
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.
SizeInMegabytes (integer) -- [REQUIRED]
Specifies the size of the volume, in megabytes (MB), that you are creating.
StorageEfficiencyEnabled (boolean) -- [REQUIRED]
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
StorageVirtualMachineId (string) -- [REQUIRED]
Specifies the ONTAP SVM in which to create the volume.
TieringPolicy (dict) --
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.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
list
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) -- [REQUIRED]
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) -- [REQUIRED]
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
dict
Response Syntax
{
'Volume': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
}
Response Structure
(dict) --
Volume (dict) --
Returned after a successful CreateVolume API operation, describing the volume just created.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
See also: AWS API Documentation
Request Syntax
client.create_volume_from_backup(
BackupId='string',
ClientRequestToken='string',
Name='string',
OntapConfiguration={
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the source backup. Specifies the backup you are copying.
string
(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the new volume you're creating.
dict
Specifies the configuration of the ONTAP volume that you are creating.
JunctionPath (string) -- [REQUIRED]
Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3 .
SecurityStyle (string) --
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.
SizeInMegabytes (integer) -- [REQUIRED]
Specifies the size of the volume, in megabytes (MB), that you are creating.
StorageEfficiencyEnabled (boolean) -- [REQUIRED]
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
StorageVirtualMachineId (string) -- [REQUIRED]
Specifies the ONTAP SVM in which to create the volume.
TieringPolicy (dict) --
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.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
list
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) -- [REQUIRED]
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) -- [REQUIRED]
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
dict
Response Syntax
{
'Volume': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
}
Response Structure
(dict) --
Volume (dict) --
Returned after a successful CreateVolumeFromBackup API operation, describing the volume just created.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
See also: AWS API Documentation
Request Syntax
client.create_storage_virtual_machine(
ActiveDirectoryConfiguration={
'NetBiosName': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'Password': 'string',
'DnsIps': [
'string',
]
}
},
ClientRequestToken='string',
FileSystemId='string',
Name='string',
SvmAdminPassword='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
RootVolumeSecurityStyle='UNIX'|'NTFS'|'MIXED'
)
dict
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.
NetBiosName (string) -- [REQUIRED]
The NetBIOS name of the Active Directory computer object that will be created for your SVM.
SelfManagedActiveDirectoryConfiguration (dict) --
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 .
DomainName (string) -- [REQUIRED]
The fully qualified domain name of the self-managed AD directory, such as corp.example.com .
OrganizationalUnitDistinguishedName (string) --
(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.
Warning
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
FileSystemAdministratorsGroup (string) --
(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.
UserName (string) -- [REQUIRED]
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName , or in the default location of your AD domain.
Password (string) -- [REQUIRED]
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
DnsIps (list) -- [REQUIRED]
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
string
(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
This field is autopopulated if not provided.
string
[REQUIRED]
The globally unique ID of the file system, assigned by Amazon FSx.
string
[REQUIRED]
The name of the SVM.
string
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.
list
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) -- [REQUIRED]
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) -- [REQUIRED]
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
string
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.
dict
Response Syntax
{
'StorageVirtualMachine': {
'ActiveDirectoryConfiguration': {
'NetBiosName': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'DnsIps': [
'string',
]
}
},
'CreationTime': datetime(2015, 1, 1),
'Endpoints': {
'Iscsi': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Management': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Nfs': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Smb': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
}
},
'FileSystemId': 'string',
'Lifecycle': 'CREATED'|'CREATING'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'ResourceARN': 'string',
'StorageVirtualMachineId': 'string',
'Subtype': 'DEFAULT'|'DP_DESTINATION'|'SYNC_DESTINATION'|'SYNC_SOURCE',
'UUID': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LifecycleTransitionReason': {
'Message': 'string'
},
'RootVolumeSecurityStyle': 'UNIX'|'NTFS'|'MIXED'
}
}
Response Structure
(dict) --
StorageVirtualMachine (dict) --
Returned after a successful CreateStorageVirtualMachine operation; describes the SVM just created.
ActiveDirectoryConfiguration (dict) --
Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
NetBiosName (string) --
The NetBIOS name of the Active Directory computer object that is joined to your SVM.
SelfManagedActiveDirectoryConfiguration (dict) --
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.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
OrganizationalUnitDistinguishedName (string) --
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 (string) --
The name of the domain group whose members have administrative privileges for the FSx file system.
UserName (string) --
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
Endpoints (dict) --
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.
Iscsi (dict) --
An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
Management (dict) --
An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
Nfs (dict) --
An endpoint for connecting using the Network File System (NFS) protocol.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
Smb (dict) --
An endpoint for connecting using the Server Message Block (SMB) protocol.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the SVM, if provisioned.
ResourceARN (string) --
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 .
StorageVirtualMachineId (string) --
The SVM's system generated unique ID.
Subtype (string) --
Describes the SVM's subtype.
UUID (string) --
The SVM's UUID (universally unique identifier).
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
LifecycleTransitionReason (dict) --
Describes why the SVM lifecycle state changed.
Message (string) --
A detailed error message.
RootVolumeSecurityStyle (string) --
The security style of the root volume of the SVM.
Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
See also: AWS API Documentation
Request Syntax
client.update_storage_virtual_machine(
ActiveDirectoryConfiguration={
'SelfManagedActiveDirectoryConfiguration': {
'UserName': 'string',
'Password': 'string',
'DnsIps': [
'string',
]
}
},
ClientRequestToken='string',
StorageVirtualMachineId='string',
SvmAdminPassword='string'
)
dict
Updates the Microsoft Active Directory (AD) configuration for an SVM that is joined to an AD.
SelfManagedActiveDirectoryConfiguration (dict) --
The configuration that Amazon FSx uses to join the Windows File Server instance to a self-managed Microsoft Active Directory (AD) directory.
UserName (string) --
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName .
Password (string) --
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
string
(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the SVM that you want to update, in the format svm-0123456789abcdef0 .
string
Enter a new SvmAdminPassword if you are updating it.
dict
Response Syntax
{
'StorageVirtualMachine': {
'ActiveDirectoryConfiguration': {
'NetBiosName': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'DnsIps': [
'string',
]
}
},
'CreationTime': datetime(2015, 1, 1),
'Endpoints': {
'Iscsi': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Management': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Nfs': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Smb': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
}
},
'FileSystemId': 'string',
'Lifecycle': 'CREATED'|'CREATING'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'ResourceARN': 'string',
'StorageVirtualMachineId': 'string',
'Subtype': 'DEFAULT'|'DP_DESTINATION'|'SYNC_DESTINATION'|'SYNC_SOURCE',
'UUID': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LifecycleTransitionReason': {
'Message': 'string'
},
'RootVolumeSecurityStyle': 'UNIX'|'NTFS'|'MIXED'
}
}
Response Structure
(dict) --
StorageVirtualMachine (dict) --
Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuraton.
ActiveDirectoryConfiguration (dict) --
Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
NetBiosName (string) --
The NetBIOS name of the Active Directory computer object that is joined to your SVM.
SelfManagedActiveDirectoryConfiguration (dict) --
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.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
OrganizationalUnitDistinguishedName (string) --
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 (string) --
The name of the domain group whose members have administrative privileges for the FSx file system.
UserName (string) --
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
Endpoints (dict) --
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.
Iscsi (dict) --
An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
Management (dict) --
An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
Nfs (dict) --
An endpoint for connecting using the Network File System (NFS) protocol.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
Smb (dict) --
An endpoint for connecting using the Server Message Block (SMB) protocol.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the SVM, if provisioned.
ResourceARN (string) --
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 .
StorageVirtualMachineId (string) --
The SVM's system generated unique ID.
Subtype (string) --
Describes the SVM's subtype.
UUID (string) --
The SVM's UUID (universally unique identifier).
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
LifecycleTransitionReason (dict) --
Describes why the SVM lifecycle state changed.
Message (string) --
A detailed error message.
RootVolumeSecurityStyle (string) --
The security style of the root volume of the SVM.
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
See also: AWS API Documentation
Request Syntax
client.describe_storage_virtual_machines(
StorageVirtualMachineIds=[
'string',
],
Filters=[
{
'Name': 'file-system-id',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
list
Enter the ID of one or more SVMs that you want to view.
(string) --
list
Enter a filter name:value pair to view a select set of SVMs.
(dict) --
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.
Name (string) --
The name for this filter.
Values (list) --
The values of the filter. These are all the values for any of the applied filters.
(string) --
integer
The maximum number of resources to return in the response. This value must be an integer greater than zero.
string
(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.
dict
Response Syntax
{
'StorageVirtualMachines': [
{
'ActiveDirectoryConfiguration': {
'NetBiosName': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'DnsIps': [
'string',
]
}
},
'CreationTime': datetime(2015, 1, 1),
'Endpoints': {
'Iscsi': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Management': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Nfs': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Smb': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
}
},
'FileSystemId': 'string',
'Lifecycle': 'CREATED'|'CREATING'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'ResourceARN': 'string',
'StorageVirtualMachineId': 'string',
'Subtype': 'DEFAULT'|'DP_DESTINATION'|'SYNC_DESTINATION'|'SYNC_SOURCE',
'UUID': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LifecycleTransitionReason': {
'Message': 'string'
},
'RootVolumeSecurityStyle': 'UNIX'|'NTFS'|'MIXED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
StorageVirtualMachines (list) --
Returned after a successful DescribeStorageVirtualMachines operation, describing each SVM.
(dict) --
Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuraton.
ActiveDirectoryConfiguration (dict) --
Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
NetBiosName (string) --
The NetBIOS name of the Active Directory computer object that is joined to your SVM.
SelfManagedActiveDirectoryConfiguration (dict) --
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.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
OrganizationalUnitDistinguishedName (string) --
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 (string) --
The name of the domain group whose members have administrative privileges for the FSx file system.
UserName (string) --
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
Endpoints (dict) --
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.
Iscsi (dict) --
An endpoint for connecting using the Internet Small Computer Systems Interface (iSCSI) protocol.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
Management (dict) --
An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp ONTAP API, or NetApp CloudManager.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
Nfs (dict) --
An endpoint for connecting using the Network File System (NFS) protocol.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
Smb (dict) --
An endpoint for connecting using the Server Message Block (SMB) protocol.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
The SVM endpoint's IP addresses.
(string) --
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the SVM, if provisioned.
ResourceARN (string) --
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 .
StorageVirtualMachineId (string) --
The SVM's system generated unique ID.
Subtype (string) --
Describes the SVM's subtype.
UUID (string) --
The SVM's UUID (universally unique identifier).
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
LifecycleTransitionReason (dict) --
Describes why the SVM lifecycle state changed.
Message (string) --
A detailed error message.
RootVolumeSecurityStyle (string) --
The security style of the root volume of the SVM.
NextToken (string) --
(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.
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.
See also: AWS API Documentation
Request Syntax
client.delete_storage_virtual_machine(
ClientRequestToken='string',
StorageVirtualMachineId='string'
)
string
(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the SVM that you want to delete.
dict
Response Syntax
{
'StorageVirtualMachineId': 'string',
'Lifecycle': 'CREATED'|'CREATING'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'
}
Response Structure
(dict) --
StorageVirtualMachineId (string) --
The ID of the SVM Amazon FSx is deleting.
Lifecycle (string) --
Describes the lifecycle state of the SVM being deleted.
Updates an Amazon FSx for NetApp ONTAP volume's configuration.
See also: AWS API Documentation
Request Syntax
client.update_volume(
ClientRequestToken='string',
VolumeId='string',
OntapConfiguration={
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
}
}
)
string
(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
This field is autopopulated if not provided.
string
[REQUIRED]
Specifies the volume that you want to update, formatted fsvol-0123456789abcdef0 .
dict
The ONTAP configuration of the volume you are updating.
JunctionPath (string) --
Specifies the location in the SVM's namespace where the volume is mounted. The JunctionPath must have a leading forward slash, such as /vol3 .
SecurityStyle (string) --
The security style for the volume, which can be UNIX . NTFS , or MIXED .
SizeInMegabytes (integer) --
Specifies the size of the volume in megabytes.
StorageEfficiencyEnabled (boolean) --
Default is false . Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
TieringPolicy (dict) --
Update the volume's data tiering policy.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
dict
Response Syntax
{
'Volume': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
}
Response Structure
(dict) --
Volume (dict) --
Returned after a successful UpdateVolume API operation, describing the volume just updated.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
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.
See also: AWS API Documentation
Request Syntax
client.delete_volume(
ClientRequestToken='string',
VolumeId='string',
OntapConfiguration={
'SkipFinalBackup': True|False,
'FinalBackupTags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
)
string
(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the volume you are deleting.
dict
For Amazon FSx for ONTAP volumes, specify whether to take a final backup of the volume, and apply tags to the backup.
SkipFinalBackup (boolean) --
Set to true if you want to skip taking a final backup of the volume you are deleting.
FinalBackupTags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) -- [REQUIRED]
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) -- [REQUIRED]
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
dict
Response Syntax
{
'VolumeId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'OntapResponse': {
'FinalBackupId': 'string',
'FinalBackupTags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
VolumeId (string) --
The ID of the volume being deleted.
Lifecycle (string) --
Describes the lifecycle state of the volume being deleted.
OntapResponse (dict) --
Returned after a DeleteVolume request, showing the status of the delete request.
FinalBackupId (string) --
The ID of the source backup. Specifies the backup you are copying.
FinalBackupTags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
{'Backup': {'FileSystem': {'AdministrativeActions': {'TargetVolumeValues': {'CreationTime': 'timestamp',
'FileSystemId': 'string',
'Lifecycle': 'CREATING '
'| '
'CREATED '
'| '
'DELETING '
'| '
'FAILED '
'| '
'MISCONFIGURED '
'| '
'PENDING',
'LifecycleTransitionReason': {'Message': 'string'},
'Name': 'string',
'OntapConfiguration': {'FlexCacheEndpointType': 'NONE '
'| '
'ORIGIN '
'| '
'CACHE',
'JunctionPath': 'string',
'OntapVolumeType': 'RW '
'| '
'DP '
'| '
'LS',
'SecurityStyle': 'UNIX '
'| '
'NTFS '
'| '
'MIXED',
'SizeInMegabytes': 'integer',
'StorageEfficiencyEnabled': 'boolean',
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': 'boolean',
'TieringPolicy': {'CoolingPeriod': 'integer',
'Name': 'SNAPSHOT_ONLY '
'| '
'AUTO '
'| '
'ALL '
'| '
'NONE'},
'UUID': 'string'},
'ResourceARN': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}],
'VolumeId': 'string',
'VolumeType': 'ONTAP'}},
'FileSystemType': {'ONTAP'},
'OntapConfiguration': {'AutomaticBackupRetentionDays': 'integer',
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'DiskIopsConfiguration': {'Iops': 'long',
'Mode': 'AUTOMATIC '
'| '
'USER_PROVISIONED'},
'EndpointIpAddressRange': 'string',
'Endpoints': {'Intercluster': {'DNSName': 'string',
'IpAddresses': ['string']},
'Management': {'DNSName': 'string',
'IpAddresses': ['string']}},
'PreferredSubnetId': 'string',
'RouteTableIds': ['string'],
'ThroughputCapacity': 'integer',
'WeeklyMaintenanceStartTime': 'string'}},
'ResourceType': 'FILE_SYSTEM | VOLUME',
'Volume': {'CreationTime': 'timestamp',
'FileSystemId': 'string',
'Lifecycle': 'CREATING | CREATED | DELETING | FAILED | '
'MISCONFIGURED | PENDING',
'LifecycleTransitionReason': {'Message': 'string'},
'Name': 'string',
'OntapConfiguration': {'FlexCacheEndpointType': 'NONE | '
'ORIGIN '
'| '
'CACHE',
'JunctionPath': 'string',
'OntapVolumeType': 'RW | DP | LS',
'SecurityStyle': 'UNIX | NTFS | '
'MIXED',
'SizeInMegabytes': 'integer',
'StorageEfficiencyEnabled': 'boolean',
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': 'boolean',
'TieringPolicy': {'CoolingPeriod': 'integer',
'Name': 'SNAPSHOT_ONLY '
'| '
'AUTO '
'| ALL '
'| '
'NONE'},
'UUID': 'string'},
'ResourceARN': 'string',
'Tags': [{'Key': 'string', 'Value': 'string'}],
'VolumeId': 'string',
'VolumeType': 'ONTAP'}}}
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 .
See also: AWS API Documentation
Request Syntax
client.copy_backup(
ClientRequestToken='string',
SourceBackupId='string',
SourceRegion='string',
KmsKeyId='string',
CopyTags=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the source backup. Specifies the ID of the backup that is being copied.
string
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).
string
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 .
boolean
A boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.
If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.
list
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) -- [REQUIRED]
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) -- [REQUIRED]
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
dict
Response Syntax
{
'Backup': {
'BackupId': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'TRANSFERRING'|'DELETED'|'FAILED'|'PENDING'|'COPYING',
'FailureDetails': {
'Message': 'string'
},
'Type': 'AUTOMATIC'|'USER_INITIATED'|'AWS_BACKUP',
'ProgressPercent': 123,
'CreationTime': datetime(2015, 1, 1),
'KmsKeyId': 'string',
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'FileSystem': {
'OwnerId': 'string',
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP',
'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING',
'FailureDetails': {
'Message': 'string'
},
'StorageCapacity': 123,
'StorageType': 'SSD'|'HDD',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'NetworkInterfaceIds': [
'string',
],
'DNSName': 'string',
'KmsKeyId': 'string',
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'WindowsConfiguration': {
'ActiveDirectoryId': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'DnsIps': [
'string',
]
},
'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
'RemoteAdministrationEndpoint': 'string',
'PreferredSubnetId': 'string',
'PreferredFileServerIp': 'string',
'ThroughputCapacity': 123,
'MaintenanceOperationsInProgress': [
'PATCHING'|'BACKING_UP',
],
'WeeklyMaintenanceStartTime': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'Aliases': [
{
'Name': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'
},
],
'AuditLogConfiguration': {
'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'AuditLogDestination': 'string'
}
},
'LustreConfiguration': {
'WeeklyMaintenanceStartTime': 'string',
'DataRepositoryConfiguration': {
'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING',
'ImportPath': 'string',
'ExportPath': 'string',
'ImportedFileChunkSize': 123,
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'FailureDetails': {
'Message': 'string'
}
},
'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1',
'PerUnitStorageThroughput': 123,
'MountName': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'DriveCacheType': 'NONE'|'READ',
'DataCompressionType': 'NONE'|'LZ4'
},
'AdministrativeActions': [
{
'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION',
'ProgressPercent': 123,
'RequestTime': datetime(2015, 1, 1),
'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING',
'TargetFileSystemValues': {'... recursive ...'},
'FailureDetails': {
'Message': 'string'
},
'TargetVolumeValues': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
},
],
'OntapConfiguration': {
'AutomaticBackupRetentionDays': 123,
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'EndpointIpAddressRange': 'string',
'Endpoints': {
'Intercluster': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Management': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
}
},
'DiskIopsConfiguration': {
'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
'Iops': 123
},
'PreferredSubnetId': 'string',
'RouteTableIds': [
'string',
],
'ThroughputCapacity': 123,
'WeeklyMaintenanceStartTime': 'string'
}
},
'DirectoryInformation': {
'DomainName': 'string',
'ActiveDirectoryId': 'string',
'ResourceARN': 'string'
},
'OwnerId': 'string',
'SourceBackupId': 'string',
'SourceBackupRegion': 'string',
'ResourceType': 'FILE_SYSTEM'|'VOLUME',
'Volume': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
}
}
Response Structure
(dict) --
Backup (dict) --
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.
BackupId (string) --
The ID of the backup.
Lifecycle (string) --
The lifecycle status of the backup.
AVAILABLE - The backup is fully available.
PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.
CREATING - Amazon FSx is creating the backup.
TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.
COPYING - Amazon FSx is copying the backup.
DELETED - Amazon FSx deleted the backup and it is no longer available.
FAILED - Amazon FSx could not complete the backup.
FailureDetails (dict) --
Details explaining any failures that occur when creating a backup.
Message (string) --
A message describing the backup creation failure.
Type (string) --
The type of the file system backup.
ProgressPercent (integer) --
The current percent of progress of an asynchronous task.
CreationTime (datetime) --
The time when a particular backup was created.
KmsKeyId (string) --
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 (string) --
The Amazon Resource Name (ARN) for the backup resource.
Tags (list) --
Tags associated with a particular file system.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
FileSystem (dict) --
Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
OwnerId (string) --
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 (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The system-generated, unique 17-digit ID of the file system.
FileSystemType (string) --
The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , or ONTAP .
Lifecycle (string) --
The lifecycle status of the file system, following are the possible values and what they mean:
AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
CREATING - Amazon FSx is creating the new file system.
DELETING - Amazon FSx is deleting an existing file system.
FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.
MISCONFIGURED indicates that the file system is in a failed but recoverable state.
UPDATING indicates that the file system is undergoing a customer initiated update.
FailureDetails (dict) --
A structure providing details of any failures that occur when creating the file system has failed.
Message (string) --
A message describing any failures that occurred during file system creation.
StorageCapacity (integer) --
The storage capacity of the file system in gibibytes (GiB).
StorageType (string) --
The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.
VpcId (string) --
The ID of the primary VPC for the file system.
SubnetIds (list) --
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 .
(string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
NetworkInterfaceIds (list) --
The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.
For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.
(string) --
An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .
DNSName (string) --
The DNS name for the file system.
KmsKeyId (string) --
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 (string) --
The Amazon Resource Name (ARN) for the file system resource.
Tags (list) --
The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
WindowsConfiguration (dict) --
The configuration for this Microsoft Windows file system.
ActiveDirectoryId (string) --
The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
SelfManagedActiveDirectoryConfiguration (dict) --
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.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
OrganizationalUnitDistinguishedName (string) --
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 (string) --
The name of the domain group whose members have administrative privileges for the FSx file system.
UserName (string) --
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
DeploymentType (string) --
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.
SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see Single-AZ and Multi-AZ File Systems .
RemoteAdministrationEndpoint (string) --
For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
PreferredSubnetId (string) --
For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs . For more information, see Availability and durability: Single-AZ and Multi-AZ file systems .
PreferredFileServerIp (string) --
For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares .
ThroughputCapacity (integer) --
The throughput of the Amazon FSx file system, measured in megabytes per second.
MaintenanceOperationsInProgress (list) --
The list of maintenance operations in progress for this file system.
(string) --
An enumeration specifying the currently ongoing maintenance operation.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DailyAutomaticBackupStartTime (string) --
The preferred time to take daily automatic backups, in the UTC time zone.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Aliases (list) --
An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases .
(dict) --
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 .
Name (string) --
The name of the DNS alias. The alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com .
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
Lifecycle (string) --
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.
AuditLogConfiguration (dict) --
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.
FileAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
FileShareAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
AuditLogDestination (string) --
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.
LustreConfiguration (dict) --
The configuration for the Amazon FSx for Lustre file system.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DataRepositoryConfiguration (dict) --
The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.
Lifecycle (string) --
Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:
CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.
AVAILABLE - The data repository is available for use.
MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket .
UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.
ImportPath (string) --
The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix . If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
ExportPath (string) --
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
ImportedFileChunkSize (integer) --
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
AutoImportPolicy (string) --
Describes the file system's linked S3 data repository's AutoImportPolicy . The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
For more information, see Automatically import updates from your S3 bucket .
FailureDetails (dict) --
Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .
Message (string) --
A detailed error message.
DeploymentType (string) --
The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.
SCRATCH_1 and SCRATCH_2 deployment types are best suited for 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 .
The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = SCRATCH_1 )
PerUnitStorageThroughput (integer) --
Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
MountName (string) --
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.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)
DriveCacheType (string) --
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
DataCompressionType (string) --
The data compression configuration for the file system. DataCompressionType can have the following values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression .
AdministrativeActions (list) --
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.
(dict) --
Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.
AdministrativeActionType (string) --
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.
For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.
For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.
You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .
FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .
FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .
ProgressPercent (integer) --
Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
RequestTime (datetime) --
Time that the administrative action request was received.
Status (string) --
Describes the status of the administrative action, as follows:
FAILED - Amazon FSx failed to process the administrative action successfully.
IN_PROGRESS - Amazon FSx is processing the administrative action.
PENDING - Amazon FSx is waiting to process the administrative action.
COMPLETED - Amazon FSx has finished processing the administrative task.
UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. 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 .
TargetFileSystemValues (dict) --
Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
FailureDetails (dict) --
Provides information about a failed administrative action.
Message (string) --
Error message providing details about the failed administrative action.
TargetVolumeValues (dict) --
Describes an Amazon FSx for NetApp ONTAP volume.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
OntapConfiguration (dict) --
The configuration for this FSx for NetApp ONTAP file system.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
DeploymentType (string) --
The ONTAP file system deployment type.
EndpointIpAddressRange (string) --
The IP address range in which the endpoints to access your file system are created.
Endpoints (dict) --
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.
Intercluster (dict) --
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
Management (dict) --
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
DiskIopsConfiguration (dict) --
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
Mode (string) --
Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC ) or was provisioned by the customer (USER_PROVISIONED ).
Iops (integer) --
The total number of SSD IOPS provisioned for the file system.
PreferredSubnetId (string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
RouteTableIds (list) --
The VPC route tables in which your file system's endpoints are created.
(string) --
ThroughputCapacity (integer) --
Sustained throughput of an Amazon FSx file system in MBps.
WeeklyMaintenanceStartTime (string) --
A recurring weekly time, in the format D:HH:MM .
D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .
HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.
DirectoryInformation (dict) --
The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
ActiveDirectoryId (string) --
The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.
ResourceARN (string) --
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 .
OwnerId (string) --
An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
SourceBackupId (string) --
The ID of the source backup. Specifies the backup you are copying.
SourceBackupRegion (string) --
The source Region of the backup. Specifies the Region from where this backup is copied.
ResourceType (string) --
Specifies the resource type that is backed up.
Volume (dict) --
Describes an Amazon FSx for NetApp ONTAP volume.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
{'VolumeId': 'string'}
Response {'Backup': {'FileSystem': {'AdministrativeActions': {'TargetVolumeValues': {'CreationTime': 'timestamp',
'FileSystemId': 'string',
'Lifecycle': 'CREATING '
'| '
'CREATED '
'| '
'DELETING '
'| '
'FAILED '
'| '
'MISCONFIGURED '
'| '
'PENDING',
'LifecycleTransitionReason': {'Message': 'string'},
'Name': 'string',
'OntapConfiguration': {'FlexCacheEndpointType': 'NONE '
'| '
'ORIGIN '
'| '
'CACHE',
'JunctionPath': 'string',
'OntapVolumeType': 'RW '
'| '
'DP '
'| '
'LS',
'SecurityStyle': 'UNIX '
'| '
'NTFS '
'| '
'MIXED',
'SizeInMegabytes': 'integer',
'StorageEfficiencyEnabled': 'boolean',
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': 'boolean',
'TieringPolicy': {'CoolingPeriod': 'integer',
'Name': 'SNAPSHOT_ONLY '
'| '
'AUTO '
'| '
'ALL '
'| '
'NONE'},
'UUID': 'string'},
'ResourceARN': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}],
'VolumeId': 'string',
'VolumeType': 'ONTAP'}},
'FileSystemType': {'ONTAP'},
'OntapConfiguration': {'AutomaticBackupRetentionDays': 'integer',
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'DiskIopsConfiguration': {'Iops': 'long',
'Mode': 'AUTOMATIC '
'| '
'USER_PROVISIONED'},
'EndpointIpAddressRange': 'string',
'Endpoints': {'Intercluster': {'DNSName': 'string',
'IpAddresses': ['string']},
'Management': {'DNSName': 'string',
'IpAddresses': ['string']}},
'PreferredSubnetId': 'string',
'RouteTableIds': ['string'],
'ThroughputCapacity': 'integer',
'WeeklyMaintenanceStartTime': 'string'}},
'ResourceType': 'FILE_SYSTEM | VOLUME',
'Volume': {'CreationTime': 'timestamp',
'FileSystemId': 'string',
'Lifecycle': 'CREATING | CREATED | DELETING | FAILED | '
'MISCONFIGURED | PENDING',
'LifecycleTransitionReason': {'Message': 'string'},
'Name': 'string',
'OntapConfiguration': {'FlexCacheEndpointType': 'NONE | '
'ORIGIN '
'| '
'CACHE',
'JunctionPath': 'string',
'OntapVolumeType': 'RW | DP | LS',
'SecurityStyle': 'UNIX | NTFS | '
'MIXED',
'SizeInMegabytes': 'integer',
'StorageEfficiencyEnabled': 'boolean',
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': 'boolean',
'TieringPolicy': {'CoolingPeriod': 'integer',
'Name': 'SNAPSHOT_ONLY '
'| '
'AUTO '
'| ALL '
'| '
'NONE'},
'UUID': 'string'},
'ResourceARN': 'string',
'Tags': [{'Key': 'string', 'Value': 'string'}],
'VolumeId': 'string',
'VolumeType': 'ONTAP'}}}
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.
See also: AWS API Documentation
Request Syntax
client.create_backup(
FileSystemId='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
VolumeId='string'
)
string
The ID of the file system to back up.
string
(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.
This field is autopopulated if not provided.
list
(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.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) -- [REQUIRED]
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) -- [REQUIRED]
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
string
The ID of he FSx for NetApp ONTAP volume to back up.
dict
Response Syntax
{
'Backup': {
'BackupId': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'TRANSFERRING'|'DELETED'|'FAILED'|'PENDING'|'COPYING',
'FailureDetails': {
'Message': 'string'
},
'Type': 'AUTOMATIC'|'USER_INITIATED'|'AWS_BACKUP',
'ProgressPercent': 123,
'CreationTime': datetime(2015, 1, 1),
'KmsKeyId': 'string',
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'FileSystem': {
'OwnerId': 'string',
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP',
'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING',
'FailureDetails': {
'Message': 'string'
},
'StorageCapacity': 123,
'StorageType': 'SSD'|'HDD',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'NetworkInterfaceIds': [
'string',
],
'DNSName': 'string',
'KmsKeyId': 'string',
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'WindowsConfiguration': {
'ActiveDirectoryId': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'DnsIps': [
'string',
]
},
'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
'RemoteAdministrationEndpoint': 'string',
'PreferredSubnetId': 'string',
'PreferredFileServerIp': 'string',
'ThroughputCapacity': 123,
'MaintenanceOperationsInProgress': [
'PATCHING'|'BACKING_UP',
],
'WeeklyMaintenanceStartTime': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'Aliases': [
{
'Name': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'
},
],
'AuditLogConfiguration': {
'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'AuditLogDestination': 'string'
}
},
'LustreConfiguration': {
'WeeklyMaintenanceStartTime': 'string',
'DataRepositoryConfiguration': {
'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING',
'ImportPath': 'string',
'ExportPath': 'string',
'ImportedFileChunkSize': 123,
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'FailureDetails': {
'Message': 'string'
}
},
'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1',
'PerUnitStorageThroughput': 123,
'MountName': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'DriveCacheType': 'NONE'|'READ',
'DataCompressionType': 'NONE'|'LZ4'
},
'AdministrativeActions': [
{
'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION',
'ProgressPercent': 123,
'RequestTime': datetime(2015, 1, 1),
'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING',
'TargetFileSystemValues': {'... recursive ...'},
'FailureDetails': {
'Message': 'string'
},
'TargetVolumeValues': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
},
],
'OntapConfiguration': {
'AutomaticBackupRetentionDays': 123,
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'EndpointIpAddressRange': 'string',
'Endpoints': {
'Intercluster': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Management': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
}
},
'DiskIopsConfiguration': {
'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
'Iops': 123
},
'PreferredSubnetId': 'string',
'RouteTableIds': [
'string',
],
'ThroughputCapacity': 123,
'WeeklyMaintenanceStartTime': 'string'
}
},
'DirectoryInformation': {
'DomainName': 'string',
'ActiveDirectoryId': 'string',
'ResourceARN': 'string'
},
'OwnerId': 'string',
'SourceBackupId': 'string',
'SourceBackupRegion': 'string',
'ResourceType': 'FILE_SYSTEM'|'VOLUME',
'Volume': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
}
}
Response Structure
(dict) --
The response object for the CreateBackup operation.
Backup (dict) --
A description of the backup.
BackupId (string) --
The ID of the backup.
Lifecycle (string) --
The lifecycle status of the backup.
AVAILABLE - The backup is fully available.
PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.
CREATING - Amazon FSx is creating the backup.
TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.
COPYING - Amazon FSx is copying the backup.
DELETED - Amazon FSx deleted the backup and it is no longer available.
FAILED - Amazon FSx could not complete the backup.
FailureDetails (dict) --
Details explaining any failures that occur when creating a backup.
Message (string) --
A message describing the backup creation failure.
Type (string) --
The type of the file system backup.
ProgressPercent (integer) --
The current percent of progress of an asynchronous task.
CreationTime (datetime) --
The time when a particular backup was created.
KmsKeyId (string) --
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 (string) --
The Amazon Resource Name (ARN) for the backup resource.
Tags (list) --
Tags associated with a particular file system.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
FileSystem (dict) --
Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
OwnerId (string) --
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 (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The system-generated, unique 17-digit ID of the file system.
FileSystemType (string) --
The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , or ONTAP .
Lifecycle (string) --
The lifecycle status of the file system, following are the possible values and what they mean:
AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
CREATING - Amazon FSx is creating the new file system.
DELETING - Amazon FSx is deleting an existing file system.
FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.
MISCONFIGURED indicates that the file system is in a failed but recoverable state.
UPDATING indicates that the file system is undergoing a customer initiated update.
FailureDetails (dict) --
A structure providing details of any failures that occur when creating the file system has failed.
Message (string) --
A message describing any failures that occurred during file system creation.
StorageCapacity (integer) --
The storage capacity of the file system in gibibytes (GiB).
StorageType (string) --
The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.
VpcId (string) --
The ID of the primary VPC for the file system.
SubnetIds (list) --
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 .
(string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
NetworkInterfaceIds (list) --
The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.
For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.
(string) --
An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .
DNSName (string) --
The DNS name for the file system.
KmsKeyId (string) --
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 (string) --
The Amazon Resource Name (ARN) for the file system resource.
Tags (list) --
The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
WindowsConfiguration (dict) --
The configuration for this Microsoft Windows file system.
ActiveDirectoryId (string) --
The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
SelfManagedActiveDirectoryConfiguration (dict) --
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.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
OrganizationalUnitDistinguishedName (string) --
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 (string) --
The name of the domain group whose members have administrative privileges for the FSx file system.
UserName (string) --
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
DeploymentType (string) --
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.
SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see Single-AZ and Multi-AZ File Systems .
RemoteAdministrationEndpoint (string) --
For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
PreferredSubnetId (string) --
For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs . For more information, see Availability and durability: Single-AZ and Multi-AZ file systems .
PreferredFileServerIp (string) --
For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares .
ThroughputCapacity (integer) --
The throughput of the Amazon FSx file system, measured in megabytes per second.
MaintenanceOperationsInProgress (list) --
The list of maintenance operations in progress for this file system.
(string) --
An enumeration specifying the currently ongoing maintenance operation.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DailyAutomaticBackupStartTime (string) --
The preferred time to take daily automatic backups, in the UTC time zone.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Aliases (list) --
An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases .
(dict) --
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 .
Name (string) --
The name of the DNS alias. The alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com .
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
Lifecycle (string) --
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.
AuditLogConfiguration (dict) --
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.
FileAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
FileShareAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
AuditLogDestination (string) --
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.
LustreConfiguration (dict) --
The configuration for the Amazon FSx for Lustre file system.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DataRepositoryConfiguration (dict) --
The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.
Lifecycle (string) --
Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:
CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.
AVAILABLE - The data repository is available for use.
MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket .
UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.
ImportPath (string) --
The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix . If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
ExportPath (string) --
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
ImportedFileChunkSize (integer) --
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
AutoImportPolicy (string) --
Describes the file system's linked S3 data repository's AutoImportPolicy . The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
For more information, see Automatically import updates from your S3 bucket .
FailureDetails (dict) --
Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .
Message (string) --
A detailed error message.
DeploymentType (string) --
The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.
SCRATCH_1 and SCRATCH_2 deployment types are best suited for 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 .
The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = SCRATCH_1 )
PerUnitStorageThroughput (integer) --
Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
MountName (string) --
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.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)
DriveCacheType (string) --
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
DataCompressionType (string) --
The data compression configuration for the file system. DataCompressionType can have the following values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression .
AdministrativeActions (list) --
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.
(dict) --
Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.
AdministrativeActionType (string) --
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.
For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.
For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.
You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .
FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .
FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .
ProgressPercent (integer) --
Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
RequestTime (datetime) --
Time that the administrative action request was received.
Status (string) --
Describes the status of the administrative action, as follows:
FAILED - Amazon FSx failed to process the administrative action successfully.
IN_PROGRESS - Amazon FSx is processing the administrative action.
PENDING - Amazon FSx is waiting to process the administrative action.
COMPLETED - Amazon FSx has finished processing the administrative task.
UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. 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 .
TargetFileSystemValues (dict) --
Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
FailureDetails (dict) --
Provides information about a failed administrative action.
Message (string) --
Error message providing details about the failed administrative action.
TargetVolumeValues (dict) --
Describes an Amazon FSx for NetApp ONTAP volume.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
OntapConfiguration (dict) --
The configuration for this FSx for NetApp ONTAP file system.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
DeploymentType (string) --
The ONTAP file system deployment type.
EndpointIpAddressRange (string) --
The IP address range in which the endpoints to access your file system are created.
Endpoints (dict) --
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.
Intercluster (dict) --
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
Management (dict) --
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
DiskIopsConfiguration (dict) --
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
Mode (string) --
Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC ) or was provisioned by the customer (USER_PROVISIONED ).
Iops (integer) --
The total number of SSD IOPS provisioned for the file system.
PreferredSubnetId (string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
RouteTableIds (list) --
The VPC route tables in which your file system's endpoints are created.
(string) --
ThroughputCapacity (integer) --
Sustained throughput of an Amazon FSx file system in MBps.
WeeklyMaintenanceStartTime (string) --
A recurring weekly time, in the format D:HH:MM .
D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .
HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.
DirectoryInformation (dict) --
The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
ActiveDirectoryId (string) --
The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.
ResourceARN (string) --
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 .
OwnerId (string) --
An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
SourceBackupId (string) --
The ID of the source backup. Specifies the backup you are copying.
SourceBackupRegion (string) --
The source Region of the backup. Specifies the Region from where this backup is copied.
ResourceType (string) --
Specifies the resource type that is backed up.
Volume (dict) --
Describes an Amazon FSx for NetApp ONTAP volume.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
{'FileSystemType': {'ONTAP'},
'OntapConfiguration': {'AutomaticBackupRetentionDays': 'integer',
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'DiskIopsConfiguration': {'Iops': 'long',
'Mode': 'AUTOMATIC | '
'USER_PROVISIONED'},
'EndpointIpAddressRange': 'string',
'FsxAdminPassword': 'string',
'PreferredSubnetId': 'string',
'RouteTableIds': ['string'],
'ThroughputCapacity': 'integer',
'WeeklyMaintenanceStartTime': 'string'}}
Response {'FileSystem': {'AdministrativeActions': {'TargetVolumeValues': {'CreationTime': 'timestamp',
'FileSystemId': 'string',
'Lifecycle': 'CREATING '
'| '
'CREATED '
'| '
'DELETING '
'| '
'FAILED '
'| '
'MISCONFIGURED '
'| '
'PENDING',
'LifecycleTransitionReason': {'Message': 'string'},
'Name': 'string',
'OntapConfiguration': {'FlexCacheEndpointType': 'NONE '
'| '
'ORIGIN '
'| '
'CACHE',
'JunctionPath': 'string',
'OntapVolumeType': 'RW '
'| '
'DP '
'| '
'LS',
'SecurityStyle': 'UNIX '
'| '
'NTFS '
'| '
'MIXED',
'SizeInMegabytes': 'integer',
'StorageEfficiencyEnabled': 'boolean',
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': 'boolean',
'TieringPolicy': {'CoolingPeriod': 'integer',
'Name': 'SNAPSHOT_ONLY '
'| '
'AUTO '
'| '
'ALL '
'| '
'NONE'},
'UUID': 'string'},
'ResourceARN': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}],
'VolumeId': 'string',
'VolumeType': 'ONTAP'}},
'FileSystemType': {'ONTAP'},
'OntapConfiguration': {'AutomaticBackupRetentionDays': 'integer',
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'DiskIopsConfiguration': {'Iops': 'long',
'Mode': 'AUTOMATIC '
'| '
'USER_PROVISIONED'},
'EndpointIpAddressRange': 'string',
'Endpoints': {'Intercluster': {'DNSName': 'string',
'IpAddresses': ['string']},
'Management': {'DNSName': 'string',
'IpAddresses': ['string']}},
'PreferredSubnetId': 'string',
'RouteTableIds': ['string'],
'ThroughputCapacity': 'integer',
'WeeklyMaintenanceStartTime': 'string'}}}
Creates a new, empty Amazon FSx file system.
If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError . If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING .
Returns the description of the file system.
This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation 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.
Note
The CreateFileSystem 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.
See also: AWS API Documentation
Request Syntax
client.create_file_system(
ClientRequestToken='string',
FileSystemType='WINDOWS'|'LUSTRE'|'ONTAP',
StorageCapacity=123,
StorageType='SSD'|'HDD',
SubnetIds=[
'string',
],
SecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string',
WindowsConfiguration={
'ActiveDirectoryId': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'Password': 'string',
'DnsIps': [
'string',
]
},
'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
'PreferredSubnetId': 'string',
'ThroughputCapacity': 123,
'WeeklyMaintenanceStartTime': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'Aliases': [
'string',
],
'AuditLogConfiguration': {
'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'AuditLogDestination': 'string'
}
},
LustreConfiguration={
'WeeklyMaintenanceStartTime': 'string',
'ImportPath': 'string',
'ExportPath': 'string',
'ImportedFileChunkSize': 123,
'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1',
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'PerUnitStorageThroughput': 123,
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'DriveCacheType': 'NONE'|'READ',
'DataCompressionType': 'NONE'|'LZ4'
},
OntapConfiguration={
'AutomaticBackupRetentionDays': 123,
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'EndpointIpAddressRange': 'string',
'FsxAdminPassword': 'string',
'DiskIopsConfiguration': {
'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
'Iops': 123
},
'PreferredSubnetId': 'string',
'RouteTableIds': [
'string',
],
'ThroughputCapacity': 123,
'WeeklyMaintenanceStartTime': 'string'
}
)
string
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The type of Amazon FSx file system to create. Valid values are WINDOWS , LUSTRE , and ONTAP .
integer
[REQUIRED]
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).
string
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 .
list
[REQUIRED]
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.
(string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
list
A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.
(string) --
The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see Amazon EC2 Security Groups for Linux Instances in the Amazon EC2 User Guide .
list
The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) -- [REQUIRED]
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) -- [REQUIRED]
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
string
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 .
dict
The Microsoft Windows configuration for the file system being created.
ActiveDirectoryId (string) --
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 (dict) --
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 .
DomainName (string) -- [REQUIRED]
The fully qualified domain name of the self-managed AD directory, such as corp.example.com .
OrganizationalUnitDistinguishedName (string) --
(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.
Warning
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
FileSystemAdministratorsGroup (string) --
(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.
UserName (string) -- [REQUIRED]
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName , or in the default location of your AD domain.
Password (string) -- [REQUIRED]
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
DnsIps (list) -- [REQUIRED]
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
DeploymentType (string) --
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 (string) --
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.
ThroughputCapacity (integer) -- [REQUIRED]
The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the n th increments, between 2^3 (8) and 2^11 (2048).
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DailyAutomaticBackupStartTime (string) --
The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 90 days.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Aliases (list) --
An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.
For more information, see 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.
An alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com .
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
(string) --
AuditLogConfiguration (dict) --
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.
FileAccessAuditLogLevel (string) -- [REQUIRED]
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
FileShareAccessAuditLogLevel (string) -- [REQUIRED]
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
AuditLogDestination (string) --
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 .
dict
The Lustre configuration for the file system being created.
WeeklyMaintenanceStartTime (string) --
(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
ImportPath (string) --
(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix . If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
ExportPath (string) --
(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp] . The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z .
The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath . If you only specify a bucket name, such as s3://import-bucket , you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix] , Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.
ImportedFileChunkSize (integer) --
(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
DeploymentType (string) --
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 .
AutoImportPolicy (string) --
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
For more information, see Automatically import updates from your S3 bucket .
PerUnitStorageThroughput (integer) --
Required for the PERSISTENT_1 deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
CopyTagsToBackups (boolean) --
(Optional) Not available to use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If it's set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. If this value is true, and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
For more information, see Working with backups .
DriveCacheType (string) --
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
DataCompressionType (string) --
Sets the data compression configuration for the file system. DataCompressionType can have the following values:
NONE - (Default) Data compression is turned off when the file system is created.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression .
dict
The ONTAP configuration properties of the FSx for NetApp ONTAP file system that you are creating.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
DeploymentType (string) -- [REQUIRED]
Specifies the ONTAP file system deployment type to use in creating the file system.
EndpointIpAddressRange (string) --
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 (string) --
The ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
DiskIopsConfiguration (dict) --
The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system.
Mode (string) --
Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC ) or was provisioned by the customer (USER_PROVISIONED ).
Iops (integer) --
The total number of SSD IOPS provisioned for the file system.
PreferredSubnetId (string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
RouteTableIds (list) --
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.
(string) --
ThroughputCapacity (integer) -- [REQUIRED]
Sustained throughput of an Amazon FSx file system in MBps.
WeeklyMaintenanceStartTime (string) --
A recurring weekly time, in the format D:HH:MM .
D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .
HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.
dict
Response Syntax
{
'FileSystem': {
'OwnerId': 'string',
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP',
'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING',
'FailureDetails': {
'Message': 'string'
},
'StorageCapacity': 123,
'StorageType': 'SSD'|'HDD',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'NetworkInterfaceIds': [
'string',
],
'DNSName': 'string',
'KmsKeyId': 'string',
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'WindowsConfiguration': {
'ActiveDirectoryId': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'DnsIps': [
'string',
]
},
'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
'RemoteAdministrationEndpoint': 'string',
'PreferredSubnetId': 'string',
'PreferredFileServerIp': 'string',
'ThroughputCapacity': 123,
'MaintenanceOperationsInProgress': [
'PATCHING'|'BACKING_UP',
],
'WeeklyMaintenanceStartTime': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'Aliases': [
{
'Name': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'
},
],
'AuditLogConfiguration': {
'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'AuditLogDestination': 'string'
}
},
'LustreConfiguration': {
'WeeklyMaintenanceStartTime': 'string',
'DataRepositoryConfiguration': {
'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING',
'ImportPath': 'string',
'ExportPath': 'string',
'ImportedFileChunkSize': 123,
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'FailureDetails': {
'Message': 'string'
}
},
'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1',
'PerUnitStorageThroughput': 123,
'MountName': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'DriveCacheType': 'NONE'|'READ',
'DataCompressionType': 'NONE'|'LZ4'
},
'AdministrativeActions': [
{
'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION',
'ProgressPercent': 123,
'RequestTime': datetime(2015, 1, 1),
'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING',
'TargetFileSystemValues': {'... recursive ...'},
'FailureDetails': {
'Message': 'string'
},
'TargetVolumeValues': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
},
],
'OntapConfiguration': {
'AutomaticBackupRetentionDays': 123,
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'EndpointIpAddressRange': 'string',
'Endpoints': {
'Intercluster': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Management': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
}
},
'DiskIopsConfiguration': {
'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
'Iops': 123
},
'PreferredSubnetId': 'string',
'RouteTableIds': [
'string',
],
'ThroughputCapacity': 123,
'WeeklyMaintenanceStartTime': 'string'
}
}
}
Response Structure
(dict) --
The response object returned after the file system is created.
FileSystem (dict) --
The configuration of the file system that was created.
OwnerId (string) --
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 (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The system-generated, unique 17-digit ID of the file system.
FileSystemType (string) --
The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , or ONTAP .
Lifecycle (string) --
The lifecycle status of the file system, following are the possible values and what they mean:
AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
CREATING - Amazon FSx is creating the new file system.
DELETING - Amazon FSx is deleting an existing file system.
FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.
MISCONFIGURED indicates that the file system is in a failed but recoverable state.
UPDATING indicates that the file system is undergoing a customer initiated update.
FailureDetails (dict) --
A structure providing details of any failures that occur when creating the file system has failed.
Message (string) --
A message describing any failures that occurred during file system creation.
StorageCapacity (integer) --
The storage capacity of the file system in gibibytes (GiB).
StorageType (string) --
The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.
VpcId (string) --
The ID of the primary VPC for the file system.
SubnetIds (list) --
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 .
(string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
NetworkInterfaceIds (list) --
The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.
For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.
(string) --
An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .
DNSName (string) --
The DNS name for the file system.
KmsKeyId (string) --
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 (string) --
The Amazon Resource Name (ARN) for the file system resource.
Tags (list) --
The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
WindowsConfiguration (dict) --
The configuration for this Microsoft Windows file system.
ActiveDirectoryId (string) --
The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
SelfManagedActiveDirectoryConfiguration (dict) --
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.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
OrganizationalUnitDistinguishedName (string) --
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 (string) --
The name of the domain group whose members have administrative privileges for the FSx file system.
UserName (string) --
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
DeploymentType (string) --
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.
SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see Single-AZ and Multi-AZ File Systems .
RemoteAdministrationEndpoint (string) --
For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
PreferredSubnetId (string) --
For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs . For more information, see Availability and durability: Single-AZ and Multi-AZ file systems .
PreferredFileServerIp (string) --
For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares .
ThroughputCapacity (integer) --
The throughput of the Amazon FSx file system, measured in megabytes per second.
MaintenanceOperationsInProgress (list) --
The list of maintenance operations in progress for this file system.
(string) --
An enumeration specifying the currently ongoing maintenance operation.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DailyAutomaticBackupStartTime (string) --
The preferred time to take daily automatic backups, in the UTC time zone.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Aliases (list) --
An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases .
(dict) --
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 .
Name (string) --
The name of the DNS alias. The alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com .
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
Lifecycle (string) --
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.
AuditLogConfiguration (dict) --
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.
FileAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
FileShareAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
AuditLogDestination (string) --
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.
LustreConfiguration (dict) --
The configuration for the Amazon FSx for Lustre file system.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DataRepositoryConfiguration (dict) --
The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.
Lifecycle (string) --
Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:
CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.
AVAILABLE - The data repository is available for use.
MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket .
UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.
ImportPath (string) --
The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix . If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
ExportPath (string) --
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
ImportedFileChunkSize (integer) --
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
AutoImportPolicy (string) --
Describes the file system's linked S3 data repository's AutoImportPolicy . The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
For more information, see Automatically import updates from your S3 bucket .
FailureDetails (dict) --
Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .
Message (string) --
A detailed error message.
DeploymentType (string) --
The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.
SCRATCH_1 and SCRATCH_2 deployment types are best suited for 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 .
The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = SCRATCH_1 )
PerUnitStorageThroughput (integer) --
Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
MountName (string) --
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.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)
DriveCacheType (string) --
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
DataCompressionType (string) --
The data compression configuration for the file system. DataCompressionType can have the following values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression .
AdministrativeActions (list) --
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.
(dict) --
Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.
AdministrativeActionType (string) --
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.
For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.
For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.
You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .
FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .
FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .
ProgressPercent (integer) --
Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
RequestTime (datetime) --
Time that the administrative action request was received.
Status (string) --
Describes the status of the administrative action, as follows:
FAILED - Amazon FSx failed to process the administrative action successfully.
IN_PROGRESS - Amazon FSx is processing the administrative action.
PENDING - Amazon FSx is waiting to process the administrative action.
COMPLETED - Amazon FSx has finished processing the administrative task.
UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. 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 .
TargetFileSystemValues (dict) --
Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
FailureDetails (dict) --
Provides information about a failed administrative action.
Message (string) --
Error message providing details about the failed administrative action.
TargetVolumeValues (dict) --
Describes an Amazon FSx for NetApp ONTAP volume.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
OntapConfiguration (dict) --
The configuration for this FSx for NetApp ONTAP file system.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
DeploymentType (string) --
The ONTAP file system deployment type.
EndpointIpAddressRange (string) --
The IP address range in which the endpoints to access your file system are created.
Endpoints (dict) --
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.
Intercluster (dict) --
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
Management (dict) --
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
DiskIopsConfiguration (dict) --
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
Mode (string) --
Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC ) or was provisioned by the customer (USER_PROVISIONED ).
Iops (integer) --
The total number of SSD IOPS provisioned for the file system.
PreferredSubnetId (string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
RouteTableIds (list) --
The VPC route tables in which your file system's endpoints are created.
(string) --
ThroughputCapacity (integer) --
Sustained throughput of an Amazon FSx file system in MBps.
WeeklyMaintenanceStartTime (string) --
A recurring weekly time, in the format D:HH:MM .
D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .
HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.
{'FileSystem': {'AdministrativeActions': {'TargetVolumeValues': {'CreationTime': 'timestamp',
'FileSystemId': 'string',
'Lifecycle': 'CREATING '
'| '
'CREATED '
'| '
'DELETING '
'| '
'FAILED '
'| '
'MISCONFIGURED '
'| '
'PENDING',
'LifecycleTransitionReason': {'Message': 'string'},
'Name': 'string',
'OntapConfiguration': {'FlexCacheEndpointType': 'NONE '
'| '
'ORIGIN '
'| '
'CACHE',
'JunctionPath': 'string',
'OntapVolumeType': 'RW '
'| '
'DP '
'| '
'LS',
'SecurityStyle': 'UNIX '
'| '
'NTFS '
'| '
'MIXED',
'SizeInMegabytes': 'integer',
'StorageEfficiencyEnabled': 'boolean',
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': 'boolean',
'TieringPolicy': {'CoolingPeriod': 'integer',
'Name': 'SNAPSHOT_ONLY '
'| '
'AUTO '
'| '
'ALL '
'| '
'NONE'},
'UUID': 'string'},
'ResourceARN': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}],
'VolumeId': 'string',
'VolumeType': 'ONTAP'}},
'FileSystemType': {'ONTAP'},
'OntapConfiguration': {'AutomaticBackupRetentionDays': 'integer',
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'DiskIopsConfiguration': {'Iops': 'long',
'Mode': 'AUTOMATIC '
'| '
'USER_PROVISIONED'},
'EndpointIpAddressRange': 'string',
'Endpoints': {'Intercluster': {'DNSName': 'string',
'IpAddresses': ['string']},
'Management': {'DNSName': 'string',
'IpAddresses': ['string']}},
'PreferredSubnetId': 'string',
'RouteTableIds': ['string'],
'ThroughputCapacity': 'integer',
'WeeklyMaintenanceStartTime': 'string'}}}
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.
Note
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.
See also: AWS API Documentation
Request Syntax
client.create_file_system_from_backup(
BackupId='string',
ClientRequestToken='string',
SubnetIds=[
'string',
],
SecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
WindowsConfiguration={
'ActiveDirectoryId': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'Password': 'string',
'DnsIps': [
'string',
]
},
'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
'PreferredSubnetId': 'string',
'ThroughputCapacity': 123,
'WeeklyMaintenanceStartTime': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'Aliases': [
'string',
],
'AuditLogConfiguration': {
'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'AuditLogDestination': 'string'
}
},
LustreConfiguration={
'WeeklyMaintenanceStartTime': 'string',
'ImportPath': 'string',
'ExportPath': 'string',
'ImportedFileChunkSize': 123,
'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1',
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'PerUnitStorageThroughput': 123,
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'DriveCacheType': 'NONE'|'READ',
'DataCompressionType': 'NONE'|'LZ4'
},
StorageType='SSD'|'HDD',
KmsKeyId='string'
)
string
[REQUIRED]
The ID of the source backup. Specifies the backup you are copying.
string
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.
This field is autopopulated if not provided.
list
[REQUIRED]
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 Windows SINGLE_AZ_1 and SINGLE_AZ_2 deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
(string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
list
A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.
(string) --
The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see Amazon EC2 Security Groups for Linux Instances in the Amazon EC2 User Guide .
list
The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) -- [REQUIRED]
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) -- [REQUIRED]
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
dict
The configuration for this Microsoft Windows file system.
ActiveDirectoryId (string) --
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 (dict) --
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 .
DomainName (string) -- [REQUIRED]
The fully qualified domain name of the self-managed AD directory, such as corp.example.com .
OrganizationalUnitDistinguishedName (string) --
(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.
Warning
Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
FileSystemAdministratorsGroup (string) --
(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.
UserName (string) -- [REQUIRED]
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName , or in the default location of your AD domain.
Password (string) -- [REQUIRED]
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
DnsIps (list) -- [REQUIRED]
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
DeploymentType (string) --
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 (string) --
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.
ThroughputCapacity (integer) -- [REQUIRED]
The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the n th increments, between 2^3 (8) and 2^11 (2048).
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DailyAutomaticBackupStartTime (string) --
The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 90 days.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Aliases (list) --
An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.
For more information, see 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.
An alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com .
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
(string) --
AuditLogConfiguration (dict) --
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.
FileAccessAuditLogLevel (string) -- [REQUIRED]
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
FileShareAccessAuditLogLevel (string) -- [REQUIRED]
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
AuditLogDestination (string) --
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 .
dict
The Lustre configuration for the file system being created.
WeeklyMaintenanceStartTime (string) --
(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
ImportPath (string) --
(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix . If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
ExportPath (string) --
(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp] . The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z .
The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath . If you only specify a bucket name, such as s3://import-bucket , you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix] , Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.
ImportedFileChunkSize (integer) --
(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
DeploymentType (string) --
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 .
AutoImportPolicy (string) --
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
For more information, see Automatically import updates from your S3 bucket .
PerUnitStorageThroughput (integer) --
Required for the PERSISTENT_1 deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
CopyTagsToBackups (boolean) --
(Optional) Not available to use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If it's set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. If this value is true, and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
For more information, see Working with backups .
DriveCacheType (string) --
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
DataCompressionType (string) --
Sets the data compression configuration for the file system. DataCompressionType can have the following values:
NONE - (Default) Data compression is turned off when the file system is created.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression .
string
Sets the storage type for the Windows file system you're creating from a backup. Valid values are SSD and HDD .
Set to SSD to use solid state drive storage. Supported on all Windows deployment types.
Set to HDD to use hard disk drive storage. Supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types.
Default value is SSD .
Note
HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB.
string
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 .
dict
Response Syntax
{
'FileSystem': {
'OwnerId': 'string',
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP',
'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING',
'FailureDetails': {
'Message': 'string'
},
'StorageCapacity': 123,
'StorageType': 'SSD'|'HDD',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'NetworkInterfaceIds': [
'string',
],
'DNSName': 'string',
'KmsKeyId': 'string',
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'WindowsConfiguration': {
'ActiveDirectoryId': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'DnsIps': [
'string',
]
},
'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
'RemoteAdministrationEndpoint': 'string',
'PreferredSubnetId': 'string',
'PreferredFileServerIp': 'string',
'ThroughputCapacity': 123,
'MaintenanceOperationsInProgress': [
'PATCHING'|'BACKING_UP',
],
'WeeklyMaintenanceStartTime': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'Aliases': [
{
'Name': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'
},
],
'AuditLogConfiguration': {
'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'AuditLogDestination': 'string'
}
},
'LustreConfiguration': {
'WeeklyMaintenanceStartTime': 'string',
'DataRepositoryConfiguration': {
'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING',
'ImportPath': 'string',
'ExportPath': 'string',
'ImportedFileChunkSize': 123,
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'FailureDetails': {
'Message': 'string'
}
},
'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1',
'PerUnitStorageThroughput': 123,
'MountName': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'DriveCacheType': 'NONE'|'READ',
'DataCompressionType': 'NONE'|'LZ4'
},
'AdministrativeActions': [
{
'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION',
'ProgressPercent': 123,
'RequestTime': datetime(2015, 1, 1),
'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING',
'TargetFileSystemValues': {'... recursive ...'},
'FailureDetails': {
'Message': 'string'
},
'TargetVolumeValues': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
},
],
'OntapConfiguration': {
'AutomaticBackupRetentionDays': 123,
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'EndpointIpAddressRange': 'string',
'Endpoints': {
'Intercluster': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Management': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
}
},
'DiskIopsConfiguration': {
'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
'Iops': 123
},
'PreferredSubnetId': 'string',
'RouteTableIds': [
'string',
],
'ThroughputCapacity': 123,
'WeeklyMaintenanceStartTime': 'string'
}
}
}
Response Structure
(dict) --
The response object for the CreateFileSystemFromBackup operation.
FileSystem (dict) --
A description of the file system.
OwnerId (string) --
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 (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The system-generated, unique 17-digit ID of the file system.
FileSystemType (string) --
The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , or ONTAP .
Lifecycle (string) --
The lifecycle status of the file system, following are the possible values and what they mean:
AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
CREATING - Amazon FSx is creating the new file system.
DELETING - Amazon FSx is deleting an existing file system.
FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.
MISCONFIGURED indicates that the file system is in a failed but recoverable state.
UPDATING indicates that the file system is undergoing a customer initiated update.
FailureDetails (dict) --
A structure providing details of any failures that occur when creating the file system has failed.
Message (string) --
A message describing any failures that occurred during file system creation.
StorageCapacity (integer) --
The storage capacity of the file system in gibibytes (GiB).
StorageType (string) --
The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.
VpcId (string) --
The ID of the primary VPC for the file system.
SubnetIds (list) --
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 .
(string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
NetworkInterfaceIds (list) --
The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.
For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.
(string) --
An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .
DNSName (string) --
The DNS name for the file system.
KmsKeyId (string) --
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 (string) --
The Amazon Resource Name (ARN) for the file system resource.
Tags (list) --
The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
WindowsConfiguration (dict) --
The configuration for this Microsoft Windows file system.
ActiveDirectoryId (string) --
The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
SelfManagedActiveDirectoryConfiguration (dict) --
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.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
OrganizationalUnitDistinguishedName (string) --
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 (string) --
The name of the domain group whose members have administrative privileges for the FSx file system.
UserName (string) --
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
DeploymentType (string) --
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.
SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see Single-AZ and Multi-AZ File Systems .
RemoteAdministrationEndpoint (string) --
For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
PreferredSubnetId (string) --
For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs . For more information, see Availability and durability: Single-AZ and Multi-AZ file systems .
PreferredFileServerIp (string) --
For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares .
ThroughputCapacity (integer) --
The throughput of the Amazon FSx file system, measured in megabytes per second.
MaintenanceOperationsInProgress (list) --
The list of maintenance operations in progress for this file system.
(string) --
An enumeration specifying the currently ongoing maintenance operation.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DailyAutomaticBackupStartTime (string) --
The preferred time to take daily automatic backups, in the UTC time zone.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Aliases (list) --
An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases .
(dict) --
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 .
Name (string) --
The name of the DNS alias. The alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com .
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
Lifecycle (string) --
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.
AuditLogConfiguration (dict) --
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.
FileAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
FileShareAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
AuditLogDestination (string) --
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.
LustreConfiguration (dict) --
The configuration for the Amazon FSx for Lustre file system.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DataRepositoryConfiguration (dict) --
The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.
Lifecycle (string) --
Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:
CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.
AVAILABLE - The data repository is available for use.
MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket .
UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.
ImportPath (string) --
The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix . If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
ExportPath (string) --
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
ImportedFileChunkSize (integer) --
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
AutoImportPolicy (string) --
Describes the file system's linked S3 data repository's AutoImportPolicy . The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
For more information, see Automatically import updates from your S3 bucket .
FailureDetails (dict) --
Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .
Message (string) --
A detailed error message.
DeploymentType (string) --
The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.
SCRATCH_1 and SCRATCH_2 deployment types are best suited for 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 .
The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = SCRATCH_1 )
PerUnitStorageThroughput (integer) --
Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
MountName (string) --
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.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)
DriveCacheType (string) --
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
DataCompressionType (string) --
The data compression configuration for the file system. DataCompressionType can have the following values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression .
AdministrativeActions (list) --
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.
(dict) --
Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.
AdministrativeActionType (string) --
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.
For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.
For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.
You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .
FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .
FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .
ProgressPercent (integer) --
Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
RequestTime (datetime) --
Time that the administrative action request was received.
Status (string) --
Describes the status of the administrative action, as follows:
FAILED - Amazon FSx failed to process the administrative action successfully.
IN_PROGRESS - Amazon FSx is processing the administrative action.
PENDING - Amazon FSx is waiting to process the administrative action.
COMPLETED - Amazon FSx has finished processing the administrative task.
UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. 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 .
TargetFileSystemValues (dict) --
Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
FailureDetails (dict) --
Provides information about a failed administrative action.
Message (string) --
Error message providing details about the failed administrative action.
TargetVolumeValues (dict) --
Describes an Amazon FSx for NetApp ONTAP volume.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
OntapConfiguration (dict) --
The configuration for this FSx for NetApp ONTAP file system.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
DeploymentType (string) --
The ONTAP file system deployment type.
EndpointIpAddressRange (string) --
The IP address range in which the endpoints to access your file system are created.
Endpoints (dict) --
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.
Intercluster (dict) --
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
Management (dict) --
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
DiskIopsConfiguration (dict) --
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
Mode (string) --
Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC ) or was provisioned by the customer (USER_PROVISIONED ).
Iops (integer) --
The total number of SSD IOPS provisioned for the file system.
PreferredSubnetId (string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
RouteTableIds (list) --
The VPC route tables in which your file system's endpoints are created.
(string) --
ThroughputCapacity (integer) --
Sustained throughput of an Amazon FSx file system in MBps.
WeeklyMaintenanceStartTime (string) --
A recurring weekly time, in the format D:HH:MM .
D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .
HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.
{'Filters': {'Name': {'volume-id'}}}
Response {'Backups': {'FileSystem': {'AdministrativeActions': {'TargetVolumeValues': {'CreationTime': 'timestamp',
'FileSystemId': 'string',
'Lifecycle': 'CREATING '
'| '
'CREATED '
'| '
'DELETING '
'| '
'FAILED '
'| '
'MISCONFIGURED '
'| '
'PENDING',
'LifecycleTransitionReason': {'Message': 'string'},
'Name': 'string',
'OntapConfiguration': {'FlexCacheEndpointType': 'NONE '
'| '
'ORIGIN '
'| '
'CACHE',
'JunctionPath': 'string',
'OntapVolumeType': 'RW '
'| '
'DP '
'| '
'LS',
'SecurityStyle': 'UNIX '
'| '
'NTFS '
'| '
'MIXED',
'SizeInMegabytes': 'integer',
'StorageEfficiencyEnabled': 'boolean',
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': 'boolean',
'TieringPolicy': {'CoolingPeriod': 'integer',
'Name': 'SNAPSHOT_ONLY '
'| '
'AUTO '
'| '
'ALL '
'| '
'NONE'},
'UUID': 'string'},
'ResourceARN': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}],
'VolumeId': 'string',
'VolumeType': 'ONTAP'}},
'FileSystemType': {'ONTAP'},
'OntapConfiguration': {'AutomaticBackupRetentionDays': 'integer',
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'DiskIopsConfiguration': {'Iops': 'long',
'Mode': 'AUTOMATIC '
'| '
'USER_PROVISIONED'},
'EndpointIpAddressRange': 'string',
'Endpoints': {'Intercluster': {'DNSName': 'string',
'IpAddresses': ['string']},
'Management': {'DNSName': 'string',
'IpAddresses': ['string']}},
'PreferredSubnetId': 'string',
'RouteTableIds': ['string'],
'ThroughputCapacity': 'integer',
'WeeklyMaintenanceStartTime': 'string'}},
'ResourceType': 'FILE_SYSTEM | VOLUME',
'Volume': {'CreationTime': 'timestamp',
'FileSystemId': 'string',
'Lifecycle': 'CREATING | CREATED | DELETING | FAILED | '
'MISCONFIGURED | PENDING',
'LifecycleTransitionReason': {'Message': 'string'},
'Name': 'string',
'OntapConfiguration': {'FlexCacheEndpointType': 'NONE '
'| '
'ORIGIN '
'| '
'CACHE',
'JunctionPath': 'string',
'OntapVolumeType': 'RW | DP | '
'LS',
'SecurityStyle': 'UNIX | NTFS | '
'MIXED',
'SizeInMegabytes': 'integer',
'StorageEfficiencyEnabled': 'boolean',
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': 'boolean',
'TieringPolicy': {'CoolingPeriod': 'integer',
'Name': 'SNAPSHOT_ONLY '
'| '
'AUTO '
'| '
'ALL '
'| '
'NONE'},
'UUID': 'string'},
'ResourceARN': 'string',
'Tags': [{'Key': 'string', 'Value': 'string'}],
'VolumeId': 'string',
'VolumeType': 'ONTAP'}}}
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 NextToken value. 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.
See also: AWS API Documentation
Request Syntax
client.describe_backups(
BackupIds=[
'string',
],
Filters=[
{
'Name': 'file-system-id'|'backup-type'|'file-system-type'|'volume-id',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
list
IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.
(string) --
The ID of the source backup. Specifies the backup you are copying.
list
Filters structure. Supported names are file-system-id , backup-type , file-system-type , and volume-id .
(dict) --
A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.
Name (string) --
The name for this filter.
Values (list) --
The values of the filter. These are all the values for any of the applied filters.
(string) --
The value for a filter.
integer
Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.
string
Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.
dict
Response Syntax
{
'Backups': [
{
'BackupId': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'TRANSFERRING'|'DELETED'|'FAILED'|'PENDING'|'COPYING',
'FailureDetails': {
'Message': 'string'
},
'Type': 'AUTOMATIC'|'USER_INITIATED'|'AWS_BACKUP',
'ProgressPercent': 123,
'CreationTime': datetime(2015, 1, 1),
'KmsKeyId': 'string',
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'FileSystem': {
'OwnerId': 'string',
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP',
'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING',
'FailureDetails': {
'Message': 'string'
},
'StorageCapacity': 123,
'StorageType': 'SSD'|'HDD',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'NetworkInterfaceIds': [
'string',
],
'DNSName': 'string',
'KmsKeyId': 'string',
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'WindowsConfiguration': {
'ActiveDirectoryId': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'DnsIps': [
'string',
]
},
'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
'RemoteAdministrationEndpoint': 'string',
'PreferredSubnetId': 'string',
'PreferredFileServerIp': 'string',
'ThroughputCapacity': 123,
'MaintenanceOperationsInProgress': [
'PATCHING'|'BACKING_UP',
],
'WeeklyMaintenanceStartTime': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'Aliases': [
{
'Name': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'
},
],
'AuditLogConfiguration': {
'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'AuditLogDestination': 'string'
}
},
'LustreConfiguration': {
'WeeklyMaintenanceStartTime': 'string',
'DataRepositoryConfiguration': {
'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING',
'ImportPath': 'string',
'ExportPath': 'string',
'ImportedFileChunkSize': 123,
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'FailureDetails': {
'Message': 'string'
}
},
'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1',
'PerUnitStorageThroughput': 123,
'MountName': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'DriveCacheType': 'NONE'|'READ',
'DataCompressionType': 'NONE'|'LZ4'
},
'AdministrativeActions': [
{
'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION',
'ProgressPercent': 123,
'RequestTime': datetime(2015, 1, 1),
'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING',
'TargetFileSystemValues': {'... recursive ...'},
'FailureDetails': {
'Message': 'string'
},
'TargetVolumeValues': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
},
],
'OntapConfiguration': {
'AutomaticBackupRetentionDays': 123,
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'EndpointIpAddressRange': 'string',
'Endpoints': {
'Intercluster': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Management': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
}
},
'DiskIopsConfiguration': {
'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
'Iops': 123
},
'PreferredSubnetId': 'string',
'RouteTableIds': [
'string',
],
'ThroughputCapacity': 123,
'WeeklyMaintenanceStartTime': 'string'
}
},
'DirectoryInformation': {
'DomainName': 'string',
'ActiveDirectoryId': 'string',
'ResourceARN': 'string'
},
'OwnerId': 'string',
'SourceBackupId': 'string',
'SourceBackupRegion': 'string',
'ResourceType': 'FILE_SYSTEM'|'VOLUME',
'Volume': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Response object for DescribeBackups operation.
Backups (list) --
An array of backups.
(dict) --
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.
BackupId (string) --
The ID of the backup.
Lifecycle (string) --
The lifecycle status of the backup.
AVAILABLE - The backup is fully available.
PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx has not started creating the backup.
CREATING - Amazon FSx is creating the backup.
TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to S3.
COPYING - Amazon FSx is copying the backup.
DELETED - Amazon FSx deleted the backup and it is no longer available.
FAILED - Amazon FSx could not complete the backup.
FailureDetails (dict) --
Details explaining any failures that occur when creating a backup.
Message (string) --
A message describing the backup creation failure.
Type (string) --
The type of the file system backup.
ProgressPercent (integer) --
The current percent of progress of an asynchronous task.
CreationTime (datetime) --
The time when a particular backup was created.
KmsKeyId (string) --
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 (string) --
The Amazon Resource Name (ARN) for the backup resource.
Tags (list) --
Tags associated with a particular file system.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
FileSystem (dict) --
Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
OwnerId (string) --
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 (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The system-generated, unique 17-digit ID of the file system.
FileSystemType (string) --
The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , or ONTAP .
Lifecycle (string) --
The lifecycle status of the file system, following are the possible values and what they mean:
AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
CREATING - Amazon FSx is creating the new file system.
DELETING - Amazon FSx is deleting an existing file system.
FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.
MISCONFIGURED indicates that the file system is in a failed but recoverable state.
UPDATING indicates that the file system is undergoing a customer initiated update.
FailureDetails (dict) --
A structure providing details of any failures that occur when creating the file system has failed.
Message (string) --
A message describing any failures that occurred during file system creation.
StorageCapacity (integer) --
The storage capacity of the file system in gibibytes (GiB).
StorageType (string) --
The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.
VpcId (string) --
The ID of the primary VPC for the file system.
SubnetIds (list) --
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 .
(string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
NetworkInterfaceIds (list) --
The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.
For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.
(string) --
An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .
DNSName (string) --
The DNS name for the file system.
KmsKeyId (string) --
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 (string) --
The Amazon Resource Name (ARN) for the file system resource.
Tags (list) --
The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
WindowsConfiguration (dict) --
The configuration for this Microsoft Windows file system.
ActiveDirectoryId (string) --
The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
SelfManagedActiveDirectoryConfiguration (dict) --
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.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
OrganizationalUnitDistinguishedName (string) --
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 (string) --
The name of the domain group whose members have administrative privileges for the FSx file system.
UserName (string) --
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
DeploymentType (string) --
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.
SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see Single-AZ and Multi-AZ File Systems .
RemoteAdministrationEndpoint (string) --
For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
PreferredSubnetId (string) --
For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs . For more information, see Availability and durability: Single-AZ and Multi-AZ file systems .
PreferredFileServerIp (string) --
For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares .
ThroughputCapacity (integer) --
The throughput of the Amazon FSx file system, measured in megabytes per second.
MaintenanceOperationsInProgress (list) --
The list of maintenance operations in progress for this file system.
(string) --
An enumeration specifying the currently ongoing maintenance operation.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DailyAutomaticBackupStartTime (string) --
The preferred time to take daily automatic backups, in the UTC time zone.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Aliases (list) --
An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases .
(dict) --
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 .
Name (string) --
The name of the DNS alias. The alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com .
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
Lifecycle (string) --
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.
AuditLogConfiguration (dict) --
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.
FileAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
FileShareAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
AuditLogDestination (string) --
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.
LustreConfiguration (dict) --
The configuration for the Amazon FSx for Lustre file system.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DataRepositoryConfiguration (dict) --
The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.
Lifecycle (string) --
Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:
CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.
AVAILABLE - The data repository is available for use.
MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket .
UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.
ImportPath (string) --
The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix . If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
ExportPath (string) --
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
ImportedFileChunkSize (integer) --
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
AutoImportPolicy (string) --
Describes the file system's linked S3 data repository's AutoImportPolicy . The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
For more information, see Automatically import updates from your S3 bucket .
FailureDetails (dict) --
Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .
Message (string) --
A detailed error message.
DeploymentType (string) --
The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.
SCRATCH_1 and SCRATCH_2 deployment types are best suited for 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 .
The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = SCRATCH_1 )
PerUnitStorageThroughput (integer) --
Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
MountName (string) --
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.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)
DriveCacheType (string) --
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
DataCompressionType (string) --
The data compression configuration for the file system. DataCompressionType can have the following values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression .
AdministrativeActions (list) --
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.
(dict) --
Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.
AdministrativeActionType (string) --
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.
For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.
For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.
You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .
FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .
FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .
ProgressPercent (integer) --
Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
RequestTime (datetime) --
Time that the administrative action request was received.
Status (string) --
Describes the status of the administrative action, as follows:
FAILED - Amazon FSx failed to process the administrative action successfully.
IN_PROGRESS - Amazon FSx is processing the administrative action.
PENDING - Amazon FSx is waiting to process the administrative action.
COMPLETED - Amazon FSx has finished processing the administrative task.
UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. 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 .
TargetFileSystemValues (dict) --
Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
FailureDetails (dict) --
Provides information about a failed administrative action.
Message (string) --
Error message providing details about the failed administrative action.
TargetVolumeValues (dict) --
Describes an Amazon FSx for NetApp ONTAP volume.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
OntapConfiguration (dict) --
The configuration for this FSx for NetApp ONTAP file system.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
DeploymentType (string) --
The ONTAP file system deployment type.
EndpointIpAddressRange (string) --
The IP address range in which the endpoints to access your file system are created.
Endpoints (dict) --
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.
Intercluster (dict) --
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
Management (dict) --
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
DiskIopsConfiguration (dict) --
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
Mode (string) --
Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC ) or was provisioned by the customer (USER_PROVISIONED ).
Iops (integer) --
The total number of SSD IOPS provisioned for the file system.
PreferredSubnetId (string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
RouteTableIds (list) --
The VPC route tables in which your file system's endpoints are created.
(string) --
ThroughputCapacity (integer) --
Sustained throughput of an Amazon FSx file system in MBps.
WeeklyMaintenanceStartTime (string) --
A recurring weekly time, in the format D:HH:MM .
D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .
HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.
DirectoryInformation (dict) --
The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
ActiveDirectoryId (string) --
The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.
ResourceARN (string) --
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 .
OwnerId (string) --
An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.
SourceBackupId (string) --
The ID of the source backup. Specifies the backup you are copying.
SourceBackupRegion (string) --
The source Region of the backup. Specifies the Region from where this backup is copied.
ResourceType (string) --
Specifies the resource type that is backed up.
Volume (dict) --
Describes an Amazon FSx for NetApp ONTAP volume.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
NextToken (string) --
This is present if there are more backups than returned in the response (String). You can use the NextToken value in the later request to fetch the backups.
{'FileSystems': {'AdministrativeActions': {'TargetVolumeValues': {'CreationTime': 'timestamp',
'FileSystemId': 'string',
'Lifecycle': 'CREATING '
'| '
'CREATED '
'| '
'DELETING '
'| '
'FAILED '
'| '
'MISCONFIGURED '
'| '
'PENDING',
'LifecycleTransitionReason': {'Message': 'string'},
'Name': 'string',
'OntapConfiguration': {'FlexCacheEndpointType': 'NONE '
'| '
'ORIGIN '
'| '
'CACHE',
'JunctionPath': 'string',
'OntapVolumeType': 'RW '
'| '
'DP '
'| '
'LS',
'SecurityStyle': 'UNIX '
'| '
'NTFS '
'| '
'MIXED',
'SizeInMegabytes': 'integer',
'StorageEfficiencyEnabled': 'boolean',
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': 'boolean',
'TieringPolicy': {'CoolingPeriod': 'integer',
'Name': 'SNAPSHOT_ONLY '
'| '
'AUTO '
'| '
'ALL '
'| '
'NONE'},
'UUID': 'string'},
'ResourceARN': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}],
'VolumeId': 'string',
'VolumeType': 'ONTAP'}},
'FileSystemType': {'ONTAP'},
'OntapConfiguration': {'AutomaticBackupRetentionDays': 'integer',
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'DiskIopsConfiguration': {'Iops': 'long',
'Mode': 'AUTOMATIC '
'| '
'USER_PROVISIONED'},
'EndpointIpAddressRange': 'string',
'Endpoints': {'Intercluster': {'DNSName': 'string',
'IpAddresses': ['string']},
'Management': {'DNSName': 'string',
'IpAddresses': ['string']}},
'PreferredSubnetId': 'string',
'RouteTableIds': ['string'],
'ThroughputCapacity': 'integer',
'WeeklyMaintenanceStartTime': 'string'}}}
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 NextToken value. 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.
See also: AWS API Documentation
Request Syntax
client.describe_file_systems(
FileSystemIds=[
'string',
],
MaxResults=123,
NextToken='string'
)
list
IDs of the file systems whose descriptions you want to retrieve (String).
(string) --
The globally unique ID of the file system, assigned by Amazon FSx.
integer
Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.
string
Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the action continues the list from where the returning call left off.
dict
Response Syntax
{
'FileSystems': [
{
'OwnerId': 'string',
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP',
'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING',
'FailureDetails': {
'Message': 'string'
},
'StorageCapacity': 123,
'StorageType': 'SSD'|'HDD',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'NetworkInterfaceIds': [
'string',
],
'DNSName': 'string',
'KmsKeyId': 'string',
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'WindowsConfiguration': {
'ActiveDirectoryId': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'DnsIps': [
'string',
]
},
'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
'RemoteAdministrationEndpoint': 'string',
'PreferredSubnetId': 'string',
'PreferredFileServerIp': 'string',
'ThroughputCapacity': 123,
'MaintenanceOperationsInProgress': [
'PATCHING'|'BACKING_UP',
],
'WeeklyMaintenanceStartTime': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'Aliases': [
{
'Name': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'
},
],
'AuditLogConfiguration': {
'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'AuditLogDestination': 'string'
}
},
'LustreConfiguration': {
'WeeklyMaintenanceStartTime': 'string',
'DataRepositoryConfiguration': {
'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING',
'ImportPath': 'string',
'ExportPath': 'string',
'ImportedFileChunkSize': 123,
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'FailureDetails': {
'Message': 'string'
}
},
'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1',
'PerUnitStorageThroughput': 123,
'MountName': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'DriveCacheType': 'NONE'|'READ',
'DataCompressionType': 'NONE'|'LZ4'
},
'AdministrativeActions': [
{
'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION',
'ProgressPercent': 123,
'RequestTime': datetime(2015, 1, 1),
'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING',
'TargetFileSystemValues': {'... recursive ...'},
'FailureDetails': {
'Message': 'string'
},
'TargetVolumeValues': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
},
],
'OntapConfiguration': {
'AutomaticBackupRetentionDays': 123,
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'EndpointIpAddressRange': 'string',
'Endpoints': {
'Intercluster': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Management': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
}
},
'DiskIopsConfiguration': {
'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
'Iops': 123
},
'PreferredSubnetId': 'string',
'RouteTableIds': [
'string',
],
'ThroughputCapacity': 123,
'WeeklyMaintenanceStartTime': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response object for DescribeFileSystems operation.
FileSystems (list) --
An array of file system descriptions.
(dict) --
A description of a specific Amazon FSx file system.
OwnerId (string) --
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 (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The system-generated, unique 17-digit ID of the file system.
FileSystemType (string) --
The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , or ONTAP .
Lifecycle (string) --
The lifecycle status of the file system, following are the possible values and what they mean:
AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
CREATING - Amazon FSx is creating the new file system.
DELETING - Amazon FSx is deleting an existing file system.
FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.
MISCONFIGURED indicates that the file system is in a failed but recoverable state.
UPDATING indicates that the file system is undergoing a customer initiated update.
FailureDetails (dict) --
A structure providing details of any failures that occur when creating the file system has failed.
Message (string) --
A message describing any failures that occurred during file system creation.
StorageCapacity (integer) --
The storage capacity of the file system in gibibytes (GiB).
StorageType (string) --
The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.
VpcId (string) --
The ID of the primary VPC for the file system.
SubnetIds (list) --
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 .
(string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
NetworkInterfaceIds (list) --
The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.
For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.
(string) --
An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .
DNSName (string) --
The DNS name for the file system.
KmsKeyId (string) --
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 (string) --
The Amazon Resource Name (ARN) for the file system resource.
Tags (list) --
The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
WindowsConfiguration (dict) --
The configuration for this Microsoft Windows file system.
ActiveDirectoryId (string) --
The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
SelfManagedActiveDirectoryConfiguration (dict) --
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.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
OrganizationalUnitDistinguishedName (string) --
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 (string) --
The name of the domain group whose members have administrative privileges for the FSx file system.
UserName (string) --
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
DeploymentType (string) --
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.
SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see Single-AZ and Multi-AZ File Systems .
RemoteAdministrationEndpoint (string) --
For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
PreferredSubnetId (string) --
For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs . For more information, see Availability and durability: Single-AZ and Multi-AZ file systems .
PreferredFileServerIp (string) --
For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares .
ThroughputCapacity (integer) --
The throughput of the Amazon FSx file system, measured in megabytes per second.
MaintenanceOperationsInProgress (list) --
The list of maintenance operations in progress for this file system.
(string) --
An enumeration specifying the currently ongoing maintenance operation.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DailyAutomaticBackupStartTime (string) --
The preferred time to take daily automatic backups, in the UTC time zone.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Aliases (list) --
An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases .
(dict) --
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 .
Name (string) --
The name of the DNS alias. The alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com .
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
Lifecycle (string) --
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.
AuditLogConfiguration (dict) --
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.
FileAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
FileShareAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
AuditLogDestination (string) --
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.
LustreConfiguration (dict) --
The configuration for the Amazon FSx for Lustre file system.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DataRepositoryConfiguration (dict) --
The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.
Lifecycle (string) --
Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:
CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.
AVAILABLE - The data repository is available for use.
MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket .
UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.
ImportPath (string) --
The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix . If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
ExportPath (string) --
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
ImportedFileChunkSize (integer) --
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
AutoImportPolicy (string) --
Describes the file system's linked S3 data repository's AutoImportPolicy . The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
For more information, see Automatically import updates from your S3 bucket .
FailureDetails (dict) --
Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .
Message (string) --
A detailed error message.
DeploymentType (string) --
The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.
SCRATCH_1 and SCRATCH_2 deployment types are best suited for 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 .
The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = SCRATCH_1 )
PerUnitStorageThroughput (integer) --
Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
MountName (string) --
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.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)
DriveCacheType (string) --
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
DataCompressionType (string) --
The data compression configuration for the file system. DataCompressionType can have the following values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression .
AdministrativeActions (list) --
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.
(dict) --
Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.
AdministrativeActionType (string) --
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.
For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.
For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.
You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .
FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .
FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .
ProgressPercent (integer) --
Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
RequestTime (datetime) --
Time that the administrative action request was received.
Status (string) --
Describes the status of the administrative action, as follows:
FAILED - Amazon FSx failed to process the administrative action successfully.
IN_PROGRESS - Amazon FSx is processing the administrative action.
PENDING - Amazon FSx is waiting to process the administrative action.
COMPLETED - Amazon FSx has finished processing the administrative task.
UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. 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 .
TargetFileSystemValues (dict) --
Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
FailureDetails (dict) --
Provides information about a failed administrative action.
Message (string) --
Error message providing details about the failed administrative action.
TargetVolumeValues (dict) --
Describes an Amazon FSx for NetApp ONTAP volume.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
OntapConfiguration (dict) --
The configuration for this FSx for NetApp ONTAP file system.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
DeploymentType (string) --
The ONTAP file system deployment type.
EndpointIpAddressRange (string) --
The IP address range in which the endpoints to access your file system are created.
Endpoints (dict) --
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.
Intercluster (dict) --
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
Management (dict) --
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
DiskIopsConfiguration (dict) --
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
Mode (string) --
Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC ) or was provisioned by the customer (USER_PROVISIONED ).
Iops (integer) --
The total number of SSD IOPS provisioned for the file system.
PreferredSubnetId (string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
RouteTableIds (list) --
The VPC route tables in which your file system's endpoints are created.
(string) --
ThroughputCapacity (integer) --
Sustained throughput of an Amazon FSx file system in MBps.
WeeklyMaintenanceStartTime (string) --
A recurring weekly time, in the format D:HH:MM .
D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .
HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.
NextToken (string) --
Present if there are more file systems than returned in the response (String). You can use the NextToken value in the later request to fetch the descriptions.
{'OntapConfiguration': {'AutomaticBackupRetentionDays': 'integer',
'DailyAutomaticBackupStartTime': 'string',
'FsxAdminPassword': 'string',
'WeeklyMaintenanceStartTime': 'string'}}
Response {'FileSystem': {'AdministrativeActions': {'TargetVolumeValues': {'CreationTime': 'timestamp',
'FileSystemId': 'string',
'Lifecycle': 'CREATING '
'| '
'CREATED '
'| '
'DELETING '
'| '
'FAILED '
'| '
'MISCONFIGURED '
'| '
'PENDING',
'LifecycleTransitionReason': {'Message': 'string'},
'Name': 'string',
'OntapConfiguration': {'FlexCacheEndpointType': 'NONE '
'| '
'ORIGIN '
'| '
'CACHE',
'JunctionPath': 'string',
'OntapVolumeType': 'RW '
'| '
'DP '
'| '
'LS',
'SecurityStyle': 'UNIX '
'| '
'NTFS '
'| '
'MIXED',
'SizeInMegabytes': 'integer',
'StorageEfficiencyEnabled': 'boolean',
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': 'boolean',
'TieringPolicy': {'CoolingPeriod': 'integer',
'Name': 'SNAPSHOT_ONLY '
'| '
'AUTO '
'| '
'ALL '
'| '
'NONE'},
'UUID': 'string'},
'ResourceARN': 'string',
'Tags': [{'Key': 'string',
'Value': 'string'}],
'VolumeId': 'string',
'VolumeType': 'ONTAP'}},
'FileSystemType': {'ONTAP'},
'OntapConfiguration': {'AutomaticBackupRetentionDays': 'integer',
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'DiskIopsConfiguration': {'Iops': 'long',
'Mode': 'AUTOMATIC '
'| '
'USER_PROVISIONED'},
'EndpointIpAddressRange': 'string',
'Endpoints': {'Intercluster': {'DNSName': 'string',
'IpAddresses': ['string']},
'Management': {'DNSName': 'string',
'IpAddresses': ['string']}},
'PreferredSubnetId': 'string',
'RouteTableIds': ['string'],
'ThroughputCapacity': 'integer',
'WeeklyMaintenanceStartTime': 'string'}}}
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
See also: AWS API Documentation
Request Syntax
client.update_file_system(
FileSystemId='string',
ClientRequestToken='string',
StorageCapacity=123,
WindowsConfiguration={
'WeeklyMaintenanceStartTime': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'ThroughputCapacity': 123,
'SelfManagedActiveDirectoryConfiguration': {
'UserName': 'string',
'Password': 'string',
'DnsIps': [
'string',
]
},
'AuditLogConfiguration': {
'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'AuditLogDestination': 'string'
}
},
LustreConfiguration={
'WeeklyMaintenanceStartTime': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'DataCompressionType': 'NONE'|'LZ4'
},
OntapConfiguration={
'AutomaticBackupRetentionDays': 123,
'DailyAutomaticBackupStartTime': 'string',
'FsxAdminPassword': 'string',
'WeeklyMaintenanceStartTime': 'string'
}
)
string
[REQUIRED]
Identifies the file system that you are updating.
string
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.
This field is autopopulated if not provided.
integer
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 .
dict
The configuration updates for an Amazon FSx for Windows File Server file system.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Where d is the weekday number, from 1 through 7, with 1 = Monday and 7 = Sunday.
DailyAutomaticBackupStartTime (string) --
The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see Working with Automatic Daily Backups .
ThroughputCapacity (integer) --
Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, see Managing Throughput Capacity .
SelfManagedActiveDirectoryConfiguration (dict) --
The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD directory. You cannot make a self-managed Microsoft AD update request if there is an existing self-managed Microsoft AD update request in progress.
UserName (string) --
The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName .
Password (string) --
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
AuditLogConfiguration (dict) --
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..
FileAccessAuditLogLevel (string) -- [REQUIRED]
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
FileShareAccessAuditLogLevel (string) -- [REQUIRED]
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
AuditLogDestination (string) --
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 .
dict
The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.
WeeklyMaintenanceStartTime (string) --
(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
AutoImportPolicy (string) --
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listing up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update the file and directory listing for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
For more information, see Automatically import updates from your S3 bucket .
DataCompressionType (string) --
Sets the data compression configuration for the file system. DataCompressionType can have the following values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
If you don't use DataCompressionType , the file system retains its current data compression configuration.
For more information, see Lustre data compression .
dict
The configuration updates for an Amazon FSx for NetApp ONTAP file system.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
FsxAdminPassword (string) --
The ONTAP administrative password for the fsxadmin user.
WeeklyMaintenanceStartTime (string) --
A recurring weekly time, in the format D:HH:MM .
D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .
HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.
dict
Response Syntax
{
'FileSystem': {
'OwnerId': 'string',
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP',
'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING',
'FailureDetails': {
'Message': 'string'
},
'StorageCapacity': 123,
'StorageType': 'SSD'|'HDD',
'VpcId': 'string',
'SubnetIds': [
'string',
],
'NetworkInterfaceIds': [
'string',
],
'DNSName': 'string',
'KmsKeyId': 'string',
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'WindowsConfiguration': {
'ActiveDirectoryId': 'string',
'SelfManagedActiveDirectoryConfiguration': {
'DomainName': 'string',
'OrganizationalUnitDistinguishedName': 'string',
'FileSystemAdministratorsGroup': 'string',
'UserName': 'string',
'DnsIps': [
'string',
]
},
'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
'RemoteAdministrationEndpoint': 'string',
'PreferredSubnetId': 'string',
'PreferredFileServerIp': 'string',
'ThroughputCapacity': 123,
'MaintenanceOperationsInProgress': [
'PATCHING'|'BACKING_UP',
],
'WeeklyMaintenanceStartTime': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'Aliases': [
{
'Name': 'string',
'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'
},
],
'AuditLogConfiguration': {
'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
'AuditLogDestination': 'string'
}
},
'LustreConfiguration': {
'WeeklyMaintenanceStartTime': 'string',
'DataRepositoryConfiguration': {
'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING',
'ImportPath': 'string',
'ExportPath': 'string',
'ImportedFileChunkSize': 123,
'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED',
'FailureDetails': {
'Message': 'string'
}
},
'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1',
'PerUnitStorageThroughput': 123,
'MountName': 'string',
'DailyAutomaticBackupStartTime': 'string',
'AutomaticBackupRetentionDays': 123,
'CopyTagsToBackups': True|False,
'DriveCacheType': 'NONE'|'READ',
'DataCompressionType': 'NONE'|'LZ4'
},
'AdministrativeActions': [
{
'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION',
'ProgressPercent': 123,
'RequestTime': datetime(2015, 1, 1),
'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING',
'TargetFileSystemValues': {'... recursive ...'},
'FailureDetails': {
'Message': 'string'
},
'TargetVolumeValues': {
'CreationTime': datetime(2015, 1, 1),
'FileSystemId': 'string',
'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING',
'Name': 'string',
'OntapConfiguration': {
'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
'JunctionPath': 'string',
'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
'SizeInMegabytes': 123,
'StorageEfficiencyEnabled': True|False,
'StorageVirtualMachineId': 'string',
'StorageVirtualMachineRoot': True|False,
'TieringPolicy': {
'CoolingPeriod': 123,
'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
},
'UUID': 'string',
'OntapVolumeType': 'RW'|'DP'|'LS'
},
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VolumeId': 'string',
'VolumeType': 'ONTAP',
'LifecycleTransitionReason': {
'Message': 'string'
}
}
},
],
'OntapConfiguration': {
'AutomaticBackupRetentionDays': 123,
'DailyAutomaticBackupStartTime': 'string',
'DeploymentType': 'MULTI_AZ_1',
'EndpointIpAddressRange': 'string',
'Endpoints': {
'Intercluster': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
},
'Management': {
'DNSName': 'string',
'IpAddresses': [
'string',
]
}
},
'DiskIopsConfiguration': {
'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
'Iops': 123
},
'PreferredSubnetId': 'string',
'RouteTableIds': [
'string',
],
'ThroughputCapacity': 123,
'WeeklyMaintenanceStartTime': 'string'
}
}
}
Response Structure
(dict) --
The response object for the UpdateFileSystem operation.
FileSystem (dict) --
A description of the file system that was updated.
OwnerId (string) --
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 (datetime) --
The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The system-generated, unique 17-digit ID of the file system.
FileSystemType (string) --
The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , or ONTAP .
Lifecycle (string) --
The lifecycle status of the file system, following are the possible values and what they mean:
AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
CREATING - Amazon FSx is creating the new file system.
DELETING - Amazon FSx is deleting an existing file system.
FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.
MISCONFIGURED indicates that the file system is in a failed but recoverable state.
UPDATING indicates that the file system is undergoing a customer initiated update.
FailureDetails (dict) --
A structure providing details of any failures that occur when creating the file system has failed.
Message (string) --
A message describing any failures that occurred during file system creation.
StorageCapacity (integer) --
The storage capacity of the file system in gibibytes (GiB).
StorageType (string) --
The storage type of the file system. Valid values are SSD and HDD . If set to SSD , the file system uses solid state drive storage. If set to HDD , the file system uses hard disk drive storage.
VpcId (string) --
The ID of the primary VPC for the file system.
SubnetIds (list) --
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 .
(string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
NetworkInterfaceIds (list) --
The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.
For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.
(string) --
An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .
DNSName (string) --
The DNS name for the file system.
KmsKeyId (string) --
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 (string) --
The Amazon Resource Name (ARN) for the file system resource.
Tags (list) --
The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
WindowsConfiguration (dict) --
The configuration for this Microsoft Windows file system.
ActiveDirectoryId (string) --
The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.
SelfManagedActiveDirectoryConfiguration (dict) --
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.
DomainName (string) --
The fully qualified domain name of the self-managed AD directory.
OrganizationalUnitDistinguishedName (string) --
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 (string) --
The name of the domain group whose members have administrative privileges for the FSx file system.
UserName (string) --
The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
DnsIps (list) --
A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
(string) --
DeploymentType (string) --
Specifies the file system deployment type, valid values are the following:
MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.
SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see Single-AZ and Multi-AZ File Systems .
RemoteAdministrationEndpoint (string) --
For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
PreferredSubnetId (string) --
For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs . For more information, see Availability and durability: Single-AZ and Multi-AZ file systems .
PreferredFileServerIp (string) --
For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares .
ThroughputCapacity (integer) --
The throughput of the Amazon FSx file system, measured in megabytes per second.
MaintenanceOperationsInProgress (list) --
The list of maintenance operations in progress for this file system.
(string) --
An enumeration specifying the currently ongoing maintenance operation.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DailyAutomaticBackupStartTime (string) --
The preferred time to take daily automatic backups, in the UTC time zone.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Aliases (list) --
An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases .
(dict) --
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 .
Name (string) --
The name of the DNS alias. The alias name has to meet the following requirements:
Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com .
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.
For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
Lifecycle (string) --
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.
AuditLogConfiguration (dict) --
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.
FileAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file and folder accesses.
SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.
FileShareAccessAuditLogLevel (string) --
Sets which attempt type is logged by Amazon FSx for file share accesses.
SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.
AuditLogDestination (string) --
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.
LustreConfiguration (dict) --
The configuration for the Amazon FSx for Lustre file system.
WeeklyMaintenanceStartTime (string) --
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
DataRepositoryConfiguration (dict) --
The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.
Lifecycle (string) --
Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:
CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.
AVAILABLE - The data repository is available for use.
MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket .
UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.
ImportPath (string) --
The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix . If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
ExportPath (string) --
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.
ImportedFileChunkSize (integer) --
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
AutoImportPolicy (string) --
Describes the file system's linked S3 data repository's AutoImportPolicy . The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:
NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
For more information, see Automatically import updates from your S3 bucket .
FailureDetails (dict) --
Provides detailed information about the data respository if its Lifecycle is set to MISCONFIGURED .
Message (string) --
A detailed error message.
DeploymentType (string) --
The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.
SCRATCH_1 and SCRATCH_2 deployment types are best suited for 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 .
The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options . (Default = SCRATCH_1 )
PerUnitStorageThroughput (integer) --
Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
MountName (string) --
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.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
CopyTagsToBackups (boolean) --
A boolean flag indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)
DriveCacheType (string) --
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set to READ , improve the performance for frequently accessed files and allows 20% of the total storage capacity of the file system to be cached.
This parameter is required when StorageType is set to HDD.
DataCompressionType (string) --
The data compression configuration for the file system. DataCompressionType can have the following values:
NONE - Data compression is turned off for the file system.
LZ4 - Data compression is turned on with the LZ4 algorithm.
For more information, see Lustre data compression .
AdministrativeActions (list) --
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.
(dict) --
Describes a specific Amazon FSx administrative action for the current Windows or Lustre file system.
AdministrativeActionType (string) --
Describes the type of administrative action, as follows:
FILE_SYSTEM_UPDATE - A file system update administrative action initiated by the user from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
STORAGE_OPTIMIZATION - Once the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity completes successfully, a STORAGE_OPTIMIZATION task starts.
For Windows, storage optimization is the process of migrating the file system data to the new, larger disks.
For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.
You can track the storage optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION completes successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED . For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide and Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide .
FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new DNS alias with the file system. For more information, see .
FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see .
ProgressPercent (integer) --
Provides the percent complete of a STORAGE_OPTIMIZATION administrative action. Does not apply to any other administrative action type.
RequestTime (datetime) --
Time that the administrative action request was received.
Status (string) --
Describes the status of the administrative action, as follows:
FAILED - Amazon FSx failed to process the administrative action successfully.
IN_PROGRESS - Amazon FSx is processing the administrative action.
PENDING - Amazon FSx is waiting to process the administrative action.
COMPLETED - Amazon FSx has finished processing the administrative task.
UPDATED_OPTIMIZING - For a storage capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage optimization process. 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 .
TargetFileSystemValues (dict) --
Describes the target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.
FailureDetails (dict) --
Provides information about a failed administrative action.
Message (string) --
Error message providing details about the failed administrative action.
TargetVolumeValues (dict) --
Describes an Amazon FSx for NetApp ONTAP volume.
CreationTime (datetime) --
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
FileSystemId (string) --
The globally unique ID of the file system, assigned by Amazon FSx.
Lifecycle (string) --
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.
Name (string) --
The name of the volume.
OntapConfiguration (dict) --
The configuration of an Amazon FSx for NetApp ONTAP volume
FlexCacheEndpointType (string) --
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.
JunctionPath (string) --
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..
SecurityStyle (string) --
The security style for the volume, which can be UNIX , NTFS , or MIXED .
SizeInMegabytes (integer) --
The configured size of the volume, in megabytes (MBs).
StorageEfficiencyEnabled (boolean) --
The volume's storage efficiency setting.
StorageVirtualMachineId (string) --
The ID of the volume's storage virtual machine.
StorageVirtualMachineRoot (boolean) --
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 (dict) --
The volume's TieringPolicy setting.
CoolingPeriod (integer) --
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 .
Name (string) --
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.
UUID (string) --
The volume's UUID (universally unique identifier).
OntapVolumeType (string) --
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.
ResourceARN (string) --
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 .
Tags (list) --
A list of Tag values, with a maximum of 50 elements.
(dict) --
Specifies a key-value pair for a resource tag.
Key (string) --
A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.
Value (string) --
A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .
VolumeId (string) --
The system-generated, unique ID of the volume.
VolumeType (string) --
The type of volume; ONTAP is the only valid volume type.
LifecycleTransitionReason (dict) --
Describes why the volume lifecycle state changed.
Message (string) --
A detailed error message.
OntapConfiguration (dict) --
The configuration for this FSx for NetApp ONTAP file system.
AutomaticBackupRetentionDays (integer) --
The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.
DailyAutomaticBackupStartTime (string) --
A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
DeploymentType (string) --
The ONTAP file system deployment type.
EndpointIpAddressRange (string) --
The IP address range in which the endpoints to access your file system are created.
Endpoints (dict) --
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.
Intercluster (dict) --
An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
Management (dict) --
An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.
DNSName (string) --
The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
IpAddresses (list) --
IP addresses of the file system endpoint.
(string) --
DiskIopsConfiguration (dict) --
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
Mode (string) --
Specifies whether the number of IOPS for the file system is using the system default (AUTOMATIC ) or was provisioned by the customer (USER_PROVISIONED ).
Iops (integer) --
The total number of SSD IOPS provisioned for the file system.
PreferredSubnetId (string) --
The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.
RouteTableIds (list) --
The VPC route tables in which your file system's endpoints are created.
(string) --
ThroughputCapacity (integer) --
Sustained throughput of an Amazon FSx file system in MBps.
WeeklyMaintenanceStartTime (string) --
A recurring weekly time, in the format D:HH:MM .
D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .
HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.