aws-cdk-lib 2.173.3__py3-none-any.whl → 2.174.0__py3-none-any.whl

aws_cdk/aws_datasync/__init__.py

@@ -1017,7 +1017,7 @@ class CfnLocationEFS(
         :param efs_filesystem_arn: Specifies the ARN for your Amazon EFS file system.
         :param file_system_access_role_arn: Specifies an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system. For information on creating this role, see `Creating a DataSync IAM role for file system access <https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role>`_ .
         :param in_transit_encryption: Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system. If you specify an access point using ``AccessPointArn`` or an IAM role using ``FileSystemAccessRoleArn`` , you must set this parameter to ``TLS1_2`` .
-        :param subdirectory: Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location) on your file system. By default, DataSync uses the root directory (or `access point <https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html>`_ if you provide one by using ``AccessPointArn`` ). You can also include subdirectories using forward slashes (for example, ``/path/to/folder`` ).
+        :param subdirectory: Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location). By default, DataSync uses the root directory (or `access point <https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html>`_ if you provide one by using ``AccessPointArn`` ). You can also include subdirectories using forward slashes (for example, ``/path/to/folder`` ).
         :param tags: Specifies the key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
         '''
         if __debug__:
@@ -1307,7 +1307,7 @@ class CfnLocationEFSProps:
         :param efs_filesystem_arn: Specifies the ARN for your Amazon EFS file system.
         :param file_system_access_role_arn: Specifies an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system. For information on creating this role, see `Creating a DataSync IAM role for file system access <https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role>`_ .
         :param in_transit_encryption: Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system. If you specify an access point using ``AccessPointArn`` or an IAM role using ``FileSystemAccessRoleArn`` , you must set this parameter to ``TLS1_2`` .
-        :param subdirectory: Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location) on your file system. By default, DataSync uses the root directory (or `access point <https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html>`_ if you provide one by using ``AccessPointArn`` ). You can also include subdirectories using forward slashes (for example, ``/path/to/folder`` ).
+        :param subdirectory: Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location). By default, DataSync uses the root directory (or `access point <https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html>`_ if you provide one by using ``AccessPointArn`` ). You can also include subdirectories using forward slashes (for example, ``/path/to/folder`` ).
         :param tags: Specifies the key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationefs.html
@@ -1420,7 +1420,7 @@ class CfnLocationEFSProps:
     def subdirectory(self) -> typing.Optional[builtins.str]:
         '''Specifies a mount path for your Amazon EFS file system.
 
-        This is where DataSync reads or writes data (depending on if this is a source or destination location) on your file system.
+        This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).
 
         By default, DataSync uses the root directory (or `access point <https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html>`_ if you provide one by using ``AccessPointArn`` ). You can also include subdirectories using forward slashes (for example, ``/path/to/folder`` ).
 
@@ -1497,9 +1497,9 @@ class CfnLocationFSxLustre(
         :param scope: Scope in which this resource is defined.
         :param id: Construct identifier for this resource (unique in its scope).
         :param security_group_arns: The ARNs of the security groups that are used to configure the FSx for Lustre file system. *Pattern* : ``^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$`` *Length constraints* : Maximum length of 128.
-        :param fsx_filesystem_arn: The Amazon Resource Name (ARN) for the FSx for Lustre file system.
-        :param subdirectory: A subdirectory in the location's path. This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination.
-        :param tags: The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
+        :param fsx_filesystem_arn: Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.
+        :param subdirectory: Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories. When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory ( ``/`` ).
+        :param tags: Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__f6a366fbae202f0039019565ac7d26837d23db858eddf6c8193ddf4bd207f597)
@@ -1589,7 +1589,7 @@ class CfnLocationFSxLustre(
     @builtins.property
     @jsii.member(jsii_name="fsxFilesystemArn")
     def fsx_filesystem_arn(self) -> typing.Optional[builtins.str]:
-        '''The Amazon Resource Name (ARN) for the FSx for Lustre file system.'''
+        '''Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "fsxFilesystemArn"))
 
     @fsx_filesystem_arn.setter
@@ -1602,7 +1602,10 @@ class CfnLocationFSxLustre(
     @builtins.property
     @jsii.member(jsii_name="subdirectory")
     def subdirectory(self) -> typing.Optional[builtins.str]:
-        '''A subdirectory in the location's path.'''
+        '''Specifies a mount path for your FSx for Lustre file system.
+
+        The path can include subdirectories.
+        '''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "subdirectory"))
 
     @subdirectory.setter
