AWS SDK for C++  1.9.104
AWS SDK for C++
Public Member Functions | List of all members
Aws::Transfer::Model::UpdateAccessRequest Class Reference

#include <UpdateAccessRequest.h>

+ Inheritance diagram for Aws::Transfer::Model::UpdateAccessRequest:

Public Member Functions

 UpdateAccessRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetHomeDirectory () const
 
bool HomeDirectoryHasBeenSet () const
 
void SetHomeDirectory (const Aws::String &value)
 
void SetHomeDirectory (Aws::String &&value)
 
void SetHomeDirectory (const char *value)
 
UpdateAccessRequestWithHomeDirectory (const Aws::String &value)
 
UpdateAccessRequestWithHomeDirectory (Aws::String &&value)
 
UpdateAccessRequestWithHomeDirectory (const char *value)
 
const HomeDirectoryTypeGetHomeDirectoryType () const
 
bool HomeDirectoryTypeHasBeenSet () const
 
void SetHomeDirectoryType (const HomeDirectoryType &value)
 
void SetHomeDirectoryType (HomeDirectoryType &&value)
 
UpdateAccessRequestWithHomeDirectoryType (const HomeDirectoryType &value)
 
UpdateAccessRequestWithHomeDirectoryType (HomeDirectoryType &&value)
 
const Aws::Vector< HomeDirectoryMapEntry > & GetHomeDirectoryMappings () const
 
bool HomeDirectoryMappingsHasBeenSet () const
 
void SetHomeDirectoryMappings (const Aws::Vector< HomeDirectoryMapEntry > &value)
 
void SetHomeDirectoryMappings (Aws::Vector< HomeDirectoryMapEntry > &&value)
 
UpdateAccessRequestWithHomeDirectoryMappings (const Aws::Vector< HomeDirectoryMapEntry > &value)
 
UpdateAccessRequestWithHomeDirectoryMappings (Aws::Vector< HomeDirectoryMapEntry > &&value)
 
UpdateAccessRequestAddHomeDirectoryMappings (const HomeDirectoryMapEntry &value)
 
UpdateAccessRequestAddHomeDirectoryMappings (HomeDirectoryMapEntry &&value)
 
const Aws::StringGetPolicy () const
 
bool PolicyHasBeenSet () const
 
void SetPolicy (const Aws::String &value)
 
void SetPolicy (Aws::String &&value)
 
void SetPolicy (const char *value)
 
UpdateAccessRequestWithPolicy (const Aws::String &value)
 
UpdateAccessRequestWithPolicy (Aws::String &&value)
 
UpdateAccessRequestWithPolicy (const char *value)
 
const PosixProfileGetPosixProfile () const
 
bool PosixProfileHasBeenSet () const
 
void SetPosixProfile (const PosixProfile &value)
 
void SetPosixProfile (PosixProfile &&value)
 
UpdateAccessRequestWithPosixProfile (const PosixProfile &value)
 
UpdateAccessRequestWithPosixProfile (PosixProfile &&value)
 
const Aws::StringGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const Aws::String &value)
 
void SetRole (Aws::String &&value)
 
void SetRole (const char *value)
 
UpdateAccessRequestWithRole (const Aws::String &value)
 
UpdateAccessRequestWithRole (Aws::String &&value)
 
UpdateAccessRequestWithRole (const char *value)
 
const Aws::StringGetServerId () const
 
bool ServerIdHasBeenSet () const
 
void SetServerId (const Aws::String &value)
 
void SetServerId (Aws::String &&value)
 
void SetServerId (const char *value)
 
UpdateAccessRequestWithServerId (const Aws::String &value)
 
UpdateAccessRequestWithServerId (Aws::String &&value)
 
UpdateAccessRequestWithServerId (const char *value)
 
const Aws::StringGetExternalId () const
 
bool ExternalIdHasBeenSet () const
 
void SetExternalId (const Aws::String &value)
 
void SetExternalId (Aws::String &&value)
 
void SetExternalId (const char *value)
 
UpdateAccessRequestWithExternalId (const Aws::String &value)
 
