interface CfnVolumeProps

Language	Type name
.NET	`Amazon.CDK.AWS.FSx.CfnVolumeProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsfsx#CfnVolumeProps`
Java	`software.amazon.awscdk.services.fsx.CfnVolumeProps`
Python	`aws_cdk.aws_fsx.CfnVolumeProps`
TypeScript	`aws-cdk-lib` » `aws_fsx` » `CfnVolumeProps`

Properties for defining a CfnVolume.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_fsx as fsx } from 'aws-cdk-lib';
const cfnVolumeProps: fsx.CfnVolumeProps = {
  name: 'name',

  // the properties below are optional
  backupId: 'backupId',
  ontapConfiguration: {
    storageVirtualMachineId: 'storageVirtualMachineId',

    // the properties below are optional
    aggregateConfiguration: {
      aggregates: ['aggregates'],
      constituentsPerAggregate: 123,
    },
    copyTagsToBackups: 'copyTagsToBackups',
    junctionPath: 'junctionPath',
    ontapVolumeType: 'ontapVolumeType',
    securityStyle: 'securityStyle',
    sizeInBytes: 'sizeInBytes',
    sizeInMegabytes: 'sizeInMegabytes',
    snaplockConfiguration: {
      snaplockType: 'snaplockType',

      // the properties below are optional
      auditLogVolume: 'auditLogVolume',
      autocommitPeriod: {
        type: 'type',

        // the properties below are optional
        value: 123,
      },
      privilegedDelete: 'privilegedDelete',
      retentionPeriod: {
        defaultRetention: {
          type: 'type',

          // the properties below are optional
          value: 123,
        },
        maximumRetention: {
          type: 'type',

          // the properties below are optional
          value: 123,
        },
        minimumRetention: {
          type: 'type',

          // the properties below are optional
          value: 123,
        },
      },
      volumeAppendModeEnabled: 'volumeAppendModeEnabled',
    },
    snapshotPolicy: 'snapshotPolicy',
    storageEfficiencyEnabled: 'storageEfficiencyEnabled',
    tieringPolicy: {
      coolingPeriod: 123,
      name: 'name',
    },
    volumeStyle: 'volumeStyle',
  },
  openZfsConfiguration: {
    parentVolumeId: 'parentVolumeId',

    // the properties below are optional
    copyTagsToSnapshots: false,
    dataCompressionType: 'dataCompressionType',
    nfsExports: [{
      clientConfigurations: [{
        clients: 'clients',
        options: ['options'],
      }],
    }],
    options: ['options'],
    originSnapshot: {
      copyStrategy: 'copyStrategy',
      snapshotArn: 'snapshotArn',
    },
    readOnly: false,
    recordSizeKiB: 123,
    storageCapacityQuotaGiB: 123,
    storageCapacityReservationGiB: 123,
    userAndGroupQuotas: [{
      id: 123,
      storageCapacityQuotaGiB: 123,
      type: 'type',
    }],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  volumeType: 'volumeType',
};

Properties

Name	Type	Description
name	`string`	The name of the volume.
backupId?	`string`	Specifies the ID of the volume backup to use to create a new volume.
ontapConfiguration?	`IResolvable` `\|` `OntapConfigurationProperty`	The configuration of an Amazon FSx for NetApp ONTAP volume.
openZfsConfiguration?	`IResolvable` `\|` `OpenZFSConfigurationProperty`	The configuration of an Amazon FSx for OpenZFS volume.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this resource.
volumeType?	`string`	The type of the volume.

name

Type: string

The name of the volume.

backupId?

Type: string (optional)

Specifies the ID of the volume backup to use to create a new volume.

ontapConfiguration?

Type: IResolvable | OntapConfigurationProperty (optional)

The configuration of an Amazon FSx for NetApp ONTAP volume.

openZfsConfiguration?

Type: IResolvable | OpenZFSConfigurationProperty (optional)

The configuration of an Amazon FSx for OpenZFS volume.

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

volumeType?

Type: string (optional)

The type of the volume.