CfnLocationFSxONTAPPropsMixin
- class aws_cdk.cfn_property_mixins.aws_datasync.CfnLocationFSxONTAPPropsMixin(props, *, strategy=None)
Bases:
MixinThe
AWS::DataSync::LocationFSxONTAPresource creates an endpoint for an Amazon FSx for NetApp ONTAP file system.AWS DataSync can access this endpoint as a source or destination location.
- See:
- CloudformationResource:
AWS::DataSync::LocationFSxONTAP
- 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.cfn_property_mixins import aws_datasync as datasync import aws_cdk as cdk # merge_strategy: cdk.IMergeStrategy cfn_location_fSx_oNTAPProps_mixin = datasync.CfnLocationFSxONTAPPropsMixin(datasync.CfnLocationFSxONTAPMixinProps( protocol=datasync.CfnLocationFSxONTAPPropsMixin.ProtocolProperty( nfs=datasync.CfnLocationFSxONTAPPropsMixin.NFSProperty( mount_options=datasync.CfnLocationFSxONTAPPropsMixin.NfsMountOptionsProperty( version="version" ) ), smb=datasync.CfnLocationFSxONTAPPropsMixin.SMBProperty( cmk_secret_config=datasync.CfnLocationFSxONTAPPropsMixin.CmkSecretConfigProperty( kms_key_arn="kmsKeyArn", secret_arn="secretArn" ), custom_secret_config=datasync.CfnLocationFSxONTAPPropsMixin.CustomSecretConfigProperty( secret_access_role_arn="secretAccessRoleArn", secret_arn="secretArn" ), domain="domain", managed_secret_config=datasync.CfnLocationFSxONTAPPropsMixin.ManagedSecretConfigProperty( secret_arn="secretArn" ), mount_options=datasync.CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty( version="version" ), password="password", user="user" ) ), security_group_arns=["securityGroupArns"], storage_virtual_machine_arn="storageVirtualMachineArn", subdirectory="subdirectory", tags=[cdk.CfnTag( key="key", value="value" )] ), strategy=merge_strategy )
Create a mixin to apply properties to
AWS::DataSync::LocationFSxONTAP.- Parameters:
props (
Union[CfnLocationFSxONTAPMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
None
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['protocol', 'securityGroupArns', 'storageVirtualMachineArn', 'subdirectory', 'tags']
Static Methods
- classmethod is_mixin(x)
Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.
CmkSecretConfigProperty
- class CfnLocationFSxONTAPPropsMixin.CmkSecretConfigProperty(*, kms_key_arn=None, secret_arn=None)
Bases:
objectSpecifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.
- Parameters:
kms_key_arn (
Optional[str]) – Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn. DataSync provides this key to AWS Secrets Manager.secret_arn (
Optional[str]) – Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
- See:
- 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.cfn_property_mixins import aws_datasync as datasync cmk_secret_config_property = datasync.CfnLocationFSxONTAPPropsMixin.CmkSecretConfigProperty( kms_key_arn="kmsKeyArn", secret_arn="secretArn" )
Attributes
- kms_key_arn
Specifies the ARN for the customer-managed AWS KMS key used to encrypt the secret specified for SecretArn.
DataSync provides this key to AWS Secrets Manager.
- secret_arn
Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.
CustomSecretConfigProperty
- class CfnLocationFSxONTAPPropsMixin.CustomSecretConfigProperty(*, secret_access_role_arn=None, secret_arn=None)
Bases:
objectSpecifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.
- Parameters:
secret_access_role_arn (
Optional[str]) – Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.secret_arn (
Optional[str]) – Specifies the ARN for a customer created AWS Secrets Manager secret.
- See:
- 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.cfn_property_mixins import aws_datasync as datasync custom_secret_config_property = datasync.CfnLocationFSxONTAPPropsMixin.CustomSecretConfigProperty( secret_access_role_arn="secretAccessRoleArn", secret_arn="secretArn" )
Attributes
- secret_access_role_arn
Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
- secret_arn
Specifies the ARN for a customer created AWS Secrets Manager secret.
ManagedSecretConfigProperty
- class CfnLocationFSxONTAPPropsMixin.ManagedSecretConfigProperty(*, secret_arn=None)
Bases:
objectSpecifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location.
DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.
- Parameters:
secret_arn (
Optional[str]) – Specifies the ARN for an AWS Secrets Manager secret.- See:
- 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.cfn_property_mixins import aws_datasync as datasync managed_secret_config_property = datasync.CfnLocationFSxONTAPPropsMixin.ManagedSecretConfigProperty( secret_arn="secretArn" )
Attributes
- secret_arn
Specifies the ARN for an AWS Secrets Manager secret.
NFSProperty
- class CfnLocationFSxONTAPPropsMixin.NFSProperty(*, mount_options=None)
Bases:
objectSpecifies the Network File System (NFS) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for NetApp ONTAP file system.
For more information, see Accessing FSx for ONTAP file systems .
- Parameters:
mount_options (
Union[IResolvable,NfsMountOptionsProperty,Dict[str,Any],None]) – Specifies how DataSync can access a location using the NFS protocol.- See:
- 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.cfn_property_mixins import aws_datasync as datasync n_fSProperty = datasync.CfnLocationFSxONTAPPropsMixin.NFSProperty( mount_options=datasync.CfnLocationFSxONTAPPropsMixin.NfsMountOptionsProperty( version="version" ) )
Attributes
- mount_options
Specifies how DataSync can access a location using the NFS protocol.
NfsMountOptionsProperty
- class CfnLocationFSxONTAPPropsMixin.NfsMountOptionsProperty(*, version=None)
Bases:
objectSpecifies how DataSync can access a location using the NFS protocol.
- Parameters:
version (
Optional[str]) – Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails. You can specify the following options: -AUTOMATIC(default): DataSync chooses NFS version 4.1. -NFS3: Stateless protocol version that allows for asynchronous writes on the server. -NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems. -NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0. .. epigraph:: DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.- See:
- 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.cfn_property_mixins import aws_datasync as datasync nfs_mount_options_property = datasync.CfnLocationFSxONTAPPropsMixin.NfsMountOptionsProperty( version="version" )
Attributes
- version
Specifies the NFS version that you want DataSync to use when mounting your NFS share.
If the server refuses to use the version specified, the task fails.
You can specify the following options:
AUTOMATIC(default): DataSync chooses NFS version 4.1.NFS3: Stateless protocol version that allows for asynchronous writes on the server.NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.
DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
ProtocolProperty
- class CfnLocationFSxONTAPPropsMixin.ProtocolProperty(*, nfs=None, smb=None)
Bases:
objectSpecifies the data transfer protocol that AWS DataSync uses to access your Amazon FSx file system.
- Parameters:
nfs (
Union[IResolvable,NFSProperty,Dict[str,Any],None]) – Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for ONTAP file system’s storage virtual machine (SVM).smb (
Union[IResolvable,SMBProperty,Dict[str,Any],None]) – Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system’s SVM.
- See:
- 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.cfn_property_mixins import aws_datasync as datasync protocol_property = datasync.CfnLocationFSxONTAPPropsMixin.ProtocolProperty( nfs=datasync.CfnLocationFSxONTAPPropsMixin.NFSProperty( mount_options=datasync.CfnLocationFSxONTAPPropsMixin.NfsMountOptionsProperty( version="version" ) ), smb=datasync.CfnLocationFSxONTAPPropsMixin.SMBProperty( cmk_secret_config=datasync.CfnLocationFSxONTAPPropsMixin.CmkSecretConfigProperty( kms_key_arn="kmsKeyArn", secret_arn="secretArn" ), custom_secret_config=datasync.CfnLocationFSxONTAPPropsMixin.CustomSecretConfigProperty( secret_access_role_arn="secretAccessRoleArn", secret_arn="secretArn" ), domain="domain", managed_secret_config=datasync.CfnLocationFSxONTAPPropsMixin.ManagedSecretConfigProperty( secret_arn="secretArn" ), mount_options=datasync.CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty( version="version" ), password="password", user="user" ) )
Attributes
- nfs
Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for ONTAP file system’s storage virtual machine (SVM).
- smb
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system’s SVM.
SMBProperty
- class CfnLocationFSxONTAPPropsMixin.SMBProperty(*, cmk_secret_config=None, custom_secret_config=None, domain=None, managed_secret_config=None, mount_options=None, password=None, user=None)
Bases:
objectSpecifies the Server Message Block (SMB) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for NetApp ONTAP file system.
For more information, see Accessing FSx for ONTAP file systems .
- Parameters:
cmk_secret_config (
Union[IResolvable,CmkSecretConfigProperty,Dict[str,Any],None]) – Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.custom_secret_config (
Union[IResolvable,CustomSecretConfigProperty,Dict[str,Any],None]) – Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.domain (
Optional[str]) – Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to. If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.managed_secret_config (
Union[IResolvable,ManagedSecretConfigProperty,Dict[str,Any],None]) – Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.mount_options (
Union[IResolvable,SmbMountOptionsProperty,Dict[str,Any],None]) – Specifies how DataSync can access a location using the SMB protocol.password (
Optional[str]) – Specifies the password of a user who has permission to access your SVM.user (
Optional[str]) – Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM. If you provide a user in your Active Directory, note the following: - If you’re using AWS Directory Service for Microsoft Active Directory , the user must be a member of the AWS Delegated FSx Administrators group. - If you’re using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system. Make sure that the user has the permissions it needs to copy the data you want: -SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs). -SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options .
- See:
- 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.cfn_property_mixins import aws_datasync as datasync s_mBProperty = datasync.CfnLocationFSxONTAPPropsMixin.SMBProperty( cmk_secret_config=datasync.CfnLocationFSxONTAPPropsMixin.CmkSecretConfigProperty( kms_key_arn="kmsKeyArn", secret_arn="secretArn" ), custom_secret_config=datasync.CfnLocationFSxONTAPPropsMixin.CustomSecretConfigProperty( secret_access_role_arn="secretAccessRoleArn", secret_arn="secretArn" ), domain="domain", managed_secret_config=datasync.CfnLocationFSxONTAPPropsMixin.ManagedSecretConfigProperty( secret_arn="secretArn" ), mount_options=datasync.CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty( version="version" ), password="password", user="user" )
Attributes
- cmk_secret_config
Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.
- custom_secret_config
Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.
- domain
Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.
If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.
If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.
- managed_secret_config
Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location.
DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.
- mount_options
Specifies how DataSync can access a location using the SMB protocol.
- password
Specifies the password of a user who has permission to access your SVM.
- user
Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
If you provide a user in your Active Directory, note the following:
If you’re using AWS Directory Service for Microsoft Active Directory , the user must be a member of the AWS Delegated FSx Administrators group.
If you’re using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
Make sure that the user has the permissions it needs to copy the data you want:
SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options .
SmbMountOptionsProperty
- class CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty(*, version=None)
Bases:
objectSpecifies the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB file server.
- Parameters:
version (
Optional[str]) – By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically. These are the following options for configuring the SMB version: -AUTOMATIC(default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn’t support, you may get anOperation Not Supportederror. -SMB3: Restricts the protocol negotiation to only SMB version 3.0.2. -SMB2: Restricts the protocol negotiation to only SMB version 2.1. -SMB2_0: Restricts the protocol negotiation to only SMB version 2.0. -SMB1: Restricts the protocol negotiation to only SMB version 1.0. .. epigraph:: TheSMB1option isn’t available when creating an Amazon FSx for NetApp ONTAP location .- See:
- 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.cfn_property_mixins import aws_datasync as datasync smb_mount_options_property = datasync.CfnLocationFSxONTAPPropsMixin.SmbMountOptionsProperty( version="version" )
Attributes
- version
By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server.
You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.
These are the following options for configuring the SMB version:
AUTOMATIC(default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.
This is the recommended option. If you instead choose a specific version that your file server doesn’t support, you may get an
Operation Not Supportederror.SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.SMB2: Restricts the protocol negotiation to only SMB version 2.1.SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.SMB1: Restricts the protocol negotiation to only SMB version 1.0.
The
SMB1option isn’t available when creating an Amazon FSx for NetApp ONTAP location .