AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

UpdateUserInput

import "github.com/aws/aws-sdk-go/service/transfer"

type UpdateUserInput struct { HomeDirectory *string `type:"string"` Policy *string `type:"string"` Role *string `type:"string"` ServerId *string `type:"string" required:"true"` UserName *string `type:"string" required:"true"` }

HomeDirectory

Type: *string

The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client. An example would be: /home/username.

Policy

Type: *string

Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down users access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

Role

Type: *string

The IAM role that controls your user’s access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user’s transfer requests.

ServerId

Type: *string

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

ServerId is a required field

UserName

Type: *string

A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server.

UserName is a required field

Method

GoString

func (s UpdateUserInput) GoString() string

GoString returns the string representation

SetHomeDirectory

func (s *UpdateUserInput) SetHomeDirectory(v string) *UpdateUserInput

SetHomeDirectory sets the HomeDirectory field's value.

SetPolicy

func (s *UpdateUserInput) SetPolicy(v string) *UpdateUserInput

SetPolicy sets the Policy field's value.

SetRole

func (s *UpdateUserInput) SetRole(v string) *UpdateUserInput

SetRole sets the Role field's value.

SetServerId

func (s *UpdateUserInput) SetServerId(v string) *UpdateUserInput

SetServerId sets the ServerId field's value.

SetUserName

func (s *UpdateUserInput) SetUserName(v string) *UpdateUserInput

SetUserName sets the UserName field's value.

String

func (s UpdateUserInput) String() string

String returns the string representation

Validate

func (s *UpdateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: