Skip to main content

location_smbs

Creates, updates, deletes or gets a location_smb resource or lists location_smbs in a region

Overview

Namelocation_smbs
TypeResource
DescriptionResource schema for AWS::DataSync::LocationSMB.
Idaws.datasync.location_smbs

Fields

NameDatatypeDescription
agent_arnsarrayThe Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
domainstringThe name of the Windows domain that the SMB server belongs to.
mount_optionsobjectThe mount options used by DataSync to access the SMB server.
passwordstringThe password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
server_hostnamestringThe name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
subdirectorystringThe subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
userstringThe user who can mount the share, has the permissions to access files and folders in the SMB share.
tagsarrayAn array of key-value pairs to apply to this resource.
location_arnstringThe Amazon Resource Name (ARN) of the SMB location that is created.
location_uristringThe URL of the SMB location that was described.
regionstringAWS region.

Methods

NameAccessible byRequired Params
create_resourceINSERTUser, AgentArns, region
delete_resourceDELETEdata__Identifier, region
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
list_resourcesSELECTregion
get_resourceSELECTdata__Identifier, region

SELECT examples

Gets all location_smbs in a region.

SELECT
region,
agent_arns,
domain,
mount_options,
password,
server_hostname,
subdirectory,
user,
tags,
location_arn,
location_uri
FROM aws.datasync.location_smbs
WHERE region = 'us-east-1';

Gets all properties from an individual location_smb.

SELECT
region,
agent_arns,
domain,
mount_options,
password,
server_hostname,
subdirectory,
user,
tags,
location_arn,
location_uri
FROM aws.datasync.location_smbs
WHERE region = 'us-east-1' AND data__Identifier = '<LocationArn>';

INSERT example

Use the following StackQL query and manifest file to create a new location_smb resource, using stack-deploy.

/*+ create */
INSERT INTO aws.datasync.location_smbs (
AgentArns,
User,
region
)
SELECT
'{{ AgentArns }}',
'{{ User }}',
'{{ region }}';

DELETE example

/*+ delete */
DELETE FROM aws.datasync.location_smbs
WHERE data__Identifier = '<LocationArn>'
AND region = 'us-east-1';

Permissions

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

Create

datasync:CreateLocationSmb,
datasync:DescribeLocationSmb,
datasync:ListTagsForResource,
datasync:TagResource

Read

datasync:DescribeLocationSmb,
datasync:ListTagsForResource

Update

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

Delete

datasync:DeleteLocation

List

datasync:ListLocations