This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS DataSync **Resource types** + [AWS::DataSync::Agent](aws-resource-datasync-agent.md) + [AWS::DataSync::LocationAzureBlob](aws-resource-datasync-locationazureblob.md) + [AWS::DataSync::LocationEFS](aws-resource-datasync-locationefs.md) + [AWS::DataSync::LocationFSxLustre](aws-resource-datasync-locationfsxlustre.md) + [AWS::DataSync::LocationFSxONTAP](aws-resource-datasync-locationfsxontap.md) + [AWS::DataSync::LocationFSxOpenZFS](aws-resource-datasync-locationfsxopenzfs.md) + [AWS::DataSync::LocationFSxWindows](aws-resource-datasync-locationfsxwindows.md) + [AWS::DataSync::LocationHDFS](aws-resource-datasync-locationhdfs.md) + [AWS::DataSync::LocationNFS](aws-resource-datasync-locationnfs.md) + [AWS::DataSync::LocationObjectStorage](aws-resource-datasync-locationobjectstorage.md) + [AWS::DataSync::LocationS3](aws-resource-datasync-locations3.md) + [AWS::DataSync::LocationSMB](aws-resource-datasync-locationsmb.md) + [AWS::DataSync::Task](aws-resource-datasync-task.md) # AWS::DataSync::Agent The `AWS::DataSync::Agent` resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers. The activation process associates the agent with your AWS account. For more information, see the following topics in the *AWS DataSync User Guide*: + [DataSync agent requirements](https://docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html) + [DataSync network requirements](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html) + [Create a DataSync agent](https://docs.aws.amazon.com/datasync/latest/userguide/configure-agent.html) ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::Agent", "Properties" : { "[ActivationKey](#cfn-datasync-agent-activationkey)" : String, "[AgentName](#cfn-datasync-agent-agentname)" : String, "[SecurityGroupArns](#cfn-datasync-agent-securitygrouparns)" : [ String, ... ], "[SubnetArns](#cfn-datasync-agent-subnetarns)" : [ String, ... ], "[Tags](#cfn-datasync-agent-tags)" : [ Tag, ... ], "[VpcEndpointId](#cfn-datasync-agent-vpcendpointid)" : String } } ``` ### YAML ``` Type: AWS::DataSync::Agent Properties: [ActivationKey](#cfn-datasync-agent-activationkey): String [AgentName](#cfn-datasync-agent-agentname): String [SecurityGroupArns](#cfn-datasync-agent-securitygrouparns): - String [SubnetArns](#cfn-datasync-agent-subnetarns): - String [Tags](#cfn-datasync-agent-tags): - Tag [VpcEndpointId](#cfn-datasync-agent-vpcendpointid): String ``` ## Properties `ActivationKey` Specifies your DataSync agent's activation key. If you don't have an activation key, see [Activating your agent](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html). *Required*: No *Type*: String *Pattern*: `[A-Z0-9]{5}(-[A-Z0-9]{5}){4}` *Maximum*: `29` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `AgentName` Specifies a name for your agent. We recommend specifying a name that you can remember. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecurityGroupArns` The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets. See [SecurityGroupArns](https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns). *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$` *Required*: No *Type*: Array of String *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SubnetArns` Specifies the ARN of the subnet where your VPC service endpoint is located. You can only specify one ARN. *Required*: No *Type*: Array of String *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least one tag for your agent. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-agent-tag.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VpcEndpointId` The ID of the virtual private cloud (VPC) endpoint that the agent has access to. This is the client-side VPC endpoint, powered by AWS PrivateLink. If you don't have an AWS PrivateLink VPC endpoint, see [AWS PrivateLink and VPC endpoints](https://docs.aws.amazon.com//vpc/latest/userguide/endpoint-services-overview.html) in the *Amazon VPC User Guide*. For more information about activating your agent in a private network based on a VPC, see [Using AWS DataSync in a Virtual Private Cloud](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-in-vpc.html) in the *AWS DataSync User Guide.* A VPC endpoint ID looks like this: `vpce-01234d5aff67890e1`. *Required*: No *Type*: String *Pattern*: `^vpce-[0-9a-f]{17}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the agent Amazon Resource Name (ARN). For example: `arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). #### `AgentArn` The Amazon Resource Name (ARN) of the agent. Use the `ListAgents` operation to return a list of agents for your account and AWS Region. `EndpointType` The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet. ## Examples ### DataSync Agent The following example specifies a DataSync agent named `MyAgent`. The agent activation key is included in the template. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Specifies a DataSync agent", "Resources": { "Agent": { "Type": "AWS::DataSync::Agent", "Properties": { "ActivationKey": "AAAAA-7AAAA-GG7MC-3I9R3-27COD", "AgentName": "MyAgent" } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Specifies a DataSync agent Resources: Agent: Type: AWS::DataSync::Agent Properties: ActivationKey: AAAAA-7AAAA-GG7MC-3I9R3-27COD AgentName: MyAgent ``` # AWS::DataSync::Agent Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::Agent](aws-resource-datasync-agent.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-agent-tag-key)" : String, "[Value](#cfn-datasync-agent-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-agent-tag-key): String [Value](#cfn-datasync-agent-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationAzureBlob Creates a transfer *location* for a Microsoft Azure Blob Storage container. 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. 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). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::LocationAzureBlob", "Properties" : { "[AgentArns](#cfn-datasync-locationazureblob-agentarns)" : [ String, ... ], "[AzureAccessTier](#cfn-datasync-locationazureblob-azureaccesstier)" : String, "[AzureBlobAuthenticationType](#cfn-datasync-locationazureblob-azureblobauthenticationtype)" : String, "[AzureBlobContainerUrl](#cfn-datasync-locationazureblob-azureblobcontainerurl)" : String, "[AzureBlobSasConfiguration](#cfn-datasync-locationazureblob-azureblobsasconfiguration)" : AzureBlobSasConfiguration, "[AzureBlobType](#cfn-datasync-locationazureblob-azureblobtype)" : String, "[CmkSecretConfig](#cfn-datasync-locationazureblob-cmksecretconfig)" : CmkSecretConfig, "[CustomSecretConfig](#cfn-datasync-locationazureblob-customsecretconfig)" : CustomSecretConfig, "[Subdirectory](#cfn-datasync-locationazureblob-subdirectory)" : String, "[Tags](#cfn-datasync-locationazureblob-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataSync::LocationAzureBlob Properties: [AgentArns](#cfn-datasync-locationazureblob-agentarns): - String [AzureAccessTier](#cfn-datasync-locationazureblob-azureaccesstier): String [AzureBlobAuthenticationType](#cfn-datasync-locationazureblob-azureblobauthenticationtype): String [AzureBlobContainerUrl](#cfn-datasync-locationazureblob-azureblobcontainerurl): String [AzureBlobSasConfiguration](#cfn-datasync-locationazureblob-azureblobsasconfiguration): AzureBlobSasConfiguration [AzureBlobType](#cfn-datasync-locationazureblob-azureblobtype): String [CmkSecretConfig](#cfn-datasync-locationazureblob-cmksecretconfig): CmkSecretConfig [CustomSecretConfig](#cfn-datasync-locationazureblob-customsecretconfig): CustomSecretConfig [Subdirectory](#cfn-datasync-locationazureblob-subdirectory): String [Tags](#cfn-datasync-locationazureblob-tags): - Tag ``` ## Properties `AgentArns` (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). 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. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `128 | 4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AzureAccessTier` 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). *Required*: No *Type*: String *Allowed values*: `HOT | COOL | ARCHIVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AzureBlobAuthenticationType` Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS). *Required*: Yes *Type*: String *Allowed values*: `SAS | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AzureBlobContainerUrl` Specifies the URL of the Azure Blob Storage container involved in your transfer. *Required*: No *Type*: String *Pattern*: `^https://[A-Za-z0-9]((.|-+)?[A-Za-z0-9]){0,252}/[a-z0-9](-?[a-z0-9]){2,62}$` *Maximum*: `325` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `AzureBlobSasConfiguration` Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage. 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. *Required*: No *Type*: [AzureBlobSasConfiguration](aws-properties-datasync-locationazureblob-azureblobsasconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AzureBlobType` 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://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs). *Required*: No *Type*: String *Allowed values*: `BLOCK` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CmkSecretConfig` Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key. You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. *Required*: No *Type*: [CmkSecretConfig](aws-properties-datasync-locationazureblob-cmksecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomSecretConfig` Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. *Required*: No *Type*: [CustomSecretConfig](aws-properties-datasync-locationazureblob-customsecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Subdirectory` Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, `/my/images`). *Required*: No *Type*: String *Pattern*: `^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-locationazureblob-tag.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example: `arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CmkSecretConfig.SecretArn` Property description not available. `LocationArn` The ARN of the Azure Blob Storage transfer location that you created. `LocationUri` The URI of the Azure Blob Storage transfer location that you created. # AWS::DataSync::LocationAzureBlob AzureBlobSasConfiguration The shared access signature (SAS) configuration that allows AWS DataSync to access your Microsoft Azure Blob Storage. For more information, see [SAS tokens](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-sas-tokens) for accessing your Azure Blob Storage. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AzureBlobSasToken](#cfn-datasync-locationazureblob-azureblobsasconfiguration-azureblobsastoken)" : String } ``` ### YAML ``` [AzureBlobSasToken](#cfn-datasync-locationazureblob-azureblobsasconfiguration-azureblobsastoken): String ``` ## Properties `AzureBlobSasToken` Specifies a SAS token that provides permissions to access your Azure Blob Storage. The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this: `sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D` *Required*: Yes *Type*: String *Pattern*: `(^.+$)` *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationAzureBlob CmkSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KmsKeyArn](#cfn-datasync-locationazureblob-cmksecretconfig-kmskeyarn)" : String, "[SecretArn](#cfn-datasync-locationazureblob-cmksecretconfig-secretarn)" : String } ``` ### YAML ``` [KmsKeyArn](#cfn-datasync-locationazureblob-cmksecretconfig-kmskeyarn): String [SecretArn](#cfn-datasync-locationazureblob-cmksecretconfig-secretarn): String ``` ## Properties `KmsKeyArn` 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. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z-0-9]+:[0-9]{12}:key/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` 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`. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationAzureBlob CustomSecretConfig Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretAccessRoleArn](#cfn-datasync-locationazureblob-customsecretconfig-secretaccessrolearn)" : String, "[SecretArn](#cfn-datasync-locationazureblob-customsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretAccessRoleArn](#cfn-datasync-locationazureblob-customsecretconfig-secretaccessrolearn): String [SecretArn](#cfn-datasync-locationazureblob-customsecretconfig-secretarn): String ``` ## Properties `SecretAccessRoleArn` Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for `SecretArn`. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationAzureBlob ManagedSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretArn](#cfn-datasync-locationazureblob-managedsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretArn](#cfn-datasync-locationazureblob-managedsecretconfig-secretarn): String ``` ## Properties `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationAzureBlob Tag 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-locationazureblob-tag-key)" : String, "[Value](#cfn-datasync-locationazureblob-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-locationazureblob-tag-key): String [Value](#cfn-datasync-locationazureblob-tag-value): String ``` ## Properties `Key` The key for an AWS resource tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value for an AWS resource tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationEFS The `AWS::DataSync::LocationEFS` resource creates an endpoint for an Amazon EFS file system. AWS DataSync can access this endpoint as a source or destination location. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::LocationEFS", "Properties" : { "[AccessPointArn](#cfn-datasync-locationefs-accesspointarn)" : String, "[Ec2Config](#cfn-datasync-locationefs-ec2config)" : Ec2Config, "[EfsFilesystemArn](#cfn-datasync-locationefs-efsfilesystemarn)" : String, "[FileSystemAccessRoleArn](#cfn-datasync-locationefs-filesystemaccessrolearn)" : String, "[InTransitEncryption](#cfn-datasync-locationefs-intransitencryption)" : String, "[Subdirectory](#cfn-datasync-locationefs-subdirectory)" : String, "[Tags](#cfn-datasync-locationefs-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataSync::LocationEFS Properties: [AccessPointArn](#cfn-datasync-locationefs-accesspointarn): String [Ec2Config](#cfn-datasync-locationefs-ec2config): Ec2Config [EfsFilesystemArn](#cfn-datasync-locationefs-efsfilesystemarn): String [FileSystemAccessRoleArn](#cfn-datasync-locationefs-filesystemaccessrolearn): String [InTransitEncryption](#cfn-datasync-locationefs-intransitencryption): String [Subdirectory](#cfn-datasync-locationefs-subdirectory): String [Tags](#cfn-datasync-locationefs-tags): - Tag ``` ## Properties `AccessPointArn` Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system. For more information, see [Accessing restricted file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam). *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Ec2Config` Specifies the subnet and security groups DataSync uses to connect to one of your Amazon EFS file system's [mount targets](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html). *Required*: Yes *Type*: [Ec2Config](aws-properties-datasync-locationefs-ec2config.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EfsFilesystemArn` Specifies the ARN for your Amazon EFS file system. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]*:[0-9]{12}:file-system/fs-.*$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FileSystemAccessRoleArn` Specifies an AWS Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system. For information on creating this role, see [Creating a DataSync IAM role for file system access](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role). *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InTransitEncryption` Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your Amazon EFS file system. If you specify an access point using `AccessPointArn` or an IAM role using `FileSystemAccessRoleArn`, you must set this parameter to `TLS1_2`. *Required*: No *Type*: String *Allowed values*: `NONE | TLS1_2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Subdirectory` Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location). By default, DataSync uses the root directory (or [access point](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) if you provide one by using `AccessPointArn`). You can also include subdirectories using forward slashes (for example, `/path/to/folder`). *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Specifies the key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-locationefs-tag.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example: `arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). #### `LocationArn` The Amazon Resource Name (ARN) of the Amazon EFS file system. `LocationUri` The URI of the Amazon EFS file system. ## Examples **Topics** + [Creating an Amazon EFS location](#aws-resource-datasync-locationefs--examples--Creating_an_Amazon_EFS_location) + [Creating an Amazon EFS location with a higher level of security](#aws-resource-datasync-locationefs--examples--Creating_an_Amazon_EFS_location_with_a_higher_level_of_security) ### Creating an Amazon EFS location The following example creates a DataSync location for an Amazon EFS file system. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Specifies a DataSync location for an Amazon EFS file system.", "Resources": { "LocationEFS": { "Type": "AWS::DataSync::LocationEFS", "Properties": { "Ec2Config": { "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2" ], "SubnetArn": "arn:aws:ec2:us-east-2:11122233344:subnet/subnet-1234567890abcdef1" }, "EfsFilesystemArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:file-system/fs-021345abcdef6789", "Subdirectory": "/mount/path" } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Specifies a DataSync location for an Amazon EFS file system. Resources: LocationEFS: Type: AWS::DataSync::LocationEFS Properties: Ec2Config: SecurityGroupArns: - arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2 SubnetArn: arn:aws:ec2:us-east-2:11122233344:subnet/subnet-1234567890abcdef1 EfsFilesystemArn: arn:aws:elasticfilesystem:us-east-2:111222333444:file-system/fs-021345abcdef6789 Subdirectory: /mount/path ``` ### Creating an Amazon EFS location with a higher level of security The following example creates a DataSync location for an Amazon EFS file system that's configured for restricted access. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Specifies a DataSync location for an Amazon EFS file system configured for restricted access.", "Resources": { "LocationEFS": { "Type": "AWS::DataSync::LocationEFS", "Properties": { "AccessPointArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0", "Ec2Config": { "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2" ], "SubnetArn": "arn:aws:ec2:us-east-2:11122233344:subnet/subnet-1234567890abcdef1" }, "EfsFilesystemArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:file-system/fs-021345abcdef6789", "FileSystemAccessRoleArn": "arn:aws:iam::111222333444:role/AllowDataSyncAccess", "InTransitEncryption": "TLS1_2" } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Specifies a DataSync location for an Amazon EFS file system configured for restricted access. Resources: LocationEFS: Type: AWS::DataSync::LocationEFS Properties: AccessPointArn: arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0 Ec2Config: SecurityGroupArns: - arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2 SubnetArn: arn:aws:ec2:us-east-2:11122233344:subnet/subnet-1234567890abcdef1 EfsFilesystemArn: arn:aws:elasticfilesystem:us-east-2:111222333444:file-system/fs-021345abcdef6789 FileSystemAccessRoleArn: arn:aws:iam::111222333444:role/AllowDataSyncAccess InTransitEncryption: TLS1_2 ``` # AWS::DataSync::LocationEFS Ec2Config The subnet and security groups that AWS DataSync uses to connect to one of your Amazon EFS file system's [mount targets](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecurityGroupArns](#cfn-datasync-locationefs-ec2config-securitygrouparns)" : [ String, ... ], "[SubnetArn](#cfn-datasync-locationefs-ec2config-subnetarn)" : String } ``` ### YAML ``` [SecurityGroupArns](#cfn-datasync-locationefs-ec2config-securitygrouparns): - String [SubnetArn](#cfn-datasync-locationefs-ec2config-subnetarn): String ``` ## Properties `SecurityGroupArns` Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `128 | 5` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SubnetArn` Specifies the ARN of a subnet where DataSync creates the [network interfaces](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces.html) for managing traffic during your transfer. The subnet must be located: + In the same virtual private cloud (VPC) as the Amazon EFS file system. + In the same Availability Zone as at least one mount target for the Amazon EFS file system. You don't need to specify a subnet that includes a file system mount target. *Required*: Yes *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::DataSync::LocationEFS Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::LocationEFS](aws-resource-datasync-locationefs.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-locationefs-tag-key)" : String, "[Value](#cfn-datasync-locationefs-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-locationefs-tag-key): String [Value](#cfn-datasync-locationefs-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxLustre The `AWS::DataSync::LocationFSxLustre` resource specifies an endpoint for an Amazon FSx for Lustre file system. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::LocationFSxLustre", "Properties" : { "[FsxFilesystemArn](#cfn-datasync-locationfsxlustre-fsxfilesystemarn)" : String, "[SecurityGroupArns](#cfn-datasync-locationfsxlustre-securitygrouparns)" : [ String, ... ], "[Subdirectory](#cfn-datasync-locationfsxlustre-subdirectory)" : String, "[Tags](#cfn-datasync-locationfsxlustre-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataSync::LocationFSxLustre Properties: [FsxFilesystemArn](#cfn-datasync-locationfsxlustre-fsxfilesystemarn): String [SecurityGroupArns](#cfn-datasync-locationfsxlustre-securitygrouparns): - String [Subdirectory](#cfn-datasync-locationfsxlustre-subdirectory): String [Tags](#cfn-datasync-locationfsxlustre-tags): - Tag ``` ## Properties `FsxFilesystemArn` Specifies the Amazon Resource Name (ARN) of the FSx for Lustre file system. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SecurityGroupArns` The ARNs of the security groups that are used to configure the FSx for Lustre file system. *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$` *Length constraints*: Maximum length of 128. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `128 | 5` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Subdirectory` Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories. When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory (`/`). *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-locationfsxlustre-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example: `arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `LocationArn` The ARN of the specified FSx for Lustre file system location. `LocationUri` The URI of the specified FSx for Lustre file system location. ## Examples ### Specify an Amazon FSx for Lustre location for DataSync The following examples specify an FSx for Lustre location for DataSync, including the subdirectory `/MySubdirectory`. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Specifies an FSx for Lustre location for DataSync", "Resources": { "LocationFSxLustre": { "Type": "AWS::DataSync::LocationFSxLustre", "Properties": { "FsxFilesystemArn": "arn:aws:fsx:us-east-2:111222333444:file-system/fs-12345fsx", "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:11122233344:security-group/sg-12345678901212345" ], "Subdirectory": "/MySubdirectory" } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Specifies an FSx for Lustre location for DataSync Resources: LocationFSxLustre: Type: AWS::DataSync::LocationFSxLustre Properties: FsxFilesystemArn: arn:aws:fsx:us-east-2:111222333444:file-system/fs-12345fsx SecurityGroupArns: - arn:aws:ec2:us-east-2:11122233344:security-group/sg-12345678901212345 Subdirectory: /MySubdirectory ``` # AWS::DataSync::LocationFSxLustre Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::LocationFSxLustre](aws-resource-datasync-locationfsxlustre.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-locationfsxlustre-tag-key)" : String, "[Value](#cfn-datasync-locationfsxlustre-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-locationfsxlustre-tag-key): String [Value](#cfn-datasync-locationfsxlustre-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxONTAP The `AWS::DataSync::LocationFSxONTAP` resource creates an endpoint for an Amazon FSx for NetApp ONTAP file system. AWS DataSync can access this endpoint as a source or destination location. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::LocationFSxONTAP", "Properties" : { "[Protocol](#cfn-datasync-locationfsxontap-protocol)" : Protocol, "[SecurityGroupArns](#cfn-datasync-locationfsxontap-securitygrouparns)" : [ String, ... ], "[StorageVirtualMachineArn](#cfn-datasync-locationfsxontap-storagevirtualmachinearn)" : String, "[Subdirectory](#cfn-datasync-locationfsxontap-subdirectory)" : String, "[Tags](#cfn-datasync-locationfsxontap-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataSync::LocationFSxONTAP Properties: [Protocol](#cfn-datasync-locationfsxontap-protocol): Protocol [SecurityGroupArns](#cfn-datasync-locationfsxontap-securitygrouparns): - String [StorageVirtualMachineArn](#cfn-datasync-locationfsxontap-storagevirtualmachinearn): String [Subdirectory](#cfn-datasync-locationfsxontap-subdirectory): String [Tags](#cfn-datasync-locationfsxontap-tags): - Tag ``` ## Properties `Protocol` Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system. *Required*: No *Type*: [Protocol](aws-properties-datasync-locationfsxontap-protocol.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecurityGroupArns` Specifies the Amazon Resource Names (ARNs) of the security groups that DataSync can use to access your FSx for ONTAP file system. You must configure the security groups to allow outbound traffic on the following ports (depending on the protocol that you're using): + **Network File System (NFS)**: TCP ports 111, 635, and 2049 + **Server Message Block (SMB)**: TCP port 445 Your file system's security groups must also allow inbound traffic on the same port. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `128 | 5` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `StorageVirtualMachineArn` Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from. *Required*: Yes *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$` *Maximum*: `162` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Subdirectory` Specifies a path to the file share in the SVM where you want to transfer data to or from. You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be `/vol1`, `/vol1/tree1`, or `/share1`. Don't specify a junction path in the SVM's root volume. For more information, see [Managing FSx for ONTAP storage virtual machines](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) in the *Amazon FSx for NetApp ONTAP User Guide*. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-locationfsxontap-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example: `arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `FsxFilesystemArn` The ARN of the FSx for ONTAP file system in the specified location. `LocationArn` The ARN of the specified location. `LocationUri` The URI of the specified location. `Protocol.SMB.CmkSecretConfig.SecretArn` Property description not available. ## Examples **Topics** + [Creating an FSx for ONTAP location with NFS access](#aws-resource-datasync-locationfsxontap--examples--Creating_an_FSx_for_ONTAP_location_with_NFS_access) + [Creating an FSx for ONTAP location with SMB access](#aws-resource-datasync-locationfsxontap--examples--Creating_an_FSx_for_ONTAP_location_with_SMB_access) ### Creating an FSx for ONTAP location with NFS access The following example creates a location for an FSx for ONTAP file system that DataSync can access using NFS. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Specifies a location for an Amazon FSx for ONTAP file system that DataSync can access using NFS.", "Resources": { "LocationFSxONTAP": { "Type": "AWS::DataSync::LocationFSxONTAP", "Properties": { "Protocol": { "NFS": { "MountOptions": { "Version": "NFS3" } } }, "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2" ], "StorageVirtualMachineArn": "arn:aws:fsx:us-east-1:11122233344:storage-virtual-machine/fs-abcdef01234567890/svm-021345abcdef6789", "Subdirectory": "/vol1" } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Specifies a location for an Amazon FSx for ONTAP file system that DataSync can access using NFS. Resources: LocationFSxONTAP: Type: AWS::DataSync::LocationFSxONTAP Properties: Protocol: NFS: MountOptions: Version: NFS3 SecurityGroupArns: - arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2 StorageVirtualMachineArn: arn:aws:fsx:us-east-1:11122233344:storage-virtual-machine/fs-abcdef01234567890/svm-021345abcdef6789 Subdirectory: /vol1 ``` ### Creating an FSx for ONTAP location with SMB access The following example creates a location for an FSx for ONTAP file system that DataSync can access using SMB. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Specifies a location for an Amazon FSx for ONTAP file system that DataSync can access using SMB.", "Resources": { "LocationFSxONTAP": { "Type": "AWS::DataSync::LocationFSxONTAP", "Properties": { "Protocol": { "SMB": { "Domain": "example.company", "MountOptions": { "Version": "AUTOMATIC" }, "Password": "examplepassword", "User": "exampleusername" } }, "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2" ], "StorageVirtualMachineArn": "arn:aws:fsx:us-east-1:11122233344:storage-virtual-machine/fs-abcdef01234567890/svm-021345abcdef6789", "Subdirectory": "/vol1" } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Specifies a location for an Amazon FSx for ONTAP file system that DataSync can access using SMB. Resources: LocationFSxONTAP: Type: AWS::DataSync::LocationFSxONTAP Properties: Protocol: SMB: Domain: example.company MountOptions: Version: AUTOMATIC Password: examplepassword User: exampleusername SecurityGroupArns: - arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2 StorageVirtualMachineArn: arn:aws:fsx:us-east-1:11122233344:storage-virtual-machine/fs-abcdef01234567890/svm-021345abcdef6789 Subdirectory: /vol1 ``` # AWS::DataSync::LocationFSxONTAP CmkSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KmsKeyArn](#cfn-datasync-locationfsxontap-cmksecretconfig-kmskeyarn)" : String, "[SecretArn](#cfn-datasync-locationfsxontap-cmksecretconfig-secretarn)" : String } ``` ### YAML ``` [KmsKeyArn](#cfn-datasync-locationfsxontap-cmksecretconfig-kmskeyarn): String [SecretArn](#cfn-datasync-locationfsxontap-cmksecretconfig-secretarn): String ``` ## Properties `KmsKeyArn` 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. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z-0-9]+:[0-9]{12}:key/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` 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`. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxONTAP CustomSecretConfig Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretAccessRoleArn](#cfn-datasync-locationfsxontap-customsecretconfig-secretaccessrolearn)" : String, "[SecretArn](#cfn-datasync-locationfsxontap-customsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretAccessRoleArn](#cfn-datasync-locationfsxontap-customsecretconfig-secretaccessrolearn): String [SecretArn](#cfn-datasync-locationfsxontap-customsecretconfig-secretarn): String ``` ## Properties `SecretAccessRoleArn` Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for `SecretArn`. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxONTAP ManagedSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretArn](#cfn-datasync-locationfsxontap-managedsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretArn](#cfn-datasync-locationfsxontap-managedsecretconfig-secretarn): String ``` ## Properties `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxONTAP NFS Specifies the Network File System (NFS) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for NetApp ONTAP file system. For more information, see [Accessing FSx for ONTAP file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MountOptions](#cfn-datasync-locationfsxontap-nfs-mountoptions)" : NfsMountOptions } ``` ### YAML ``` [MountOptions](#cfn-datasync-locationfsxontap-nfs-mountoptions): NfsMountOptions ``` ## Properties `MountOptions` Specifies how DataSync can access a location using the NFS protocol. *Required*: Yes *Type*: [NfsMountOptions](aws-properties-datasync-locationfsxontap-nfsmountoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxONTAP NfsMountOptions Specifies how DataSync can access a location using the NFS protocol. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Version](#cfn-datasync-locationfsxontap-nfsmountoptions-version)" : String } ``` ### YAML ``` [Version](#cfn-datasync-locationfsxontap-nfsmountoptions-version): String ``` ## Properties `Version` Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails. You can specify the following options: + `AUTOMATIC` (default): DataSync chooses NFS version 4.1. + `NFS3`: Stateless protocol version that allows for asynchronous writes on the server. + `NFSv4_0`: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems. + `NFSv4_1`: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0. DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations. *Required*: No *Type*: String *Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxONTAP Protocol Specifies the data transfer protocol that AWS DataSync uses to access your Amazon FSx file system. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[NFS](#cfn-datasync-locationfsxontap-protocol-nfs)" : NFS, "[SMB](#cfn-datasync-locationfsxontap-protocol-smb)" : SMB } ``` ### YAML ``` [NFS](#cfn-datasync-locationfsxontap-protocol-nfs): NFS [SMB](#cfn-datasync-locationfsxontap-protocol-smb): SMB ``` ## Properties `NFS` Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for ONTAP file system's storage virtual machine (SVM). *Required*: No *Type*: [NFS](aws-properties-datasync-locationfsxontap-nfs.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SMB` Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM. *Required*: No *Type*: [SMB](aws-properties-datasync-locationfsxontap-smb.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxONTAP SMB Specifies the Server Message Block (SMB) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for NetApp ONTAP file system. For more information, see [Accessing FSx for ONTAP file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CmkSecretConfig](#cfn-datasync-locationfsxontap-smb-cmksecretconfig)" : CmkSecretConfig, "[CustomSecretConfig](#cfn-datasync-locationfsxontap-smb-customsecretconfig)" : CustomSecretConfig, "[Domain](#cfn-datasync-locationfsxontap-smb-domain)" : String, "[ManagedSecretConfig](#cfn-datasync-locationfsxontap-smb-managedsecretconfig)" : ManagedSecretConfig, "[MountOptions](#cfn-datasync-locationfsxontap-smb-mountoptions)" : SmbMountOptions, "[Password](#cfn-datasync-locationfsxontap-smb-password)" : String, "[User](#cfn-datasync-locationfsxontap-smb-user)" : String } ``` ### YAML ``` [CmkSecretConfig](#cfn-datasync-locationfsxontap-smb-cmksecretconfig): CmkSecretConfig [CustomSecretConfig](#cfn-datasync-locationfsxontap-smb-customsecretconfig): CustomSecretConfig [Domain](#cfn-datasync-locationfsxontap-smb-domain): String [ManagedSecretConfig](#cfn-datasync-locationfsxontap-smb-managedsecretconfig): ManagedSecretConfig [MountOptions](#cfn-datasync-locationfsxontap-smb-mountoptions): SmbMountOptions [Password](#cfn-datasync-locationfsxontap-smb-password): String [User](#cfn-datasync-locationfsxontap-smb-user): String ``` ## Properties `CmkSecretConfig` Property description not available. *Required*: No *Type*: [CmkSecretConfig](aws-properties-datasync-locationfsxontap-cmksecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomSecretConfig` Property description not available. *Required*: No *Type*: [CustomSecretConfig](aws-properties-datasync-locationfsxontap-customsecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Domain` Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to. If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM. *Required*: No *Type*: String *Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$` *Maximum*: `253` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ManagedSecretConfig` Property description not available. *Required*: No *Type*: [ManagedSecretConfig](aws-properties-datasync-locationfsxontap-managedsecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MountOptions` Specifies how DataSync can access a location using the SMB protocol. *Required*: Yes *Type*: [SmbMountOptions](aws-properties-datasync-locationfsxontap-smbmountoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Password` Specifies the password of a user who has permission to access your SVM. *Required*: No *Type*: String *Pattern*: `^.{0,104}$` *Maximum*: `104` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `User` Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM. If you provide a user in your Active Directory, note the following: + If you're using AWS Directory Service for Microsoft Active Directory, the user must be a member of the AWS Delegated FSx Administrators group. + If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system. Make sure that the user has the permissions it needs to copy the data you want: + `SE_TCB_NAME`: Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs). + `SE_SECURITY_NAME`: May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see [Ownership and permissions-related options](https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html#configure-ownership-and-permissions). *Required*: Yes *Type*: String *Pattern*: `^[^\x5B\x5D\\/:;|=,+*?]{1,104}$` *Maximum*: `104` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxONTAP SmbMountOptions Specifies the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB file server. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Version](#cfn-datasync-locationfsxontap-smbmountoptions-version)" : String } ``` ### YAML ``` [Version](#cfn-datasync-locationfsxontap-smbmountoptions-version): String ``` ## Properties `Version` By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically. These are the following options for configuring the SMB version: + `AUTOMATIC` (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an `Operation Not Supported` error. + `SMB3`: Restricts the protocol negotiation to only SMB version 3.0.2. + `SMB2`: Restricts the protocol negotiation to only SMB version 2.1. + `SMB2_0`: Restricts the protocol negotiation to only SMB version 2.0. + `SMB1`: Restricts the protocol negotiation to only SMB version 1.0. **Note** The `SMB1` option isn't available when [creating an Amazon FSx for NetApp ONTAP location](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html). *Required*: No *Type*: String *Allowed values*: `AUTOMATIC | SMB2 | SMB3` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxONTAP Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::LocationFSxONTAP](aws-resource-datasync-locationfsxontap.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-locationfsxontap-tag-key)" : String, "[Value](#cfn-datasync-locationfsxontap-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-locationfsxontap-tag-key): String [Value](#cfn-datasync-locationfsxontap-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxOpenZFS The `AWS::DataSync::LocationFSxOpenZFS` resource specifies an endpoint for an Amazon FSx for OpenZFS file system. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::LocationFSxOpenZFS", "Properties" : { "[FsxFilesystemArn](#cfn-datasync-locationfsxopenzfs-fsxfilesystemarn)" : String, "[Protocol](#cfn-datasync-locationfsxopenzfs-protocol)" : Protocol, "[SecurityGroupArns](#cfn-datasync-locationfsxopenzfs-securitygrouparns)" : [ String, ... ], "[Subdirectory](#cfn-datasync-locationfsxopenzfs-subdirectory)" : String, "[Tags](#cfn-datasync-locationfsxopenzfs-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataSync::LocationFSxOpenZFS Properties: [FsxFilesystemArn](#cfn-datasync-locationfsxopenzfs-fsxfilesystemarn): String [Protocol](#cfn-datasync-locationfsxopenzfs-protocol): Protocol [SecurityGroupArns](#cfn-datasync-locationfsxopenzfs-securitygrouparns): - String [Subdirectory](#cfn-datasync-locationfsxopenzfs-subdirectory): String [Tags](#cfn-datasync-locationfsxopenzfs-tags): - Tag ``` ## Properties `FsxFilesystemArn` The Amazon Resource Name (ARN) of the FSx for OpenZFS file system. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Protocol` The type of protocol that AWS DataSync uses to access your file system. *Required*: Yes *Type*: [Protocol](aws-properties-datasync-locationfsxopenzfs-protocol.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecurityGroupArns` The ARNs of the security groups that are used to configure the FSx for OpenZFS file system. *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$` *Length constraints*: Maximum length of 128. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `128 | 5` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Subdirectory` A subdirectory in the location's path that must begin with `/fsx`. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location). *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-locationfsxopenzfs-tag.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example: `arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3` For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `LocationArn` The ARN of the specified FSx for OpenZFS file system location. `LocationUri` The URI of the specified FSx for OpenZFS file system location. ## Examples ### Specify an Amazon FSx for OpenZFS location for DataSync The following examples specify an FSx for OpenZFS location for DataSync. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Specifies an FSx for OpenZFS location for DataSync", "Resources": { "LocationFSxOpenZFS": { "Type": "AWS::DataSync::LocationFSxOpenZFS", "Properties": { "FsxFilesystemArn": "arn:aws:fsx:us-east-2:111222333444:file-system/fs-12345fsx", "Protocol": { "NFS": { "MountOptions": { "Version": "NFS4_1" } } }, "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:11122233344:security-group/sg-12345678901212345" ], "Subdirectory": "/MySubdirectory" } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Specifies an FSx for OpenZFS location for DataSync Resources: LocationFSxOpenZFS: Type: AWS::DataSync::LocationFSxOpenZFS Properties: FsxFilesystemArn: arn:aws:fsx:us-east-2:111222333444:file-system/fs-12345fsx Protocol: NFS: MountOptions: Version: NFS4_1 SecurityGroupArns: - arn:aws:ec2:us-east-2:11122233344:security-group/sg-12345678901212345 Subdirectory: /MySubdirectory ``` # AWS::DataSync::LocationFSxOpenZFS MountOptions Represents the mount options that are available for DataSync to access a Network File System (NFS) location. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Version](#cfn-datasync-locationfsxopenzfs-mountoptions-version)" : String } ``` ### YAML ``` [Version](#cfn-datasync-locationfsxopenzfs-mountoptions-version): String ``` ## Properties `Version` The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. If you don't specify a version, DataSync defaults to `AUTOMATIC`. That is, DataSync automatically selects a version based on negotiation with the NFS server. You can specify the following NFS versions: + ** [NFSv3](https://tools.ietf.org/html/rfc1813) **: Stateless protocol version that allows for asynchronous writes on the server. + ** [NFSv4.0](https://tools.ietf.org/html/rfc3530) **: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems. + ** [NFSv4.1](https://tools.ietf.org/html/rfc5661) **: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0. *Required*: No *Type*: String *Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxOpenZFS NFS Represents the Network File System (NFS) protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MountOptions](#cfn-datasync-locationfsxopenzfs-nfs-mountoptions)" : MountOptions } ``` ### YAML ``` [MountOptions](#cfn-datasync-locationfsxopenzfs-nfs-mountoptions): MountOptions ``` ## Properties `MountOptions` Represents the mount options that are available for DataSync to access an NFS location. *Required*: Yes *Type*: [MountOptions](aws-properties-datasync-locationfsxopenzfs-mountoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxOpenZFS Protocol Represents the protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[NFS](#cfn-datasync-locationfsxopenzfs-protocol-nfs)" : NFS } ``` ### YAML ``` [NFS](#cfn-datasync-locationfsxopenzfs-protocol-nfs): NFS ``` ## Properties `NFS` Represents the Network File System (NFS) protocol that DataSync uses to access your FSx for OpenZFS file system. *Required*: No *Type*: [NFS](aws-properties-datasync-locationfsxopenzfs-nfs.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxOpenZFS Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::LocationFSxOpenZFS](aws-resource-datasync-locationfsxopenzfs.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-locationfsxopenzfs-tag-key)" : String, "[Value](#cfn-datasync-locationfsxopenzfs-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-locationfsxopenzfs-tag-key): String [Value](#cfn-datasync-locationfsxopenzfs-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxWindows The `AWS::DataSync::LocationFSxWindows` resource specifies an endpoint for an Amazon FSx for Windows Server file system. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::LocationFSxWindows", "Properties" : { "[CmkSecretConfig](#cfn-datasync-locationfsxwindows-cmksecretconfig)" : CmkSecretConfig, "[CustomSecretConfig](#cfn-datasync-locationfsxwindows-customsecretconfig)" : CustomSecretConfig, "[Domain](#cfn-datasync-locationfsxwindows-domain)" : String, "[FsxFilesystemArn](#cfn-datasync-locationfsxwindows-fsxfilesystemarn)" : String, "[Password](#cfn-datasync-locationfsxwindows-password)" : String, "[SecurityGroupArns](#cfn-datasync-locationfsxwindows-securitygrouparns)" : [ String, ... ], "[Subdirectory](#cfn-datasync-locationfsxwindows-subdirectory)" : String, "[Tags](#cfn-datasync-locationfsxwindows-tags)" : [ Tag, ... ], "[User](#cfn-datasync-locationfsxwindows-user)" : String } } ``` ### YAML ``` Type: AWS::DataSync::LocationFSxWindows Properties: [CmkSecretConfig](#cfn-datasync-locationfsxwindows-cmksecretconfig): CmkSecretConfig [CustomSecretConfig](#cfn-datasync-locationfsxwindows-customsecretconfig): CustomSecretConfig [Domain](#cfn-datasync-locationfsxwindows-domain): String [FsxFilesystemArn](#cfn-datasync-locationfsxwindows-fsxfilesystemarn): String [Password](#cfn-datasync-locationfsxwindows-password): String [SecurityGroupArns](#cfn-datasync-locationfsxwindows-securitygrouparns): - String [Subdirectory](#cfn-datasync-locationfsxwindows-subdirectory): String [Tags](#cfn-datasync-locationfsxwindows-tags): - Tag [User](#cfn-datasync-locationfsxwindows-user): String ``` ## Properties `CmkSecretConfig` Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key. You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. *Required*: No *Type*: [CmkSecretConfig](aws-properties-datasync-locationfsxwindows-cmksecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomSecretConfig` Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. *Required*: No *Type*: [CustomSecretConfig](aws-properties-datasync-locationfsxwindows-customsecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Domain` Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system. *Required*: No *Type*: String *Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$` *Maximum*: `253` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FsxFilesystemArn` Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]*:[0-9]{12}:file-system/fs-.*$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Password` Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system. *Required*: No *Type*: String *Pattern*: `^.{0,104}$` *Maximum*: `104` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecurityGroupArns` The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system. *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$` *Length constraints*: Maximum length of 128. *Required*: Yes *Type*: Array of String *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Subdirectory` Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location). *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-locationfsxwindows-tag.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `User` The user who has the permissions to access files and folders in the FSx for Windows File Server file system. For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see [user](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#FSxWuser). *Required*: Yes *Type*: String *Pattern*: `^[^\x5B\x5D\\/:;|=,+*?]{1,104}$` *Maximum*: `104` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example: `arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). #### `CmkSecretConfig.SecretArn` Property description not available. `LocationArn` The ARN of the specified FSx for Windows Server file system location. `LocationUri` The URI of the specified FSx for Windows Server file system location. ## Examples ### Specify an Amazon FSx for Windows File Server location for DataSync The following examples specify an FSx for Windows File Server location for DataSync, including the subdirectory `/MySubdirectory`, user `Admin`, and password. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Specifies an FSx for Windows File Server location for DataSync", "Resources": { "LocationFSxWindows": { "Type": "AWS::DataSync::LocationFSxWindows", "Properties": { "FsxFilesystemArn": "arn:aws:fsx:us-east-2:111222333444:file-system/fs-12345fsx", "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:11122233344:security-group/sg-12345678901212345" ], "Subdirectory": "/MySubdirectory", "User": "Admin", "Password": { "Ref": "Password" } } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Specifies an FSx for Windows File Server location for DataSync Resources: LocationFSxWindows: Type: AWS::DataSync::LocationFSxWindows Properties: FsxFilesystemArn: arn:aws:fsx:us-east-2:111222333444:file-system/fs-12345fsx SecurityGroupArns: - arn:aws:ec2:us-east-2:11122233344:security-group/sg-12345678901212345 Subdirectory: /MySubdirectory User: Admin Password: !Ref Password ``` # AWS::DataSync::LocationFSxWindows CmkSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KmsKeyArn](#cfn-datasync-locationfsxwindows-cmksecretconfig-kmskeyarn)" : String, "[SecretArn](#cfn-datasync-locationfsxwindows-cmksecretconfig-secretarn)" : String } ``` ### YAML ``` [KmsKeyArn](#cfn-datasync-locationfsxwindows-cmksecretconfig-kmskeyarn): String [SecretArn](#cfn-datasync-locationfsxwindows-cmksecretconfig-secretarn): String ``` ## Properties `KmsKeyArn` 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. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z-0-9]+:[0-9]{12}:key/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` 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`. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxWindows CustomSecretConfig Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretAccessRoleArn](#cfn-datasync-locationfsxwindows-customsecretconfig-secretaccessrolearn)" : String, "[SecretArn](#cfn-datasync-locationfsxwindows-customsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretAccessRoleArn](#cfn-datasync-locationfsxwindows-customsecretconfig-secretaccessrolearn): String [SecretArn](#cfn-datasync-locationfsxwindows-customsecretconfig-secretarn): String ``` ## Properties `SecretAccessRoleArn` Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for `SecretArn`. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxWindows ManagedSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretArn](#cfn-datasync-locationfsxwindows-managedsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretArn](#cfn-datasync-locationfsxwindows-managedsecretconfig-secretarn): String ``` ## Properties `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationFSxWindows Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::LocationFSxWindows](aws-resource-datasync-locationfsxwindows.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-locationfsxwindows-tag-key)" : String, "[Value](#cfn-datasync-locationfsxwindows-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-locationfsxwindows-tag-key): String [Value](#cfn-datasync-locationfsxwindows-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationHDFS The `AWS::DataSync::LocationHDFS` resource specifies an endpoint for a Hadoop Distributed File System (HDFS). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::LocationHDFS", "Properties" : { "[AgentArns](#cfn-datasync-locationhdfs-agentarns)" : [ String, ... ], "[AuthenticationType](#cfn-datasync-locationhdfs-authenticationtype)" : String, "[BlockSize](#cfn-datasync-locationhdfs-blocksize)" : Integer, "[CmkSecretConfig](#cfn-datasync-locationhdfs-cmksecretconfig)" : CmkSecretConfig, "[CustomSecretConfig](#cfn-datasync-locationhdfs-customsecretconfig)" : CustomSecretConfig, "[KerberosKeytab](#cfn-datasync-locationhdfs-kerberoskeytab)" : String, "[KerberosKrb5Conf](#cfn-datasync-locationhdfs-kerberoskrb5conf)" : String, "[KerberosPrincipal](#cfn-datasync-locationhdfs-kerberosprincipal)" : String, "[KmsKeyProviderUri](#cfn-datasync-locationhdfs-kmskeyprovideruri)" : String, "[NameNodes](#cfn-datasync-locationhdfs-namenodes)" : [ NameNode, ... ], "[QopConfiguration](#cfn-datasync-locationhdfs-qopconfiguration)" : QopConfiguration, "[ReplicationFactor](#cfn-datasync-locationhdfs-replicationfactor)" : Integer, "[SimpleUser](#cfn-datasync-locationhdfs-simpleuser)" : String, "[Subdirectory](#cfn-datasync-locationhdfs-subdirectory)" : String, "[Tags](#cfn-datasync-locationhdfs-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataSync::LocationHDFS Properties: [AgentArns](#cfn-datasync-locationhdfs-agentarns): - String [AuthenticationType](#cfn-datasync-locationhdfs-authenticationtype): String [BlockSize](#cfn-datasync-locationhdfs-blocksize): Integer [CmkSecretConfig](#cfn-datasync-locationhdfs-cmksecretconfig): CmkSecretConfig [CustomSecretConfig](#cfn-datasync-locationhdfs-customsecretconfig): CustomSecretConfig [KerberosKeytab](#cfn-datasync-locationhdfs-kerberoskeytab): String [KerberosKrb5Conf](#cfn-datasync-locationhdfs-kerberoskrb5conf): String [KerberosPrincipal](#cfn-datasync-locationhdfs-kerberosprincipal): String [KmsKeyProviderUri](#cfn-datasync-locationhdfs-kmskeyprovideruri): String [NameNodes](#cfn-datasync-locationhdfs-namenodes): - NameNode [QopConfiguration](#cfn-datasync-locationhdfs-qopconfiguration): QopConfiguration [ReplicationFactor](#cfn-datasync-locationhdfs-replicationfactor): Integer [SimpleUser](#cfn-datasync-locationhdfs-simpleuser): String [Subdirectory](#cfn-datasync-locationhdfs-subdirectory): String [Tags](#cfn-datasync-locationhdfs-tags): - Tag ``` ## Properties `AgentArns` The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `128 | 4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AuthenticationType` Property description not available. *Required*: Yes *Type*: String *Allowed values*: `SIMPLE | KERBEROS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BlockSize` The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB). *Required*: No *Type*: Integer *Minimum*: `1048576` *Maximum*: `1073741824` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CmkSecretConfig` Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key. You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. *Required*: No *Type*: [CmkSecretConfig](aws-properties-datasync-locationhdfs-cmksecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomSecretConfig` Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. *Required*: No *Type*: [CustomSecretConfig](aws-properties-datasync-locationhdfs-customsecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KerberosKeytab` The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. Provide the base64-encoded file text. If `KERBEROS` is specified for `AuthType`, this value is required. *Required*: No *Type*: String *Maximum*: `87384` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KerberosKrb5Conf` The `krb5.conf` file that contains the Kerberos configuration information. You can load the `krb5.conf` by providing a string of the file's contents or an Amazon S3 presigned URL of the file. If`KERBEROS` is specified for `AuthType`, this value is required. *Required*: No *Type*: String *Maximum*: `174764` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KerberosPrincipal` The Kerberos principal with access to the files and folders on the HDFS cluster. If `KERBEROS` is specified for `AuthenticationType`, this parameter is required. *Required*: No *Type*: String *Pattern*: `^.+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KmsKeyProviderUri` The URI of the HDFS cluster's Key Management Server (KMS). *Required*: No *Type*: String *Pattern*: `^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NameNodes` The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode. *Required*: Yes *Type*: Array of [NameNode](aws-properties-datasync-locationhdfs-namenode.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `QopConfiguration` The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster. If `QopConfiguration` isn't specified, `RpcProtection` and `DataTransferProtection` default to `PRIVACY`. If you set `RpcProtection` or `DataTransferProtection`, the other parameter assumes the same value. *Required*: No *Type*: [QopConfiguration](aws-properties-datasync-locationhdfs-qopconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ReplicationFactor` The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `512` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SimpleUser` The user name used to identify the client on the host operating system. If `SIMPLE` is specified for `AuthenticationType`, this parameter is required. *Required*: No *Type*: String *Pattern*: `^[_.A-Za-z0-9][-_.A-Za-z0-9]*$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Subdirectory` A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to `/`. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-locationhdfs-tag.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example: `arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). #### `CmkSecretConfig.SecretArn` Property description not available. `LocationArn` The Amazon Resource Name (ARN) of the HDFS cluster location to describe. `LocationUri` The URI of the HDFS cluster location. # AWS::DataSync::LocationHDFS CmkSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KmsKeyArn](#cfn-datasync-locationhdfs-cmksecretconfig-kmskeyarn)" : String, "[SecretArn](#cfn-datasync-locationhdfs-cmksecretconfig-secretarn)" : String } ``` ### YAML ``` [KmsKeyArn](#cfn-datasync-locationhdfs-cmksecretconfig-kmskeyarn): String [SecretArn](#cfn-datasync-locationhdfs-cmksecretconfig-secretarn): String ``` ## Properties `KmsKeyArn` 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. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z-0-9]+:[0-9]{12}:key/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` 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`. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationHDFS CustomSecretConfig Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretAccessRoleArn](#cfn-datasync-locationhdfs-customsecretconfig-secretaccessrolearn)" : String, "[SecretArn](#cfn-datasync-locationhdfs-customsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretAccessRoleArn](#cfn-datasync-locationhdfs-customsecretconfig-secretaccessrolearn): String [SecretArn](#cfn-datasync-locationhdfs-customsecretconfig-secretarn): String ``` ## Properties `SecretAccessRoleArn` Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for `SecretArn`. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationHDFS ManagedSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretArn](#cfn-datasync-locationhdfs-managedsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretArn](#cfn-datasync-locationhdfs-managedsecretconfig-secretarn): String ``` ## Properties `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationHDFS NameNode The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system's namespace and performs operations such as opening, closing, and renaming files and directories. The NameNode also contains the information to map blocks of data to the DataNodes. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Hostname](#cfn-datasync-locationhdfs-namenode-hostname)" : String, "[Port](#cfn-datasync-locationhdfs-namenode-port)" : Integer } ``` ### YAML ``` [Hostname](#cfn-datasync-locationhdfs-namenode-hostname): String [Port](#cfn-datasync-locationhdfs-namenode-port): Integer ``` ## Properties `Hostname` The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network. *Required*: Yes *Type*: String *Pattern*: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Port` The port that the NameNode uses to listen to client requests. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `65536` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationHDFS QopConfiguration The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DataTransferProtection](#cfn-datasync-locationhdfs-qopconfiguration-datatransferprotection)" : String, "[RpcProtection](#cfn-datasync-locationhdfs-qopconfiguration-rpcprotection)" : String } ``` ### YAML ``` [DataTransferProtection](#cfn-datasync-locationhdfs-qopconfiguration-datatransferprotection): String [RpcProtection](#cfn-datasync-locationhdfs-qopconfiguration-rpcprotection): String ``` ## Properties `DataTransferProtection` The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your `dfs.data.transfer.protection` setting in the `hdfs-site.xml` file on your Hadoop cluster. *Required*: No *Type*: String *Allowed values*: `AUTHENTICATION | INTEGRITY | PRIVACY | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RpcProtection` The Remote Procedure Call (RPC) protection setting configured on the HDFS cluster. This setting corresponds to your `hadoop.rpc.protection` setting in your `core-site.xml` file on your Hadoop cluster. *Required*: No *Type*: String *Allowed values*: `AUTHENTICATION | INTEGRITY | PRIVACY | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationHDFS Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::LocationHDFS](aws-resource-datasync-locationhdfs.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-locationhdfs-tag-key)" : String, "[Value](#cfn-datasync-locationhdfs-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-locationhdfs-tag-key): String [Value](#cfn-datasync-locationhdfs-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationNFS The `AWS::DataSync::LocationNFS` resource specifies a Network File System (NFS) file server that AWS DataSync can use as a transfer source or destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::LocationNFS", "Properties" : { "[MountOptions](#cfn-datasync-locationnfs-mountoptions)" : MountOptions, "[OnPremConfig](#cfn-datasync-locationnfs-onpremconfig)" : OnPremConfig, "[ServerHostname](#cfn-datasync-locationnfs-serverhostname)" : String, "[Subdirectory](#cfn-datasync-locationnfs-subdirectory)" : String, "[Tags](#cfn-datasync-locationnfs-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataSync::LocationNFS Properties: [MountOptions](#cfn-datasync-locationnfs-mountoptions): MountOptions [OnPremConfig](#cfn-datasync-locationnfs-onpremconfig): OnPremConfig [ServerHostname](#cfn-datasync-locationnfs-serverhostname): String [Subdirectory](#cfn-datasync-locationnfs-subdirectory): String [Tags](#cfn-datasync-locationnfs-tags): - Tag ``` ## Properties `MountOptions` Specifies the options that DataSync can use to mount your NFS file server. *Required*: No *Type*: [MountOptions](aws-properties-datasync-locationnfs-mountoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OnPremConfig` Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect to your NFS file server. You can specify more than one agent. For more information, see [Using multiple DataSync agents](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents). *Required*: Yes *Type*: [OnPremConfig](aws-properties-datasync-locationnfs-onpremconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServerHostname` Specifies the DNS name or IP address (IPv4 or IPv6) of the NFS file server that your DataSync agent connects to. *Required*: No *Type*: String *Pattern*: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Subdirectory` Specifies the export path in your NFS file server that you want DataSync to mount. This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see [Accessing NFS file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs). *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-locationnfs-tag.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example: `arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). #### `LocationArn` The Amazon Resource Name (ARN) of the NFS location that you created. `LocationUri` The URI of the NFS location that you created. ## Examples ### Create an NFS location for DataSync The following example specifies an NFS location for DataSync, using a source and destination location. In this example, the server hostname is `MyServer@example.com`, using NFS version 4.0, in the subdirectory `/MySubdirectory`. #### JSON ``` { "Resources": { "LocationNFS": { "Type": "AWS::DataSync::LocationNFS", "Properties": { "MountOptions": { "Version": "NFS4_0" }, "OnPremConfig": { "AgentArns": [ "arn:aws:datasync:us-east-2:111222333444:agent/agent-000addbcdf44bbnfs" ] }, "ServerHostname": "MyServer@example.com", "Subdirectory": "/MySubdirectory" } } } } ``` #### YAML ``` Resources: LocationNFS: Type: 'AWS::DataSync::LocationNFS' Properties: MountOptions: Version: NFS4_0 OnPremConfig: AgentArns: - >- arn:aws:datasync:us-east-2:111222333444:agent/agent-000addbcdf44bbnfs ServerHostname: MyServer@example.com Subdirectory: /MySubdirectory ``` # AWS::DataSync::LocationNFS MountOptions Specifies the options that DataSync can use to mount your NFS file server. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Version](#cfn-datasync-locationnfs-mountoptions-version)" : String } ``` ### YAML ``` [Version](#cfn-datasync-locationnfs-mountoptions-version): String ``` ## Properties `Version` Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails. You can specify the following options: + `AUTOMATIC` (default): DataSync chooses NFS version 4.1. + `NFS3`: Stateless protocol version that allows for asynchronous writes on the server. + `NFSv4_0`: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems. + `NFSv4_1`: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0. DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations. *Required*: No *Type*: String *Allowed values*: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationNFS OnPremConfig The AWS DataSync agents that can connect to your Network File System (NFS) file server. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AgentArns](#cfn-datasync-locationnfs-onpremconfig-agentarns)" : [ String, ... ] } ``` ### YAML ``` [AgentArns](#cfn-datasync-locationnfs-onpremconfig-agentarns): - String ``` ## Properties `AgentArns` The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS file server. You can specify more than one agent. For more information, see [Using multiple DataSync agents](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents). *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `128 | 8` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationNFS Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::LocationNFS](aws-resource-datasync-locationnfs.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-locationnfs-tag-key)" : String, "[Value](#cfn-datasync-locationnfs-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-locationnfs-tag-key): String [Value](#cfn-datasync-locationnfs-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationObjectStorage The `AWS::DataSync::LocationObjectStorage` resource specifies an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see [Creating a Location for Object Storage](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::LocationObjectStorage", "Properties" : { "[AccessKey](#cfn-datasync-locationobjectstorage-accesskey)" : String, "[AgentArns](#cfn-datasync-locationobjectstorage-agentarns)" : [ String, ... ], "[BucketName](#cfn-datasync-locationobjectstorage-bucketname)" : String, "[CmkSecretConfig](#cfn-datasync-locationobjectstorage-cmksecretconfig)" : CmkSecretConfig, "[CustomSecretConfig](#cfn-datasync-locationobjectstorage-customsecretconfig)" : CustomSecretConfig, "[SecretKey](#cfn-datasync-locationobjectstorage-secretkey)" : String, "[ServerCertificate](#cfn-datasync-locationobjectstorage-servercertificate)" : String, "[ServerHostname](#cfn-datasync-locationobjectstorage-serverhostname)" : String, "[ServerPort](#cfn-datasync-locationobjectstorage-serverport)" : Integer, "[ServerProtocol](#cfn-datasync-locationobjectstorage-serverprotocol)" : String, "[Subdirectory](#cfn-datasync-locationobjectstorage-subdirectory)" : String, "[Tags](#cfn-datasync-locationobjectstorage-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataSync::LocationObjectStorage Properties: [AccessKey](#cfn-datasync-locationobjectstorage-accesskey): String [AgentArns](#cfn-datasync-locationobjectstorage-agentarns): - String [BucketName](#cfn-datasync-locationobjectstorage-bucketname): String [CmkSecretConfig](#cfn-datasync-locationobjectstorage-cmksecretconfig): CmkSecretConfig [CustomSecretConfig](#cfn-datasync-locationobjectstorage-customsecretconfig): CustomSecretConfig [SecretKey](#cfn-datasync-locationobjectstorage-secretkey): String [ServerCertificate](#cfn-datasync-locationobjectstorage-servercertificate): String [ServerHostname](#cfn-datasync-locationobjectstorage-serverhostname): String [ServerPort](#cfn-datasync-locationobjectstorage-serverport): Integer [ServerProtocol](#cfn-datasync-locationobjectstorage-serverprotocol): String [Subdirectory](#cfn-datasync-locationobjectstorage-subdirectory): String [Tags](#cfn-datasync-locationobjectstorage-tags): - Tag ``` ## Properties `AccessKey` Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server. *Required*: No *Type*: String *Pattern*: `^.+$` *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AgentArns` (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. 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. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `128 | 4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketName` Specifies the name of the object storage bucket involved in the transfer. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` *Minimum*: `3` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CmkSecretConfig` 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 parameter 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 that DataSync has permission to access the KMS key that you specify. For more information, see [ Using a service-managed secret encrypted with a custom AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key). 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. *Required*: No *Type*: [CmkSecretConfig](aws-properties-datasync-locationobjectstorage-cmksecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomSecretConfig` 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, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see [ Using a secret that you manage](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key). 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. *Required*: No *Type*: [CustomSecretConfig](aws-properties-datasync-locationobjectstorage-customsecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretKey` Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server. 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. *Required*: No *Type*: String *Pattern*: `^.+$` *Minimum*: `8` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServerCertificate` 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`. *Required*: No *Type*: String *Maximum*: `32768` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServerHostname` Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to. *Required*: No *Type*: String *Pattern*: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServerPort` Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443). *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `65536` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServerProtocol` Specifies the protocol that your object storage server uses to communicate. If not specified, the default value is `HTTPS`. *Required*: No *Type*: String *Allowed values*: `HTTPS | HTTP` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\p{Zs}]*$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-locationobjectstorage-tag.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource Amazon Resource Name (ARN). For example: `arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). #### `CmkSecretConfig.SecretArn` Property description not available. `LocationArn` The Amazon Resource Name (ARN) of the specified object storage location. `LocationUri` The URI of the specified object storage location. ## Examples ### Create an object storage location for DataSync The following example specifies an object storage location for DataSync. In this example, the object storage location uses the bucket named `MyBucket`, on the server named `MyServer@example.com`. This example also specifies the server protocol `HTTPS` and the subdirectory `/Subdirectory`. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Specifies an object storage location for DataSync", "Resources": { "LocationObjectStorage": { "Type": "AWS::DataSync::LocationObjectStorage", "Properties": { "AgentArns": [ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs" ], "BucketName": "MyBucket", "ServerHostname": "MyServer@example.com", "ServerProtocol": "HTTPS", "Subdirectory": "/MySubdirectory" } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Specifies an object storage location for DataSync Resources: LocationObjectStorage: Type: AWS::DataSync::LocationObjectStorage Properties: AgentArns: - arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs BucketName: MyBucket ServerHostname: MyServer@example.com ServerProtocol: HTTPS Subdirectory: /MySubdirectory ``` # AWS::DataSync::LocationObjectStorage CmkSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KmsKeyArn](#cfn-datasync-locationobjectstorage-cmksecretconfig-kmskeyarn)" : String, "[SecretArn](#cfn-datasync-locationobjectstorage-cmksecretconfig-secretarn)" : String } ``` ### YAML ``` [KmsKeyArn](#cfn-datasync-locationobjectstorage-cmksecretconfig-kmskeyarn): String [SecretArn](#cfn-datasync-locationobjectstorage-cmksecretconfig-secretarn): String ``` ## Properties `KmsKeyArn` 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. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z-0-9]+:[0-9]{12}:key/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` 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`. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationObjectStorage CustomSecretConfig Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretAccessRoleArn](#cfn-datasync-locationobjectstorage-customsecretconfig-secretaccessrolearn)" : String, "[SecretArn](#cfn-datasync-locationobjectstorage-customsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretAccessRoleArn](#cfn-datasync-locationobjectstorage-customsecretconfig-secretaccessrolearn): String [SecretArn](#cfn-datasync-locationobjectstorage-customsecretconfig-secretarn): String ``` ## Properties `SecretAccessRoleArn` Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for `SecretArn`. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationObjectStorage ManagedSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretArn](#cfn-datasync-locationobjectstorage-managedsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretArn](#cfn-datasync-locationobjectstorage-managedsecretconfig-secretarn): String ``` ## Properties `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationObjectStorage Tag 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. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-locationobjectstorage-tag-key)" : String, "[Value](#cfn-datasync-locationobjectstorage-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-locationobjectstorage-tag-key): String [Value](#cfn-datasync-locationobjectstorage-tag-value): String ``` ## Properties `Key` The key for an AWS resource tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value for an AWS resource tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationS3 The `AWS::DataSync::LocationS3` resource specifies an endpoint for an Amazon S3 bucket. For more information, see the [https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::LocationS3", "Properties" : { "[S3BucketArn](#cfn-datasync-locations3-s3bucketarn)" : String, "[S3Config](#cfn-datasync-locations3-s3config)" : S3Config, "[S3StorageClass](#cfn-datasync-locations3-s3storageclass)" : String, "[Subdirectory](#cfn-datasync-locations3-subdirectory)" : String, "[Tags](#cfn-datasync-locations3-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::DataSync::LocationS3 Properties: [S3BucketArn](#cfn-datasync-locations3-s3bucketarn): String [S3Config](#cfn-datasync-locations3-s3config): S3Config [S3StorageClass](#cfn-datasync-locations3-s3storageclass): String [Subdirectory](#cfn-datasync-locations3-subdirectory): String [Tags](#cfn-datasync-locations3-tags): - Tag ``` ## Properties `S3BucketArn` The ARN of the Amazon S3 bucket. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:[a-z\-0-9]*:[0-9]*:.*$` *Maximum*: `156` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `S3Config` The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket. For detailed information about using such a role, see [Creating a Location for Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location) in the *AWS DataSync User Guide*. *Required*: Yes *Type*: [S3Config](aws-properties-datasync-locations3-s3config.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3StorageClass` The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in AWS Regions, the storage class defaults to S3 Standard. For more information about S3 storage classes, see [Amazon S3 Storage Classes](https://aws.amazon.com/s3/storage-classes/). Some storage classes have behaviors that can affect your S3 storage costs. For detailed information, see [Considerations When Working with Amazon S3 Storage Classes in DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes). *Required*: No *Type*: String *Allowed values*: `STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | GLACIER_INSTANT_RETRIEVAL | DEEP_ARCHIVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Subdirectory` Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location). DataSync can't transfer objects with a prefix that begins with a slash (`/`) or includes `//`, `/./`, or `/../` patterns. For example: + `/photos` + `photos//2006/January` + `photos/./2006/February` + `photos/../2006/March` *Required*: No *Type*: String *Pattern*: `^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-locations3-tag.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource Amazon Resource Name (ARN). For example: `arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). #### `LocationArn` The Amazon Resource Name (ARN) of the specified Amazon S3 location. `LocationUri` The URI of the specified Amazon S3 location. ## Examples ### Create an Amazon S3 location for DataSync The following example specifies an S3 location for DataSync. In this example, the S3 location uses the bucket specified by the Amazon Resource Name (ARN) `arn:aws:s3:::amzn-s3-demo-bucket`. The access role is specified by the ARN `arn:aws:iam::111222333444:role/amzn-s3-demo-bucket-access-role`. The example uses the S3 Standard storage class and refers to the subdirectory `/MyFolder`. AWS Security Token Service (AWS STS) must be activated in your account and Region for DataSync to assume the IAM role. For more information about temporary security credentials, see [Temporary security credentials in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html) in the * IAM User Guide *. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Specifies an S3 location for DataSync", "Resources": { "LocationS3": { "Type": "AWS::DataSync::LocationS3", "Properties": { "S3BucketArn": "arn:aws:s3:::amzn-s3-demo-bucket", "S3Config": { "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/amzn-s3-demo-bucket-access-role" }, "S3StorageClass": "STANDARD", "Subdirectory": "/MyFolder" } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Specifies an S3 location for DataSync Resources: LocationS3: Type: AWS::DataSync::LocationS3 Properties: S3BucketArn: arn:aws:s3:::amzn-s3-demo-bucket S3Config: BucketAccessRoleArn: arn:aws:iam::111222333444:role/amzn-s3-demo-bucket-access-role S3StorageClass: STANDARD Subdirectory: /MyFolder ``` # AWS::DataSync::LocationS3 S3Config Specifies the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket. For more information, see [Providing DataSync access to S3 buckets](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketAccessRoleArn](#cfn-datasync-locations3-s3config-bucketaccessrolearn)" : String } ``` ### YAML ``` [BucketAccessRoleArn](#cfn-datasync-locations3-s3config-bucketaccessrolearn): String ``` ## Properties `BucketAccessRoleArn` Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket. *Required*: Yes *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationS3 Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::LocationS3](aws-resource-datasync-locations3.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-locations3-tag-key)" : String, "[Value](#cfn-datasync-locations3-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-locations3-tag-key): String [Value](#cfn-datasync-locations3-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationSMB The `AWS::DataSync::LocationSMB` resource specifies a Server Message Block (SMB) location that AWS DataSync can use as a transfer source or destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::LocationSMB", "Properties" : { "[AgentArns](#cfn-datasync-locationsmb-agentarns)" : [ String, ... ], "[AuthenticationType](#cfn-datasync-locationsmb-authenticationtype)" : String, "[CmkSecretConfig](#cfn-datasync-locationsmb-cmksecretconfig)" : CmkSecretConfig, "[CustomSecretConfig](#cfn-datasync-locationsmb-customsecretconfig)" : CustomSecretConfig, "[DnsIpAddresses](#cfn-datasync-locationsmb-dnsipaddresses)" : [ String, ... ], "[Domain](#cfn-datasync-locationsmb-domain)" : String, "[KerberosKeytab](#cfn-datasync-locationsmb-kerberoskeytab)" : String, "[KerberosKrb5Conf](#cfn-datasync-locationsmb-kerberoskrb5conf)" : String, "[KerberosPrincipal](#cfn-datasync-locationsmb-kerberosprincipal)" : String, "[MountOptions](#cfn-datasync-locationsmb-mountoptions)" : MountOptions, "[Password](#cfn-datasync-locationsmb-password)" : String, "[ServerHostname](#cfn-datasync-locationsmb-serverhostname)" : String, "[Subdirectory](#cfn-datasync-locationsmb-subdirectory)" : String, "[Tags](#cfn-datasync-locationsmb-tags)" : [ Tag, ... ], "[User](#cfn-datasync-locationsmb-user)" : String } } ``` ### YAML ``` Type: AWS::DataSync::LocationSMB Properties: [AgentArns](#cfn-datasync-locationsmb-agentarns): - String [AuthenticationType](#cfn-datasync-locationsmb-authenticationtype): String [CmkSecretConfig](#cfn-datasync-locationsmb-cmksecretconfig): CmkSecretConfig [CustomSecretConfig](#cfn-datasync-locationsmb-customsecretconfig): CustomSecretConfig [DnsIpAddresses](#cfn-datasync-locationsmb-dnsipaddresses): - String [Domain](#cfn-datasync-locationsmb-domain): String [KerberosKeytab](#cfn-datasync-locationsmb-kerberoskeytab): String [KerberosKrb5Conf](#cfn-datasync-locationsmb-kerberoskrb5conf): String [KerberosPrincipal](#cfn-datasync-locationsmb-kerberosprincipal): String [MountOptions](#cfn-datasync-locationsmb-mountoptions): MountOptions [Password](#cfn-datasync-locationsmb-password): String [ServerHostname](#cfn-datasync-locationsmb-serverhostname): String [Subdirectory](#cfn-datasync-locationsmb-subdirectory): String [Tags](#cfn-datasync-locationsmb-tags): - Tag [User](#cfn-datasync-locationsmb-user): String ``` ## Properties `AgentArns` 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). *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `128 | 8` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AuthenticationType` Property description not available. *Required*: No *Type*: String *Allowed values*: `NTLM | KERBEROS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CmkSecretConfig` Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key. You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. *Required*: No *Type*: [CmkSecretConfig](aws-properties-datasync-locationsmb-cmksecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomSecretConfig` Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. *Required*: No *Type*: [CustomSecretConfig](aws-properties-datasync-locationsmb-customsecretconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DnsIpAddresses` Property description not available. *Required*: No *Type*: Array of String *Minimum*: `7` *Maximum*: `15 | 2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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. *Required*: No *Type*: String *Pattern*: `^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$` *Maximum*: `253` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KerberosKeytab` Property description not available. *Required*: No *Type*: String *Maximum*: `87384` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KerberosKrb5Conf` Property description not available. *Required*: No *Type*: String *Maximum*: `174764` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KerberosPrincipal` Property description not available. *Required*: No *Type*: String *Pattern*: `^.+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MountOptions` Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. *Required*: No *Type*: [MountOptions](aws-properties-datasync-locationsmb-mountoptions.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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`. *Required*: No *Type*: String *Pattern*: `^.{0,104}$` *Maximum*: `104` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServerHostname` Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to. If you're using Kerberos authentication, you must specify a domain name. *Required*: No *Type*: String *Pattern*: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$` *Maximum*: `255` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Subdirectory` Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, `/path/to/subdirectory`). Make sure that other SMB clients in your network can also mount this path. To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. 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). *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your location. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-locationsmb-tag.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `User` Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if `AuthenticationType` is set to `NTLM`. For information about choosing a user with the right level of access for your transfer, see [Providing DataSync access to SMB file servers](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions). *Required*: No *Type*: String *Pattern*: `^[^\x5B\x5D\\/:;|=,+*?]{1,104}$` *Maximum*: `104` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource Amazon Resource Name (ARN). For example: `arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). #### `CmkSecretConfig.SecretArn` Property description not available. `LocationArn` The Amazon Resource Name (ARN) of the specified SMB location. `LocationUri` The URI of the specified SMB location. ## Examples ### Creating an SMB location The following example specifies an SMB location for DataSync. In this example, the SMB location uses the domain `EXAMPLE` with SMB version 3. The server hostname is `MyServer@example.com`, and the SMB location is in the `/share` subdirectory. This example also specifies the user ID `user-1` for NTLM authentication. #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Creates an SMB location for DataSync", "Resources": { "LocationSMB": { "Type": "AWS::DataSync::LocationSMB", "Properties": { "AgentArns": [ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs,", "arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3" ], "Domain": "EXAMPLE", "AuthenticationType": "NTLM", "MountOptions": { "Version": "SMB3" }, "Password": "Password", "ServerHostname": "MyServer.example.com", "Subdirectory": "/share", "User": "user-1" } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Creates an SMB location for DataSync Resources: LocationSMB: Type: AWS::DataSync::LocationSMB Properties: AgentArns: - arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs, - arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3 Domain: EXAMPLE AuthenticationType: NTLM MountOptions: Version: SMB3 Password: Password ServerHostname: MyServer.example.com Subdirectory: /share User: user-1 ``` # AWS::DataSync::LocationSMB CmkSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KmsKeyArn](#cfn-datasync-locationsmb-cmksecretconfig-kmskeyarn)" : String, "[SecretArn](#cfn-datasync-locationsmb-cmksecretconfig-secretarn)" : String } ``` ### YAML ``` [KmsKeyArn](#cfn-datasync-locationsmb-cmksecretconfig-kmskeyarn): String [SecretArn](#cfn-datasync-locationsmb-cmksecretconfig-secretarn): String ``` ## Properties `KmsKeyArn` 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. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z-0-9]+:[0-9]{12}:key/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` 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`. *Required*: No *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationSMB CustomSecretConfig Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. **Note** You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretAccessRoleArn](#cfn-datasync-locationsmb-customsecretconfig-secretaccessrolearn)" : String, "[SecretArn](#cfn-datasync-locationsmb-customsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretAccessRoleArn](#cfn-datasync-locationsmb-customsecretconfig-secretaccessrolearn): String [SecretArn](#cfn-datasync-locationsmb-customsecretconfig-secretarn): String ``` ## Properties `SecretAccessRoleArn` Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for `SecretArn`. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationSMB ManagedSecretConfig Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SecretArn](#cfn-datasync-locationsmb-managedsecretconfig-secretarn)" : String } ``` ### YAML ``` [SecretArn](#cfn-datasync-locationsmb-managedsecretconfig-secretarn): String ``` ## Properties `SecretArn` Specifies the ARN for an AWS Secrets Manager secret. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z-0-9]+:[0-9]{12}:secret:.*|)$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationSMB MountOptions Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Version](#cfn-datasync-locationsmb-mountoptions-version)" : String } ``` ### YAML ``` [Version](#cfn-datasync-locationsmb-mountoptions-version): String ``` ## Properties `Version` By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically. These are the following options for configuring the SMB version: + `AUTOMATIC` (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an `Operation Not Supported` error. + `SMB3`: Restricts the protocol negotiation to only SMB version 3.0.2. + `SMB2`: Restricts the protocol negotiation to only SMB version 2.1. + `SMB2_0`: Restricts the protocol negotiation to only SMB version 2.0. + `SMB1`: Restricts the protocol negotiation to only SMB version 1.0. **Note** The `SMB1` option isn't available when [creating an Amazon FSx for NetApp ONTAP location](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html). *Required*: No *Type*: String *Allowed values*: `AUTOMATIC | SMB1 | SMB2_0 | SMB2 | SMB3` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::LocationSMB Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::LocationSMB](aws-resource-datasync-locationsmb.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-locationsmb-tag-key)" : String, "[Value](#cfn-datasync-locationsmb-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-locationsmb-tag-key): String [Value](#cfn-datasync-locationsmb-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task The `AWS::DataSync::Task` resource specifies a task. A task is a set of two locations (source and destination) and a set of `Options` that you use to control the behavior of a task. If you don't specify `Options` when you create a task, AWS DataSync populates them with service defaults. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::DataSync::Task", "Properties" : { "[CloudWatchLogGroupArn](#cfn-datasync-task-cloudwatchloggrouparn)" : String, "[DestinationLocationArn](#cfn-datasync-task-destinationlocationarn)" : String, "[Excludes](#cfn-datasync-task-excludes)" : [ FilterRule, ... ], "[Includes](#cfn-datasync-task-includes)" : [ FilterRule, ... ], "[ManifestConfig](#cfn-datasync-task-manifestconfig)" : ManifestConfig, "[Name](#cfn-datasync-task-name)" : String, "[Options](#cfn-datasync-task-options)" : Options, "[Schedule](#cfn-datasync-task-schedule)" : TaskSchedule, "[SourceLocationArn](#cfn-datasync-task-sourcelocationarn)" : String, "[Tags](#cfn-datasync-task-tags)" : [ Tag, ... ], "[TaskMode](#cfn-datasync-task-taskmode)" : String, "[TaskReportConfig](#cfn-datasync-task-taskreportconfig)" : TaskReportConfig } } ``` ### YAML ``` Type: AWS::DataSync::Task Properties: [CloudWatchLogGroupArn](#cfn-datasync-task-cloudwatchloggrouparn): String [DestinationLocationArn](#cfn-datasync-task-destinationlocationarn): String [Excludes](#cfn-datasync-task-excludes): - FilterRule [Includes](#cfn-datasync-task-includes): - FilterRule [ManifestConfig](#cfn-datasync-task-manifestconfig): ManifestConfig [Name](#cfn-datasync-task-name): String [Options](#cfn-datasync-task-options): Options [Schedule](#cfn-datasync-task-schedule): TaskSchedule [SourceLocationArn](#cfn-datasync-task-sourcelocationarn): String [Tags](#cfn-datasync-task-tags): - Tag [TaskMode](#cfn-datasync-task-taskmode): String [TaskReportConfig](#cfn-datasync-task-taskreportconfig): TaskReportConfig ``` ## Properties `CloudWatchLogGroupArn` Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task. For Enhanced mode tasks, you don't need to specify anything. DataSync automatically sends logs to a CloudWatch log group named `/aws/datasync`. For more information, see [Monitoring data transfers with CloudWatch Logs](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html). *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]*:[0-9]{12}:log-group:([^:\*]*)(:\*)?$` *Maximum*: `562` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DestinationLocationArn` The Amazon Resource Name (ARN) of an AWS storage resource's location. *Required*: Yes *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Excludes` Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see [Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). *Required*: No *Type*: Array of [FilterRule](aws-properties-datasync-task-filterrule.md) *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Includes` Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see [Specifying what DataSync transfers by using filters](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html). *Required*: No *Type*: Array of [FilterRule](aws-properties-datasync-task-filterrule.md) *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ManifestConfig` The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see [Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html). *Required*: No *Type*: [ManifestConfig](aws-properties-datasync-task-manifestconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` Specifies the name of your task. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Options` Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options. *Required*: No *Type*: [Options](aws-properties-datasync-task-options.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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). *Required*: No *Type*: [TaskSchedule](aws-properties-datasync-task-taskschedule.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceLocationArn` Specifies the ARN of your transfer's source location. *Required*: Yes *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `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. *Required*: No *Type*: Array of [Tag](aws-properties-datasync-task-tag.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TaskMode` 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). *Required*: No *Type*: String *Allowed values*: `BASIC | ENHANCED` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TaskReportConfig` 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). *Required*: No *Type*: [TaskReportConfig](aws-properties-datasync-task-taskreportconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the location resource ARN. For example: `arn:aws:datasync:us-east-2:111222333444:task/task-07db7abfc326c50s3` For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `DestinationNetworkInterfaceArns` The ARNs of the destination elastic network interfaces (ENIs) that were created for your subnet. `SourceNetworkInterfaceArns` The ARNs of the source ENIs that were created for your subnet. `Status` The status of the task that was described. `TaskArn` The ARN of the task. ## Examples **Topics** + [Creating an Enhanced mode task](#aws-resource-datasync-task--examples--Creating_an_Enhanced_mode_task) + [Creating a Basic mode task](#aws-resource-datasync-task--examples--Creating_a_Basic_mode_task) ### Creating an Enhanced mode task The following examples create an Enhanced mode task. For more information, see [Choosing a task mode for your data transfer](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html). #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Creates a DataSync task that uses Enhanced mode", "Resources": { "Task": { "Type": "AWS::DataSync::Task", "Properties": { "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2", "Name": "My-Enhanced-mode-task", "TaskMode": "ENHANCED", "Options": { "TransferMode": "CHANGED", "VerifyMode": "ONLY_FILES_TRANSFERRED", "ObjectTags": "PRESERVE", "LogLevel": "TRANSFER" } } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Creates a DataSync task that uses Enhanced mode Resources: Task: Type: AWS::DataSync::Task Properties: SourceLocationArn: arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3 DestinationLocationArn: arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2 Name: My-Enhanced-mode-task TaskMode: ENHANCED Options: TransferMode: CHANGED VerifyMode: ONLY_FILES_TRANSFERRED ObjectTags: PRESERVE LogLevel: TRANSFER ``` ### Creating a Basic mode task The following examples create a Basic mode task. For more information, see [Choosing a task mode for your data transfer](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html). #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Creates a DataSync task that uses Basic mode", "Resources": { "Task": { "Type": "AWS::DataSync::Task", "Properties": { "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2", "Name": "My-Basic-mode-task", "TaskMode": "BASIC", "Options": { "TransferMode": "CHANGED", "VerifyMode": "POINT_IN_TIME_CONSISTENT", "LogLevel": "TRANSFER" }, "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/my-log-group-name:*" } } } } ``` #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: Creates a DataSync task that uses Basic mode Resources: Task: Type: AWS::DataSync::Task Properties: SourceLocationArn: arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3 DestinationLocationArn: arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2 Name: My-Basic-mode-task TaskMode: BASIC Options: TransferMode: CHANGED VerifyMode: POINT_IN_TIME_CONSISTENT LogLevel: TRANSFER CloudWatchLogGroupArn: arn:aws:logs:us-east-2:111222333444:log-group:/my-log-group-name:* ``` # AWS::DataSync::Task Deleted The `Deleted` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReportLevel](#cfn-datasync-task-deleted-reportlevel)" : String } ``` ### YAML ``` [ReportLevel](#cfn-datasync-task-deleted-reportlevel): String ``` ## Properties `ReportLevel` Property description not available. *Required*: No *Type*: String *Allowed values*: `ERRORS_ONLY | SUCCESSES_AND_ERRORS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Destination The `Destination` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3](#cfn-datasync-task-destination-s3)" : TaskReportConfigDestinationS3 } ``` ### YAML ``` [S3](#cfn-datasync-task-destination-s3): TaskReportConfigDestinationS3 ``` ## Properties `S3` Property description not available. *Required*: No *Type*: [TaskReportConfigDestinationS3](aws-properties-datasync-task-taskreportconfigdestinations3.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task FilterRule Specifies which files, folders, and objects to include or exclude when transferring files from source to destination. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FilterType](#cfn-datasync-task-filterrule-filtertype)" : String, "[Value](#cfn-datasync-task-filterrule-value)" : String } ``` ### YAML ``` [FilterType](#cfn-datasync-task-filterrule-filtertype): String [Value](#cfn-datasync-task-filterrule-value): String ``` ## Properties `FilterType` The type of filter rule to apply. AWS DataSync only supports the SIMPLE\$1PATTERN rule type. *Required*: No *Type*: String *Allowed values*: `SIMPLE_PATTERN` *Pattern*: `^[A-Z0-9_]+$` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "\$1" (that is, a pipe), for example: `/folder1|/folder2` *Required*: No *Type*: String *Pattern*: `^[^\x00]+$` *Maximum*: `409600` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task ManifestConfig Configures a manifest, which is a list of files or objects that you want AWS DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Action](#cfn-datasync-task-manifestconfig-action)" : String, "[Format](#cfn-datasync-task-manifestconfig-format)" : String, "[Source](#cfn-datasync-task-manifestconfig-source)" : Source } ``` ### YAML ``` [Action](#cfn-datasync-task-manifestconfig-action): String [Format](#cfn-datasync-task-manifestconfig-format): String [Source](#cfn-datasync-task-manifestconfig-source): Source ``` ## Properties `Action` Specifies what DataSync uses the manifest for. *Required*: No *Type*: String *Allowed values*: `TRANSFER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Format` Specifies the file format of your manifest. For more information, see [Creating a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create). *Required*: No *Type*: String *Allowed values*: `CSV` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` Specifies the manifest that you want DataSync to use and where it's hosted. You must specify this parameter if you're configuring a new manifest on or after February 7, 2024. If you don't, you'll get a 400 status code and `ValidationException` error stating that you're missing the IAM role for DataSync to access the S3 bucket where you're hosting your manifest. For more information, see [Providing DataSync access to your manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access). *Required*: Yes *Type*: [Source](aws-properties-datasync-task-source.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task ManifestConfigSourceS3 The `ManifestConfigSourceS3` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketAccessRoleArn](#cfn-datasync-task-manifestconfigsources3-bucketaccessrolearn)" : String, "[ManifestObjectPath](#cfn-datasync-task-manifestconfigsources3-manifestobjectpath)" : String, "[ManifestObjectVersionId](#cfn-datasync-task-manifestconfigsources3-manifestobjectversionid)" : String, "[S3BucketArn](#cfn-datasync-task-manifestconfigsources3-s3bucketarn)" : String } ``` ### YAML ``` [BucketAccessRoleArn](#cfn-datasync-task-manifestconfigsources3-bucketaccessrolearn): String [ManifestObjectPath](#cfn-datasync-task-manifestconfigsources3-manifestobjectpath): String [ManifestObjectVersionId](#cfn-datasync-task-manifestconfigsources3-manifestobjectversionid): String [S3BucketArn](#cfn-datasync-task-manifestconfigsources3-s3bucketarn): String ``` ## Properties `BucketAccessRoleArn` Property description not available. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ManifestObjectPath` Property description not available. *Required*: No *Type*: String *Pattern*: `^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ManifestObjectVersionId` Property description not available. *Required*: No *Type*: String *Pattern*: `^.+$` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3BucketArn` Property description not available. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\-0-9]*:[0-9]*:.*$` *Maximum*: `156` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Options Represents the options that are available to control the behavior of a [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) operation. This behavior includes preserving metadata, such as user ID (UID), group ID (GID), and file permissions; overwriting files in the destination; data integrity verification; and so on. A task has a set of default options associated with it. If you don't specify an option in [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html), the default value is used. You can override the default options on each task execution by specifying an overriding `Options` value to [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Atime](#cfn-datasync-task-options-atime)" : String, "[BytesPerSecond](#cfn-datasync-task-options-bytespersecond)" : Integer, "[Gid](#cfn-datasync-task-options-gid)" : String, "[LogLevel](#cfn-datasync-task-options-loglevel)" : String, "[Mtime](#cfn-datasync-task-options-mtime)" : String, "[ObjectTags](#cfn-datasync-task-options-objecttags)" : String, "[OverwriteMode](#cfn-datasync-task-options-overwritemode)" : String, "[PosixPermissions](#cfn-datasync-task-options-posixpermissions)" : String, "[PreserveDeletedFiles](#cfn-datasync-task-options-preservedeletedfiles)" : String, "[PreserveDevices](#cfn-datasync-task-options-preservedevices)" : String, "[SecurityDescriptorCopyFlags](#cfn-datasync-task-options-securitydescriptorcopyflags)" : String, "[TaskQueueing](#cfn-datasync-task-options-taskqueueing)" : String, "[TransferMode](#cfn-datasync-task-options-transfermode)" : String, "[Uid](#cfn-datasync-task-options-uid)" : String, "[VerifyMode](#cfn-datasync-task-options-verifymode)" : String } ``` ### YAML ``` [Atime](#cfn-datasync-task-options-atime): String [BytesPerSecond](#cfn-datasync-task-options-bytespersecond): Integer [Gid](#cfn-datasync-task-options-gid): String [LogLevel](#cfn-datasync-task-options-loglevel): String [Mtime](#cfn-datasync-task-options-mtime): String [ObjectTags](#cfn-datasync-task-options-objecttags): String [OverwriteMode](#cfn-datasync-task-options-overwritemode): String [PosixPermissions](#cfn-datasync-task-options-posixpermissions): String [PreserveDeletedFiles](#cfn-datasync-task-options-preservedeletedfiles): String [PreserveDevices](#cfn-datasync-task-options-preservedevices): String [SecurityDescriptorCopyFlags](#cfn-datasync-task-options-securitydescriptorcopyflags): String [TaskQueueing](#cfn-datasync-task-options-taskqueueing): String [TransferMode](#cfn-datasync-task-options-transfermode): String [Uid](#cfn-datasync-task-options-uid): String [VerifyMode](#cfn-datasync-task-options-verifymode): String ``` ## Properties `Atime` A file metadata value that shows the last time that a file was accessed (that is, when the file was read or written to). If you set `Atime` to `BEST_EFFORT`, AWS DataSync attempts to preserve the original `Atime` attribute on all source files (that is, the version before the PREPARING phase). However, `Atime`'s behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis. Default value: `BEST_EFFORT` `BEST_EFFORT`: Attempt to preserve the per-file `Atime` value (recommended). `NONE`: Ignore `Atime`. If `Atime` is set to `BEST_EFFORT`, `Mtime` must be set to `PRESERVE`. If `Atime` is set to `NONE`, `Mtime` must also be `NONE`. *Required*: No *Type*: String *Allowed values*: `NONE | BEST_EFFORT` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BytesPerSecond` A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to `1048576` (=1024\$11024). *Required*: No *Type*: Integer *Minimum*: `-1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Gid` The group ID (GID) of the file's owners. Default value: `INT_VALUE` `INT_VALUE`: Preserve the integer value of the user ID (UID) and group ID (GID) (recommended). `NAME`: Currently not supported. `NONE`: Ignore the UID and GID. *Required*: No *Type*: String *Allowed values*: `NONE | INT_VALUE | NAME | BOTH` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LogLevel` Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn). + `BASIC` - Publishes logs with only basic information (such as transfer errors). + `TRANSFER` - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on. + `OFF` - No logs are published. *Required*: No *Type*: String *Allowed values*: `OFF | BASIC | TRANSFER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Mtime` A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time. Default value: `PRESERVE` `PRESERVE`: Preserve original `Mtime` (recommended) `NONE`: Ignore `Mtime`. If `Mtime` is set to `PRESERVE`, `Atime` must be set to `BEST_EFFORT`. If `Mtime` is set to `NONE`, `Atime` must also be set to `NONE`. *Required*: No *Type*: String *Allowed values*: `NONE | PRESERVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectTags` Specifies whether you want DataSync to `PRESERVE` object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the `NONE` value. *Required*: No *Type*: String *Allowed values*: `PRESERVE | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OverwriteMode` Specifies whether DataSync should modify or preserve data at the destination location. + `ALWAYS` (default) - DataSync modifies data in the destination location when source data (including metadata) has changed. If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see [Storage class considerations with Amazon S3 transfers](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes). + `NEVER` - DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination. *Required*: No *Type*: String *Allowed values*: `ALWAYS | NEVER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PosixPermissions` A value that determines which users or groups can access a file for a specific purpose, such as reading, writing, or execution of the file. This option should be set only for Network File System (NFS), Amazon EFS, and Amazon S3 locations. For more information about what metadata is copied by DataSync, see [Metadata Copied by DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied). Default value: `PRESERVE` `PRESERVE`: Preserve POSIX-style permissions (recommended). `NONE`: Ignore permissions. AWS DataSync can preserve extant permissions of a source location. *Required*: No *Type*: String *Allowed values*: `NONE | PRESERVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PreserveDeletedFiles` A value that specifies whether files in the destination that don't exist in the source file system are preserved. This option can affect your storage costs. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see [Considerations when working with Amazon S3 storage classes in DataSync ](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) in the *AWS DataSync User Guide*. Default value: `PRESERVE` `PRESERVE`: Ignore destination files that aren't present in the source (recommended). `REMOVE`: Delete destination files that aren't present in the source. *Required*: No *Type*: String *Allowed values*: `PRESERVE | REMOVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PreserveDevices` A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata. AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker. Default value: `NONE` `NONE`: Ignore special devices (recommended). `PRESERVE`: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS. *Required*: No *Type*: String *Allowed values*: `NONE | PRESERVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SecurityDescriptorCopyFlags` A value that determines which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. For more information about how DataSync handles metadata, see [How DataSync Handles Metadata and Special Files](https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html). Default value: `OWNER_DACL` `OWNER_DACL`: For each copied object, DataSync copies the following metadata: + Object owner. + NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object. When you use option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object. `OWNER_DACL_SACL`: For each copied object, DataSync copies the following metadata: + Object owner. + NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object. + NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object. Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see [user](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#SMBuser). `NONE`: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration. *Required*: No *Type*: String *Allowed values*: `NONE | OWNER_DACL | OWNER_DACL_SACL` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TaskQueueing` Specifies whether your transfer tasks should be put into a queue during certain scenarios when [running multiple tasks](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#running-multiple-tasks). This is `ENABLED` by default. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TransferMode` A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing it to the destination location. `CHANGED`: DataSync copies only data or metadata that is new or different from the source location to the destination location. `ALL`: DataSync copies all source location content to the destination, without comparing it to existing content on the destination. *Required*: No *Type*: String *Allowed values*: `CHANGED | ALL` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Uid` The user ID (UID) of the file's owner. Default value: `INT_VALUE` `INT_VALUE`: Preserve the integer value of the UID and group ID (GID) (recommended). `NAME`: Currently not supported `NONE`: Ignore the UID and GID. *Required*: No *Type*: String *Allowed values*: `NONE | INT_VALUE | NAME | BOTH` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VerifyMode` A value that determines whether a data integrity verification is performed at the end of a task execution after all data and metadata have been transferred. For more information, see [Configure task settings](https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html). Default value: `POINT_IN_TIME_CONSISTENT` `ONLY_FILES_TRANSFERRED` (recommended): Perform verification only on files that were transferred. `POINT_IN_TIME_CONSISTENT`: Scan the entire source and entire destination at the end of the transfer to verify that the source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes. `NONE`: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer. *Required*: No *Type*: String *Allowed values*: `POINT_IN_TIME_CONSISTENT | ONLY_FILES_TRANSFERRED | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Overrides The `Overrides` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Deleted](#cfn-datasync-task-overrides-deleted)" : Deleted, "[Skipped](#cfn-datasync-task-overrides-skipped)" : Skipped, "[Transferred](#cfn-datasync-task-overrides-transferred)" : Transferred, "[Verified](#cfn-datasync-task-overrides-verified)" : Verified } ``` ### YAML ``` [Deleted](#cfn-datasync-task-overrides-deleted): Deleted [Skipped](#cfn-datasync-task-overrides-skipped): Skipped [Transferred](#cfn-datasync-task-overrides-transferred): Transferred [Verified](#cfn-datasync-task-overrides-verified): Verified ``` ## Properties `Deleted` Property description not available. *Required*: No *Type*: [Deleted](aws-properties-datasync-task-deleted.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Skipped` Property description not available. *Required*: No *Type*: [Skipped](aws-properties-datasync-task-skipped.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Transferred` Property description not available. *Required*: No *Type*: [Transferred](aws-properties-datasync-task-transferred.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Verified` Property description not available. *Required*: No *Type*: [Verified](aws-properties-datasync-task-verified.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Skipped The `Skipped` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReportLevel](#cfn-datasync-task-skipped-reportlevel)" : String } ``` ### YAML ``` [ReportLevel](#cfn-datasync-task-skipped-reportlevel): String ``` ## Properties `ReportLevel` Property description not available. *Required*: No *Type*: String *Allowed values*: `ERRORS_ONLY | SUCCESSES_AND_ERRORS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Source The `Source` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3](#cfn-datasync-task-source-s3)" : ManifestConfigSourceS3 } ``` ### YAML ``` [S3](#cfn-datasync-task-source-s3): ManifestConfigSourceS3 ``` ## Properties `S3` Property description not available. *Required*: No *Type*: [ManifestConfigSourceS3](aws-properties-datasync-task-manifestconfigsources3.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Tag The `Tag` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-datasync-task-tag-key)" : String, "[Value](#cfn-datasync-task-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-datasync-task-tag-key): String [Value](#cfn-datasync-task-tag-value): String ``` ## Properties `Key` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` Property description not available. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s+=._:@/-]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task TaskReportConfig Specifies how you want to configure a task report, which provides detailed information about for your AWS DataSync transfer. For more information, see [Task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Destination](#cfn-datasync-task-taskreportconfig-destination)" : Destination, "[ObjectVersionIds](#cfn-datasync-task-taskreportconfig-objectversionids)" : String, "[OutputType](#cfn-datasync-task-taskreportconfig-outputtype)" : String, "[Overrides](#cfn-datasync-task-taskreportconfig-overrides)" : Overrides, "[ReportLevel](#cfn-datasync-task-taskreportconfig-reportlevel)" : String } ``` ### YAML ``` [Destination](#cfn-datasync-task-taskreportconfig-destination): Destination [ObjectVersionIds](#cfn-datasync-task-taskreportconfig-objectversionids): String [OutputType](#cfn-datasync-task-taskreportconfig-outputtype): String [Overrides](#cfn-datasync-task-taskreportconfig-overrides): Overrides [ReportLevel](#cfn-datasync-task-taskreportconfig-reportlevel): String ``` ## Properties `Destination` Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see [Task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access). *Required*: Yes *Type*: [Destination](aws-properties-datasync-task-destination.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectVersionIds` Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you [enable versioning on your bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html). Keep in mind that setting this to `INCLUDE` can increase the duration of your task execution. *Required*: No *Type*: String *Allowed values*: `INCLUDE | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputType` Specifies the type of task report that you want: + `SUMMARY_ONLY`: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration. + `STANDARD`: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more. *Required*: Yes *Type*: String *Allowed values*: `SUMMARY_ONLY | STANDARD` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Overrides` Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location. *Required*: No *Type*: [Overrides](aws-properties-datasync-task-overrides.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ReportLevel` Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. + `ERRORS_ONLY`: A report shows what DataSync was unable to transfer, skip, verify, and delete. + `SUCCESSES_AND_ERRORS`: A report shows what DataSync was able and unable to transfer, skip, verify, and delete. *Required*: No *Type*: String *Allowed values*: `ERRORS_ONLY | SUCCESSES_AND_ERRORS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task TaskReportConfigDestinationS3 The `TaskReportConfigDestinationS3` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketAccessRoleArn](#cfn-datasync-task-taskreportconfigdestinations3-bucketaccessrolearn)" : String, "[S3BucketArn](#cfn-datasync-task-taskreportconfigdestinations3-s3bucketarn)" : String, "[Subdirectory](#cfn-datasync-task-taskreportconfigdestinations3-subdirectory)" : String } ``` ### YAML ``` [BucketAccessRoleArn](#cfn-datasync-task-taskreportconfigdestinations3-bucketaccessrolearn): String [S3BucketArn](#cfn-datasync-task-taskreportconfigdestinations3-s3bucketarn): String [Subdirectory](#cfn-datasync-task-taskreportconfigdestinations3-subdirectory): String ``` ## Properties `BucketAccessRoleArn` Property description not available. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3BucketArn` Property description not available. *Required*: No *Type*: String *Pattern*: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):(s3|s3-outposts):[a-z\-0-9]*:[0-9]*:.*$` *Maximum*: `156` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Subdirectory` Property description not available. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-\+\./\p{Zs}]*$` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task TaskSchedule 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). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ScheduleExpression](#cfn-datasync-task-taskschedule-scheduleexpression)" : String, "[Status](#cfn-datasync-task-taskschedule-status)" : String } ``` ### YAML ``` [ScheduleExpression](#cfn-datasync-task-taskschedule-scheduleexpression): String [Status](#cfn-datasync-task-taskschedule-status): String ``` ## Properties `ScheduleExpression` 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 [https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html). *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9\ \_\*\?\,\|\^\-\/\#\s\+]*$` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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). *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Transferred The `Transferred` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReportLevel](#cfn-datasync-task-transferred-reportlevel)" : String } ``` ### YAML ``` [ReportLevel](#cfn-datasync-task-transferred-reportlevel): String ``` ## Properties `ReportLevel` Property description not available. *Required*: No *Type*: String *Allowed values*: `ERRORS_ONLY | SUCCESSES_AND_ERRORS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::DataSync::Task Verified The `Verified` property type specifies Property description not available. for an [AWS::DataSync::Task](aws-resource-datasync-task.md). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ReportLevel](#cfn-datasync-task-verified-reportlevel)" : String } ``` ### YAML ``` [ReportLevel](#cfn-datasync-task-verified-reportlevel): String ``` ## Properties `ReportLevel` Property description not available. *Required*: No *Type*: String *Allowed values*: `ERRORS_ONLY | SUCCESSES_AND_ERRORS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)