OpenZfsFileSystemState class

Input properties used for looking up and filtering OpenZfsFileSystem resources.

Constructors

OpenZfsFileSystemState({Input<String?>? arn, Input<int?>? automaticBackupRetentionDays, Input<String?>? backupId, Input<bool?>? copyTagsToBackups, Input<bool?>? copyTagsToVolumes, Input<String?>? dailyAutomaticBackupStartTime, Input<List<String>?>? deleteOptions, Input<String?>? deploymentType, Input<OpenZfsFileSystemDiskIopsConfiguration?>? diskIopsConfiguration, Input<String?>? dnsName, Input<String?>? endpointIpAddress, Input<String?>? endpointIpAddressRange, Input<Map<String, String>?>? finalBackupTags, Input<String?>? kmsKeyId, Input<List<String>?>? networkInterfaceIds, Input<String?>? networkType, Input<String?>? ownerId, Input<String?>? preferredSubnetId, Input<OpenZfsFileSystemReadCacheConfiguration?>? readCacheConfiguration, Input<String?>? region, Input<OpenZfsFileSystemRootVolumeConfiguration?>? rootVolumeConfiguration, Input<String?>? rootVolumeId, Input<List<String>?>? routeTableIds, Input<List<String>?>? securityGroupIds, Input<bool?>? skipFinalBackup, Input<int?>? storageCapacity, Input<String?>? storageType, Input<List<String>?>? subnetIds, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<int?>? throughputCapacity, Input<String?>? vpcId, Input<String?>? weeklyMaintenanceStartTime})
Creates a new OpenZfsFileSystemState. 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. backupId ID of the source backup to create the filesystem from. copyTagsToBackups Whether tags for the file system should be copied to backups. Default value is false. copyTagsToVolumes Whether tags for the file system should be copied to snapshots. Default value is false. 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. deleteOptions List of delete options, which at present supports only one value that specifies whether to delete all child volumes and snapshots when the file system is deleted. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. deploymentType Filesystem deployment type. See the AWS API documentation for a list of valid values. diskIopsConfiguration SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See diskIopsConfiguration Block for details. dnsName DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com endpointIpAddress IP address of the endpoint that is used to access data or to manage the file system. endpointIpAddressRange (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. finalBackupTags Map of tags to apply to the file system's final backup. 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 (Multi-AZ only) Required when deploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. readCacheConfiguration Configuration block for optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class. Required when storageType is set to INTELLIGENT_TIERING. See readCacheConfiguration Block for details. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. rootVolumeConfiguration Configuration for the root volume of the file system. All other volumes are children or the root volume. See rootVolumeConfiguration Block for details. rootVolumeId Identifier of the root volume, e.g., fsvol-12345678 routeTableIds (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. 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. skipFinalBackup When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false. storageCapacity Storage capacity (GiB) of the file system. Valid values between 64 and 524288. Required when storageType is set to SSD. Must not be set when storageType is set to INTELLIGENT_TIERING. storageType Filesystem storage type. Valid values are SSD and INTELLIGENT_TIERING. INTELLIGENT_TIERING requires deploymentType to be MULTI_AZ_1. subnetIds List of IDs for the subnets that the file system will be accessible from. 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 Throughput (MB/s) of the file system. Valid values depend on deploymentType. Must be one of 64, 128, 256, 512, 1024, 2048, 3072, 4096 for SINGLE_AZ_1. Must be one of 160, 320, 640, 1280, 2560, 3840, 5120, 7680, 10240 for SINGLE_AZ_2. 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
OpenZfsFileSystemState.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
backupId → Input<String?>?
ID of the source backup to create the filesystem from.
final
copyTagsToBackups → Input<bool?>?
Whether tags for the file system should be copied to backups. Default value is false.
final
copyTagsToVolumes → Input<bool?>?
Whether tags for the file system should be copied to snapshots. Default value is false.
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
deleteOptions → Input<List<String>?>?
List of delete options, which at present supports only one value that specifies whether to delete all child volumes and snapshots when the file system is deleted. Valid values: DELETE_CHILD_VOLUMES_AND_SNAPSHOTS.
final
deploymentType → Input<String?>?
Filesystem deployment type. See the AWS API documentation for a list of valid values.
final
diskIopsConfiguration → Input<OpenZfsFileSystemDiskIopsConfiguration?>?
SSD IOPS configuration for the Amazon FSx for OpenZFS file system. See diskIopsConfiguration Block for details.
final
dnsName → Input<String?>?
DNS name for the file system, e.g., fs-12345678.fsx.us-west-2.amazonaws.com
final
endpointIpAddress → Input<String?>?
IP address of the endpoint that is used to access data or to manage the file system.
final
endpointIpAddressRange → Input<String?>?
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
final
finalBackupTags → Input<Map<String, String>?>?
Map of tags to apply to the file system's final backup.
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?>?
(Multi-AZ only) Required when deploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.
final
readCacheConfiguration → Input<OpenZfsFileSystemReadCacheConfiguration?>?
Configuration block for optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class. Required when storageType is set to INTELLIGENT_TIERING. See readCacheConfiguration Block for details.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
rootVolumeConfiguration → Input<OpenZfsFileSystemRootVolumeConfiguration?>?
Configuration for the root volume of the file system. All other volumes are children or the root volume. See rootVolumeConfiguration Block for details.
final
rootVolumeId → Input<String?>?
Identifier of the root volume, e.g., fsvol-12345678
final
routeTableIds → Input<List<String>?>?
(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. 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
skipFinalBackup → Input<bool?>?
When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to false.
final
storageCapacity → Input<int?>?
Storage capacity (GiB) of the file system. Valid values between 64 and 524288. Required when storageType is set to SSD. Must not be set when storageType is set to INTELLIGENT_TIERING.
final
storageType → Input<String?>?
Filesystem storage type. Valid values are SSD and INTELLIGENT_TIERING. INTELLIGENT_TIERING requires deploymentType to be MULTI_AZ_1.
final
subnetIds → Input<List<String>?>?
List of IDs for the subnets that the file system will be accessible from.
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?>?
Throughput (MB/s) of the file system. Valid values depend on deploymentType. Must be one of 64, 128, 256, 512, 1024, 2048, 3072, 4096 for SINGLE_AZ_1. Must be one of 160, 320, 640, 1280, 2560, 3840, 5120, 7680, 10240 for SINGLE_AZ_2.
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