aws-cdk-lib 2.200.1__py3-none-any.whl → 2.201.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +105 -13
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.200.1.jsii.tgz → aws-cdk-lib@2.201.0.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +2 -3
- aws_cdk/aws_amplify/__init__.py +3 -3
- aws_cdk/aws_apigateway/__init__.py +21 -17
- aws_cdk/aws_apigatewayv2/__init__.py +87 -45
- aws_cdk/aws_appconfig/__init__.py +38 -1
- aws_cdk/aws_appsync/__init__.py +10 -10
- aws_cdk/aws_athena/__init__.py +226 -0
- aws_cdk/aws_autoscaling/__init__.py +38 -37
- aws_cdk/aws_bedrock/__init__.py +5108 -1571
- aws_cdk/aws_cloudfront/__init__.py +8 -0
- aws_cdk/aws_cloudtrail/__init__.py +178 -0
- aws_cdk/aws_cloudwatch/__init__.py +7 -3
- aws_cdk/aws_codepipeline_actions/__init__.py +746 -0
- aws_cdk/aws_connect/__init__.py +5 -5
- aws_cdk/aws_customerprofiles/__init__.py +377 -8
- aws_cdk/aws_datasync/__init__.py +189 -160
- aws_cdk/aws_datazone/__init__.py +512 -170
- aws_cdk/aws_deadline/__init__.py +32 -4
- aws_cdk/aws_dsql/__init__.py +150 -10
- aws_cdk/aws_ec2/__init__.py +793 -56
- aws_cdk/aws_ecs/__init__.py +94 -11
- aws_cdk/aws_efs/__init__.py +92 -12
- aws_cdk/aws_eks/__init__.py +166 -19
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +2 -2
- aws_cdk/aws_emr/__init__.py +10 -4
- aws_cdk/aws_entityresolution/__init__.py +25 -10
- aws_cdk/aws_evs/__init__.py +2204 -0
- aws_cdk/aws_fsx/__init__.py +7 -7
- aws_cdk/aws_lambda/__init__.py +409 -32
- aws_cdk/aws_lightsail/__init__.py +17 -13
- aws_cdk/aws_logs/__init__.py +1 -0
- aws_cdk/aws_networkfirewall/__init__.py +562 -0
- aws_cdk/aws_opensearchservice/__init__.py +3 -3
- aws_cdk/aws_opsworkscm/__init__.py +9 -43
- aws_cdk/aws_rds/__init__.py +284 -87
- aws_cdk/aws_s3/__init__.py +23 -15
- aws_cdk/aws_sagemaker/__init__.py +223 -3
- aws_cdk/aws_securityhub/__init__.py +18 -34
- aws_cdk/aws_ssm/__init__.py +83 -1
- aws_cdk/aws_stepfunctions/__init__.py +235 -45
- aws_cdk/aws_synthetics/__init__.py +74 -0
- aws_cdk/aws_transfer/__init__.py +3 -3
- aws_cdk/aws_verifiedpermissions/__init__.py +17 -6
- aws_cdk/aws_wafv2/__init__.py +39 -2
- {aws_cdk_lib-2.200.1.dist-info → aws_cdk_lib-2.201.0.dist-info}/METADATA +2 -2
- {aws_cdk_lib-2.200.1.dist-info → aws_cdk_lib-2.201.0.dist-info}/RECORD +53 -52
- {aws_cdk_lib-2.200.1.dist-info → aws_cdk_lib-2.201.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.200.1.dist-info → aws_cdk_lib-2.201.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.200.1.dist-info → aws_cdk_lib-2.201.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.200.1.dist-info → aws_cdk_lib-2.201.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_datasync/__init__.py
CHANGED
|
@@ -458,9 +458,9 @@ class CfnLocationAzureBlob(
|
|
|
458
458
|
):
|
|
459
459
|
'''Creates a transfer *location* for a Microsoft Azure Blob Storage container.
|
|
460
460
|
|
|
461
|
-
AWS DataSync can use this location as a transfer source or destination.
|
|
461
|
+
AWS DataSync can use this location as a transfer source or destination. You can make transfers with or without a `DataSync agent <https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent>`_ that connects to your container.
|
|
462
462
|
|
|
463
|
-
Before you begin, make sure you know `how DataSync accesses Azure Blob Storage <https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access>`_ and works with `access tiers <https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers>`_ and `blob types <https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types>`_ .
|
|
463
|
+
Before you begin, make sure you know `how DataSync accesses Azure Blob Storage <https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access>`_ and works with `access tiers <https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers>`_ and `blob types <https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types>`_ .
|
|
464
464
|
|
|
465
465
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html
|
|
466
466
|
:cloudformationResource: AWS::DataSync::LocationAzureBlob
|
|
@@ -519,13 +519,13 @@ class CfnLocationAzureBlob(
|
|
|
519
519
|
:param scope: Scope in which this resource is defined.
|
|
520
520
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
521
521
|
:param azure_blob_authentication_type: Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS). Default: - "SAS"
|
|
522
|
-
:param agent_arns: Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. You can specify more than one agent. For more information, see `Using multiple agents for your transfer <https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html>`_ .
|
|
522
|
+
:param agent_arns: (Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter. You can specify more than one agent. For more information, see `Using multiple agents for your transfer <https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html>`_ . .. epigraph:: Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.
|
|
523
523
|
:param azure_access_tier: Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see `Access tiers <https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers>`_ . Default: - "HOT"
|
|
524
524
|
:param azure_blob_container_url: Specifies the URL of the Azure Blob Storage container involved in your transfer.
|
|
525
|
-
:param azure_blob_sas_configuration: Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
|
|
525
|
+
:param azure_blob_sas_configuration: Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage. .. epigraph:: If you provide an authentication token using ``SasConfiguration`` , but do not provide secret configuration details using ``CmkSecretConfig`` or ``CustomSecretConfig`` , then DataSync stores the token using your AWS account's secrets manager secret.
|
|
526
526
|
:param azure_blob_type: Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the `Azure Blob Storage documentation <https://docs.aws.amazon.com/https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>`_ . Default: - "BLOCK"
|
|
527
|
-
:param cmk_secret_config: Specifies configuration information for a DataSync-managed secret, such as an authentication token or
|
|
528
|
-
:param custom_secret_config: Specifies configuration information for a customer-managed secret
|
|
527
|
+
:param cmk_secret_config: Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key . .. epigraph:: You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.
|
|
528
|
+
:param custom_secret_config: Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. .. epigraph:: You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.
|
|
529
529
|
:param subdirectory: Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, ``/my/images`` ).
|
|
530
530
|
: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 transfer location.
|
|
531
531
|
'''
|
|
@@ -581,7 +581,9 @@ class CfnLocationAzureBlob(
|
|
|
581
581
|
@builtins.property
|
|
582
582
|
@jsii.member(jsii_name="attrCmkSecretConfigSecretArn")
|
|
583
583
|
def attr_cmk_secret_config_secret_arn(self) -> builtins.str:
|
|
584
|
-
'''Specifies the ARN for
|
|
584
|
+
'''Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.
|
|
585
|
+
|
|
586
|
+
This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for ``KmsKeyArn`` .
|
|
585
587
|
|
|
586
588
|
:cloudformationAttribute: CmkSecretConfig.SecretArn
|
|
587
589
|
'''
|
|
@@ -643,7 +645,7 @@ class CfnLocationAzureBlob(
|
|
|
643
645
|
@builtins.property
|
|
644
646
|
@jsii.member(jsii_name="agentArns")
|
|
645
647
|
def agent_arns(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
646
|
-
'''Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.'''
|
|
648
|
+
'''(Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.'''
|
|
647
649
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "agentArns"))
|
|
648
650
|
|
|
649
651
|
@agent_arns.setter
|
|
@@ -715,7 +717,7 @@ class CfnLocationAzureBlob(
|
|
|
715
717
|
def cmk_secret_config(
|
|
716
718
|
self,
|
|
717
719
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLocationAzureBlob.CmkSecretConfigProperty"]]:
|
|
718
|
-
'''Specifies configuration information for a DataSync-managed secret, such as an authentication token or
|
|
720
|
+
'''Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .'''
|
|
719
721
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLocationAzureBlob.CmkSecretConfigProperty"]], jsii.get(self, "cmkSecretConfig"))
|
|
720
722
|
|
|
721
723
|
@cmk_secret_config.setter
|
|
@@ -733,7 +735,7 @@ class CfnLocationAzureBlob(
|
|
|
733
735
|
def custom_secret_config(
|
|
734
736
|
self,
|
|
735
737
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLocationAzureBlob.CustomSecretConfigProperty"]]:
|
|
736
|
-
'''Specifies configuration information for a customer-managed
|
|
738
|
+
'''Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.'''
|
|
737
739
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLocationAzureBlob.CustomSecretConfigProperty"]], jsii.get(self, "customSecretConfig"))
|
|
738
740
|
|
|
739
741
|
@custom_secret_config.setter
|
|
@@ -842,10 +844,14 @@ class CfnLocationAzureBlob(
|
|
|
842
844
|
kms_key_arn: typing.Optional[builtins.str] = None,
|
|
843
845
|
secret_arn: typing.Optional[builtins.str] = None,
|
|
844
846
|
) -> None:
|
|
845
|
-
'''Specifies configuration information for a DataSync-managed secret, such as an authentication token or
|
|
847
|
+
'''Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
|
|
848
|
+
|
|
849
|
+
.. epigraph::
|
|
846
850
|
|
|
847
|
-
|
|
848
|
-
|
|
851
|
+
You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.
|
|
852
|
+
|
|
853
|
+
:param kms_key_arn: Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for ``SecretArn`` . DataSync provides this key to AWS Secrets Manager .
|
|
854
|
+
:param secret_arn: Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for ``KmsKeyArn`` .
|
|
849
855
|
|
|
850
856
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-cmksecretconfig.html
|
|
851
857
|
:exampleMetadata: fixture=_generated
|
|
@@ -873,9 +879,9 @@ class CfnLocationAzureBlob(
|
|
|
873
879
|
|
|
874
880
|
@builtins.property
|
|
875
881
|
def kms_key_arn(self) -> typing.Optional[builtins.str]:
|
|
876
|
-
'''Specifies the ARN for the customer-managed AWS KMS key
|
|
882
|
+
'''Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for ``SecretArn`` .
|
|
877
883
|
|
|
878
|
-
DataSync provides this key to AWS Secrets Manager.
|
|
884
|
+
DataSync provides this key to AWS Secrets Manager .
|
|
879
885
|
|
|
880
886
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-cmksecretconfig.html#cfn-datasync-locationazureblob-cmksecretconfig-kmskeyarn
|
|
881
887
|
'''
|
|
@@ -884,7 +890,9 @@ class CfnLocationAzureBlob(
|
|
|
884
890
|
|
|
885
891
|
@builtins.property
|
|
886
892
|
def secret_arn(self) -> typing.Optional[builtins.str]:
|
|
887
|
-
'''Specifies the ARN for
|
|
893
|
+
'''Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.
|
|
894
|
+
|
|
895
|
+
This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for ``KmsKeyArn`` .
|
|
888
896
|
|
|
889
897
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-cmksecretconfig.html#cfn-datasync-locationazureblob-cmksecretconfig-secretarn
|
|
890
898
|
'''
|
|
@@ -917,10 +925,15 @@ class CfnLocationAzureBlob(
|
|
|
917
925
|
secret_access_role_arn: builtins.str,
|
|
918
926
|
secret_arn: builtins.str,
|
|
919
927
|
) -> None:
|
|
920
|
-
'''Specifies configuration information for a customer-managed
|
|
928
|
+
'''Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.
|
|
921
929
|
|
|
922
|
-
|
|
923
|
-
|
|
930
|
+
This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.
|
|
931
|
+
.. epigraph::
|
|
932
|
+
|
|
933
|
+
You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.
|
|
934
|
+
|
|
935
|
+
:param 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`` .
|
|
936
|
+
:param secret_arn: Specifies the ARN for an AWS Secrets Manager secret.
|
|
924
937
|
|
|
925
938
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-customsecretconfig.html
|
|
926
939
|
:exampleMetadata: fixture=_generated
|
|
@@ -947,7 +960,7 @@ class CfnLocationAzureBlob(
|
|
|
947
960
|
|
|
948
961
|
@builtins.property
|
|
949
962
|
def secret_access_role_arn(self) -> builtins.str:
|
|
950
|
-
'''Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
|
|
963
|
+
'''Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for ``SecretArn`` .
|
|
951
964
|
|
|
952
965
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-customsecretconfig.html#cfn-datasync-locationazureblob-customsecretconfig-secretaccessrolearn
|
|
953
966
|
'''
|
|
@@ -957,7 +970,7 @@ class CfnLocationAzureBlob(
|
|
|
957
970
|
|
|
958
971
|
@builtins.property
|
|
959
972
|
def secret_arn(self) -> builtins.str:
|
|
960
|
-
'''Specifies the ARN for
|
|
973
|
+
'''Specifies the ARN for an AWS Secrets Manager secret.
|
|
961
974
|
|
|
962
975
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationazureblob-customsecretconfig.html#cfn-datasync-locationazureblob-customsecretconfig-secretarn
|
|
963
976
|
'''
|
|
@@ -985,7 +998,7 @@ class CfnLocationAzureBlob(
|
|
|
985
998
|
def __init__(self, *, secret_arn: builtins.str) -> None:
|
|
986
999
|
'''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.
|
|
987
1000
|
|
|
988
|
-
DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.
|
|
1001
|
+
DataSync uses the default AWS -managed KMS key to encrypt this secret in AWS Secrets Manager .
|
|
989
1002
|
|
|
990
1003
|
:param secret_arn: Specifies the ARN for an AWS Secrets Manager secret.
|
|
991
1004
|
|
|
@@ -1065,13 +1078,13 @@ class CfnLocationAzureBlobProps:
|
|
|
1065
1078
|
'''Properties for defining a ``CfnLocationAzureBlob``.
|
|
1066
1079
|
|
|
1067
1080
|
:param azure_blob_authentication_type: Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS). Default: - "SAS"
|
|
1068
|
-
:param agent_arns: Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. You can specify more than one agent. For more information, see `Using multiple agents for your transfer <https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html>`_ .
|
|
1081
|
+
:param agent_arns: (Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter. You can specify more than one agent. For more information, see `Using multiple agents for your transfer <https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html>`_ . .. epigraph:: Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.
|
|
1069
1082
|
:param azure_access_tier: Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see `Access tiers <https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers>`_ . Default: - "HOT"
|
|
1070
1083
|
:param azure_blob_container_url: Specifies the URL of the Azure Blob Storage container involved in your transfer.
|
|
1071
|
-
:param azure_blob_sas_configuration: Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
|
|
1084
|
+
:param azure_blob_sas_configuration: Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage. .. epigraph:: If you provide an authentication token using ``SasConfiguration`` , but do not provide secret configuration details using ``CmkSecretConfig`` or ``CustomSecretConfig`` , then DataSync stores the token using your AWS account's secrets manager secret.
|
|
1072
1085
|
:param azure_blob_type: Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the `Azure Blob Storage documentation <https://docs.aws.amazon.com/https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs>`_ . Default: - "BLOCK"
|
|
1073
|
-
:param cmk_secret_config: Specifies configuration information for a DataSync-managed secret, such as an authentication token or
|
|
1074
|
-
:param custom_secret_config: Specifies configuration information for a customer-managed secret
|
|
1086
|
+
:param cmk_secret_config: Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key . .. epigraph:: You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.
|
|
1087
|
+
:param custom_secret_config: Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. .. epigraph:: You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.
|
|
1075
1088
|
:param subdirectory: Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, ``/my/images`` ).
|
|
1076
1089
|
: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 transfer location.
|
|
1077
1090
|
|
|
@@ -1160,9 +1173,14 @@ class CfnLocationAzureBlobProps:
|
|
|
1160
1173
|
|
|
1161
1174
|
@builtins.property
|
|
1162
1175
|
def agent_arns(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
1163
|
-
'''Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.
|
|
1176
|
+
'''(Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.
|
|
1177
|
+
|
|
1178
|
+
If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
|
|
1164
1179
|
|
|
1165
1180
|
You can specify more than one agent. For more information, see `Using multiple agents for your transfer <https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html>`_ .
|
|
1181
|
+
.. epigraph::
|
|
1182
|
+
|
|
1183
|
+
Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.
|
|
1166
1184
|
|
|
1167
1185
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-agentarns
|
|
1168
1186
|
'''
|
|
@@ -1197,6 +1215,10 @@ class CfnLocationAzureBlobProps:
|
|
|
1197
1215
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnLocationAzureBlob.AzureBlobSasConfigurationProperty]]:
|
|
1198
1216
|
'''Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
|
|
1199
1217
|
|
|
1218
|
+
.. epigraph::
|
|
1219
|
+
|
|
1220
|
+
If you provide an authentication token using ``SasConfiguration`` , but do not provide secret configuration details using ``CmkSecretConfig`` or ``CustomSecretConfig`` , then DataSync stores the token using your AWS account's secrets manager secret.
|
|
1221
|
+
|
|
1200
1222
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-azureblobsasconfiguration
|
|
1201
1223
|
'''
|
|
1202
1224
|
result = self._values.get("azure_blob_sas_configuration")
|
|
@@ -1219,7 +1241,11 @@ class CfnLocationAzureBlobProps:
|
|
|
1219
1241
|
def cmk_secret_config(
|
|
1220
1242
|
self,
|
|
1221
1243
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnLocationAzureBlob.CmkSecretConfigProperty]]:
|
|
1222
|
-
'''Specifies configuration information for a DataSync-managed secret, such as an authentication token or
|
|
1244
|
+
'''Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
|
|
1245
|
+
|
|
1246
|
+
.. epigraph::
|
|
1247
|
+
|
|
1248
|
+
You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.
|
|
1223
1249
|
|
|
1224
1250
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-cmksecretconfig
|
|
1225
1251
|
'''
|
|
@@ -1230,7 +1256,12 @@ class CfnLocationAzureBlobProps:
|
|
|
1230
1256
|
def custom_secret_config(
|
|
1231
1257
|
self,
|
|
1232
1258
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnLocationAzureBlob.CustomSecretConfigProperty]]:
|
|
1233
|
-
'''Specifies configuration information for a customer-managed
|
|
1259
|
+
'''Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.
|
|
1260
|
+
|
|
1261
|
+
This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.
|
|
1262
|
+
.. epigraph::
|
|
1263
|
+
|
|
1264
|
+
You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.
|
|
1234
1265
|
|
|
1235
1266
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationazureblob.html#cfn-datasync-locationazureblob-customsecretconfig
|
|
1236
1267
|
'''
|
|
@@ -5092,15 +5123,15 @@ class CfnLocationObjectStorage(
|
|
|
5092
5123
|
:param scope: Scope in which this resource is defined.
|
|
5093
5124
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
5094
5125
|
:param access_key: Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
|
|
5095
|
-
:param agent_arns: Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.
|
|
5126
|
+
:param agent_arns: (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter. .. epigraph:: Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.
|
|
5096
5127
|
:param bucket_name: Specifies the name of the object storage bucket involved in the transfer.
|
|
5097
|
-
:param cmk_secret_config: Specifies configuration information for a DataSync-managed secret,
|
|
5098
|
-
:param custom_secret_config: Specifies configuration information for a customer-managed secret
|
|
5099
|
-
:param secret_key: Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
|
|
5128
|
+
:param cmk_secret_config: Specifies configuration information for a DataSync-managed secret, which includes the ``SecretKey`` that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key . When you include this paramater as part of a ``CreateLocationObjectStorage`` request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the ``SecretKey`` parameter to create a DataSync-managed secret to store the location access credentials. Make sure the DataSync has permission to access the KMS key that you specify. .. epigraph:: You can use either ``CmkSecretConfig`` (with ``SecretKey`` ) or ``CustomSecretConfig`` (without ``SecretKey`` ) to provide credentials for a ``CreateLocationObjectStorage`` request. Do not provide both parameters for the same request.
|
|
5129
|
+
:param custom_secret_config: Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. .. epigraph:: You can use either ``CmkSecretConfig`` (with ``SecretKey`` ) or ``CustomSecretConfig`` (without ``SecretKey`` ) to provide credentials for a ``CreateLocationObjectStorage`` request. Do not provide both parameters for the same request.
|
|
5130
|
+
:param secret_key: Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server. .. epigraph:: If you provide a secret using ``SecretKey`` , but do not provide secret configuration details using ``CmkSecretConfig`` or ``CustomSecretConfig`` , then DataSync stores the token using your AWS account's Secrets Manager secret.
|
|
5100
5131
|
:param server_certificate: Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single ``.pem`` file with a full certificate chain (for example, ``file:///home/user/.ssh/object_storage_certificates.pem`` ). The certificate chain might include: - The object storage system's certificate - All intermediate certificates (if there are any) - The root certificate of the signing CA You can concatenate your certificates into a ``.pem`` file (which can be up to 32768 bytes before base64 encoding). The following example ``cat`` command creates an ``object_storage_certificates.pem`` file that includes three certificates: ``cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem`` To use this parameter, configure ``ServerProtocol`` to ``HTTPS`` .
|
|
5101
5132
|
:param server_hostname: Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync agent connects to.
|
|
5102
5133
|
:param server_port: Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
|
|
5103
|
-
:param server_protocol: Specifies the protocol that your object storage server uses to communicate.
|
|
5134
|
+
:param server_protocol: Specifies the protocol that your object storage server uses to communicate. If not specified, the default value is ``HTTPS`` .
|
|
5104
5135
|
:param subdirectory: Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.
|
|
5105
5136
|
:param tags: Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
|
|
5106
5137
|
'''
|
|
@@ -5158,7 +5189,9 @@ class CfnLocationObjectStorage(
|
|
|
5158
5189
|
@builtins.property
|
|
5159
5190
|
@jsii.member(jsii_name="attrCmkSecretConfigSecretArn")
|
|
5160
5191
|
def attr_cmk_secret_config_secret_arn(self) -> builtins.str:
|
|
5161
|
-
'''Specifies the ARN for
|
|
5192
|
+
'''Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.
|
|
5193
|
+
|
|
5194
|
+
This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for ``KmsKeyArn`` .
|
|
5162
5195
|
|
|
5163
5196
|
:cloudformationAttribute: CmkSecretConfig.SecretArn
|
|
5164
5197
|
'''
|
|
@@ -5220,7 +5253,7 @@ class CfnLocationObjectStorage(
|
|
|
5220
5253
|
@builtins.property
|
|
5221
5254
|
@jsii.member(jsii_name="agentArns")
|
|
5222
5255
|
def agent_arns(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5223
|
-
'''Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.'''
|
|
5256
|
+
'''(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.'''
|
|
5224
5257
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "agentArns"))
|
|
5225
5258
|
|
|
5226
5259
|
@agent_arns.setter
|
|
@@ -5248,7 +5281,7 @@ class CfnLocationObjectStorage(
|
|
|
5248
5281
|
def cmk_secret_config(
|
|
5249
5282
|
self,
|
|
5250
5283
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLocationObjectStorage.CmkSecretConfigProperty"]]:
|
|
5251
|
-
'''Specifies configuration information for a DataSync-managed secret,
|
|
5284
|
+
'''Specifies configuration information for a DataSync-managed secret, which includes the ``SecretKey`` that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .'''
|
|
5252
5285
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLocationObjectStorage.CmkSecretConfigProperty"]], jsii.get(self, "cmkSecretConfig"))
|
|
5253
5286
|
|
|
5254
5287
|
@cmk_secret_config.setter
|
|
@@ -5266,7 +5299,7 @@ class CfnLocationObjectStorage(
|
|
|
5266
5299
|
def custom_secret_config(
|
|
5267
5300
|
self,
|
|
5268
5301
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLocationObjectStorage.CustomSecretConfigProperty"]]:
|
|
5269
|
-
'''Specifies configuration information for a customer-managed
|
|
5302
|
+
'''Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text.'''
|
|
5270
5303
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLocationObjectStorage.CustomSecretConfigProperty"]], jsii.get(self, "customSecretConfig"))
|
|
5271
5304
|
|
|
5272
5305
|
@custom_secret_config.setter
|
|
@@ -5382,10 +5415,14 @@ class CfnLocationObjectStorage(
|
|
|
5382
5415
|
kms_key_arn: typing.Optional[builtins.str] = None,
|
|
5383
5416
|
secret_arn: typing.Optional[builtins.str] = None,
|
|
5384
5417
|
) -> None:
|
|
5385
|
-
'''Specifies configuration information for a DataSync-managed secret, such as an authentication token or
|
|
5418
|
+
'''Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
|
|
5419
|
+
|
|
5420
|
+
.. epigraph::
|
|
5386
5421
|
|
|
5387
|
-
|
|
5388
|
-
|
|
5422
|
+
You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.
|
|
5423
|
+
|
|
5424
|
+
:param kms_key_arn: Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for ``SecretArn`` . DataSync provides this key to AWS Secrets Manager .
|
|
5425
|
+
:param secret_arn: Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for ``KmsKeyArn`` .
|
|
5389
5426
|
|
|
5390
5427
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-cmksecretconfig.html
|
|
5391
5428
|
:exampleMetadata: fixture=_generated
|
|
@@ -5413,9 +5450,9 @@ class CfnLocationObjectStorage(
|
|
|
5413
5450
|
|
|
5414
5451
|
@builtins.property
|
|
5415
5452
|
def kms_key_arn(self) -> typing.Optional[builtins.str]:
|
|
5416
|
-
'''Specifies the ARN for the customer-managed AWS KMS key
|
|
5453
|
+
'''Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for ``SecretArn`` .
|
|
5417
5454
|
|
|
5418
|
-
DataSync provides this key to AWS Secrets Manager.
|
|
5455
|
+
DataSync provides this key to AWS Secrets Manager .
|
|
5419
5456
|
|
|
5420
5457
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-cmksecretconfig.html#cfn-datasync-locationobjectstorage-cmksecretconfig-kmskeyarn
|
|
5421
5458
|
'''
|
|
@@ -5424,7 +5461,9 @@ class CfnLocationObjectStorage(
|
|
|
5424
5461
|
|
|
5425
5462
|
@builtins.property
|
|
5426
5463
|
def secret_arn(self) -> typing.Optional[builtins.str]:
|
|
5427
|
-
'''Specifies the ARN for
|
|
5464
|
+
'''Specifies the ARN for the DataSync-managed AWS Secrets Manager secret that that is used to access a specific storage location.
|
|
5465
|
+
|
|
5466
|
+
This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for ``KmsKeyArn`` .
|
|
5428
5467
|
|
|
5429
5468
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-cmksecretconfig.html#cfn-datasync-locationobjectstorage-cmksecretconfig-secretarn
|
|
5430
5469
|
'''
|
|
@@ -5457,10 +5496,15 @@ class CfnLocationObjectStorage(
|
|
|
5457
5496
|
secret_access_role_arn: builtins.str,
|
|
5458
5497
|
secret_arn: builtins.str,
|
|
5459
5498
|
) -> None:
|
|
5460
|
-
'''Specifies configuration information for a customer-managed
|
|
5499
|
+
'''Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text.
|
|
5500
|
+
|
|
5501
|
+
This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.
|
|
5502
|
+
.. epigraph::
|
|
5503
|
+
|
|
5504
|
+
You can use either ``CmkSecretConfig`` or ``CustomSecretConfig`` to provide credentials for a ``CreateLocation`` request. Do not provide both parameters for the same request.
|
|
5461
5505
|
|
|
5462
|
-
:param 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.
|
|
5463
|
-
:param secret_arn: Specifies the ARN for
|
|
5506
|
+
:param 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`` .
|
|
5507
|
+
:param secret_arn: Specifies the ARN for an AWS Secrets Manager secret.
|
|
5464
5508
|
|
|
5465
5509
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-customsecretconfig.html
|
|
5466
5510
|
:exampleMetadata: fixture=_generated
|
|
@@ -5487,7 +5531,7 @@ class CfnLocationObjectStorage(
|
|
|
5487
5531
|
|
|
5488
5532
|
@builtins.property
|
|
5489
5533
|
def secret_access_role_arn(self) -> builtins.str:
|
|
5490
|
-
'''Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.
|
|
5534
|
+
'''Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for ``SecretArn`` .
|
|
5491
5535
|
|
|
5492
5536
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-customsecretconfig.html#cfn-datasync-locationobjectstorage-customsecretconfig-secretaccessrolearn
|
|
5493
5537
|
'''
|
|
@@ -5497,7 +5541,7 @@ class CfnLocationObjectStorage(
|
|
|
5497
5541
|
|
|
5498
5542
|
@builtins.property
|
|
5499
5543
|
def secret_arn(self) -> builtins.str:
|
|
5500
|
-
'''Specifies the ARN for
|
|
5544
|
+
'''Specifies the ARN for an AWS Secrets Manager secret.
|
|
5501
5545
|
|
|
5502
5546
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-locationobjectstorage-customsecretconfig.html#cfn-datasync-locationobjectstorage-customsecretconfig-secretarn
|
|
5503
5547
|
'''
|
|
@@ -5525,7 +5569,7 @@ class CfnLocationObjectStorage(
|
|
|
5525
5569
|
def __init__(self, *, secret_arn: builtins.str) -> None:
|
|
5526
5570
|
'''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.
|
|
5527
5571
|
|
|
5528
|
-
DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.
|
|
5572
|
+
DataSync uses the default AWS -managed KMS key to encrypt this secret in AWS Secrets Manager .
|
|
5529
5573
|
|
|
5530
5574
|
:param secret_arn: Specifies the ARN for an AWS Secrets Manager secret.
|
|
5531
5575
|
|
|
@@ -5609,15 +5653,15 @@ class CfnLocationObjectStorageProps:
|
|
|
5609
5653
|
'''Properties for defining a ``CfnLocationObjectStorage``.
|
|
5610
5654
|
|
|
5611
5655
|
:param access_key: Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
|
|
5612
|
-
:param agent_arns: Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.
|
|
5656
|
+
:param agent_arns: (Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter. .. epigraph:: Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.
|
|
5613
5657
|
:param bucket_name: Specifies the name of the object storage bucket involved in the transfer.
|
|
5614
|
-
:param cmk_secret_config: Specifies configuration information for a DataSync-managed secret,
|
|
5615
|
-
:param custom_secret_config: Specifies configuration information for a customer-managed secret
|
|
5616
|
-
:param secret_key: Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
|
|
5658
|
+
:param cmk_secret_config: Specifies configuration information for a DataSync-managed secret, which includes the ``SecretKey`` that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key . When you include this paramater as part of a ``CreateLocationObjectStorage`` request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the ``SecretKey`` parameter to create a DataSync-managed secret to store the location access credentials. Make sure the DataSync has permission to access the KMS key that you specify. .. epigraph:: You can use either ``CmkSecretConfig`` (with ``SecretKey`` ) or ``CustomSecretConfig`` (without ``SecretKey`` ) to provide credentials for a ``CreateLocationObjectStorage`` request. Do not provide both parameters for the same request.
|
|
5659
|
+
:param custom_secret_config: Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. .. epigraph:: You can use either ``CmkSecretConfig`` (with ``SecretKey`` ) or ``CustomSecretConfig`` (without ``SecretKey`` ) to provide credentials for a ``CreateLocationObjectStorage`` request. Do not provide both parameters for the same request.
|
|
5660
|
+
:param secret_key: Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server. .. epigraph:: If you provide a secret using ``SecretKey`` , but do not provide secret configuration details using ``CmkSecretConfig`` or ``CustomSecretConfig`` , then DataSync stores the token using your AWS account's Secrets Manager secret.
|
|
5617
5661
|
:param server_certificate: Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single ``.pem`` file with a full certificate chain (for example, ``file:///home/user/.ssh/object_storage_certificates.pem`` ). The certificate chain might include: - The object storage system's certificate - All intermediate certificates (if there are any) - The root certificate of the signing CA You can concatenate your certificates into a ``.pem`` file (which can be up to 32768 bytes before base64 encoding). The following example ``cat`` command creates an ``object_storage_certificates.pem`` file that includes three certificates: ``cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem`` To use this parameter, configure ``ServerProtocol`` to ``HTTPS`` .
|
|
5618
5662
|
:param server_hostname: Specifies the domain name or IP version 4 (IPv4) address of the object storage server that your DataSync agent connects to.
|
|
5619
5663
|
:param server_port: Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
|
|
5620
|
-
:param server_protocol: Specifies the protocol that your object storage server uses to communicate.
|
|
5664
|
+
:param server_protocol: Specifies the protocol that your object storage server uses to communicate. If not specified, the default value is ``HTTPS`` .
|
|
5621
5665
|
:param subdirectory: Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.
|
|
5622
5666
|
:param tags: Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
|
|
5623
5667
|
|
|
@@ -5705,7 +5749,12 @@ class CfnLocationObjectStorageProps:
|
|
|
5705
5749
|
|
|
5706
5750
|
@builtins.property
|
|
5707
5751
|
def agent_arns(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5708
|
-
'''Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.
|
|
5752
|
+
'''(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system.
|
|
5753
|
+
|
|
5754
|
+
If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
|
|
5755
|
+
.. epigraph::
|
|
5756
|
+
|
|
5757
|
+
Make sure you configure this parameter correctly when you first create your storage location. You cannot add or remove agents from a storage location after you create it.
|
|
5709
5758
|
|
|
5710
5759
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-agentarns
|
|
5711
5760
|
'''
|
|
@@ -5725,7 +5774,14 @@ class CfnLocationObjectStorageProps:
|
|
|
5725
5774
|
def cmk_secret_config(
|
|
5726
5775
|
self,
|
|
5727
5776
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnLocationObjectStorage.CmkSecretConfigProperty]]:
|
|
5728
|
-
'''Specifies configuration information for a DataSync-managed secret,
|
|
5777
|
+
'''Specifies configuration information for a DataSync-managed secret, which includes the ``SecretKey`` that DataSync uses to access a specific object storage location, with a customer-managed AWS KMS key .
|
|
5778
|
+
|
|
5779
|
+
When you include this paramater as part of a ``CreateLocationObjectStorage`` request, you provide only the KMS key ARN. DataSync uses this KMS key together with the value you specify for the ``SecretKey`` parameter to create a DataSync-managed secret to store the location access credentials.
|
|
5780
|
+
|
|
5781
|
+
Make sure the DataSync has permission to access the KMS key that you specify.
|
|
5782
|
+
.. epigraph::
|
|
5783
|
+
|
|
5784
|
+
You can use either ``CmkSecretConfig`` (with ``SecretKey`` ) or ``CustomSecretConfig`` (without ``SecretKey`` ) to provide credentials for a ``CreateLocationObjectStorage`` request. Do not provide both parameters for the same request.
|
|
5729
5785
|
|
|
5730
5786
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-cmksecretconfig
|
|
5731
5787
|
'''
|
|
@@ -5736,7 +5792,12 @@ class CfnLocationObjectStorageProps:
|
|
|
5736
5792
|
def custom_secret_config(
|
|
5737
5793
|
self,
|
|
5738
5794
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnLocationObjectStorage.CustomSecretConfigProperty]]:
|
|
5739
|
-
'''Specifies configuration information for a customer-managed
|
|
5795
|
+
'''Specifies configuration information for a customer-managed Secrets Manager secret where the secret key for a specific object storage location is stored in plain text.
|
|
5796
|
+
|
|
5797
|
+
This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.
|
|
5798
|
+
.. epigraph::
|
|
5799
|
+
|
|
5800
|
+
You can use either ``CmkSecretConfig`` (with ``SecretKey`` ) or ``CustomSecretConfig`` (without ``SecretKey`` ) to provide credentials for a ``CreateLocationObjectStorage`` request. Do not provide both parameters for the same request.
|
|
5740
5801
|
|
|
5741
5802
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-customsecretconfig
|
|
5742
5803
|
'''
|
|
@@ -5747,6 +5808,10 @@ class CfnLocationObjectStorageProps:
|
|
|
5747
5808
|
def secret_key(self) -> typing.Optional[builtins.str]:
|
|
5748
5809
|
'''Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
|
|
5749
5810
|
|
|
5811
|
+
.. epigraph::
|
|
5812
|
+
|
|
5813
|
+
If you provide a secret using ``SecretKey`` , but do not provide secret configuration details using ``CmkSecretConfig`` or ``CustomSecretConfig`` , then DataSync stores the token using your AWS account's Secrets Manager secret.
|
|
5814
|
+
|
|
5750
5815
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-secretkey
|
|
5751
5816
|
'''
|
|
5752
5817
|
result = self._values.get("secret_key")
|
|
@@ -5797,6 +5862,8 @@ class CfnLocationObjectStorageProps:
|
|
|
5797
5862
|
def server_protocol(self) -> typing.Optional[builtins.str]:
|
|
5798
5863
|
'''Specifies the protocol that your object storage server uses to communicate.
|
|
5799
5864
|
|
|
5865
|
+
If not specified, the default value is ``HTTPS`` .
|
|
5866
|
+
|
|
5800
5867
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationobjectstorage.html#cfn-datasync-locationobjectstorage-serverprotocol
|
|
5801
5868
|
'''
|
|
5802
5869
|
result = self._values.get("server_protocol")
|
|
@@ -6306,12 +6373,12 @@ class CfnLocationSMB(
|
|
|
6306
6373
|
:param scope: Scope in which this resource is defined.
|
|
6307
6374
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
6308
6375
|
:param agent_arns: Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
|
|
6309
|
-
:param authentication_type:
|
|
6310
|
-
:param dns_ip_addresses: Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if
|
|
6376
|
+
:param authentication_type: The authentication mode used to determine identity of user.
|
|
6377
|
+
:param dns_ip_addresses: Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
|
|
6311
6378
|
:param domain: Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if ``AuthenticationType`` is set to ``NTLM`` . If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
|
|
6312
|
-
:param kerberos_keytab: Specifies your Kerberos key table (keytab) file, which includes mappings between your
|
|
6313
|
-
:param kerberos_krb5_conf: Specifies a Kerberos configuration file (
|
|
6314
|
-
:param kerberos_principal: Specifies a
|
|
6379
|
+
:param kerberos_keytab: The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
|
|
6380
|
+
:param kerberos_krb5_conf: The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
|
|
6381
|
+
:param kerberos_principal: Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
|
|
6315
6382
|
:param mount_options: Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
|
|
6316
6383
|
:param password: Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if ``AuthenticationType`` is set to ``NTLM`` .
|
|
6317
6384
|
:param server_hostname: Specifies the domain name or IP address of the SMB file server that your DataSync agent connects to. Remember the following when configuring this parameter: - You can't specify an IP version 6 (IPv6) address. - If you're using Kerberos authentication, you must specify a domain name.
|
|
@@ -6416,7 +6483,7 @@ class CfnLocationSMB(
|
|
|
6416
6483
|
@builtins.property
|
|
6417
6484
|
@jsii.member(jsii_name="authenticationType")
|
|
6418
6485
|
def authentication_type(self) -> typing.Optional[builtins.str]:
|
|
6419
|
-
'''
|
|
6486
|
+
'''The authentication mode used to determine identity of user.'''
|
|
6420
6487
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "authenticationType"))
|
|
6421
6488
|
|
|
6422
6489
|
@authentication_type.setter
|
|
@@ -6458,7 +6525,7 @@ class CfnLocationSMB(
|
|
|
6458
6525
|
@builtins.property
|
|
6459
6526
|
@jsii.member(jsii_name="kerberosKeytab")
|
|
6460
6527
|
def kerberos_keytab(self) -> typing.Optional[builtins.str]:
|
|
6461
|
-
'''
|
|
6528
|
+
'''The Base64 string representation of the Keytab file.'''
|
|
6462
6529
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "kerberosKeytab"))
|
|
6463
6530
|
|
|
6464
6531
|
@kerberos_keytab.setter
|
|
@@ -6471,7 +6538,7 @@ class CfnLocationSMB(
|
|
|
6471
6538
|
@builtins.property
|
|
6472
6539
|
@jsii.member(jsii_name="kerberosKrb5Conf")
|
|
6473
6540
|
def kerberos_krb5_conf(self) -> typing.Optional[builtins.str]:
|
|
6474
|
-
'''Specifies a Kerberos configuration file (
|
|
6541
|
+
'''The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.'''
|
|
6475
6542
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "kerberosKrb5Conf"))
|
|
6476
6543
|
|
|
6477
6544
|
@kerberos_krb5_conf.setter
|
|
@@ -6484,7 +6551,7 @@ class CfnLocationSMB(
|
|
|
6484
6551
|
@builtins.property
|
|
6485
6552
|
@jsii.member(jsii_name="kerberosPrincipal")
|
|
6486
6553
|
def kerberos_principal(self) -> typing.Optional[builtins.str]:
|
|
6487
|
-
'''Specifies a
|
|
6554
|
+
'''Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.'''
|
|
6488
6555
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "kerberosPrincipal"))
|
|
6489
6556
|
|
|
6490
6557
|
@kerberos_principal.setter
|
|
@@ -6686,12 +6753,12 @@ class CfnLocationSMBProps:
|
|
|
6686
6753
|
'''Properties for defining a ``CfnLocationSMB``.
|
|
6687
6754
|
|
|
6688
6755
|
:param agent_arns: Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
|
|
6689
|
-
:param authentication_type:
|
|
6690
|
-
:param dns_ip_addresses: Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if
|
|
6756
|
+
:param authentication_type: The authentication mode used to determine identity of user.
|
|
6757
|
+
:param dns_ip_addresses: Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
|
|
6691
6758
|
:param domain: Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if ``AuthenticationType`` is set to ``NTLM`` . If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
|
|
6692
|
-
:param kerberos_keytab: Specifies your Kerberos key table (keytab) file, which includes mappings between your
|
|
6693
|
-
:param kerberos_krb5_conf: Specifies a Kerberos configuration file (
|
|
6694
|
-
:param kerberos_principal: Specifies a
|
|
6759
|
+
:param kerberos_keytab: The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
|
|
6760
|
+
:param kerberos_krb5_conf: The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
|
|
6761
|
+
:param kerberos_principal: Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
|
|
6695
6762
|
:param mount_options: Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
|
|
6696
6763
|
:param password: Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if ``AuthenticationType`` is set to ``NTLM`` .
|
|
6697
6764
|
:param server_hostname: Specifies the domain name or IP address of the SMB file server that your DataSync agent connects to. Remember the following when configuring this parameter: - You can't specify an IP version 6 (IPv6) address. - If you're using Kerberos authentication, you must specify a domain name.
|
|
@@ -6788,11 +6855,7 @@ class CfnLocationSMBProps:
|
|
|
6788
6855
|
|
|
6789
6856
|
@builtins.property
|
|
6790
6857
|
def authentication_type(self) -> typing.Optional[builtins.str]:
|
|
6791
|
-
'''
|
|
6792
|
-
|
|
6793
|
-
DataSync supports ``NTLM`` (default) and ``KERBEROS`` authentication.
|
|
6794
|
-
|
|
6795
|
-
For more information, see `Providing DataSync access to SMB file servers <https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions>`_ .
|
|
6858
|
+
'''The authentication mode used to determine identity of user.
|
|
6796
6859
|
|
|
6797
6860
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-authenticationtype
|
|
6798
6861
|
'''
|
|
@@ -6803,9 +6866,7 @@ class CfnLocationSMBProps:
|
|
|
6803
6866
|
def dns_ip_addresses(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
6804
6867
|
'''Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.
|
|
6805
6868
|
|
|
6806
|
-
This parameter applies only if
|
|
6807
|
-
|
|
6808
|
-
If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
|
|
6869
|
+
This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
|
|
6809
6870
|
|
|
6810
6871
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-dnsipaddresses
|
|
6811
6872
|
'''
|
|
@@ -6827,11 +6888,9 @@ class CfnLocationSMBProps:
|
|
|
6827
6888
|
|
|
6828
6889
|
@builtins.property
|
|
6829
6890
|
def kerberos_keytab(self) -> typing.Optional[builtins.str]:
|
|
6830
|
-
'''
|
|
6891
|
+
'''The Base64 string representation of the Keytab file.
|
|
6831
6892
|
|
|
6832
|
-
|
|
6833
|
-
|
|
6834
|
-
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for ``KerberosPrincipal`` .
|
|
6893
|
+
Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
|
|
6835
6894
|
|
|
6836
6895
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-kerberoskeytab
|
|
6837
6896
|
'''
|
|
@@ -6840,9 +6899,7 @@ class CfnLocationSMBProps:
|
|
|
6840
6899
|
|
|
6841
6900
|
@builtins.property
|
|
6842
6901
|
def kerberos_krb5_conf(self) -> typing.Optional[builtins.str]:
|
|
6843
|
-
'''Specifies a Kerberos configuration file (
|
|
6844
|
-
|
|
6845
|
-
The file must be base64 encoded.
|
|
6902
|
+
'''The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
|
|
6846
6903
|
|
|
6847
6904
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-kerberoskrb5conf
|
|
6848
6905
|
'''
|
|
@@ -6851,11 +6908,9 @@ class CfnLocationSMBProps:
|
|
|
6851
6908
|
|
|
6852
6909
|
@builtins.property
|
|
6853
6910
|
def kerberos_principal(self) -> typing.Optional[builtins.str]:
|
|
6854
|
-
'''Specifies a
|
|
6911
|
+
'''Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.
|
|
6855
6912
|
|
|
6856
|
-
|
|
6857
|
-
|
|
6858
|
-
Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.
|
|
6913
|
+
SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
|
|
6859
6914
|
|
|
6860
6915
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html#cfn-datasync-locationsmb-kerberosprincipal
|
|
6861
6916
|
'''
|
|
@@ -7084,8 +7139,8 @@ class CfnTask(
|
|
|
7084
7139
|
:param options: Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
|
|
7085
7140
|
:param schedule: Specifies a schedule for when you want your task to run. For more information, see `Scheduling your task <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html>`_ .
|
|
7086
7141
|
:param tags: Specifies the tags that you want to apply to your task. *Tags* are key-value pairs that help you manage, filter, and search for your DataSync resources.
|
|
7087
|
-
:param task_mode:
|
|
7088
|
-
:param task_report_config:
|
|
7142
|
+
:param task_mode: The task mode that you're using. For more information, see `Choosing a task mode for your data transfer <https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html>`_ .
|
|
7143
|
+
:param task_report_config: The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see `Monitoring your DataSync transfers with task reports <https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html>`_ .
|
|
7089
7144
|
'''
|
|
7090
7145
|
if __debug__:
|
|
7091
7146
|
type_hints = typing.get_type_hints(_typecheckingstub__9add9673a1f0ceb078949e967bce91066ff7e0441dae95d55c11c4a503a397a6)
|
|
@@ -7343,7 +7398,7 @@ class CfnTask(
|
|
|
7343
7398
|
@builtins.property
|
|
7344
7399
|
@jsii.member(jsii_name="taskMode")
|
|
7345
7400
|
def task_mode(self) -> typing.Optional[builtins.str]:
|
|
7346
|
-
'''
|
|
7401
|
+
'''The task mode that you're using.'''
|
|
7347
7402
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "taskMode"))
|
|
7348
7403
|
|
|
7349
7404
|
@task_mode.setter
|
|
@@ -7358,7 +7413,7 @@ class CfnTask(
|
|
|
7358
7413
|
def task_report_config(
|
|
7359
7414
|
self,
|
|
7360
7415
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.TaskReportConfigProperty"]]:
|
|
7361
|
-
'''
|
|
7416
|
+
'''The configuration of your task report, which provides detailed information about your DataSync transfer.'''
|
|
7362
7417
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.TaskReportConfigProperty"]], jsii.get(self, "taskReportConfig"))
|
|
7363
7418
|
|
|
7364
7419
|
@task_report_config.setter
|
|
@@ -7382,9 +7437,11 @@ class CfnTask(
|
|
|
7382
7437
|
*,
|
|
7383
7438
|
report_level: typing.Optional[builtins.str] = None,
|
|
7384
7439
|
) -> None:
|
|
7385
|
-
'''
|
|
7440
|
+
'''Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location.
|
|
7441
|
+
|
|
7442
|
+
This only applies if you configure your task to delete data in the destination that isn't in the source.
|
|
7386
7443
|
|
|
7387
|
-
:param 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.
|
|
7444
|
+
:param 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.
|
|
7388
7445
|
|
|
7389
7446
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-deleted.html
|
|
7390
7447
|
:exampleMetadata: fixture=_generated
|
|
@@ -7410,9 +7467,6 @@ class CfnTask(
|
|
|
7410
7467
|
def report_level(self) -> typing.Optional[builtins.str]:
|
|
7411
7468
|
'''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.
|
|
7412
7469
|
|
|
7413
|
-
- ``ERRORS_ONLY`` : A report shows what DataSync was unable to delete.
|
|
7414
|
-
- ``SUCCESSES_AND_ERRORS`` : A report shows what DataSync was able and unable to delete.
|
|
7415
|
-
|
|
7416
7470
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-deleted.html#cfn-datasync-task-deleted-reportlevel
|
|
7417
7471
|
'''
|
|
7418
7472
|
result = self._values.get("report_level")
|
|
@@ -7440,7 +7494,7 @@ class CfnTask(
|
|
|
7440
7494
|
*,
|
|
7441
7495
|
s3: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnTask.S3Property", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
7442
7496
|
) -> None:
|
|
7443
|
-
'''Specifies where DataSync uploads your
|
|
7497
|
+
'''Specifies where DataSync uploads your task report.
|
|
7444
7498
|
|
|
7445
7499
|
:param s3: Specifies the Amazon S3 bucket where DataSync uploads your task report.
|
|
7446
7500
|
|
|
@@ -7692,11 +7746,9 @@ class CfnTask(
|
|
|
7692
7746
|
) -> None:
|
|
7693
7747
|
'''Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.
|
|
7694
7748
|
|
|
7695
|
-
|
|
7696
|
-
|
|
7697
|
-
:param
|
|
7698
|
-
:param manifest_object_path: Specifies the Amazon S3 object key of your manifest. This can include a prefix (for example, ``prefix/my-manifest.csv`` ).
|
|
7699
|
-
:param manifest_object_version_id: Specifies the object version ID of the manifest that you want DataSync to use. If you don't set this, DataSync uses the latest version of the object.
|
|
7749
|
+
:param bucket_access_role_arn: Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
|
|
7750
|
+
:param manifest_object_path: Specifies the Amazon S3 object key of your manifest.
|
|
7751
|
+
:param manifest_object_version_id: Specifies the object version ID of the manifest that you want DataSync to use.
|
|
7700
7752
|
:param s3_bucket_arn: Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
|
|
7701
7753
|
|
|
7702
7754
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html
|
|
@@ -7735,8 +7787,6 @@ class CfnTask(
|
|
|
7735
7787
|
def bucket_access_role_arn(self) -> typing.Optional[builtins.str]:
|
|
7736
7788
|
'''Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest.
|
|
7737
7789
|
|
|
7738
|
-
For more information, see `Providing DataSync access to your manifest <https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access>`_ .
|
|
7739
|
-
|
|
7740
7790
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html#cfn-datasync-task-manifestconfigsources3-bucketaccessrolearn
|
|
7741
7791
|
'''
|
|
7742
7792
|
result = self._values.get("bucket_access_role_arn")
|
|
@@ -7746,8 +7796,6 @@ class CfnTask(
|
|
|
7746
7796
|
def manifest_object_path(self) -> typing.Optional[builtins.str]:
|
|
7747
7797
|
'''Specifies the Amazon S3 object key of your manifest.
|
|
7748
7798
|
|
|
7749
|
-
This can include a prefix (for example, ``prefix/my-manifest.csv`` ).
|
|
7750
|
-
|
|
7751
7799
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html#cfn-datasync-task-manifestconfigsources3-manifestobjectpath
|
|
7752
7800
|
'''
|
|
7753
7801
|
result = self._values.get("manifest_object_path")
|
|
@@ -7757,8 +7805,6 @@ class CfnTask(
|
|
|
7757
7805
|
def manifest_object_version_id(self) -> typing.Optional[builtins.str]:
|
|
7758
7806
|
'''Specifies the object version ID of the manifest that you want DataSync to use.
|
|
7759
7807
|
|
|
7760
|
-
If you don't set this, DataSync uses the latest version of the object.
|
|
7761
|
-
|
|
7762
7808
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-manifestconfigsources3.html#cfn-datasync-task-manifestconfigsources3-manifestobjectversionid
|
|
7763
7809
|
'''
|
|
7764
7810
|
result = self._values.get("manifest_object_version_id")
|
|
@@ -8211,12 +8257,12 @@ class CfnTask(
|
|
|
8211
8257
|
) -> None:
|
|
8212
8258
|
'''Customizes the reporting level for aspects of your task report.
|
|
8213
8259
|
|
|
8214
|
-
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
|
|
8260
|
+
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.
|
|
8215
8261
|
|
|
8216
|
-
:param deleted: Specifies the level of reporting for the files, objects, and directories that
|
|
8217
|
-
:param skipped: Specifies the level of reporting for the files, objects, and directories that
|
|
8218
|
-
:param transferred: Specifies the level of reporting for the files, objects, and directories that
|
|
8219
|
-
:param verified: Specifies the level of reporting for the files, objects, and directories that
|
|
8262
|
+
:param 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.
|
|
8263
|
+
:param skipped: Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
|
|
8264
|
+
:param transferred: Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
|
|
8265
|
+
:param 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)
|
|
8220
8266
|
|
|
8221
8267
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html
|
|
8222
8268
|
:exampleMetadata: fixture=_generated
|
|
@@ -8262,9 +8308,9 @@ class CfnTask(
|
|
|
8262
8308
|
def deleted(
|
|
8263
8309
|
self,
|
|
8264
8310
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.DeletedProperty"]]:
|
|
8265
|
-
'''Specifies the level of reporting for the files, objects, and directories that
|
|
8311
|
+
'''Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location.
|
|
8266
8312
|
|
|
8267
|
-
This only applies if you
|
|
8313
|
+
This only applies if you configure your task to delete data in the destination that isn't in the source.
|
|
8268
8314
|
|
|
8269
8315
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-deleted
|
|
8270
8316
|
'''
|
|
@@ -8275,7 +8321,7 @@ class CfnTask(
|
|
|
8275
8321
|
def skipped(
|
|
8276
8322
|
self,
|
|
8277
8323
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.SkippedProperty"]]:
|
|
8278
|
-
'''Specifies the level of reporting for the files, objects, and directories that
|
|
8324
|
+
'''Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
|
|
8279
8325
|
|
|
8280
8326
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-skipped
|
|
8281
8327
|
'''
|
|
@@ -8286,7 +8332,7 @@ class CfnTask(
|
|
|
8286
8332
|
def transferred(
|
|
8287
8333
|
self,
|
|
8288
8334
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.TransferredProperty"]]:
|
|
8289
|
-
'''Specifies the level of reporting for the files, objects, and directories that
|
|
8335
|
+
'''Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
|
|
8290
8336
|
|
|
8291
8337
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-transferred
|
|
8292
8338
|
'''
|
|
@@ -8297,7 +8343,9 @@ class CfnTask(
|
|
|
8297
8343
|
def verified(
|
|
8298
8344
|
self,
|
|
8299
8345
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.VerifiedProperty"]]:
|
|
8300
|
-
'''Specifies the level of reporting for the files, objects, and directories that
|
|
8346
|
+
'''Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer.
|
|
8347
|
+
|
|
8348
|
+
This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)
|
|
8301
8349
|
|
|
8302
8350
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-overrides.html#cfn-datasync-task-overrides-verified
|
|
8303
8351
|
'''
|
|
@@ -8411,9 +8459,9 @@ class CfnTask(
|
|
|
8411
8459
|
*,
|
|
8412
8460
|
report_level: typing.Optional[builtins.str] = None,
|
|
8413
8461
|
) -> None:
|
|
8414
|
-
'''
|
|
8462
|
+
'''Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
|
|
8415
8463
|
|
|
8416
|
-
:param 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.
|
|
8464
|
+
:param 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.
|
|
8417
8465
|
|
|
8418
8466
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-skipped.html
|
|
8419
8467
|
:exampleMetadata: fixture=_generated
|
|
@@ -8439,9 +8487,6 @@ class CfnTask(
|
|
|
8439
8487
|
def report_level(self) -> typing.Optional[builtins.str]:
|
|
8440
8488
|
'''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.
|
|
8441
8489
|
|
|
8442
|
-
- ``ERRORS_ONLY`` : A report shows what DataSync was unable to skip.
|
|
8443
|
-
- ``SUCCESSES_AND_ERRORS`` : A report shows what DataSync was able and unable to skip.
|
|
8444
|
-
|
|
8445
8490
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-skipped.html#cfn-datasync-task-skipped-reportlevel
|
|
8446
8491
|
'''
|
|
8447
8492
|
result = self._values.get("report_level")
|
|
@@ -8469,11 +8514,9 @@ class CfnTask(
|
|
|
8469
8514
|
*,
|
|
8470
8515
|
s3: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnTask.ManifestConfigSourceS3Property", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
8471
8516
|
) -> None:
|
|
8472
|
-
'''Specifies the manifest that you want
|
|
8473
|
-
|
|
8474
|
-
For more information and configuration examples, see `Specifying what DataSync transfers by using a manifest <https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html>`_ .
|
|
8517
|
+
'''Specifies the manifest that you want DataSync to use and where it's hosted.
|
|
8475
8518
|
|
|
8476
|
-
:param s3: Specifies the S3 bucket where you're hosting
|
|
8519
|
+
:param s3: Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.
|
|
8477
8520
|
|
|
8478
8521
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-source.html
|
|
8479
8522
|
:exampleMetadata: fixture=_generated
|
|
@@ -8504,7 +8547,7 @@ class CfnTask(
|
|
|
8504
8547
|
def s3(
|
|
8505
8548
|
self,
|
|
8506
8549
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTask.ManifestConfigSourceS3Property"]]:
|
|
8507
|
-
'''Specifies the S3 bucket where you're hosting
|
|
8550
|
+
'''Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.
|
|
8508
8551
|
|
|
8509
8552
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-source.html#cfn-datasync-task-source-s3
|
|
8510
8553
|
'''
|
|
@@ -8698,7 +8741,7 @@ class CfnTask(
|
|
|
8698
8741
|
'''Configures your AWS DataSync task to run on a `schedule <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html>`_ (at a minimum interval of 1 hour).
|
|
8699
8742
|
|
|
8700
8743
|
:param 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* <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html>`_ .
|
|
8701
|
-
:param 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
|
|
8744
|
+
:param 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 <https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html>`_ .
|
|
8702
8745
|
|
|
8703
8746
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html
|
|
8704
8747
|
:exampleMetadata: fixture=_generated
|
|
@@ -8747,9 +8790,9 @@ class CfnTask(
|
|
|
8747
8790
|
def status(self) -> typing.Optional[builtins.str]:
|
|
8748
8791
|
'''Specifies whether to enable or disable your task schedule.
|
|
8749
8792
|
|
|
8750
|
-
Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to
|
|
8793
|
+
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.
|
|
8751
8794
|
|
|
8752
|
-
DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see
|
|
8795
|
+
DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see `TaskScheduleDetails <https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html>`_ .
|
|
8753
8796
|
|
|
8754
8797
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-taskschedule.html#cfn-datasync-task-taskschedule-status
|
|
8755
8798
|
'''
|
|
@@ -8778,9 +8821,9 @@ class CfnTask(
|
|
|
8778
8821
|
*,
|
|
8779
8822
|
report_level: typing.Optional[builtins.str] = None,
|
|
8780
8823
|
) -> None:
|
|
8781
|
-
'''
|
|
8824
|
+
'''Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
|
|
8782
8825
|
|
|
8783
|
-
:param 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.
|
|
8826
|
+
:param 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.
|
|
8784
8827
|
|
|
8785
8828
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-transferred.html
|
|
8786
8829
|
:exampleMetadata: fixture=_generated
|
|
@@ -8806,9 +8849,6 @@ class CfnTask(
|
|
|
8806
8849
|
def report_level(self) -> typing.Optional[builtins.str]:
|
|
8807
8850
|
'''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.
|
|
8808
8851
|
|
|
8809
|
-
- ``ERRORS_ONLY`` : A report shows what DataSync was unable to transfer.
|
|
8810
|
-
- ``SUCCESSES_AND_ERRORS`` : A report shows what DataSync was able and unable to transfer.
|
|
8811
|
-
|
|
8812
8852
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-transferred.html#cfn-datasync-task-transferred-reportlevel
|
|
8813
8853
|
'''
|
|
8814
8854
|
result = self._values.get("report_level")
|
|
@@ -8836,9 +8876,11 @@ class CfnTask(
|
|
|
8836
8876
|
*,
|
|
8837
8877
|
report_level: typing.Optional[builtins.str] = None,
|
|
8838
8878
|
) -> None:
|
|
8839
|
-
'''
|
|
8879
|
+
'''Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer.
|
|
8880
|
+
|
|
8881
|
+
This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)
|
|
8840
8882
|
|
|
8841
|
-
:param 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.
|
|
8883
|
+
:param 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.
|
|
8842
8884
|
|
|
8843
8885
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-verified.html
|
|
8844
8886
|
:exampleMetadata: fixture=_generated
|
|
@@ -8864,9 +8906,6 @@ class CfnTask(
|
|
|
8864
8906
|
def report_level(self) -> typing.Optional[builtins.str]:
|
|
8865
8907
|
'''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.
|
|
8866
8908
|
|
|
8867
|
-
- ``ERRORS_ONLY`` : A report shows what DataSync was unable to verify.
|
|
8868
|
-
- ``SUCCESSES_AND_ERRORS`` : A report shows what DataSync was able and unable to verify.
|
|
8869
|
-
|
|
8870
8909
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datasync-task-verified.html#cfn-datasync-task-verified-reportlevel
|
|
8871
8910
|
'''
|
|
8872
8911
|
result = self._values.get("report_level")
|
|
@@ -8931,8 +8970,8 @@ class CfnTaskProps:
|
|
|
8931
8970
|
:param options: Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
|
|
8932
8971
|
:param schedule: Specifies a schedule for when you want your task to run. For more information, see `Scheduling your task <https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html>`_ .
|
|
8933
8972
|
:param tags: Specifies the tags that you want to apply to your task. *Tags* are key-value pairs that help you manage, filter, and search for your DataSync resources.
|
|
8934
|
-
:param task_mode:
|
|
8935
|
-
:param task_report_config:
|
|
8973
|
+
:param task_mode: The task mode that you're using. For more information, see `Choosing a task mode for your data transfer <https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html>`_ .
|
|
8974
|
+
:param task_report_config: The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see `Monitoring your DataSync transfers with task reports <https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html>`_ .
|
|
8936
8975
|
|
|
8937
8976
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html
|
|
8938
8977
|
:exampleMetadata: fixture=_generated
|
|
@@ -9185,17 +9224,9 @@ class CfnTaskProps:
|
|
|
9185
9224
|
|
|
9186
9225
|
@builtins.property
|
|
9187
9226
|
def task_mode(self) -> typing.Optional[builtins.str]:
|
|
9188
|
-
'''
|
|
9227
|
+
'''The task mode that you're using.
|
|
9189
9228
|
|
|
9190
|
-
|
|
9191
|
-
|
|
9192
|
-
.. epigraph::
|
|
9193
|
-
|
|
9194
|
-
To create an Enhanced mode task, the IAM role that you use to call the ``CreateTask`` operation must have the ``iam:CreateServiceLinkedRole`` permission.
|
|
9195
|
-
|
|
9196
|
-
- ``BASIC`` (default) - Transfer files or objects between AWS storage and all other supported DataSync locations. Basic mode tasks are subject to `quotas <https://docs.aws.amazon.com/datasync/latest/userguide/datasync-limits.html>`_ on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.
|
|
9197
|
-
|
|
9198
|
-
For more information, see `Understanding task mode differences <https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences>`_ .
|
|
9229
|
+
For more information, see `Choosing a task mode for your data transfer <https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html>`_ .
|
|
9199
9230
|
|
|
9200
9231
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskmode
|
|
9201
9232
|
'''
|
|
@@ -9206,12 +9237,10 @@ class CfnTaskProps:
|
|
|
9206
9237
|
def task_report_config(
|
|
9207
9238
|
self,
|
|
9208
9239
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnTask.TaskReportConfigProperty]]:
|
|
9209
|
-
'''
|
|
9240
|
+
'''The configuration of your task report, which provides detailed information about your DataSync transfer.
|
|
9210
9241
|
|
|
9211
9242
|
For more information, see `Monitoring your DataSync transfers with task reports <https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html>`_ .
|
|
9212
9243
|
|
|
9213
|
-
When using this parameter, your caller identity (the role that you're using DataSync with) must have the ``iam:PassRole`` permission. The `AWSDataSyncFullAccess <https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess>`_ policy includes this permission.
|
|
9214
|
-
|
|
9215
9244
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-task.html#cfn-datasync-task-taskreportconfig
|
|
9216
9245
|
'''
|
|
9217
9246
|
result = self._values.get("task_report_config")
|