OntapFileSystemState class

Input properties used for looking up and filtering OntapFileSystem resources.

Constructors

OntapFileSystemState({Input<String?>? arn, Input<int?>? automaticBackupRetentionDays, Input<String?>? dailyAutomaticBackupStartTime, Input<String?>? deploymentType, Input<OntapFileSystemDiskIopsConfiguration?>? diskIopsConfiguration, Input<String?>? dnsName, Input<String?>? endpointIpAddressRange, Input<List<OntapFileSystemEndpoint>?>? endpoints, Input<String?>? fsxAdminPassword, Input<int?>? haPairs, Input<String?>? kmsKeyId, Input<List<String>?>? networkInterfaceIds, Input<String?>? networkType, Input<String?>? ownerId, Input<String?>? preferredSubnetId, Input<String?>? region, Input<List<String>?>? routeTableIds, Input<List<String>?>? securityGroupIds, Input<int?>? storageCapacity, Input<String?>? storageType, Input<List<String>?>? subnetIds, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<int?>? throughputCapacity, Input<int?>? throughputCapacityPerHaPair, Input<String?>? vpcId, Input<String?>? weeklyMaintenanceStartTime})
Creates a new OntapFileSystemState. arn ARN of the file system. automaticBackupRetentionDays 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. dailyAutomaticBackupStartTime 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. Requires automaticBackupRetentionDays to be set. deploymentType Filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2. diskIopsConfiguration SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See diskIopsConfiguration below. dnsName Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name. endpointIpAddressRange 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. Note that the 198.19.* range is also used by AWS services such as WorkSpaces and AppStream 2.0 for their management network interfaces. endpoints Endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See endpoints below. fsxAdminPassword ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API. haPairs Number of haPairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2. kmsKeyId ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key. networkInterfaceIds Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface. networkType Network type. Valid values are IPV4 and DUAL. Default value is IPV4. ownerId AWS account identifier that created the file system. preferredSubnetId ID for a subnet. A subnet is a range of IP addresses in your VPC. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. routeTableIds 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. securityGroupIds List of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces. storageCapacity Storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deploymentType SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deploymentType SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair. storageType Filesystem storage type. Defaults to SSD. subnetIds List of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided. tags Map of tags to assign to the file system. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. throughputCapacity Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the haPairs parameter. Either throughputCapacity or throughputCapacityPerHaPair must be specified. throughputCapacityPerHaPair Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughputCapacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where haPairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where haPairs is greater than 1. This parameter is only supported when specifying the haPairs parameter. Either throughputCapacity or throughputCapacityPerHaPair must be specified. vpcId Identifier of the VPC for the file system. weeklyMaintenanceStartTime Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
const
OntapFileSystemState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the file system.
final
automaticBackupRetentionDays → Input<int?>?
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.
final
dailyAutomaticBackupStartTime → Input<String?>?
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. Requires automaticBackupRetentionDays to be set.
final
deploymentType → Input<String?>?
Filesystem deployment type. Supports MULTI_AZ_1, MULTI_AZ_2, SINGLE_AZ_1, and SINGLE_AZ_2.
final
diskIopsConfiguration → Input<OntapFileSystemDiskIopsConfiguration?>?
SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See diskIopsConfiguration below.
final
dnsName → Input<String?>?
Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.
final
endpointIpAddressRange → Input<String?>?
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. Note that the 198.19.* range is also used by AWS services such as WorkSpaces and AppStream 2.0 for their management network interfaces.
final
endpoints → Input<List<OntapFileSystemEndpoint>?>?
Endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See endpoints below.
final
fsxAdminPassword → Input<String?>?
ONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.
final
haPairs → Input<int?>?
Number of haPairs to deploy for the file system. Valid value is 1 for SINGLE_AZ_1 or MULTI_AZ_1 and MULTI_AZ_2. Valid values are 1 through 12 for SINGLE_AZ_2.
final
hashCode → int
The hash code for this object.
no setterinherited
kmsKeyId → Input<String?>?
ARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.
final
networkInterfaceIds → Input<List<String>?>?
Set of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.
final
networkType → Input<String?>?
Network type. Valid values are IPV4 and DUAL. Default value is IPV4.
final
ownerId → Input<String?>?
AWS account identifier that created the file system.
final
preferredSubnetId → Input<String?>?
ID for a subnet. A subnet is a range of IP addresses in your VPC.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
routeTableIds → Input<List<String>?>?
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupIds → Input<List<String>?>?
List of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces.
final
storageCapacity → Input<int?>?
Storage capacity (GiB) of the file system. Valid values between 1024 and 196608 for file systems with deploymentType SINGLE_AZ_1 and MULTI_AZ_1. Valid values are between 1024 and 524288 for MULTI_AZ_2. Valid values between 1024 (1024 per ha pair) and 1048576 for file systems with deploymentType SINGLE_AZ_2. For SINGLE_AZ_2, the 1048576 (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is 524288 (512TB) when using 1 ha_pair.
final
storageType → Input<String?>?
Filesystem storage type. Defaults to SSD.
final
subnetIds → Input<List<String>?>?
List of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the file system. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
throughputCapacity → Input<int?>?
Sets the throughput capacity (in MBps) for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096. This parameter is only supported when not using the haPairs parameter. Either throughputCapacity or throughputCapacityPerHaPair must be specified.
final
throughputCapacityPerHaPair → Input<int?>?
Sets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed to throughputCapacity which specifies the total throughput capacity for the file system. Valid value for MULTI_AZ_1 and SINGLE_AZ_1 are 128, 256, 512, 1024, 2048, and 4096. Valid values for deployment type MULTI_AZ_2 and SINGLE_AZ_2 are 384,768,1536,3072,6144 where haPairs is 1. Valid values for deployment type SINGLE_AZ_2 are 1536, 3072, and 6144 where haPairs is greater than 1. This parameter is only supported when specifying the haPairs parameter. Either throughputCapacity or throughputCapacityPerHaPair must be specified.
final
vpcId → Input<String?>?
Identifier of the VPC for the file system.
final
weeklyMaintenanceStartTime → Input<String?>?
Preferred start time (in d:HH:MM format) to perform weekly maintenance, in the UTC time zone.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited