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< ? endpoints, Input<OntapFileSystemEndpoint> ?>String?> ? fsxAdminPassword, Input<int?> ? haPairs, Input<String?> ? kmsKeyId, Input<List< ? networkInterfaceIds, Input<String> ?>String?> ? networkType, Input<String?> ? ownerId, Input<String?> ? preferredSubnetId, Input<String?> ? region, Input<List< ? routeTableIds, Input<String> ?>List< ? securityGroupIds, Input<String> ?>int?> ? storageCapacity, Input<String?> ? storageType, Input<List< ? subnetIds, Input<String> ?>Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>int?> ? throughputCapacity, Input<int?> ? throughputCapacityPerHaPair, Input<String?> ? vpcId, Input<String?> ? weeklyMaintenanceStartTime}) -
Creates a new OntapFileSystemState.
arnARN of the file system.automaticBackupRetentionDaysNumber of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.dailyAutomaticBackupStartTimeRecurring 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. RequiresautomaticBackupRetentionDaysto be set.deploymentTypeFilesystem deployment type. SupportsMULTI_AZ_1,MULTI_AZ_2,SINGLE_AZ_1, andSINGLE_AZ_2.diskIopsConfigurationSSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. SeediskIopsConfigurationbelow.dnsNameDomain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.endpointIpAddressRangeIP 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.endpointsEndpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. Seeendpointsbelow.fsxAdminPasswordONTAP administrative password for the fsxadmin user that you can use to administer your file system using the ONTAP CLI and REST API.haPairsNumber of haPairs to deploy for the file system. Valid value is 1 forSINGLE_AZ_1orMULTI_AZ_1andMULTI_AZ_2. Valid values are 1 through 12 forSINGLE_AZ_2.kmsKeyIdARN for the KMS Key to encrypt the file system at rest, Defaults to an AWS managed KMS Key.networkInterfaceIdsSet of Elastic Network Interface identifiers from which the file system is accessible The first network interface returned is the primary network interface.networkTypeNetwork type. Valid values areIPV4andDUAL. Default value isIPV4.ownerIdAWS account identifier that created the file system.preferredSubnetIdID for a subnet. A subnet is a range of IP addresses in your VPC.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.routeTableIdsVPC 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.securityGroupIdsList 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.storageCapacityStorage capacity (GiB) of the file system. Valid values between1024and196608for file systems with deploymentTypeSINGLE_AZ_1andMULTI_AZ_1. Valid values are between1024and524288forMULTI_AZ_2. Valid values between1024(1024per ha pair) and1048576for file systems with deploymentTypeSINGLE_AZ_2. ForSINGLE_AZ_2, the1048576(1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is524288(512TB) when using 1 ha_pair.storageTypeFilesystem storage type. Defaults toSSD.subnetIdsList of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided.tagsMap of tags to assign to the file system. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.throughputCapacitySets the throughput capacity (in MBps) for the file system that you're creating. Valid values are128,256,512,1024,2048, and4096. This parameter is only supported when not using the haPairs parameter. Either throughputCapacity or throughputCapacityPerHaPair must be specified.throughputCapacityPerHaPairSets the per-HA-pair throughput capacity (in MBps) for the file system that you're creating, as opposed tothroughputCapacitywhich specifies the total throughput capacity for the file system. Valid value forMULTI_AZ_1andSINGLE_AZ_1are128,256,512,1024,2048, and4096. Valid values for deployment typeMULTI_AZ_2andSINGLE_AZ_2are384,768,1536,3072,6144wherehaPairsis1. Valid values for deployment typeSINGLE_AZ_2are1536,3072, and6144wherehaPairsis greater than 1. This parameter is only supported when specifying the haPairs parameter. Either throughputCapacity or throughputCapacityPerHaPair must be specified.vpcIdIdentifier of the VPC for the file system.weeklyMaintenanceStartTimePreferred start time (ind:HH:MMformat) 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
automaticBackupRetentionDaysto be set.final -
deploymentType
→ Input<
String?> ? -
Filesystem deployment type. Supports
MULTI_AZ_1,MULTI_AZ_2,SINGLE_AZ_1, andSINGLE_AZ_2.final -
diskIopsConfiguration
→ Input<
OntapFileSystemDiskIopsConfiguration?> ? -
SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file system. See
diskIopsConfigurationbelow.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
endpointsbelow.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_1orMULTI_AZ_1andMULTI_AZ_2. Valid values are 1 through 12 forSINGLE_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
IPV4andDUAL. Default value isIPV4.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
1024and196608for file systems with deploymentTypeSINGLE_AZ_1andMULTI_AZ_1. Valid values are between1024and524288forMULTI_AZ_2. Valid values between1024(1024per ha pair) and1048576for file systems with deploymentTypeSINGLE_AZ_2. ForSINGLE_AZ_2, the1048576(1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is524288(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
-
Map of tags to assign to the file system. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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, and4096. 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
throughputCapacitywhich specifies the total throughput capacity for the file system. Valid value forMULTI_AZ_1andSINGLE_AZ_1are128,256,512,1024,2048, and4096. Valid values for deployment typeMULTI_AZ_2andSINGLE_AZ_2are384,768,1536,3072,6144wherehaPairsis1. Valid values for deployment typeSINGLE_AZ_2are1536,3072, and6144wherehaPairsis 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:MMformat) 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