@@ -1615,7 +1618,7 @@ class CfnLocationFSxLustre(
     @builtins.property
     @jsii.member(jsii_name="tagsRaw")
     def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
-        '''The key-value pair that represents a tag that you want to add to the resource.'''
+        '''Specifies labels that help you categorize, filter, and search for your AWS resources.'''
         return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
 
     @tags_raw.setter
@@ -1648,9 +1651,9 @@ class CfnLocationFSxLustreProps:
         '''Properties for defining a ``CfnLocationFSxLustre``.
 
         :param security_group_arns: The ARNs of the security groups that are used to configure the FSx for Lustre file system. *Pattern* : ``^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$`` *Length constraints* : Maximum length of 128.
-        :param fsx_filesystem_arn: The Amazon Resource Name (ARN) for the FSx for Lustre file system.
-        :param subdirectory: A subdirectory in the location's path. This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination.
-        :param tags: The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
+        :param fsx_filesystem_arn: Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.
+        :param subdirectory: Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories. When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory ( ``/`` ).
+        :param tags: Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html
         :exampleMetadata: fixture=_generated
@@ -1705,7 +1708,7 @@ class CfnLocationFSxLustreProps:
 
     @builtins.property
     def fsx_filesystem_arn(self) -> typing.Optional[builtins.str]:
-        '''The Amazon Resource Name (ARN) for the FSx for Lustre file system.
+        '''Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#cfn-datasync-locationfsxlustre-fsxfilesystemarn
         '''
@@ -1714,9 +1717,9 @@ class CfnLocationFSxLustreProps:
 
     @builtins.property
     def subdirectory(self) -> typing.Optional[builtins.str]:
-        '''A subdirectory in the location's path.
+        '''Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.
 
-        This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination.
+        When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory ( ``/`` ).
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#cfn-datasync-locationfsxlustre-subdirectory
         '''
@@ -1725,9 +1728,9 @@ class CfnLocationFSxLustreProps:
 
     @builtins.property
     def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
-        '''The key-value pair that represents a tag that you want to add to the resource.
+        '''Specifies labels that help you categorize, filter, and search for your AWS resources.
 
-        The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
+        We recommend creating at least a name tag for your location.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxlustre.html#cfn-datasync-locationfsxlustre-tags
         '''
@@ -1813,7 +1816,7 @@ class CfnLocationFSxONTAP(
         :param security_group_arns: Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system. You must configure the security groups to allow outbound traffic on the following ports (depending on the protocol that you're using): - *Network File System (NFS)* : TCP ports 111, 635, and 2049 - *Server Message Block (SMB)* : TCP port 445 Your file system's security groups must also allow inbound traffic on the same port.
         :param storage_virtual_machine_arn: Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
         :param protocol: Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
-        :param subdirectory: Specifies a path to the file share in the SVM where you'll copy your data. You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be ``/vol1`` , ``/vol1/tree1`` , or ``/share1`` . .. epigraph:: Don't specify a junction path in the SVM's root volume. For more information, see `Managing FSx for ONTAP storage virtual machines <https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html>`_ in the *Amazon FSx for NetApp ONTAP User Guide* .
+        :param subdirectory: Specifies a path to the file share in the SVM where you want to transfer data to or from. You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be ``/vol1`` , ``/vol1/tree1`` , or ``/share1`` . .. epigraph:: Don't specify a junction path in the SVM's root volume. For more information, see `Managing FSx for ONTAP storage virtual machines <https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html>`_ in the *Amazon FSx for NetApp ONTAP User Guide* .
         :param tags: Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.
         '''
         if __debug__:
@@ -1945,7 +1948,7 @@ class CfnLocationFSxONTAP(
     @builtins.property
     @jsii.member(jsii_name="subdirectory")
     def subdirectory(self) -> typing.Optional[builtins.str]:
-        '''Specifies a path to the file share in the SVM where you'll copy your data.'''
+        '''Specifies a path to the file share in the SVM where you want to transfer data to or from.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "subdirectory"))
 
     @subdirectory.setter
@@ -2207,7 +2210,7 @@ class CfnLocationFSxONTAP(
             :param mount_options: Specifies how DataSync can access a location using the SMB protocol.
             :param password: Specifies the password of a user who has permission to access your SVM.
             :param 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 <https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions>`_ .
-            :param domain: Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory 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.
+            :param 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.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html
             :exampleMetadata: fixture=_generated
@@ -2287,10 +2290,12 @@ class CfnLocationFSxONTAP(
 
         @builtins.property
         def domain(self) -> typing.Optional[builtins.str]:
-            '''Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
+            '''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.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationfsxontap-smb.html#cfn-datasync-locationfsxontap-smb-domain
             '''
             result = self._values.get("domain")
@@ -2402,7 +2407,7 @@ class CfnLocationFSxONTAPProps:
         :param security_group_arns: Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system. You must configure the security groups to allow outbound traffic on the following ports (depending on the protocol that you're using): - *Network File System (NFS)* : TCP ports 111, 635, and 2049 - *Server Message Block (SMB)* : TCP port 445 Your file system's security groups must also allow inbound traffic on the same port.
         :param storage_virtual_machine_arn: Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
         :param protocol: Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
-        :param subdirectory: Specifies a path to the file share in the SVM where you'll copy your data. You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be ``/vol1`` , ``/vol1/tree1`` , or ``/share1`` . .. epigraph:: Don't specify a junction path in the SVM's root volume. For more information, see `Managing FSx for ONTAP storage virtual machines <https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html>`_ in the *Amazon FSx for NetApp ONTAP User Guide* .
+        :param subdirectory: Specifies a path to the file share in the SVM where you want to transfer data to or from. You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be ``/vol1`` , ``/vol1/tree1`` , or ``/share1`` . .. epigraph:: Don't specify a junction path in the SVM's root volume. For more information, see `Managing FSx for ONTAP storage virtual machines <https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html>`_ in the *Amazon FSx for NetApp ONTAP User Guide* .
         :param tags: Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationfsxontap.html
@@ -2501,7 +2506,7 @@ class CfnLocationFSxONTAPProps:
 
     @builtins.property
     def subdirectory(self) -> typing.Optional[builtins.str]:
-        '''Specifies a path to the file share in the SVM where you'll copy your data.
+        '''Specifies a path to the file share in the SVM where you want to transfer data to or from.
 
         You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be ``/vol1`` , ``/vol1/tree1`` , or ``/share1`` .
         .. epigraph::
@@ -3114,7 +3119,7 @@ class CfnLocationFSxWindows(
         :param id: Construct identifier for this resource (unique in its scope).
         :param security_group_arns: The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system. *Pattern* : ``^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$`` *Length constraints* : Maximum length of 128.
         :param user: The user who has the permissions to access files and folders in the FSx for Windows File Server file system. For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see `user <https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#FSxWuser>`_ .
-        :param domain: Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
+        :param domain: Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
         :param fsx_filesystem_arn: Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
         :param password: Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
         :param subdirectory: Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
@@ -3224,7 +3229,7 @@ class CfnLocationFSxWindows(
     @builtins.property
     @jsii.member(jsii_name="domain")
     def domain(self) -> typing.Optional[builtins.str]:
-        '''Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.'''
+        '''Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to.'''
         return typing.cast(typing.Optional[builtins.str], jsii.get(self, "domain"))
 
     @domain.setter
@@ -3316,7 +3321,7 @@ class CfnLocationFSxWindowsProps:
 
         :param security_group_arns: The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system. *Pattern* : ``^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$`` *Length constraints* : Maximum length of 128.
         :param user: The user who has the permissions to access files and folders in the FSx for Windows File Server file system. For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see `user <https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#FSxWuser>`_ .
-        :param domain: Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
+        :param domain: Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
         :param fsx_filesystem_arn: Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
         :param password: Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
         :param subdirectory: Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
@@ -3398,7 +3403,7 @@ class CfnLocationFSxWindowsProps:
 
     @builtins.property
     def domain(self) -> typing.Optional[builtins.str]:
-        '''Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.
+        '''Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to.
 
         If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
 
@@ -5422,7 +5427,7 @@ class CfnLocationS3(
         def __init__(self, *, bucket_access_role_arn: builtins.str) -> None:
             '''Specifies the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
 
-            For more information, see `Accessing S3 buckets <https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access>`_ .
+            For more information, see `Providing DataSync access to S3 buckets <https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access>`_ .
 
             :param bucket_access_role_arn: Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.