class CfnVolumePropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.FSx.CfnVolumePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsfsx#CfnVolumePropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.fsx.CfnVolumePropsMixin
Python	aws_cdk.cfn_property_mixins.aws_fsx.CfnVolumePropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_fsx » CfnVolumePropsMixin

Implements IMixin

Extends Mixin

Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.

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

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/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnVolumePropsMixin = new fsx.CfnVolumePropsMixin({
  backupId: 'backupId',
  name: 'name',
  ontapConfiguration: {
    aggregateConfiguration: {
      aggregates: ['aggregates'],
      constituentsPerAggregate: 123,
    },
    copyTagsToBackups: 'copyTagsToBackups',
    junctionPath: 'junctionPath',
    ontapVolumeType: 'ontapVolumeType',
    securityStyle: 'securityStyle',
    sizeInBytes: 'sizeInBytes',
    sizeInMegabytes: 'sizeInMegabytes',
    snaplockConfiguration: {
      auditLogVolume: 'auditLogVolume',
      autocommitPeriod: {
        type: 'type',
        value: 123,
      },
      privilegedDelete: 'privilegedDelete',
      retentionPeriod: {
        defaultRetention: {
          type: 'type',
          value: 123,
        },
        maximumRetention: {
          type: 'type',
          value: 123,
        },
        minimumRetention: {
          type: 'type',
          value: 123,
        },
      },
      snaplockType: 'snaplockType',
      volumeAppendModeEnabled: 'volumeAppendModeEnabled',
    },
    snapshotPolicy: 'snapshotPolicy',
    storageEfficiencyEnabled: 'storageEfficiencyEnabled',
    storageVirtualMachineId: 'storageVirtualMachineId',
    tieringPolicy: {
      coolingPeriod: 123,
      name: 'name',
    },
    volumeStyle: 'volumeStyle',
  },
  openZfsConfiguration: {
    copyTagsToSnapshots: false,
    dataCompressionType: 'dataCompressionType',
    nfsExports: [{
      clientConfigurations: [{
        clients: 'clients',
        options: ['options'],
      }],
    }],
    options: ['options'],
    originSnapshot: {
      copyStrategy: 'copyStrategy',
      snapshotArn: 'snapshotArn',
    },
    parentVolumeId: 'parentVolumeId',
    readOnly: false,
    recordSizeKiB: 123,
    storageCapacityQuotaGiB: 123,
    storageCapacityReservationGiB: 123,
    userAndGroupQuotas: [{
      id: 123,
      storageCapacityQuotaGiB: 123,
      type: 'type',
    }],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  volumeType: 'volumeType',
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnVolumePropsMixin(props: CfnVolumeMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnVolumeMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::FSx::Volume.

Properties

Name	Type	Description
props	CfnVolumeMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnVolumeMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.