MountableBlockVolumeProps

class aws_rfdk.MountableBlockVolumeProps(*, block_volume, extra_mount_options=None, volume_format=None)

Bases: object

Properties that are required to create a {@link MountableBlockVolume}.

Parameters
  • block_volume (IVolume) – The {@link https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.Volume.htmlEBS Block Volume} that will be mounted by this object.

  • extra_mount_options (Optional[Sequence[str]]) – Extra mount options that will be added to /etc/fstab for the file system. See the Linux man page for mounting the Volume’s file system type for information on available options. The given values will be joined together into a single string by commas. ex: [‘soft’, ‘rsize=4096’] will become ‘soft,rsize=4096’ Default: No extra options.

  • volume_format (Optional[BlockVolumeFormat]) – The filesystem format of the block volume. Default: BlockVolumeFormat.XFS

Attributes

block_volume

//docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.Volume.htmlEBS Block Volume} that will be mounted by this object.

Type

The {@link https

Return type

IVolume

extra_mount_options

Extra mount options that will be added to /etc/fstab for the file system.

See the Linux man page for mounting the Volume’s file system type for information on available options.

The given values will be joined together into a single string by commas. ex: [‘soft’, ‘rsize=4096’] will become ‘soft,rsize=4096’

Default

No extra options.

Return type

Optional[List[str]]

volume_format

The filesystem format of the block volume.

Default

BlockVolumeFormat.XFS

Remark

If the volume is already formatted, but does not match this format then the mounting script employed by {@link MountableBlockVolume } will mount the volume as-is if it is able. No formatting will be performed.

Return type

Optional[BlockVolumeFormat]