location_smbs_list_only
Lists location_smbs
in a region or regions, for all properties use location_smbs
Overview
Name | location_smbs_list_only |
Type | Resource |
Description | Resource schema for AWS::DataSync::LocationSMB. |
Id | aws.datasync.location_smbs_list_only |
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 | The mount options used by DataSync to access the SMB server. |
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
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
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