Skip to content

OpenZFSFileSystemConfiguration

Source code in docs_src/capo_fsx/types/open_zfs_file_system_configuration.py
class OpenZFSFileSystemConfiguration(TypedDict, closed=True):
    automatic_backup_retention_days: NotRequired[
        "capo_fsx.types.automatic_backup_retention_days.AutomaticBackupRetentionDays"
    ]
    copy_tags_to_backups: NotRequired["capo_fsx.types.flag.Flag"]
    """<p>A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to <code>true</code>, 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 <code>true</code> 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. </p>"""
    copy_tags_to_volumes: NotRequired["capo_fsx.types.flag.Flag"]
    """<p>A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to <code>false</code>. If it's set to <code>true</code>, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is <code>true</code> and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value. </p>"""
    daily_automatic_backup_start_time: NotRequired[
        "capo_fsx.types.daily_time.DailyTime"
    ]
    deployment_type: NotRequired[
        "capo_fsx.types.open_zfs_deployment_type.OpenZFSDeploymentType"
    ]
    """<p>Specifies the file-system deployment type. Amazon FSx for OpenZFS supports <code>MULTI_AZ_1</code>, <code>SINGLE_AZ_HA_2</code>, <code>SINGLE_AZ_HA_1</code>, <code>SINGLE_AZ_2</code>, and <code>SINGLE_AZ_1</code>.</p>"""
    throughput_capacity: NotRequired[
        "capo_fsx.types.megabytes_per_second.MegabytesPerSecond"
    ]
    """<p>The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).</p>"""
    weekly_maintenance_start_time: NotRequired["capo_fsx.types.weekly_time.WeeklyTime"]
    disk_iops_configuration: NotRequired[
        "capo_fsx.types.disk_iops_configuration.DiskIopsConfiguration"
    ]
    root_volume_id: NotRequired["capo_fsx.types.volume_id.VolumeId"]
    """<p>The ID of the root volume of the OpenZFS file system. </p>"""
    preferred_subnet_id: NotRequired["capo_fsx.types.subnet_id.SubnetId"]
    """<p>Required when <code>DeploymentType</code> is set to <code>MULTI_AZ_1</code>. This specifies the subnet in which you want the preferred file server to be located.</p>"""
    endpoint_ip_address_range: NotRequired[
        "capo_fsx.types.ip_address_range.IpAddressRange"
    ]
    """<p>(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.</p>"""
    endpoint_ipv6_address_range: NotRequired[
        "capo_fsx.types.ipv6_address_range.Ipv6AddressRange"
    ]
    """<p>(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.</p>"""
    route_table_ids: NotRequired["capo_fsx.types.route_table_ids.RouteTableIds"]
    """<p>(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.</p>"""
    endpoint_ip_address: NotRequired["capo_fsx.types.ip_address.IpAddress"]
    """<p>The IPv4 address of the endpoint that is used to access data or to manage the file system.</p>"""
    endpoint_ipv6_address: NotRequired["capo_fsx.types.ip_address.IpAddress"]
    """<p>The IPv6 address of the endpoint that is used to access data or to manage the file system.</p>"""
    read_cache_configuration: NotRequired[
        "capo_fsx.types.open_zfs_read_cache_configuration.OpenZFSReadCacheConfiguration"
    ]
    """<p> Required when <code>StorageType</code> is set to <code>INTELLIGENT_TIERING</code>. Specifies the optional provisioned SSD read cache. </p>"""

automatic_backup_retention_days instance-attribute

automatic_backup_retention_days: NotRequired[AutomaticBackupRetentionDays]

copy_tags_to_backups instance-attribute

copy_tags_to_backups: NotRequired[Flag]

A Boolean value 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.

copy_tags_to_volumes instance-attribute

copy_tags_to_volumes: NotRequired[Flag]

A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots 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 snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

daily_automatic_backup_start_time instance-attribute

daily_automatic_backup_start_time: NotRequired[DailyTime]

deployment_type instance-attribute

deployment_type: NotRequired[OpenZFSDeploymentType]

Specifies the file-system deployment type. Amazon FSx for OpenZFS supports MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

disk_iops_configuration instance-attribute

disk_iops_configuration: NotRequired[DiskIopsConfiguration]

endpoint_ip_address instance-attribute

endpoint_ip_address: NotRequired[IpAddress]

The IPv4 address of the endpoint that is used to access data or to manage the file system.

endpoint_ip_address_range instance-attribute

endpoint_ip_address_range: NotRequired[IpAddressRange]

(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

endpoint_ipv6_address instance-attribute

endpoint_ipv6_address: NotRequired[IpAddress]

The IPv6 address of the endpoint that is used to access data or to manage the file system.

endpoint_ipv6_address_range instance-attribute

endpoint_ipv6_address_range: NotRequired[Ipv6AddressRange]

(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.

preferred_subnet_id instance-attribute

preferred_subnet_id: NotRequired[SubnetId]

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

read_cache_configuration instance-attribute

read_cache_configuration: NotRequired[OpenZFSReadCacheConfiguration]

Required when StorageType is set to INTELLIGENT_TIERING. Specifies the optional provisioned SSD read cache.

root_volume_id instance-attribute

root_volume_id: NotRequired[VolumeId]

The ID of the root volume of the OpenZFS file system.

route_table_ids instance-attribute

route_table_ids: NotRequired[RouteTableIds]

(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

throughput_capacity instance-attribute

throughput_capacity: NotRequired[MegabytesPerSecond]

The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

weekly_maintenance_start_time instance-attribute

weekly_maintenance_start_time: NotRequired[WeeklyTime]