CfnVolumeMixinProps
- class aws_cdk.mixins_preview.aws_fsx.mixins.CfnVolumeMixinProps(*, backup_id=None, name=None, ontap_configuration=None, open_zfs_configuration=None, tags=None, volume_type=None)
Bases:
objectProperties for CfnVolumePropsMixin.
- Parameters:
backup_id (
Optional[str]) – Specifies the ID of the volume backup to use to create a new volume.name (
Optional[str]) – The name of the 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.mixins_preview.aws_fsx import mixins as fsx_mixins cfn_volume_mixin_props = fsx_mixins.CfnVolumeMixinProps( backup_id="backupId", name="name", ontap_configuration=fsx_mixins.CfnVolumePropsMixin.OntapConfigurationProperty( aggregate_configuration=fsx_mixins.CfnVolumePropsMixin.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_mixins.CfnVolumePropsMixin.SnaplockConfigurationProperty( audit_log_volume="auditLogVolume", autocommit_period=fsx_mixins.CfnVolumePropsMixin.AutocommitPeriodProperty( type="type", value=123 ), privileged_delete="privilegedDelete", retention_period=fsx_mixins.CfnVolumePropsMixin.SnaplockRetentionPeriodProperty( default_retention=fsx_mixins.CfnVolumePropsMixin.RetentionPeriodProperty( type="type", value=123 ), maximum_retention=fsx_mixins.CfnVolumePropsMixin.RetentionPeriodProperty( type="type", value=123 ), minimum_retention=fsx_mixins.CfnVolumePropsMixin.RetentionPeriodProperty( type="type", value=123 ) ), snaplock_type="snaplockType", volume_append_mode_enabled="volumeAppendModeEnabled" ), snapshot_policy="snapshotPolicy", storage_efficiency_enabled="storageEfficiencyEnabled", storage_virtual_machine_id="storageVirtualMachineId", tiering_policy=fsx_mixins.CfnVolumePropsMixin.TieringPolicyProperty( cooling_period=123, name="name" ), volume_style="volumeStyle" ), open_zfs_configuration=fsx_mixins.CfnVolumePropsMixin.OpenZFSConfigurationProperty( copy_tags_to_snapshots=False, data_compression_type="dataCompressionType", nfs_exports=[fsx_mixins.CfnVolumePropsMixin.NfsExportsProperty( client_configurations=[fsx_mixins.CfnVolumePropsMixin.ClientConfigurationsProperty( clients="clients", options=["options"] )] )], options=["options"], origin_snapshot=fsx_mixins.CfnVolumePropsMixin.OriginSnapshotProperty( copy_strategy="copyStrategy", snapshot_arn="snapshotArn" ), parent_volume_id="parentVolumeId", 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_mixins.CfnVolumePropsMixin.UserAndGroupQuotasProperty( id=123, storage_capacity_quota_gi_b=123, type="type" )] ), tags=[CfnTag( key="key", value="value" )], volume_type="volumeType" )
Attributes
- backup_id
Specifies the ID of the volume backup to use to create a new volume.
- name
The name of the volume.
- ontap_configuration
The configuration of an Amazon FSx for NetApp ONTAP volume.
- open_zfs_configuration
The configuration of an Amazon FSx for OpenZFS volume.
- volume_type
The type of the volume.