CfnVolumeProps

class aws_cdk.aws_fsx.CfnVolumeProps(*, name, backup_id=None, ontap_configuration=None, open_zfs_configuration=None, tags=None, volume_type=None)

Bases: object

Properties for defining a CfnVolume.

Parameters:

name (str) – The name of the volume.
backup_id (Optional[str]) – Specifies the ID of the volume backup to use to create a new volume.
ontap_configuration (Union[IResolvable, OntapConfigurationProperty, Dict[str, Any], None]) – The configuration of an Amazon FSx for NetApp ONTAP volume.
open_zfs_configuration (Union[IResolvable, OpenZFSConfigurationProperty, Dict[str, Any], None]) – The configuration of an Amazon FSx for OpenZFS volume.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
volume_type (Optional[str]) – The type of the volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_fsx as fsx

cfn_volume_props = fsx.CfnVolumeProps(
    name="name",

    # the properties below are optional
    backup_id="backupId",
    ontap_configuration=fsx.CfnVolume.OntapConfigurationProperty(
        storage_virtual_machine_id="storageVirtualMachineId",

        # the properties below are optional
        aggregate_configuration=fsx.CfnVolume.AggregateConfigurationProperty(
            aggregates=["aggregates"],
            constituents_per_aggregate=123
        ),
        copy_tags_to_backups="copyTagsToBackups",
        junction_path="junctionPath",
        ontap_volume_type="ontapVolumeType",
        security_style="securityStyle",
        size_in_bytes="sizeInBytes",
        size_in_megabytes="sizeInMegabytes",
        snaplock_configuration=fsx.CfnVolume.SnaplockConfigurationProperty(
            snaplock_type="snaplockType",

            # the properties below are optional
            audit_log_volume="auditLogVolume",
            autocommit_period=fsx.CfnVolume.AutocommitPeriodProperty(
                type="type",

                # the properties below are optional
                value=123
            ),
            privileged_delete="privilegedDelete",
            retention_period=fsx.CfnVolume.SnaplockRetentionPeriodProperty(
                default_retention=fsx.CfnVolume.RetentionPeriodProperty(
                    type="type",

                    # the properties below are optional
                    value=123
                ),
                maximum_retention=fsx.CfnVolume.RetentionPeriodProperty(
                    type="type",

                    # the properties below are optional
                    value=123
                ),
                minimum_retention=fsx.CfnVolume.RetentionPeriodProperty(
                    type="type",

                    # the properties below are optional
                    value=123
                )
            ),
            volume_append_mode_enabled="volumeAppendModeEnabled"
        ),
        snapshot_policy="snapshotPolicy",
        storage_efficiency_enabled="storageEfficiencyEnabled",
        tiering_policy=fsx.CfnVolume.TieringPolicyProperty(
            cooling_period=123,
            name="name"
        ),
        volume_style="volumeStyle"
    ),
    open_zfs_configuration=fsx.CfnVolume.OpenZFSConfigurationProperty(
        parent_volume_id="parentVolumeId",

        # the properties below are optional
        copy_tags_to_snapshots=False,
        data_compression_type="dataCompressionType",
        nfs_exports=[fsx.CfnVolume.NfsExportsProperty(
            client_configurations=[fsx.CfnVolume.ClientConfigurationsProperty(
                clients="clients",
                options=["options"]
            )]
        )],
        options=["options"],
        origin_snapshot=fsx.CfnVolume.OriginSnapshotProperty(
            copy_strategy="copyStrategy",
            snapshot_arn="snapshotArn"
        ),
        read_only=False,
        record_size_ki_b=123,
        storage_capacity_quota_gi_b=123,
        storage_capacity_reservation_gi_b=123,
        user_and_group_quotas=[fsx.CfnVolume.UserAndGroupQuotasProperty(
            id=123,
            storage_capacity_quota_gi_b=123,
            type="type"
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    volume_type="volumeType"
)