UpdateAccessRequestWithExternalId (Aws::String &&value)
 
UpdateAccessRequestWithExternalId (const char *value)
 
- Public Member Functions inherited from Aws::Transfer::TransferRequest
virtual ~TransferRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file UpdateAccessRequest.h.

Constructor & Destructor Documentation

◆ UpdateAccessRequest()

Aws::Transfer::Model::UpdateAccessRequest::UpdateAccessRequest ( )

Member Function Documentation

◆ AddHomeDirectoryMappings() [1/2]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::AddHomeDirectoryMappings ( const HomeDirectoryMapEntry value)
inline

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 374 of file UpdateAccessRequest.h.

◆ AddHomeDirectoryMappings() [2/2]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::AddHomeDirectoryMappings ( HomeDirectoryMapEntry &&  value)
inline

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 405 of file UpdateAccessRequest.h.

◆ ExternalIdHasBeenSet()

bool Aws::Transfer::Model::UpdateAccessRequest::ExternalIdHasBeenSet ( ) const
inline

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 746 of file UpdateAccessRequest.h.

◆ GetExternalId()

const Aws::String& Aws::Transfer::Model::UpdateAccessRequest::GetExternalId ( ) const
inline

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 731 of file UpdateAccessRequest.h.

◆ GetHomeDirectory()

const Aws::String& Aws::Transfer::Model::UpdateAccessRequest::GetHomeDirectory ( ) const
inline

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

Definition at line 46 of file UpdateAccessRequest.h.

◆ GetHomeDirectoryMappings()

const Aws::Vector<HomeDirectoryMapEntry>& Aws::Transfer::Model::UpdateAccessRequest::GetHomeDirectoryMappings ( ) const
inline

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 188 of file UpdateAccessRequest.h.

◆ GetHomeDirectoryType()

const HomeDirectoryType& Aws::Transfer::Model::UpdateAccessRequest::GetHomeDirectoryType ( ) const
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Definition at line 106 of file UpdateAccessRequest.h.

◆ GetPolicy()

const Aws::String& Aws::Transfer::Model::UpdateAccessRequest::GetPolicy ( ) const
inline

A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

Definition at line 425 of file UpdateAccessRequest.h.

◆ GetPosixProfile()

const PosixProfile& Aws::Transfer::Model::UpdateAccessRequest::GetPosixProfile ( ) const
inline

Definition at line 562 of file UpdateAccessRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Transfer::Model::UpdateAccessRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Transfer::TransferRequest.

◆ GetRole()

const Aws::String& Aws::Transfer::Model::UpdateAccessRequest::GetRole ( ) const
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

Definition at line 589 of file UpdateAccessRequest.h.

◆ GetServerId()

const Aws::String& Aws::Transfer::Model::UpdateAccessRequest::GetServerId ( ) const
inline

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

Definition at line 673 of file UpdateAccessRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Transfer::Model::UpdateAccessRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file UpdateAccessRequest.h.

◆ HomeDirectoryHasBeenSet()

bool Aws::Transfer::Model::UpdateAccessRequest::HomeDirectoryHasBeenSet ( ) const
inline

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

Definition at line 53 of file UpdateAccessRequest.h.

◆ HomeDirectoryMappingsHasBeenSet()

bool Aws::Transfer::Model::UpdateAccessRequest::HomeDirectoryMappingsHasBeenSet ( ) const
inline

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 219 of file UpdateAccessRequest.h.

◆ HomeDirectoryTypeHasBeenSet()

bool Aws::Transfer::Model::UpdateAccessRequest::HomeDirectoryTypeHasBeenSet ( ) const
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Definition at line 116 of file UpdateAccessRequest.h.

◆ PolicyHasBeenSet()

bool Aws::Transfer::Model::UpdateAccessRequest::PolicyHasBeenSet ( ) const
inline

A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

Definition at line 444 of file UpdateAccessRequest.h.

◆ PosixProfileHasBeenSet()

bool Aws::Transfer::Model::UpdateAccessRequest::PosixProfileHasBeenSet ( ) const
inline

