CfnFileSystemProps

class aws_cdk.aws_fsx.CfnFileSystemProps(*, backup_id=None, file_system_type, file_system_type_version=None, kms_key_id=None, lustre_configuration=None, ontap_configuration=None, security_group_ids=None, storage_capacity=None, storage_type=None, subnet_ids, tags=None, windows_configuration=None)

Bases: object

Properties for defining a AWS::FSx::FileSystem.

Parameters
  • backup_id (Optional[str]) – AWS::FSx::FileSystem.BackupId.

  • file_system_type (str) – AWS::FSx::FileSystem.FileSystemType.

  • file_system_type_version (Optional[str]) – AWS::FSx::FileSystem.FileSystemTypeVersion.

  • kms_key_id (Optional[str]) – AWS::FSx::FileSystem.KmsKeyId.

  • lustre_configuration (Union[LustreConfigurationProperty, IResolvable, None]) – AWS::FSx::FileSystem.LustreConfiguration.

  • ontap_configuration (Union[IResolvable, OntapConfigurationProperty, None]) – AWS::FSx::FileSystem.OntapConfiguration.

  • security_group_ids (Optional[Sequence[str]]) – AWS::FSx::FileSystem.SecurityGroupIds.

  • storage_capacity (Union[int, float, None]) – AWS::FSx::FileSystem.StorageCapacity.

  • storage_type (Optional[str]) – AWS::FSx::FileSystem.StorageType.

  • subnet_ids (Sequence[str]) – AWS::FSx::FileSystem.SubnetIds.

  • tags (Optional[Sequence[CfnTag]]) – AWS::FSx::FileSystem.Tags.

  • windows_configuration (Union[IResolvable, WindowsConfigurationProperty, None]) – AWS::FSx::FileSystem.WindowsConfiguration.

Link

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 aws_cdk.aws_fsx as fsx

cfn_file_system_props = fsx.CfnFileSystemProps(
    file_system_type="fileSystemType",
    subnet_ids=["subnetIds"],

    # the properties below are optional
    backup_id="backupId",
    file_system_type_version="fileSystemTypeVersion",
    kms_key_id="kmsKeyId",
    lustre_configuration=fsx.CfnFileSystem.LustreConfigurationProperty(
        auto_import_policy="autoImportPolicy",
        automatic_backup_retention_days=123,
        copy_tags_to_backups=False,
        daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
        data_compression_type="dataCompressionType",
        deployment_type="deploymentType",
        drive_cache_type="driveCacheType",
        export_path="exportPath",
        imported_file_chunk_size=123,
        import_path="importPath",
        per_unit_storage_throughput=123,
        weekly_maintenance_start_time="weeklyMaintenanceStartTime"
    ),
    ontap_configuration=fsx.CfnFileSystem.OntapConfigurationProperty(
        deployment_type="deploymentType",

        # the properties below are optional
        automatic_backup_retention_days=123,
        daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
        disk_iops_configuration=fsx.CfnFileSystem.DiskIopsConfigurationProperty(
            iops=123,
            mode="mode"
        ),
        endpoint_ip_address_range="endpointIpAddressRange",
        fsx_admin_password="fsxAdminPassword",
        preferred_subnet_id="preferredSubnetId",
        route_table_ids=["routeTableIds"],
        throughput_capacity=123,
        weekly_maintenance_start_time="weeklyMaintenanceStartTime"
    ),
    security_group_ids=["securityGroupIds"],
    storage_capacity=123,
    storage_type="storageType",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    windows_configuration=fsx.CfnFileSystem.WindowsConfigurationProperty(
        throughput_capacity=123,

        # the properties below are optional
        active_directory_id="activeDirectoryId",
        aliases=["aliases"],
        audit_log_configuration=fsx.CfnFileSystem.AuditLogConfigurationProperty(
            file_access_audit_log_level="fileAccessAuditLogLevel",
            file_share_access_audit_log_level="fileShareAccessAuditLogLevel",

            # the properties below are optional
            audit_log_destination="auditLogDestination"
        ),
        automatic_backup_retention_days=123,
        copy_tags_to_backups=False,
        daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
        deployment_type="deploymentType",
        preferred_subnet_id="preferredSubnetId",
        self_managed_active_directory_configuration=fsx.CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty(
            dns_ips=["dnsIps"],
            domain_name="domainName",
            file_system_administrators_group="fileSystemAdministratorsGroup",
            organizational_unit_distinguished_name="organizationalUnitDistinguishedName",
            password="password",
            user_name="userName"
        ),
        weekly_maintenance_start_time="weeklyMaintenanceStartTime"
    )
)

Attributes

backup_id

AWS::FSx::FileSystem.BackupId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-backupid

Return type

Optional[str]

file_system_type

AWS::FSx::FileSystem.FileSystemType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-filesystemtype

Return type

str

file_system_type_version

AWS::FSx::FileSystem.FileSystemTypeVersion.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-filesystemtypeversion

Return type

Optional[str]

kms_key_id

AWS::FSx::FileSystem.KmsKeyId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-kmskeyid

Return type

Optional[str]

lustre_configuration

AWS::FSx::FileSystem.LustreConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-lustreconfiguration

Return type

Union[LustreConfigurationProperty, IResolvable, None]

ontap_configuration

AWS::FSx::FileSystem.OntapConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-ontapconfiguration

Return type

Union[IResolvable, OntapConfigurationProperty, None]

security_group_ids

AWS::FSx::FileSystem.SecurityGroupIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-securitygroupids

Return type

Optional[List[str]]

storage_capacity

AWS::FSx::FileSystem.StorageCapacity.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagecapacity

Return type

Union[int, float, None]

storage_type

AWS::FSx::FileSystem.StorageType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagetype

Return type

Optional[str]

subnet_ids

AWS::FSx::FileSystem.SubnetIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-subnetids

Return type

List[str]

tags

AWS::FSx::FileSystem.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-tags

Return type

Optional[List[CfnTag]]

windows_configuration

AWS::FSx::FileSystem.WindowsConfiguration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-windowsconfiguration

Return type

Union[IResolvable, WindowsConfigurationProperty, None]