CfnTaskPropsMixin

class aws_cdk.mixins_preview.aws_datasync.mixins.CfnTaskPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::DataSync::Task resource specifies a task.

A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don’t specify Options when you create a task, AWS DataSync populates them with service defaults.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html
CloudformationResource:: AWS::DataSync::Task
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_datasync import mixins as datasync_mixins

cfn_task_props_mixin = datasync_mixins.CfnTaskPropsMixin(datasync_mixins.CfnTaskMixinProps(
    cloud_watch_log_group_arn="cloudWatchLogGroupArn",
    destination_location_arn="destinationLocationArn",
    excludes=[datasync_mixins.CfnTaskPropsMixin.FilterRuleProperty(
        filter_type="filterType",
        value="value"
    )],
    includes=[datasync_mixins.CfnTaskPropsMixin.FilterRuleProperty(
        filter_type="filterType",
        value="value"
    )],
    manifest_config=datasync_mixins.CfnTaskPropsMixin.ManifestConfigProperty(
        action="action",
        format="format",
        source=datasync_mixins.CfnTaskPropsMixin.SourceProperty(
            s3=datasync_mixins.CfnTaskPropsMixin.ManifestConfigSourceS3Property(
                bucket_access_role_arn="bucketAccessRoleArn",
                manifest_object_path="manifestObjectPath",
                manifest_object_version_id="manifestObjectVersionId",
                s3_bucket_arn="s3BucketArn"
            )
        )
    ),
    name="name",
    options=datasync_mixins.CfnTaskPropsMixin.OptionsProperty(
        atime="atime",
        bytes_per_second=123,
        gid="gid",
        log_level="logLevel",
        mtime="mtime",
        object_tags="objectTags",
        overwrite_mode="overwriteMode",
        posix_permissions="posixPermissions",
        preserve_deleted_files="preserveDeletedFiles",
        preserve_devices="preserveDevices",
        security_descriptor_copy_flags="securityDescriptorCopyFlags",
        task_queueing="taskQueueing",
        transfer_mode="transferMode",
        uid="uid",
        verify_mode="verifyMode"
    ),
    schedule=datasync_mixins.CfnTaskPropsMixin.TaskScheduleProperty(
        schedule_expression="scheduleExpression",
        status="status"
    ),
    source_location_arn="sourceLocationArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    task_mode="taskMode",
    task_report_config=datasync_mixins.CfnTaskPropsMixin.TaskReportConfigProperty(
        destination=datasync_mixins.CfnTaskPropsMixin.DestinationProperty(
            s3=datasync_mixins.CfnTaskPropsMixin.S3Property(
                bucket_access_role_arn="bucketAccessRoleArn",
                s3_bucket_arn="s3BucketArn",
                subdirectory="subdirectory"
            )
        ),
        object_version_ids="objectVersionIds",
        output_type="outputType",
        overrides=datasync_mixins.CfnTaskPropsMixin.OverridesProperty(
            deleted=datasync_mixins.CfnTaskPropsMixin.DeletedProperty(
                report_level="reportLevel"
            ),
            skipped=datasync_mixins.CfnTaskPropsMixin.SkippedProperty(
                report_level="reportLevel"
            ),
            transferred=datasync_mixins.CfnTaskPropsMixin.TransferredProperty(
                report_level="reportLevel"
            ),
            verified=datasync_mixins.CfnTaskPropsMixin.VerifiedProperty(
                report_level="reportLevel"
            )
        ),
        report_level="reportLevel"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::DataSync::Task.

Parameters:

props (Union[CfnTaskMixinProps, 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 = ['cloudWatchLogGroupArn', 'destinationLocationArn', 'excludes', 'includes', 'manifestConfig', 'name', 'options', 'schedule', 'sourceLocationArn', 'tags', 'taskMode', 'taskReportConfig']

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

DeletedProperty

class CfnTaskPropsMixin.DeletedProperty(*, report_level=None)

Bases: object

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location.

This only applies if you configure your task to delete data in the destination that isn’t in the source.

Parameters:: report_level (Optional[str]) – Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-deleted.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_datasync import mixins as datasync_mixins

deleted_property = datasync_mixins.CfnTaskPropsMixin.DeletedProperty(
    report_level="reportLevel"
)

Attributes

report_level

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-deleted.html#cfn-datasync-task-deleted-reportlevel

DestinationProperty

class CfnTaskPropsMixin.DestinationProperty(*, s3=None)

Bases: object

Specifies where DataSync uploads your task report.

Parameters:: s3 (Union[IResolvable, S3Property, Dict[str, Any], None]) – Specifies the Amazon S3 bucket where DataSync uploads your task report.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-destination.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_datasync import mixins as datasync_mixins

destination_property = datasync_mixins.CfnTaskPropsMixin.DestinationProperty(
    s3=datasync_mixins.CfnTaskPropsMixin.S3Property(
        bucket_access_role_arn="bucketAccessRoleArn",
        s3_bucket_arn="s3BucketArn",
        subdirectory="subdirectory"
    )
)

Attributes

s3

Specifies the Amazon S3 bucket where DataSync uploads your task report.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-destination.html#cfn-datasync-task-destination-s3

FilterRuleProperty

class CfnTaskPropsMixin.FilterRuleProperty(*, filter_type=None, value=None)

Bases: object

Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.

Parameters:

filter_type (Optional[str]) – The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
value (Optional[str]) – A single filter string that consists of the patterns to include or exclude. The patterns are delimited by “|” (that is, a pipe), for example: /folder1|/folder2

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.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_datasync import mixins as datasync_mixins

filter_rule_property = datasync_mixins.CfnTaskPropsMixin.FilterRuleProperty(
    filter_type="filterType",
    value="value"
)

Attributes

filter_type

The type of filter rule to apply.

AWS DataSync only supports the SIMPLE_PATTERN rule type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html#cfn-datasync-task-filterrule-filtertype

value

A single filter string that consists of the patterns to include or exclude.

The patterns are delimited by “|” (that is, a pipe), for example: /folder1|/folder2

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-filterrule.html#cfn-datasync-task-filterrule-value

ManifestConfigProperty

class CfnTaskPropsMixin.ManifestConfigProperty(*, action=None, format=None, source=None)

Bases: object

Configures a manifest, which is a list of files or objects that you want AWS DataSync to transfer.

For more information and configuration examples, see Specifying what DataSync transfers by using a manifest .

Parameters:

action (Optional[str]) – Specifies what DataSync uses the manifest for.
format (Optional[str]) – Specifies the file format of your manifest. For more information, see Creating a manifest .
source (Union[IResolvable, SourceProperty, Dict[str, Any], None]) – Specifies the manifest that you want DataSync to use and where it’s hosted. .. epigraph:: You must specify this parameter if you’re configuring a new manifest on or after February 7, 2024. If you don’t, you’ll get a 400 status code and ValidationException error stating that you’re missing the IAM role for DataSync to access the S3 bucket where you’re hosting your manifest. For more information, see Providing DataSync access to your manifest .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfig.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_datasync import mixins as datasync_mixins

manifest_config_property = datasync_mixins.CfnTaskPropsMixin.ManifestConfigProperty(
    action="action",
    format="format",
    source=datasync_mixins.CfnTaskPropsMixin.SourceProperty(
        s3=datasync_mixins.CfnTaskPropsMixin.ManifestConfigSourceS3Property(
            bucket_access_role_arn="bucketAccessRoleArn",
            manifest_object_path="manifestObjectPath",
            manifest_object_version_id="manifestObjectVersionId",
            s3_bucket_arn="s3BucketArn"
        )
    )
)

Attributes

action

Specifies what DataSync uses the manifest for.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfig.html#cfn-datasync-task-manifestconfig-action

format

Specifies the file format of your manifest.

For more information, see Creating a manifest .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfig.html#cfn-datasync-task-manifestconfig-format

source

Specifies the manifest that you want DataSync to use and where it’s hosted.

You must specify this parameter if you’re configuring a new manifest on or after February 7, 2024.

If you don’t, you’ll get a 400 status code and ValidationException error stating that you’re missing the IAM role for DataSync to access the S3 bucket where you’re hosting your manifest. For more information, see Providing DataSync access to your manifest .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfig.html#cfn-datasync-task-manifestconfig-source

ManifestConfigSourceS3Property

class CfnTaskPropsMixin.ManifestConfigSourceS3Property(*, bucket_access_role_arn=None, manifest_object_path=None, manifest_object_version_id=None, s3_bucket_arn=None)

Bases: object

Specifies the S3 bucket where you’re hosting the manifest that you want AWS DataSync to use.

Parameters:

bucket_access_role_arn (Optional[str]) – Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
manifest_object_path (Optional[str]) – Specifies the Amazon S3 object key of your manifest.
manifest_object_version_id (Optional[str]) – Specifies the object version ID of the manifest that you want DataSync to use.
s3_bucket_arn (Optional[str]) – Specifies the Amazon Resource Name (ARN) of the S3 bucket where you’re hosting your manifest.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.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_datasync import mixins as datasync_mixins

manifest_config_source_s3_property = datasync_mixins.CfnTaskPropsMixin.ManifestConfigSourceS3Property(
    bucket_access_role_arn="bucketAccessRoleArn",
    manifest_object_path="manifestObjectPath",
    manifest_object_version_id="manifestObjectVersionId",
    s3_bucket_arn="s3BucketArn"
)

Attributes

bucket_access_role_arn

Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html#cfn-datasync-task-manifestconfigsources3-bucketaccessrolearn

manifest_object_path

Specifies the Amazon S3 object key of your manifest.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html#cfn-datasync-task-manifestconfigsources3-manifestobjectpath

manifest_object_version_id

Specifies the object version ID of the manifest that you want DataSync to use.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html#cfn-datasync-task-manifestconfigsources3-manifestobjectversionid

s3_bucket_arn

Specifies the Amazon Resource Name (ARN) of the S3 bucket where you’re hosting your manifest.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html#cfn-datasync-task-manifestconfigsources3-s3bucketarn

OptionsProperty

class CfnTaskPropsMixin.OptionsProperty(*, atime=None, bytes_per_second=None, gid=None, log_level=None, mtime=None, object_tags=None, overwrite_mode=None, posix_permissions=None, preserve_deleted_files=None, preserve_devices=None, security_descriptor_copy_flags=None, task_queueing=None, transfer_mode=None, uid=None, verify_mode=None)

Bases: object

Represents the options that are available to control the behavior of a StartTaskExecution operation. This behavior includes preserving metadata, such as user ID (UID), group ID (GID), and file permissions; overwriting files in the destination; data integrity verification; and so on.

A task has a set of default options associated with it. If you don’t specify an option in StartTaskExecution , the default value is used. You can override the default options on each task execution by specifying an overriding Options value to StartTaskExecution .

Parameters:

atime (Optional[str]) – A file metadata value that shows the last time that a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT , AWS DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime ‘s behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis. Default value: BEST_EFFORT BEST_EFFORT : Attempt to preserve the per-file Atime value (recommended). NONE : Ignore Atime . .. epigraph:: If Atime is set to BEST_EFFORT , Mtime must be set to PRESERVE . If Atime is set to NONE , Mtime must also be NONE .
bytes_per_second (Union[int, float, None]) – A value that limits the bandwidth used by AWS DataSync . For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).
gid (Optional[str]) – The group ID (GID) of the file’s owners. Default value: INT_VALUE INT_VALUE : Preserve the integer value of the user ID (UID) and group ID (GID) (recommended). NAME : Currently not supported. NONE : Ignore the UID and GID.
log_level (Optional[str]) – Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn . - BASIC - Publishes logs with only basic information (such as transfer errors). - TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on. - OFF - No logs are published.
mtime (Optional[str]) – A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time. Default value: PRESERVE PRESERVE : Preserve original Mtime (recommended) NONE : Ignore Mtime . .. epigraph:: If Mtime is set to PRESERVE , Atime must be set to BEST_EFFORT . If Mtime is set to NONE , Atime must also be set to NONE .
object_tags (Optional[str]) – Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.
overwrite_mode (Optional[str]) – Specifies whether DataSync should modify or preserve data at the destination location. - ALWAYS (default) - DataSync modifies data in the destination location when source data (including metadata) has changed. If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers . - NEVER - DataSync doesn’t overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination.
posix_permissions (Optional[str]) – A value that determines which users or groups can access a file for a specific purpose, such as reading, writing, or execution of the file. This option should be set only for Network File System (NFS), Amazon EFS, and Amazon S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync . Default value: PRESERVE PRESERVE : Preserve POSIX-style permissions (recommended). NONE : Ignore permissions. .. epigraph:: AWS DataSync can preserve extant permissions of a source location.
preserve_deleted_files (Optional[str]) – A value that specifies whether files in the destination that don’t exist in the source file system are preserved. This option can affect your storage costs. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the AWS DataSync User Guide . Default value: PRESERVE PRESERVE : Ignore destination files that aren’t present in the source (recommended). REMOVE : Delete destination files that aren’t present in the source.
preserve_devices (Optional[str]) – A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata. .. epigraph:: AWS DataSync can’t sync the actual contents of such devices, because they are nonterminal and don’t return an end-of-file (EOF) marker. Default value: NONE NONE : Ignore special devices (recommended). PRESERVE : Preserve character and block device metadata. This option isn’t currently supported for Amazon EFS.
security_descriptor_copy_flags (Optional[str]) – A value that determines which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files . Default value: OWNER_DACL OWNER_DACL : For each copied object, DataSync copies the following metadata: - Object owner. - NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object. When you use option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object. OWNER_DACL_SACL : For each copied object, DataSync copies the following metadata: - Object owner. - NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object. - NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object. Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user . NONE : None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.
task_queueing (Optional[str]) – Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks . This is ENABLED by default.
transfer_mode (Optional[str]) – A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing it to the destination location. CHANGED : DataSync copies only data or metadata that is new or different from the source location to the destination location. ALL : DataSync copies all source location content to the destination, without comparing it to existing content on the destination.
uid (Optional[str]) – The user ID (UID) of the file’s owner. Default value: INT_VALUE INT_VALUE : Preserve the integer value of the UID and group ID (GID) (recommended). NAME : Currently not supported NONE : Ignore the UID and GID.
verify_mode (Optional[str]) – A value that determines whether a data integrity verification is performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings . Default value: POINT_IN_TIME_CONSISTENT ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred. POINT_IN_TIME_CONSISTENT : Scan the entire source and entire destination at the end of the transfer to verify that the source and destination are fully synchronized. This option isn’t supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes. NONE : No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.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_datasync import mixins as datasync_mixins

options_property = datasync_mixins.CfnTaskPropsMixin.OptionsProperty(
    atime="atime",
    bytes_per_second=123,
    gid="gid",
    log_level="logLevel",
    mtime="mtime",
    object_tags="objectTags",
    overwrite_mode="overwriteMode",
    posix_permissions="posixPermissions",
    preserve_deleted_files="preserveDeletedFiles",
    preserve_devices="preserveDevices",
    security_descriptor_copy_flags="securityDescriptorCopyFlags",
    task_queueing="taskQueueing",
    transfer_mode="transferMode",
    uid="uid",
    verify_mode="verifyMode"
)

Attributes

atime

A file metadata value that shows the last time that a file was accessed (that is, when the file was read or written to).

If you set Atime to BEST_EFFORT , AWS DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime ‘s behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT

BEST_EFFORT : Attempt to preserve the per-file Atime value (recommended).

NONE : Ignore Atime . .. epigraph:

If ``Atime`` is set to ``BEST_EFFORT`` , ``Mtime`` must be set to ``PRESERVE`` .

If ``Atime`` is set to ``NONE`` , ``Mtime`` must also be ``NONE`` .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-atime

bytes_per_second

A value that limits the bandwidth used by AWS DataSync .

For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-bytespersecond

gid

The group ID (GID) of the file’s owners.

Default value: INT_VALUE

INT_VALUE : Preserve the integer value of the user ID (UID) and group ID (GID) (recommended).

NAME : Currently not supported.

NONE : Ignore the UID and GID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-gid

log_level

Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group.

To specify the log group, see CloudWatchLogGroupArn .

BASIC - Publishes logs with only basic information (such as transfer errors).
TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.
OFF - No logs are published.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-loglevel

mtime

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

This option is required for cases when you need to run the same task more than one time.

Default value: PRESERVE

PRESERVE : Preserve original Mtime (recommended)

NONE : Ignore Mtime . .. epigraph:

If ``Mtime`` is set to ``PRESERVE`` , ``Atime`` must be set to ``BEST_EFFORT`` .

If ``Mtime`` is set to ``NONE`` , ``Atime`` must also be set to ``NONE`` .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-mtime

object_tags

Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring between object storage systems.

If you want your DataSync task to ignore object tags, specify the NONE value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-objecttags

overwrite_mode

Specifies whether DataSync should modify or preserve data at the destination location.

ALWAYS (default) - DataSync modifies data in the destination location when source data (including metadata) has changed.

If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers .

NEVER - DataSync doesn’t overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-overwritemode

posix_permissions

A value that determines which users or groups can access a file for a specific purpose, such as reading, writing, or execution of the file.

This option should be set only for Network File System (NFS), Amazon EFS, and Amazon S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync .

Default value: PRESERVE

PRESERVE : Preserve POSIX-style permissions (recommended).

NONE : Ignore permissions. .. epigraph:

AWS DataSync can preserve extant permissions of a source location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-posixpermissions

preserve_deleted_files

A value that specifies whether files in the destination that don’t exist in the source file system are preserved.

This option can affect your storage costs. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the AWS DataSync User Guide .

Default value: PRESERVE

PRESERVE : Ignore destination files that aren’t present in the source (recommended).

REMOVE : Delete destination files that aren’t present in the source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-preservedeletedfiles

preserve_devices

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination.

DataSync does not copy the contents of such devices, only the name and metadata. .. epigraph:

AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE

NONE : Ignore special devices (recommended).

PRESERVE : Preserve character and block device metadata. This option isn’t currently supported for Amazon EFS.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-preservedevices

security_descriptor_copy_flags

A value that determines which components of the SMB security descriptor are copied from source to destination objects.

This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files .

Default value: OWNER_DACL

OWNER_DACL : For each copied object, DataSync copies the following metadata:

Object owner.
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

When you use option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.

OWNER_DACL_SACL : For each copied object, DataSync copies the following metadata:

Object owner.
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.

Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user .

NONE : None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-securitydescriptorcopyflags

task_queueing

Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks . This is ENABLED by default.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-taskqueueing

transfer_mode

A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing it to the destination location.

CHANGED : DataSync copies only data or metadata that is new or different from the source location to the destination location.

ALL : DataSync copies all source location content to the destination, without comparing it to existing content on the destination.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-transfermode

uid

The user ID (UID) of the file’s owner.

Default value: INT_VALUE

INT_VALUE : Preserve the integer value of the UID and group ID (GID) (recommended).

NAME : Currently not supported

NONE : Ignore the UID and GID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-uid

verify_mode

A value that determines whether a data integrity verification is performed at the end of a task execution after all data and metadata have been transferred.

For more information, see Configure task settings .

Default value: POINT_IN_TIME_CONSISTENT

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.

POINT_IN_TIME_CONSISTENT : Scan the entire source and entire destination at the end of the transfer to verify that the source and destination are fully synchronized. This option isn’t supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.

NONE : No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-options.html#cfn-datasync-task-options-verifymode

OverridesProperty

class CfnTaskPropsMixin.OverridesProperty(*, deleted=None, skipped=None, transferred=None, verified=None)

Bases: object

Customizes the reporting level for aspects of your task report.

For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location.

Parameters:

deleted (Union[IResolvable, DeletedProperty, Dict[str, Any], None]) – Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn’t in the source.
skipped (Union[IResolvable, SkippedProperty, Dict[str, Any], None]) – Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
transferred (Union[IResolvable, TransferredProperty, Dict[str, Any], None]) – Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
verified (Union[IResolvable, VerifiedProperty, Dict[str, Any], None]) – Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.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_datasync import mixins as datasync_mixins

overrides_property = datasync_mixins.CfnTaskPropsMixin.OverridesProperty(
    deleted=datasync_mixins.CfnTaskPropsMixin.DeletedProperty(
        report_level="reportLevel"
    ),
    skipped=datasync_mixins.CfnTaskPropsMixin.SkippedProperty(
        report_level="reportLevel"
    ),
    transferred=datasync_mixins.CfnTaskPropsMixin.TransferredProperty(
        report_level="reportLevel"
    ),
    verified=datasync_mixins.CfnTaskPropsMixin.VerifiedProperty(
        report_level="reportLevel"
    )
)

Attributes

deleted

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location.

This only applies if you configure your task to delete data in the destination that isn’t in the source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-deleted

skipped

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-skipped

transferred

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-transferred

verified

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer.

This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-verified

S3Property

class CfnTaskPropsMixin.S3Property(*, bucket_access_role_arn=None, s3_bucket_arn=None, subdirectory=None)

Bases: object

Parameters:

bucket_access_role_arn (Optional[str])
s3_bucket_arn (Optional[str])
subdirectory (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-s3.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_datasync import mixins as datasync_mixins

s3_property = datasync_mixins.CfnTaskPropsMixin.S3Property(
    bucket_access_role_arn="bucketAccessRoleArn",
    s3_bucket_arn="s3BucketArn",
    subdirectory="subdirectory"
)

Attributes

bucket_access_role_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-s3.html#cfn-datasync-task-s3-bucketaccessrolearn

Type:: see

s3_bucket_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-s3.html#cfn-datasync-task-s3-s3bucketarn

Type:: see

subdirectory

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-s3.html#cfn-datasync-task-s3-subdirectory

Type:: see

SkippedProperty

class CfnTaskPropsMixin.SkippedProperty(*, report_level=None)

Bases: object

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.

Parameters:: report_level (Optional[str]) – Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-skipped.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_datasync import mixins as datasync_mixins

skipped_property = datasync_mixins.CfnTaskPropsMixin.SkippedProperty(
    report_level="reportLevel"
)

Attributes

report_level

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-skipped.html#cfn-datasync-task-skipped-reportlevel

SourceProperty

class CfnTaskPropsMixin.SourceProperty(*, s3=None)

Bases: object

Specifies the manifest that you want DataSync to use and where it’s hosted.

Parameters:: s3 (Union[IResolvable, ManifestConfigSourceS3Property, Dict[str, Any], None]) – Specifies the S3 bucket where you’re hosting the manifest that you want AWS DataSync to use.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-source.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_datasync import mixins as datasync_mixins

source_property = datasync_mixins.CfnTaskPropsMixin.SourceProperty(
    s3=datasync_mixins.CfnTaskPropsMixin.ManifestConfigSourceS3Property(
        bucket_access_role_arn="bucketAccessRoleArn",
        manifest_object_path="manifestObjectPath",
        manifest_object_version_id="manifestObjectVersionId",
        s3_bucket_arn="s3BucketArn"
    )
)

Attributes

s3

Specifies the S3 bucket where you’re hosting the manifest that you want AWS DataSync to use.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-source.html#cfn-datasync-task-source-s3

TaskReportConfigProperty

class CfnTaskPropsMixin.TaskReportConfigProperty(*, destination=None, object_version_ids=None, output_type=None, overrides=None, report_level=None)

Bases: object

Specifies how you want to configure a task report, which provides detailed information about for your AWS DataSync transfer.

For more information, see Task reports .

Parameters:

destination (Union[IResolvable, DestinationProperty, Dict[str, Any], None]) –
Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports .
object_version_ids (Optional[str]) – Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket . Keep in mind that setting this to INCLUDE can increase the duration of your task execution.
output_type (Optional[str]) – Specifies the type of task report that you want:. - SUMMARY_ONLY : Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration. - STANDARD : Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.
overrides (Union[IResolvable, OverridesProperty, Dict[str, Any], None]) – Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.
report_level (Optional[str]) – Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t. - ERRORS_ONLY : A report shows what DataSync was unable to transfer, skip, verify, and delete. - SUCCESSES_AND_ERRORS : A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.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_datasync import mixins as datasync_mixins

task_report_config_property = datasync_mixins.CfnTaskPropsMixin.TaskReportConfigProperty(
    destination=datasync_mixins.CfnTaskPropsMixin.DestinationProperty(
        s3=datasync_mixins.CfnTaskPropsMixin.S3Property(
            bucket_access_role_arn="bucketAccessRoleArn",
            s3_bucket_arn="s3BucketArn",
            subdirectory="subdirectory"
        )
    ),
    object_version_ids="objectVersionIds",
    output_type="outputType",
    overrides=datasync_mixins.CfnTaskPropsMixin.OverridesProperty(
        deleted=datasync_mixins.CfnTaskPropsMixin.DeletedProperty(
            report_level="reportLevel"
        ),
        skipped=datasync_mixins.CfnTaskPropsMixin.SkippedProperty(
            report_level="reportLevel"
        ),
        transferred=datasync_mixins.CfnTaskPropsMixin.TransferredProperty(
            report_level="reportLevel"
        ),
        verified=datasync_mixins.CfnTaskPropsMixin.VerifiedProperty(
            report_level="reportLevel"
        )
    ),
    report_level="reportLevel"
)

Attributes

destination

Specifies the Amazon S3 bucket where DataSync uploads your task report.

For more information, see Task reports .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-destination

object_version_ids

Specifies whether your task report includes the new version of each object transferred into an S3 bucket.

This only applies if you enable versioning on your bucket . Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-objectversionids

output_type

.

SUMMARY_ONLY : Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.
STANDARD : Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-outputtype
Type:: Specifies the type of task report that you want

overrides

Customizes the reporting level for aspects of your task report.

For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-overrides

report_level

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t.

ERRORS_ONLY : A report shows what DataSync was unable to transfer, skip, verify, and delete.
SUCCESSES_AND_ERRORS : A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskreportconfig.html#cfn-datasync-task-taskreportconfig-reportlevel

TaskScheduleProperty

class CfnTaskPropsMixin.TaskScheduleProperty(*, schedule_expression=None, status=None)

Bases: object

Configures your AWS DataSync task to run on a schedule (at a minimum interval of 1 hour).

Parameters:

schedule_expression (Optional[str]) – Specifies your task schedule by using a cron or rate expression. Use cron expressions for task schedules that run on a specific time and day. For example, the following cron expression creates a task schedule that runs at 8 AM on the first Wednesday of every month: cron(0 8 * * 3#1) Use rate expressions for task schedules that run on a regular interval. For example, the following rate expression creates a task schedule that runs every 12 hours: rate(12 hours) For information about cron and rate expression syntax, see the *Amazon EventBridge User Guide* .
status (Optional[str]) – Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system. DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.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_datasync import mixins as datasync_mixins

task_schedule_property = datasync_mixins.CfnTaskPropsMixin.TaskScheduleProperty(
    schedule_expression="scheduleExpression",
    status="status"
)

Attributes

schedule_expression

Specifies your task schedule by using a cron or rate expression.

Use cron expressions for task schedules that run on a specific time and day. For example, the following cron expression creates a task schedule that runs at 8 AM on the first Wednesday of every month:

cron(0 8 * * 3#1)

Use rate expressions for task schedules that run on a regular interval. For example, the following rate expression creates a task schedule that runs every 12 hours:

rate(12 hours)

For information about cron and rate expression syntax, see the *Amazon EventBridge User Guide* .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html#cfn-datasync-task-taskschedule-scheduleexpression

status

Specifies whether to enable or disable your task schedule.

Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html#cfn-datasync-task-taskschedule-status

TransferredProperty

class CfnTaskPropsMixin.TransferredProperty(*, report_level=None)

Bases: object

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.

Parameters:: report_level (Optional[str]) – Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-transferred.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_datasync import mixins as datasync_mixins

transferred_property = datasync_mixins.CfnTaskPropsMixin.TransferredProperty(
    report_level="reportLevel"
)

Attributes

report_level

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-transferred.html#cfn-datasync-task-transferred-reportlevel

VerifiedProperty

class CfnTaskPropsMixin.VerifiedProperty(*, report_level=None)

Bases: object

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer.

This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)

Parameters:: report_level (Optional[str]) – Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-verified.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_datasync import mixins as datasync_mixins

verified_property = datasync_mixins.CfnTaskPropsMixin.VerifiedProperty(
    report_level="reportLevel"
)

Attributes

report_level

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn’t.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-verified.html#cfn-datasync-task-verified-reportlevel