class CfnFileSystemPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.FSx.Mixins.CfnFileSystemPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsfsx/mixins#CfnFileSystemPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.fsx.mixins.CfnFileSystemPropsMixin
Python	aws_cdk.mixins_preview.aws_fsx.mixins.CfnFileSystemPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_fsx » mixins » CfnFileSystemPropsMixin

Implements IMixin

Extends Mixin

The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system.

You can create any of the following supported file system types:

• Amazon FSx for Lustre
• Amazon FSx for NetApp ONTAP
• FSx for OpenZFS
• Amazon FSx for Windows File Server

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as fsx_mixins } from '@aws-cdk/mixins-preview/aws-fsx';
const cfnFileSystemPropsMixin = new fsx_mixins.CfnFileSystemPropsMixin({
  backupId: 'backupId',
  fileSystemType: 'fileSystemType',
  fileSystemTypeVersion: 'fileSystemTypeVersion',
  kmsKeyId: 'kmsKeyId',
  lustreConfiguration: {
    autoImportPolicy: 'autoImportPolicy',
    automaticBackupRetentionDays: 123,
    copyTagsToBackups: false,
    dailyAutomaticBackupStartTime: 'dailyAutomaticBackupStartTime',
    dataCompressionType: 'dataCompressionType',
    dataReadCacheConfiguration: {
      sizeGiB: 123,
      sizingMode: 'sizingMode',
    },
    deploymentType: 'deploymentType',
    driveCacheType: 'driveCacheType',
    efaEnabled: false,
    exportPath: 'exportPath',
    importedFileChunkSize: 123,
    importPath: 'importPath',
    metadataConfiguration: {
      iops: 123,
      mode: 'mode',
    },
    perUnitStorageThroughput: 123,
    throughputCapacity: 123,
    weeklyMaintenanceStartTime: 'weeklyMaintenanceStartTime',
  },
  networkType: 'networkType',
  ontapConfiguration: {
    automaticBackupRetentionDays: 123,
    dailyAutomaticBackupStartTime: 'dailyAutomaticBackupStartTime',
    deploymentType: 'deploymentType',
    diskIopsConfiguration: {
      iops: 123,
      mode: 'mode',
    },
    endpointIpAddressRange: 'endpointIpAddressRange',
    endpointIpv6AddressRange: 'endpointIpv6AddressRange',
    fsxAdminPassword: 'fsxAdminPassword',
    haPairs: 123,
    preferredSubnetId: 'preferredSubnetId',
    routeTableIds: ['routeTableIds'],
    throughputCapacity: 123,
    throughputCapacityPerHaPair: 123,
    weeklyMaintenanceStartTime: 'weeklyMaintenanceStartTime',
  },
  openZfsConfiguration: {
    automaticBackupRetentionDays: 123,
    copyTagsToBackups: false,
    copyTagsToVolumes: false,
    dailyAutomaticBackupStartTime: 'dailyAutomaticBackupStartTime',
    deploymentType: 'deploymentType',
    diskIopsConfiguration: {
      iops: 123,
      mode: 'mode',
    },
    endpointIpAddressRange: 'endpointIpAddressRange',
    endpointIpv6AddressRange: 'endpointIpv6AddressRange',
    options: ['options'],
    preferredSubnetId: 'preferredSubnetId',
    readCacheConfiguration: {
      sizeGiB: 123,
      sizingMode: 'sizingMode',
    },
    rootVolumeConfiguration: {
      copyTagsToSnapshots: false,
      dataCompressionType: 'dataCompressionType',
      nfsExports: [{
        clientConfigurations: [{
          clients: 'clients',
          options: ['options'],
        }],
      }],
      readOnly: false,
      recordSizeKiB: 123,
      userAndGroupQuotas: [{
        id: 123,
        storageCapacityQuotaGiB: 123,
        type: 'type',
      }],
    },
    routeTableIds: ['routeTableIds'],
    throughputCapacity: 123,
    weeklyMaintenanceStartTime: 'weeklyMaintenanceStartTime',
  },
  securityGroupIds: ['securityGroupIds'],
  storageCapacity: 123,
  storageType: 'storageType',
  subnetIds: ['subnetIds'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  windowsConfiguration: {
    activeDirectoryId: 'activeDirectoryId',
    aliases: ['aliases'],
    auditLogConfiguration: {
      auditLogDestination: 'auditLogDestination',
      fileAccessAuditLogLevel: 'fileAccessAuditLogLevel',
      fileShareAccessAuditLogLevel: 'fileShareAccessAuditLogLevel',
    },
    automaticBackupRetentionDays: 123,
    copyTagsToBackups: false,
    dailyAutomaticBackupStartTime: 'dailyAutomaticBackupStartTime',
    deploymentType: 'deploymentType',
    diskIopsConfiguration: {
      iops: 123,
      mode: 'mode',
    },
    preferredSubnetId: 'preferredSubnetId',
    selfManagedActiveDirectoryConfiguration: {
      dnsIps: ['dnsIps'],
      domainJoinServiceAccountSecret: 'domainJoinServiceAccountSecret',
      domainName: 'domainName',
      fileSystemAdministratorsGroup: 'fileSystemAdministratorsGroup',
      organizationalUnitDistinguishedName: 'organizationalUnitDistinguishedName',
      password: 'password',
      userName: 'userName',
    },
    throughputCapacity: 123,
    weeklyMaintenanceStartTime: 'weeklyMaintenanceStartTime',
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnFileSystemPropsMixin(props: CfnFileSystemMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

Name	Type	Description
props	CfnFileSystemMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnFileSystemMixinProps

---

strategy

Type: PropertyMergeStrategy

---

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): IConstruct

Parameters

• construct IConstruct

Returns

• 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.