Skip to main content

access

Creates, updates, deletes, gets or lists an access resource.

Overview​

Nameaccess
TypeResource
Idaws.transfer.access

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
accessobjectThe external identifier of the server that the access is attached to.
server_idstringA system-assigned unique identifier for a server that has this access assigned. (pattern: <code>s-([0-9a-f]{17})</code>)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_accessselectregionDescribes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId. The response from this call returns the properties of the access that is associated with the ServerId value that was specified.
create_accessinsertregion, Role, ServerId, ExternalIdUsed by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.
update_accessupdateregion, ServerId, ExternalIdAllows you to update parameters for the access specified in the ServerID and ExternalID parameters.
delete_accessdeleteregionAllows you to delete the access specified in the ServerID and ExternalID parameters.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId. The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

SELECT
access,
server_id
FROM aws.transfer.access
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Used by administrators to choose which groups in the directory should have access to upload and download files over the enabled protocols using Transfer Family. For example, a Microsoft Active Directory might contain 50,000 users, but only a small fraction might need the ability to transfer files to the server. An administrator can use CreateAccess to limit the access to the correct set of users who need this ability.

INSERT INTO aws.transfer.access (
HomeDirectory,
HomeDirectoryType,
HomeDirectoryMappings,
Policy,
PosixProfile,
Role,
ServerId,
ExternalId,
region
)
SELECT 
'{{ HomeDirectory }}',
'{{ HomeDirectoryType }}',
'{{ HomeDirectoryMappings }}',
'{{ Policy }}',
'{{ PosixProfile }}',
'{{ Role }}' /* required */,
'{{ ServerId }}' /* required */,
'{{ ExternalId }}' /* required */,
'{{ region }}'
RETURNING
external_id,
server_id
;

UPDATE examples​

Allows you to update parameters for the access specified in the ServerID and ExternalID parameters.

UPDATE aws.transfer.access
SET 
HomeDirectory = '{{ HomeDirectory }}',
HomeDirectoryType = '{{ HomeDirectoryType }}',
HomeDirectoryMappings = '{{ HomeDirectoryMappings }}',
Policy = '{{ Policy }}',
PosixProfile = '{{ PosixProfile }}',
Role = '{{ Role }}',
ServerId = '{{ ServerId }}',
ExternalId = '{{ ExternalId }}'
WHERE 
region = '{{ region }}' --required
AND ServerId = '{{ ServerId }}' --required
AND ExternalId = '{{ ExternalId }}' --required
RETURNING
external_id,
server_id;

DELETE examples​

Allows you to delete the access specified in the ServerID and ExternalID parameters.

DELETE FROM aws.transfer.access
WHERE region = '{{ region }}' --required
;
Last updated on