location_smb

Gets an individual location_smb resource

Overview

Name	location_smb
Type	Resource
Description	location_smb
Id	awscc.datasync.location_smb

Fields

Name	Datatype	Description
agent_arns	array	The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
domain	string	The name of the Windows domain that the SMB server belongs to.
mount_options	object
password	string	The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
server_hostname	string	The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
subdirectory	string	The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
user	string	The user who can mount the share, has the permissions to access files and folders in the SMB share.
tags	array	An array of key-value pairs to apply to this resource.
location_arn	string	The Amazon Resource Name (ARN) of the SMB location that is created.
location_uri	string	The URL of the SMB location that was described.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
agent_arns,
domain,
mount_options,
password,
server_hostname,
subdirectory,
user,
tags,
location_arn,
location_uri
FROM awscc.datasync.location_smb
WHERE data__Identifier = '<LocationArn>';

Permissions

To operate on the location_smb resource, the following permissions are required:

Read

datasync:DescribeLocationSmb,
datasync:ListTagsForResource

Update

datasync:DescribeLocationSmb,
datasync:ListTagsForResource,
datasync:TagResource,
datasync:UntagResource,
datasync:UpdateLocationSmb

Delete

datasync:DeleteLocation