Definition at line 565 of file UpdateAccessRequest.h.

◆ RoleHasBeenSet()

bool Aws::Transfer::Model::UpdateAccessRequest::RoleHasBeenSet ( ) const
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

Definition at line 600 of file UpdateAccessRequest.h.

◆ SerializePayload()

Aws::String Aws::Transfer::Model::UpdateAccessRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServerIdHasBeenSet()

bool Aws::Transfer::Model::UpdateAccessRequest::ServerIdHasBeenSet ( ) const
inline

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

Definition at line 679 of file UpdateAccessRequest.h.

◆ SetExternalId() [1/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetExternalId ( Aws::String &&  value)
inline

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 776 of file UpdateAccessRequest.h.

◆ SetExternalId() [2/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetExternalId ( const Aws::String value)
inline

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 761 of file UpdateAccessRequest.h.

◆ SetExternalId() [3/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetExternalId ( const char *  value)
inline

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 791 of file UpdateAccessRequest.h.

◆ SetHomeDirectory() [1/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetHomeDirectory ( Aws::String &&  value)
inline

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

Definition at line 67 of file UpdateAccessRequest.h.

◆ SetHomeDirectory() [2/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetHomeDirectory ( const Aws::String value)
inline

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

Definition at line 60 of file UpdateAccessRequest.h.

◆ SetHomeDirectory() [3/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetHomeDirectory ( const char *  value)
inline

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

Definition at line 74 of file UpdateAccessRequest.h.

◆ SetHomeDirectoryMappings() [1/2]

void Aws::Transfer::Model::UpdateAccessRequest::SetHomeDirectoryMappings ( Aws::Vector< HomeDirectoryMapEntry > &&  value)
inline

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 281 of file UpdateAccessRequest.h.

◆ SetHomeDirectoryMappings() [2/2]

void Aws::Transfer::Model::UpdateAccessRequest::SetHomeDirectoryMappings ( const Aws::Vector< HomeDirectoryMapEntry > &  value)
inline

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 250 of file UpdateAccessRequest.h.

◆ SetHomeDirectoryType() [1/2]

void Aws::Transfer::Model::UpdateAccessRequest::SetHomeDirectoryType ( const HomeDirectoryType value)
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Definition at line 126 of file UpdateAccessRequest.h.

◆ SetHomeDirectoryType() [2/2]

void Aws::Transfer::Model::UpdateAccessRequest::SetHomeDirectoryType ( HomeDirectoryType &&  value)
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Definition at line 136 of file UpdateAccessRequest.h.

◆ SetPolicy() [1/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetPolicy ( Aws::String &&  value)
inline

A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

Definition at line 482 of file UpdateAccessRequest.h.

◆ SetPolicy() [2/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetPolicy ( const Aws::String value)
inline

A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

Definition at line 463 of file UpdateAccessRequest.h.

◆ SetPolicy() [3/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetPolicy ( const char *  value)
inline

A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

Definition at line 501 of file UpdateAccessRequest.h.

◆ SetPosixProfile() [1/2]

void Aws::Transfer::Model::UpdateAccessRequest::SetPosixProfile ( const PosixProfile value)
inline

Definition at line 568 of file UpdateAccessRequest.h.

◆ SetPosixProfile() [2/2]

void Aws::Transfer::Model::UpdateAccessRequest::SetPosixProfile ( PosixProfile &&  value)
inline

Definition at line 571 of file UpdateAccessRequest.h.

◆ SetRole() [1/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetRole ( Aws::String &&  value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

Definition at line 622 of file UpdateAccessRequest.h.

◆ SetRole() [2/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetRole ( const Aws::String value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

Definition at line 611 of file UpdateAccessRequest.h.

◆ SetRole() [3/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetRole ( const char *  value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

Definition at line 633 of file UpdateAccessRequest.h.

◆ SetServerId() [1/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetServerId ( Aws::String &&  value)
inline

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

Definition at line 691 of file UpdateAccessRequest.h.

◆ SetServerId() [2/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetServerId ( const Aws::String value)
inline

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

Definition at line 685 of file UpdateAccessRequest.h.

◆ SetServerId() [3/3]

void Aws::Transfer::Model::UpdateAccessRequest::SetServerId ( const char *  value)
inline

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

Definition at line 697 of file UpdateAccessRequest.h.

◆ WithExternalId() [1/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithExternalId ( Aws::String &&  value)
inline

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 821 of file UpdateAccessRequest.h.

◆ WithExternalId() [2/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithExternalId ( const Aws::String value)
inline

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 806 of file UpdateAccessRequest.h.

◆ WithExternalId() [3/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithExternalId ( const char *  value)
inline

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Amazon Web Services Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Definition at line 836 of file UpdateAccessRequest.h.

◆ WithHomeDirectory() [1/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithHomeDirectory ( Aws::String &&  value)
inline

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

Definition at line 88 of file UpdateAccessRequest.h.

◆ WithHomeDirectory() [2/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithHomeDirectory ( const Aws::String value)
inline

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

Definition at line 81 of file UpdateAccessRequest.h.

◆ WithHomeDirectory() [3/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithHomeDirectory ( const char *  value)
inline

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

Definition at line 95 of file UpdateAccessRequest.h.

◆ WithHomeDirectoryMappings() [1/2]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithHomeDirectoryMappings ( Aws::Vector< HomeDirectoryMapEntry > &&  value)
inline

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 343 of file UpdateAccessRequest.h.

◆ WithHomeDirectoryMappings() [2/2]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithHomeDirectoryMappings ( const Aws::Vector< HomeDirectoryMapEntry > &  value)
inline

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]

In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("<code>chroot</code>"). To do this, you can set Entry to / and set Target to the HomeDirectory parameter value.

The following is an Entry and Target pair example for chroot.

[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object –bucket bucketname –key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Definition at line 312 of file UpdateAccessRequest.h.

◆ WithHomeDirectoryType() [1/2]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithHomeDirectoryType ( const HomeDirectoryType value)
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Definition at line 146 of file UpdateAccessRequest.h.

◆ WithHomeDirectoryType() [2/2]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithHomeDirectoryType ( HomeDirectoryType &&  value)
inline

The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Definition at line 156 of file UpdateAccessRequest.h.

◆ WithPolicy() [1/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithPolicy ( Aws::String &&  value)
inline

A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

Definition at line 539 of file UpdateAccessRequest.h.

◆ WithPolicy() [2/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithPolicy ( const Aws::String value)
inline

A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

Definition at line 520 of file UpdateAccessRequest.h.

◆ WithPolicy() [3/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithPolicy ( const char *  value)
inline

A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

This only applies when the domain of ServerId is S3. EFS does not use session policies.

For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.

Definition at line 558 of file UpdateAccessRequest.h.

◆ WithPosixProfile() [1/2]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithPosixProfile ( const PosixProfile value)
inline

Definition at line 574 of file UpdateAccessRequest.h.

◆ WithPosixProfile() [2/2]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithPosixProfile ( PosixProfile &&  value)
inline

Definition at line 577 of file UpdateAccessRequest.h.

◆ WithRole() [1/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithRole ( Aws::String &&  value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

Definition at line 655 of file UpdateAccessRequest.h.

◆ WithRole() [2/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithRole ( const Aws::String value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

Definition at line 644 of file UpdateAccessRequest.h.

◆ WithRole() [3/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithRole ( const char *  value)
inline

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

Definition at line 666 of file UpdateAccessRequest.h.

◆ WithServerId() [1/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithServerId ( Aws::String &&  value)
inline

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

Definition at line 709 of file UpdateAccessRequest.h.

◆ WithServerId() [2/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithServerId ( const Aws::String value)
inline

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

Definition at line 703 of file UpdateAccessRequest.h.

◆ WithServerId() [3/3]

UpdateAccessRequest& Aws::Transfer::Model::UpdateAccessRequest::WithServerId ( const char *  value)
inline

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

Definition at line 715 of file UpdateAccessRequest.h.


The documentation for this class was generated from the following file: