Skip to main content

location_smbs_list_only

Lists location_smbs in a region or regions, for all properties use location_smbs

Overview

Namelocation_smbs_list_only
TypeResource
DescriptionResource schema for AWS::DataSync::LocationSMB.
Idaws.datasync.location_smbs_list_only

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
list_resourcesSELECTregion

SELECT examples

Lists all location_smbs in a region.

SELECT
region,
location_arn
FROM aws.datasync.location_smbs_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the location_smbs_list_only resource, see location_smbs