Resource: awsDatasyncLocationSmb
Manages a SMB Location within AWS DataSync.
\~> NOTE: The DataSync Agents must be available before creating this resource.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.datasyncLocationSmb.DatasyncLocationSmb(this, "example", {
agentArns: ["${aws_datasync_agent.example.arn}"],
password: "ANotGreatPassword",
serverHostname: "smb.example.com",
subdirectory: "/exported/path",
user: "Guest",
});
Argument Reference
The following arguments are supported:
agentArns
- (Required) A list of DataSync Agent ARNs with which this location will be associated.domain
- (Optional) The name of the Windows domain the SMB server belongs to.mountOptions
- (Optional) Configuration block containing mount options used by DataSync to access the SMB Server. Can beautomatic
,smb2
, orsmb3
.password
- (Required) The password of the user who can mount the share and has file permissions in the SMB.serverHostname
- (Required) Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.subdirectory
- (Required) Subdirectory to perform actions as source or destination. Should be exported by the NFS server.tags
- (Optional) Key-value pairs of resource tags to assign to the DataSync Location. If configured with a providerdefaultTags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.user
- (Required) The user who can mount the share and has file and folder permissions in the SMB share.
mount_options Argument Reference
The following arguments are supported inside the mountOptions
configuration block:
version
- (Optional) The specific SMB version that you want DataSync to use for mounting your SMB share. Valid values:automatic
,smb2
, andsmb3
. Default:automatic
Attributes Reference
In addition to all arguments above, the following attributes are exported:
arn
- Amazon Resource Name (ARN) of the DataSync Location.tagsAll
- A map of tags assigned to the resource, including those inherited from the providerdefaultTags
configuration block.
Import
awsDatasyncLocationSmb
can be imported by using the Amazon Resource Name (ARN), e.g.,