CfnStorageVirtualMachinePropsMixin

class aws_cdk.mixins_preview.aws_fsx.mixins.CfnStorageVirtualMachinePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html
CloudformationResource:: AWS::FSx::StorageVirtualMachine
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_fsx import mixins as fsx_mixins

cfn_storage_virtual_machine_props_mixin = fsx_mixins.CfnStorageVirtualMachinePropsMixin(fsx_mixins.CfnStorageVirtualMachineMixinProps(
    active_directory_configuration=fsx_mixins.CfnStorageVirtualMachinePropsMixin.ActiveDirectoryConfigurationProperty(
        net_bios_name="netBiosName",
        self_managed_active_directory_configuration=fsx_mixins.CfnStorageVirtualMachinePropsMixin.SelfManagedActiveDirectoryConfigurationProperty(
            dns_ips=["dnsIps"],
            domain_join_service_account_secret="domainJoinServiceAccountSecret",
            domain_name="domainName",
            file_system_administrators_group="fileSystemAdministratorsGroup",
            organizational_unit_distinguished_name="organizationalUnitDistinguishedName",
            password="password",
            user_name="userName"
        )
    ),
    file_system_id="fileSystemId",
    name="name",
    root_volume_security_style="rootVolumeSecurityStyle",
    svm_admin_password="svmAdminPassword",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnStorageVirtualMachineMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['activeDirectoryConfiguration', 'fileSystemId', 'name', 'rootVolumeSecurityStyle', 'svmAdminPassword', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ActiveDirectoryConfigurationProperty

class CfnStorageVirtualMachinePropsMixin.ActiveDirectoryConfigurationProperty(*, net_bios_name=None, self_managed_active_directory_configuration=None)

Bases: object

Describes the self-managed Microsoft Active Directory to which you want to join the SVM.

Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS clients accessing the file system.

Parameters:

net_bios_name (Optional[str]) – The NetBIOS name of the Active Directory computer object that will be created for your SVM.
self_managed_active_directory_configuration (Union[IResolvable, SelfManagedActiveDirectoryConfigurationProperty, Dict[str, Any], None]) – The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_fsx import mixins as fsx_mixins

active_directory_configuration_property = fsx_mixins.CfnStorageVirtualMachinePropsMixin.ActiveDirectoryConfigurationProperty(
    net_bios_name="netBiosName",
    self_managed_active_directory_configuration=fsx_mixins.CfnStorageVirtualMachinePropsMixin.SelfManagedActiveDirectoryConfigurationProperty(
        dns_ips=["dnsIps"],
        domain_join_service_account_secret="domainJoinServiceAccountSecret",
        domain_name="domainName",
        file_system_administrators_group="fileSystemAdministratorsGroup",
        organizational_unit_distinguished_name="organizationalUnitDistinguishedName",
        password="password",
        user_name="userName"
    )
)

Attributes

net_bios_name

The NetBIOS name of the Active Directory computer object that will be created for your SVM.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-netbiosname

self_managed_active_directory_configuration

The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-activedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration-selfmanagedactivedirectoryconfiguration

SelfManagedActiveDirectoryConfigurationProperty

class CfnStorageVirtualMachinePropsMixin.SelfManagedActiveDirectoryConfigurationProperty(*, dns_ips=None, domain_join_service_account_secret=None, domain_name=None, file_system_administrators_group=None, organizational_unit_distinguished_name=None, password=None, user_name=None)

Bases: object

The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.

Parameters:

dns_ips (Optional[Sequence[str]]) – A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
domain_join_service_account_secret (Optional[str]) – The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the self-managed Active Directory domain join service account credentials. When provided, Amazon FSx uses the credentials stored in this secret to join the file system to your self-managed Active Directory domain. The secret must contain two key-value pairs: - CUSTOMER_MANAGED_ACTIVE_DIRECTORY_USERNAME - The username for the service account - CUSTOMER_MANAGED_ACTIVE_DIRECTORY_PASSWORD - The password for the service account For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Using Amazon FSx for ONTAP with your self-managed Microsoft Active Directory .
domain_name (Optional[str]) – The fully qualified domain name of the self-managed AD directory, such as corp.example.com .
file_system_administrators_group (Optional[str]) – (Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don’t provide one, your AD domain’s Domain Admins group is used.
organizational_unit_distinguished_name (Optional[str]) – (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com . To learn more, see RFC 2253 . If none is provided, the FSx file system is created in the default location of your self-managed AD directory. .. epigraph:: Only Organizational Unit (OU) objects can be the direct parent of the file system that you’re creating.
password (Optional[str]) – The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
user_name (Optional[str]) – The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName , or in the default location of your AD domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_fsx import mixins as fsx_mixins

self_managed_active_directory_configuration_property = fsx_mixins.CfnStorageVirtualMachinePropsMixin.SelfManagedActiveDirectoryConfigurationProperty(
    dns_ips=["dnsIps"],
    domain_join_service_account_secret="domainJoinServiceAccountSecret",
    domain_name="domainName",
    file_system_administrators_group="fileSystemAdministratorsGroup",
    organizational_unit_distinguished_name="organizationalUnitDistinguishedName",
    password="password",
    user_name="userName"
)

Attributes

dns_ips

A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-dnsips

domain_join_service_account_secret

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the self-managed Active Directory domain join service account credentials.

When provided, Amazon FSx uses the credentials stored in this secret to join the file system to your self-managed Active Directory domain.

The secret must contain two key-value pairs:

CUSTOMER_MANAGED_ACTIVE_DIRECTORY_USERNAME - The username for the service account
CUSTOMER_MANAGED_ACTIVE_DIRECTORY_PASSWORD - The password for the service account

For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Using Amazon FSx for ONTAP with your self-managed Microsoft Active Directory .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-domainjoinserviceaccountsecret

domain_name

The fully qualified domain name of the self-managed AD directory, such as corp.example.com .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-domainname

file_system_administrators_group

(Optional) The name of the domain group whose members are granted administrative privileges for the file system.

Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don’t provide one, your AD domain’s Domain Admins group is used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-filesystemadministratorsgroup

organizational_unit_distinguished_name

(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory.

Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com . To learn more, see RFC 2253 . If none is provided, the FSx file system is created in the default location of your self-managed AD directory. .. epigraph:

Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-organizationalunitdistinguishedname

password

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-password

user_name

The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName , or in the default location of your AD domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-storagevirtualmachine-selfmanagedactivedirectoryconfiguration-username