AWS::DataSync::LocationSMB - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::DataSync::LocationSMB

The AWS::DataSync::LocationSMB resource specifies a Server Message Block (SMB) location that Amazon DataSync can use as a transfer source or destination.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataSync::LocationSMB",
  "Properties" : {
      "AgentArns" : [ String, ... ],
      "AuthenticationType" : String,
      "CmkSecretConfig" : CmkSecretConfig,
      "CustomSecretConfig" : CustomSecretConfig,
      "DnsIpAddresses" : [ String, ... ],
      "Domain" : String,
      "KerberosKeytab" : String,
      "KerberosKrb5Conf" : String,
      "KerberosPrincipal" : String,
      "MountOptions" : MountOptions,
      "Password" : String,
      "ServerHostname" : String,
      "Subdirectory" : String,
      "Tags" : [ Tag, ... ],
      "User" : String
    }
}

YAML

Type: AWS::DataSync::LocationSMB
Properties:
  AgentArns: 
    - String
  AuthenticationType: String
  CmkSecretConfig: 
    CmkSecretConfig
  CustomSecretConfig: 
    CustomSecretConfig
  DnsIpAddresses: 
    - String
  Domain: String
  KerberosKeytab: String
  KerberosKrb5Conf: String
  KerberosPrincipal: String
  MountOptions: 
    MountOptions
  Password: String
  ServerHostname: String
  Subdirectory: String
  Tags: 
    - Tag
  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 | 4

Update requires: No interruption

AuthenticationType

Property description not available.

Required: No

Type: String

Allowed values: NTLM | KERBEROS

Update requires: No interruption

CmkSecretConfig

Specifies configuration information for a DataSync-managed secret, such as an authentication token or secret key that DataSync uses to access a specific storage location, with a customer-managed Amazon 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.

Required: No

Type: CmkSecretConfig

Update requires: No interruption

CustomSecretConfig

Specifies configuration information for a customer-managed Secrets Manager secret where a storage location authentication token or secret key is stored in plain text. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

Note

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

Update requires: No interruption

DnsIpAddresses

Property description not available.

Required: No

Type: Array of String

Minimum: 7

Maximum: 15 | 2

Update requires: No interruption

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

KerberosKeytab

Property description not available.

Required: No

Type: String

Maximum: 87384

Update requires: No interruption

KerberosKrb5Conf

Property description not available.

Required: No

Type: String

Maximum: 174764

Update requires: No interruption

KerberosPrincipal

Property description not available.

Required: No

Type: String

Pattern: ^.+$

Minimum: 1

Maximum: 256

Update requires: No interruption

MountOptions

Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

Required: No

Type: MountOptions

Update requires: No interruption

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

ServerHostname

Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.

Note

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

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.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$

Maximum: 4096

Update requires: No interruption

Tags

Specifies labels that help you categorize, filter, and search for your Amazon resources. We recommend creating at least a name tag for your location.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

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.

Required: No

Type: String

Pattern: ^[^\x5B\x5D\\/:;|=,+*?]{1,104}$

Maximum: 104

Update requires: No interruption

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.

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.

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