package transfer
import "github.com/aws/aws-sdk-go-v2/service/transfer"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CreateServer(ctx context.Context, params *CreateServerInput, optFns ...func(*Options)) (*CreateServerOutput, error)
- func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)
- func (c *Client) DeleteServer(ctx context.Context, params *DeleteServerInput, optFns ...func(*Options)) (*DeleteServerOutput, error)
- func (c *Client) DeleteSshPublicKey(ctx context.Context, params *DeleteSshPublicKeyInput, optFns ...func(*Options)) (*DeleteSshPublicKeyOutput, error)
- func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
- func (c *Client) DescribeServer(ctx context.Context, params *DescribeServerInput, optFns ...func(*Options)) (*DescribeServerOutput, error)
- func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error)
- func (c *Client) ImportSshPublicKey(ctx context.Context, params *ImportSshPublicKeyInput, optFns ...func(*Options)) (*ImportSshPublicKeyOutput, error)
- func (c *Client) ListServers(ctx context.Context, params *ListServersInput, optFns ...func(*Options)) (*ListServersOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)
- func (c *Client) StartServer(ctx context.Context, params *StartServerInput, optFns ...func(*Options)) (*StartServerOutput, error)
- func (c *Client) StopServer(ctx context.Context, params *StopServerInput, optFns ...func(*Options)) (*StopServerOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) TestIdentityProvider(ctx context.Context, params *TestIdentityProviderInput, optFns ...func(*Options)) (*TestIdentityProviderOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateServer(ctx context.Context, params *UpdateServerInput, optFns ...func(*Options)) (*UpdateServerOutput, error)
- func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)
- type CreateServerInput
- type CreateServerOutput
- type CreateUserInput
- type CreateUserOutput
- type DeleteServerInput
- type DeleteServerOutput
- type DeleteSshPublicKeyInput
- type DeleteSshPublicKeyOutput
- type DeleteUserInput
- type DeleteUserOutput
- type DescribeServerInput
- type DescribeServerOutput
- type DescribeUserInput
- type DescribeUserOutput
- type EndpointResolver
- type EndpointResolverFunc
- type HTTPClient
- type HTTPSignerV4
- type ImportSshPublicKeyInput
- type ImportSshPublicKeyOutput
- type ListServersInput
- type ListServersOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListUsersInput
- type ListUsersOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
- type StartServerInput
- type StartServerOutput
- type StopServerInput
- type StopServerOutput
- type TagResourceInput
- type TagResourceOutput
- type TestIdentityProviderInput
- type TestIdentityProviderOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateServerInput
- type UpdateServerOutput
- type UpdateUserInput
- type UpdateUserOutput
Constants ¶
const ServiceAPIVersion = "2018-11-05"
const ServiceID = "Transfer"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
AWS Transfer Family is a fully managed service that enables the transfer of files over the the File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon S3). AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer Family by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53 so nothing changes for your customers and partners, or their applications. With your data in Amazon S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer Family is easy since there is no infrastructure to buy and set up.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateServer ¶
func (c *Client) CreateServer(ctx context.Context, params *CreateServerInput, optFns ...func(*Options)) (*CreateServerOutput, error)
Instantiates an autoscaling virtual server based on the selected file transfer protocol in AWS. When you make updates to your file transfer protocol-enabled server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.
func (*Client) CreateUser ¶
func (c *Client) CreateUser(ctx context.Context, params *CreateUserInput, optFns ...func(*Options)) (*CreateUserOutput, error)
Creates a user and associates them with an existing file transfer protocol-enabled server. You can only create and associate users with servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.
func (*Client) DeleteServer ¶
func (c *Client) DeleteServer(ctx context.Context, params *DeleteServerInput, optFns ...func(*Options)) (*DeleteServerOutput, error)
Deletes the file transfer protocol-enabled server that you specify. <p>No response returns from this operation.</p>
func (*Client) DeleteSshPublicKey ¶
func (c *Client) DeleteSshPublicKey(ctx context.Context, params *DeleteSshPublicKeyInput, optFns ...func(*Options)) (*DeleteSshPublicKeyOutput, error)
Deletes a user's Secure Shell (SSH) public key. <p>No response is returned from this operation.</p>
func (*Client) DeleteUser ¶
func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
Deletes the user belonging to a file transfer protocol-enabled server you specify. <p>No response returns from this operation.</p> <note> <p>When you delete a user from a server, the user's information is lost.</p> </note>
func (*Client) DescribeServer ¶
func (c *Client) DescribeServer(ctx context.Context, params *DescribeServerInput, optFns ...func(*Options)) (*DescribeServerOutput, error)
Describes a file transfer protocol-enabled server that you specify by passing the ServerId parameter. <p>The response contains a description of a server's properties. When you set <code>EndpointType</code> to VPC, the response will contain the <code>EndpointDetails</code>.</p>
func (*Client) DescribeUser ¶
func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error)
Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property. <p>The response from this call returns the properties of the user associated with the <code>ServerId</code> value that was specified.</p>
func (*Client) ImportSshPublicKey ¶
func (c *Client) ImportSshPublicKey(ctx context.Context, params *ImportSshPublicKeyInput, optFns ...func(*Options)) (*ImportSshPublicKeyOutput, error)
Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to the specific file transfer protocol-enabled server, identified by ServerId. <p>The response returns the <code>UserName</code> value, the <code>ServerId</code> value, and the name of the <code>SshPublicKeyId</code>.</p>
func (*Client) ListServers ¶
func (c *Client) ListServers(ctx context.Context, params *ListServersInput, optFns ...func(*Options)) (*ListServersOutput, error)
Lists the file transfer protocol-enabled servers that are associated with your AWS account.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
func (*Client) ListUsers ¶
func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)
Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.
func (*Client) StartServer ¶
func (c *Client) StartServer(ctx context.Context, params *StartServerInput, optFns ...func(*Options)) (*StartServerOutput, error)
Changes the state of a file transfer protocol-enabled server from OFFLINE to ONLINE. It has no impact on a server that is already ONLINE. An ONLINE server can accept and process file transfer jobs. <p>The state of <code>STARTING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of <code>START_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>
func (*Client) StopServer ¶
func (c *Client) StopServer(ctx context.Context, params *StopServerInput, optFns ...func(*Options)) (*StopServerOutput, error)
Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server. Stopping the server will not reduce or impact your file transfer protocol endpoint billing. <p>The state of <code>STOPPING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>STOP_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. <p>There is no response returned from this call.</p>
func (*Client) TestIdentityProvider ¶
func (c *Client) TestIdentityProvider(ctx context.Context, params *TestIdentityProviderInput, optFns ...func(*Options)) (*TestIdentityProviderOutput, error)
If the IdentityProviderType of a file transfer protocol-enabled server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities. <p>No response is returned from this call.</p>
func (*Client) UpdateServer ¶
func (c *Client) UpdateServer(ctx context.Context, params *UpdateServerInput, optFns ...func(*Options)) (*UpdateServerOutput, error)
Updates the file transfer protocol-enabled server's properties after that server has been created. <p>The <code>UpdateServer</code> call returns the <code>ServerId</code> of the server you updated.</p>
func (*Client) UpdateUser ¶
func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify. <p>The response returns the <code>ServerId</code> and the <code>UserName</code> for the updated user.</p>
type CreateServerInput ¶
type CreateServerInput struct { // The virtual private cloud (VPC) endpoint settings that are configured for your // file transfer protocol-enabled server. When you host your endpoint within your // VPC, you can make it accessible only to resources within your VPC, or you can // attach Elastic IPs and make it accessible to clients over the internet. Your // VPC's default security groups are automatically assigned to your endpoint. EndpointDetails *types.EndpointDetails // The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. // Required when Protocols is set to FTPS. <p>To request a new public certificate, // see <a // href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request // a public certificate</a> in the <i> AWS Certificate Manager User Guide</i>.</p> // <p>To import an existing certificate into ACM, see <a // href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing // certificates into ACM</a> in the <i> AWS Certificate Manager User Guide</i>.</p> // <p>To request a private certificate to use FTPS through private IP addresses, // see <a // href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request // a private certificate</a> in the <i> AWS Certificate Manager User Guide</i>.</p> // <p>Certificates with the following cryptographic algorithms and key sizes are // supported:</p> <ul> <li> <p>2048-bit RSA (RSA_2048)</p> </li> <li> <p>4096-bit // RSA (RSA_4096)</p> </li> <li> <p>Elliptic Prime Curve 256 bit // (EC_prime256v1)</p> </li> <li> <p>Elliptic Prime Curve 384 bit // (EC_secp384r1)</p> </li> <li> <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p> // </li> </ul> <note> <p>The certificate must be a valid SSL/TLS X.509 version 3 // certificate with FQDN or IP address specified and information about the // issuer.</p> </note> Certificate *string // Key-value pairs that can be used to group and search for file transfer // protocol-enabled servers. Tags []*types.Tag // Specifies the mode of authentication for a file transfer protocol-enabled // server. The default value is SERVICE_MANAGED, which allows you to store and // access user credentials within the AWS Transfer Family service. Use the // API_GATEWAY value to integrate with an identity provider of your choosing. The // API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call // for authentication using the IdentityProviderDetails parameter. IdentityProviderType types.IdentityProviderType // The RSA private key as generated by the ssh-keygen -N "" -m PEM -f // my-new-server-key command. <important> <p>If you aren't planning to migrate // existing users from an existing SFTP-enabled server to a new server, don't // update the host key. Accidentally changing a server's host key can be // disruptive.</p> </important> <p>For more information, see <a // href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change // the host key for your SFTP-enabled server</a> in the <i>AWS Transfer Family User // Guide</i>.</p> HostKey *string // Specifies the file transfer protocol or protocols over which your file transfer // protocol client can connect to your server's endpoint. The available protocols // are: <ul> <li> <p> <code>SFTP</code> (Secure Shell (SSH) File Transfer // Protocol): File transfer over SSH</p> </li> <li> <p> <code>FTPS</code> (File // Transfer Protocol Secure): File transfer with TLS encryption</p> </li> <li> <p> // <code>FTP</code> (File Transfer Protocol): Unencrypted file transfer</p> </li> // </ul> <note> <p>If you select <code>FTPS</code>, you must choose a certificate // stored in AWS Certificate Manager (ACM) which will be used to identify your // server when clients connect to it over FTPS.</p> <p>If <code>Protocol</code> // includes either <code>FTP</code> or <code>FTPS</code>, then the // <code>EndpointType</code> must be <code>VPC</code> and the // <code>IdentityProviderType</code> must be <code>API_GATEWAY</code>.</p> <p>If // <code>Protocol</code> includes <code>FTP</code>, then // <code>AddressAllocationIds</code> cannot be associated.</p> <p>If // <code>Protocol</code> is set only to <code>SFTP</code>, the // <code>EndpointType</code> can be set to <code>PUBLIC</code> and the // <code>IdentityProviderType</code> can be set to // <code>SERVICE_MANAGED</code>.</p> </note> Protocols []types.Protocol // The type of VPC endpoint that you want your file transfer protocol-enabled // server to connect to. You can choose to connect to the public internet or a VPC // endpoint. With a VPC endpoint, you can restrict access to your server and // resources only within your VPC. <note> <p>It is recommended that you use // <code>VPC</code> as the <code>EndpointType</code>. With this endpoint type, you // have the option to directly associate up to three Elastic IPv4 addresses (BYO IP // included) with your server's endpoint and use VPC security groups to restrict // traffic by the client's public IP address. This is not possible with // <code>EndpointType</code> set to <code>VPC_ENDPOINT</code>.</p> </note> EndpointType types.EndpointType // Allows the service to write your users' activity to your Amazon CloudWatch logs // for monitoring and auditing purposes. LoggingRole *string // Required when IdentityProviderType is set to API_GATEWAY. Accepts an array // containing all of the information required to call a customer-supplied // authentication API, including the API Gateway URL. Not required when // IdentityProviderType is set to SERVICE_MANAGED. IdentityProviderDetails *types.IdentityProviderDetails }
type CreateServerOutput ¶
type CreateServerOutput struct { // The service-assigned ID of the file transfer protocol-enabled server that is // created. ServerId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateUserInput ¶
type CreateUserInput struct { // A system-assigned unique identifier for a file transfer protocol-enabled server // instance. This is the specific server that you added your user to. ServerId *string // A unique string that identifies a user and is associated with a file transfer // protocol-enabled server as specified by the ServerId. This user name must be a // minimum of 3 and a maximum of 32 characters long. The following are valid // characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start // with a hyphen. UserName *string // Key-value pairs that can be used to group and search for users. Tags are // metadata attached to users for any purpose. Tags []*types.Tag // The IAM role that controls your users' 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 file transfer protocol-enabled server to access your resources when // servicing your users' transfer requests. Role *string // A scope-down policy for your user so 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}. // <note> <p>For scope-down policies, AWS 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 <code>Policy</code> argument.</p> // <p>For an example of a scope-down policy, see <a // href="https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating // a scope-down policy</a>.</p> <p>For more information, see <a // href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> // in the <i>AWS Security Token Service API Reference</i>.</p> </note> Policy *string // The public portion of the Secure Shell (SSH) key used to authenticate the user // to the file transfer protocol-enabled server. SshPublicKeyBody *string // Logical directory mappings that specify what Amazon S3 paths and keys should be // visible to your user and how you want to make them visible. You will need to // specify the "Entry" and "Target" pair, where Entry shows how the path is made // visible and Target is the actual Amazon S3 path. If you only specify a target, // it will be displayed as is. You will need to also make sure that your IAM role // provides access to paths in Target. The following is an example. <p> <code>'[ // "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": // "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'</code> </p> <p>In // most cases, you can use this value instead of the scope-down policy to lock your // user down to the designated home directory ("chroot"). To do this, you can set // <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory // parameter value.</p> <note> <p>If the target of a logical directory entry does // not exist in Amazon S3, the entry will be ignored. As a workaround, you can use // the Amazon S3 api to create 0 byte objects as place holders for your directory. // If using the CLI, use the <code>s3api</code> call instead of <code>s3</code> so // you can use the put-object operation. For example, you use the following: // <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. // Make sure that the end of the key name ends in a '/' for it to be considered a // folder.</p> </note> HomeDirectoryMappings []*types.HomeDirectoryMapEntry // The landing directory (folder) for a user when they log in to the file transfer // protocol-enabled server using the client. <p>An example is <i> // <code>your-Amazon-S3-bucket-name>/home/username</code> </i>.</p> HomeDirectory *string // The type of landing directory (folder) you want your users' home directory to be // when they log into the file transfer protocol-enabled server. If you set it to // PATH, the user will see the absolute Amazon S3 bucket paths as is in their file // transfer protocol clients. If you set it LOGICAL, you will need to provide // mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths // visible to your users. HomeDirectoryType types.HomeDirectoryType }
type CreateUserOutput ¶
type CreateUserOutput struct { // A unique string that identifies a user account associated with a file transfer // protocol-enabled server. UserName *string // The ID of the file transfer protocol-enabled server that the user is attached // to. ServerId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteServerInput ¶
type DeleteServerInput struct { // A unique system-assigned identifier for a file transfer protocol-enabled server // instance. ServerId *string }
type DeleteServerOutput ¶
type DeleteServerOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteSshPublicKeyInput ¶
type DeleteSshPublicKeyInput struct { // A unique identifier used to reference your user's specific SSH key. SshPublicKeyId *string // A system-assigned unique identifier for a file transfer protocol-enabled server // instance that has the user assigned to it. ServerId *string // A unique string that identifies a user whose public key is being deleted. UserName *string }
type DeleteSshPublicKeyOutput ¶
type DeleteSshPublicKeyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteUserInput ¶
type DeleteUserInput struct { // A system-assigned unique identifier for a file transfer protocol-enabled server // instance that has the user assigned to it. ServerId *string // A unique string that identifies a user that is being deleted from a file // transfer protocol-enabled server. UserName *string }
type DeleteUserOutput ¶
type DeleteUserOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeServerInput ¶
type DescribeServerInput struct { // A system-assigned unique identifier for a file transfer protocol-enabled server. ServerId *string }
type DescribeServerOutput ¶
type DescribeServerOutput struct { // An array containing the properties of a file transfer protocol-enabled server // with the ServerID you specified. Server *types.DescribedServer // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeUserInput ¶
type DescribeUserInput struct { // A system-assigned unique identifier for a file transfer protocol-enabled server // that has this user assigned. ServerId *string // The name of the user assigned to one or more file transfer protocol-enabled // servers. User names are part of the sign-in credentials to use the AWS Transfer // Family service and perform file transfer tasks. UserName *string }
type DescribeUserOutput ¶
type DescribeUserOutput struct { // An array containing the properties of the user account for the ServerID value // that you specified. User *types.DescribedUser // A system-assigned unique identifier for a file transfer protocol-enabled server // that has this user assigned. ServerId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ImportSshPublicKeyInput ¶
type ImportSshPublicKeyInput struct { // The public key portion of an SSH key pair. SshPublicKeyBody *string // A system-assigned unique identifier for a file transfer protocol-enabled server. ServerId *string // The name of the user account that is assigned to one or more file transfer // protocol-enabled servers. UserName *string }
type ImportSshPublicKeyOutput ¶
type ImportSshPublicKeyOutput struct { // The name given to a public key by the system that was imported. SshPublicKeyId *string // A system-assigned unique identifier for a file transfer protocol-enabled server. ServerId *string // A user name assigned to the ServerID value that you specified. UserName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Identifies the user, the file transfer protocol-enabled server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.
type ListServersInput ¶
type ListServersInput struct { // When additional results are obtained from theListServers command, a NextToken // parameter is returned in the output. You can then pass the NextToken parameter // in a subsequent command to continue listing additional file transfer // protocol-enabled servers. NextToken *string // Specifies the number of file transfer protocol-enabled servers to return as a // response to the ListServers query. MaxResults *int32 }
type ListServersOutput ¶
type ListServersOutput struct { // An array of file transfer protocol-enabled servers that were listed. Servers []*types.ListedServer // When you can get additional results from the ListServers operation, a NextToken // parameter is returned in the output. In a following command, you can pass in the // NextToken parameter to continue listing additional file transfer // protocol-enabled servers. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // Specifies the number of tags to return as a response to the ListTagsForResource // request. MaxResults *int32 // Requests the tags associated with a particular Amazon Resource Name (ARN). An // ARN is an identifier for a specific AWS resource, such as a server, user, or // role. Arn *string // When you request additional results from the ListTagsForResource operation, a // NextToken parameter is returned in the input. You can then pass in a subsequent // command to the NextToken parameter to continue listing additional tags. NextToken *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // When you can get additional results from the ListTagsForResource call, a // NextToken parameter is returned in the output. You can then pass in a subsequent // command to the NextToken parameter to continue listing additional tags. NextToken *string // Key-value pairs that are assigned to a resource, usually for the purpose of // grouping and searching for items. Tags are metadata that you define. Tags []*types.Tag // The ARN you specified to list the tags of. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListUsersInput ¶
type ListUsersInput struct { // Specifies the number of users to return as a response to the ListUsers request. MaxResults *int32 // When you can get additional results from the ListUsers call, a NextToken // parameter is returned in the output. You can then pass in a subsequent command // to the NextToken parameter to continue listing additional users. NextToken *string // A system-assigned unique identifier for a file transfer protocol-enabled server // that has users assigned to it. ServerId *string }
type ListUsersOutput ¶
type ListUsersOutput struct { // Returns the user accounts and their properties for the ServerId value that you // specify. Users []*types.ListedUser // A system-assigned unique identifier for a file transfer protocol-enabled server // that the users are assigned to. ServerId *string // When you can get additional results from the ListUsers call, a NextToken // parameter is returned in the output. You can then pass in a subsequent command // to the NextToken parameter to continue listing additional users. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type StartServerInput ¶
type StartServerInput struct { // A system-assigned unique identifier for a file transfer protocol-enabled server // that you start. ServerId *string }
type StartServerOutput ¶
type StartServerOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StopServerInput ¶
type StopServerInput struct { // A system-assigned unique identifier for a file transfer protocol-enabled server // that you stopped. ServerId *string }
type StopServerOutput ¶
type StopServerOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TagResourceInput ¶
type TagResourceInput struct { // Key-value pairs assigned to ARNs that you can use to group and search for // resources by type. You can attach this metadata to user accounts for any // purpose. Tags []*types.Tag // An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, // user, or role. Arn *string }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TestIdentityProviderInput ¶
type TestIdentityProviderInput struct { // The password of the user account to be tested. UserPassword *string // The source IP address of the user account to be tested. SourceIp *string // The type of file transfer protocol to be tested. <p>The available protocols // are:</p> <ul> <li> <p>Secure Shell (SSH) File Transfer Protocol (SFTP)</p> </li> // <li> <p>File Transfer Protocol Secure (FTPS)</p> </li> <li> <p>File Transfer // Protocol (FTP)</p> </li> </ul> ServerProtocol types.Protocol // A system-assigned identifier for a specific file transfer protocol-enabled // server. That server's user authentication method is tested with a user name and // password. ServerId *string // The name of the user account to be tested. UserName *string }
type TestIdentityProviderOutput ¶
type TestIdentityProviderOutput struct { // The response that is returned from your API Gateway. Response *string // A message that indicates whether the test was successful or not. Message *string // The HTTP status code that is the response from your API Gateway. StatusCode *int32 // The endpoint of the service used to authenticate a user. Url *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The value of the resource that will have the tag removed. An Amazon Resource // Name (ARN) is an identifier for a specific AWS resource, such as a server, user, // or role. Arn *string // TagKeys are key-value pairs assigned to ARNs that can be used to group and // search for resources by type. This metadata can be attached to resources for any // purpose. TagKeys []*string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateServerInput ¶
type UpdateServerInput struct { // The virtual private cloud (VPC) endpoint settings that are configured for your // file transfer protocol-enabled server. With a VPC endpoint, you can restrict // access to your server to resources only within your VPC. To control incoming // internet traffic, you will need to associate one or more Elastic IP addresses // with your server's endpoint. EndpointDetails *types.EndpointDetails // The type of endpoint that you want your file transfer protocol-enabled server to // connect to. You can choose to connect to the public internet or a VPC endpoint. // With a VPC endpoint, you can restrict access to your server and resources only // within your VPC. <note> <p>It is recommended that you use <code>VPC</code> as // the <code>EndpointType</code>. With this endpoint type, you have the option to // directly associate up to three Elastic IPv4 addresses (BYO IP included) with // your server's endpoint and use VPC security groups to restrict traffic by the // client's public IP address. This is not possible with <code>EndpointType</code> // set to <code>VPC_ENDPOINT</code>.</p> </note> EndpointType types.EndpointType // An array containing all of the information required to call a customer's // authentication API method. IdentityProviderDetails *types.IdentityProviderDetails // A system-assigned unique identifier for a file transfer protocol-enabled server // instance that the user account is assigned to. ServerId *string // Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 // events to be logged in Amazon CloudWatch, turning logging on or off. LoggingRole *string // The RSA private key as generated by ssh-keygen -N "" -m PEM -f // my-new-server-key. <important> <p>If you aren't planning to migrate existing // users from an existing file transfer protocol-enabled server to a new server, // don't update the host key. Accidentally changing a server's host key can be // disruptive.</p> </important> <p>For more information, see <a // href="https://docs.aws.amazon.com/transfer/latest/userguide/edit-server-config.html#configuring-servers-change-host-key">Change // the host key for your SFTP-enabled server</a> in the <i>AWS Transfer Family User // Guide</i>.</p> HostKey *string // Specifies the file transfer protocol or protocols over which your file transfer // protocol client can connect to your server's endpoint. The available protocols // are: <ul> <li> <p>Secure Shell (SSH) File Transfer Protocol (SFTP): File // transfer over SSH</p> </li> <li> <p>File Transfer Protocol Secure (FTPS): File // transfer with TLS encryption</p> </li> <li> <p>File Transfer Protocol (FTP): // Unencrypted file transfer</p> </li> </ul> <note> <p>If you select // <code>FTPS</code>, you must choose a certificate stored in AWS Certificate // Manager (ACM) which will be used to identify your server when clients connect to // it over FTPS.</p> <p>If <code>Protocol</code> includes either <code>FTP</code> // or <code>FTPS</code>, then the <code>EndpointType</code> must be // <code>VPC</code> and the <code>IdentityProviderType</code> must be // <code>API_GATEWAY</code>.</p> <p>If <code>Protocol</code> includes // <code>FTP</code>, then <code>AddressAllocationIds</code> cannot be // associated.</p> <p>If <code>Protocol</code> is set only to <code>SFTP</code>, // the <code>EndpointType</code> can be set to <code>PUBLIC</code> and the // <code>IdentityProviderType</code> can be set to // <code>SERVICE_MANAGED</code>.</p> </note> Protocols []types.Protocol // The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. // Required when Protocols is set to FTPS. <p>To request a new public certificate, // see <a // href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html">Request // a public certificate</a> in the <i> AWS Certificate Manager User Guide</i>.</p> // <p>To import an existing certificate into ACM, see <a // href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing // certificates into ACM</a> in the <i> AWS Certificate Manager User Guide</i>.</p> // <p>To request a private certificate to use FTPS through private IP addresses, // see <a // href="https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-private.html">Request // a private certificate</a> in the <i> AWS Certificate Manager User Guide</i>.</p> // <p>Certificates with the following cryptographic algorithms and key sizes are // supported:</p> <ul> <li> <p>2048-bit RSA (RSA_2048)</p> </li> <li> <p>4096-bit // RSA (RSA_4096)</p> </li> <li> <p>Elliptic Prime Curve 256 bit // (EC_prime256v1)</p> </li> <li> <p>Elliptic Prime Curve 384 bit // (EC_secp384r1)</p> </li> <li> <p>Elliptic Prime Curve 521 bit (EC_secp521r1)</p> // </li> </ul> <note> <p>The certificate must be a valid SSL/TLS X.509 version 3 // certificate with FQDN or IP address specified and information about the // issuer.</p> </note> Certificate *string }
type UpdateServerOutput ¶
type UpdateServerOutput struct { // A system-assigned unique identifier for a file transfer protocol-enabled server // that the user account is assigned to. ServerId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateUserInput ¶
type UpdateUserInput struct { // Allows you to supply a scope-down policy for your user so you can use the same // IAM role across multiple users. The policy scopes down user access to portions // of your Amazon S3 bucket. Variables you can use inside this policy include // ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For // scope-down policies, AWS 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. <p>For an example of a // scope-down policy, see <a // href="https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down">Creating // a scope-down policy</a>.</p> <p>For more information, see <a // href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">AssumeRole</a> // in the <i>AWS Security Token Service API Reference</i>.</p> </note> Policy *string // The IAM role that controls your users' 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 file transfer protocol-enabled server to access your resources when // servicing your users' transfer requests. Role *string // A system-assigned unique identifier for a file transfer protocol-enabled server // instance that the user account is assigned to. ServerId *string // A unique string that identifies a user and is associated with a file transfer // protocol-enabled server as specified by the ServerId. This is the string that // will be used by your user when they log in to your server. This user name is a // minimum of 3 and a maximum of 32 characters long. The following are valid // characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start // with a hyphen. UserName *string // Logical directory mappings that specify what Amazon S3 paths and keys should be // visible to your user and how you want to make them visible. You will need to // specify the "Entry" and "Target" pair, where Entry shows how the path is made // visible and Target is the actual Amazon S3 path. If you only specify a target, // it will be displayed as is. You will need to also make sure that your IAM role // provides access to paths in Target. The following is an example. <p> <code>'[ // "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": // "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'</code> </p> <p>In // most cases, you can use this value instead of the scope-down policy to lock your // user down to the designated home directory ("chroot"). To do this, you can set // <code>Entry</code> to '/' and set <code>Target</code> to the HomeDirectory // parameter value.</p> <note> <p>If the target of a logical directory entry does // not exist in Amazon S3, the entry will be ignored. As a workaround, you can use // the Amazon S3 api to create 0 byte objects as place holders for your directory. // If using the CLI, use the <code>s3api</code> call instead of <code>s3</code> so // you can use the put-object operation. For example, you use the following: // <code>aws s3api put-object --bucket bucketname --key path/to/folder/</code>. // Make sure that the end of the key name ends in a / for it to be considered a // folder.</p> </note> HomeDirectoryMappings []*types.HomeDirectoryMapEntry // Specifies the landing directory (folder) for a user when they log in to the file // transfer protocol-enabled server using their file transfer protocol client. // <p>An example is <code>your-Amazon-S3-bucket-name>/home/username</code>.</p> HomeDirectory *string // The type of landing directory (folder) you want your users' home directory to be // when they log into the file transfer protocol-enabled server. If you set it to // PATH, the user will see the absolute Amazon S3 bucket paths as is in their file // transfer protocol clients. If you set it LOGICAL, you will need to provide // mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths // visible to your users. HomeDirectoryType types.HomeDirectoryType }
type UpdateUserOutput ¶
type UpdateUserOutput struct { // The unique identifier for a user that is assigned to a file transfer // protocol-enabled server instance that was specified in the request. UserName *string // A system-assigned unique identifier for a file transfer protocol-enabled server // instance that the user account is assigned to. ServerId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
UpdateUserResponse returns the user name and file transfer protocol-enabled server identifier for the request to update a user's properties.
Source Files ¶
api_client.go api_op_CreateServer.go api_op_CreateUser.go api_op_DeleteServer.go api_op_DeleteSshPublicKey.go api_op_DeleteUser.go api_op_DescribeServer.go api_op_DescribeUser.go api_op_ImportSshPublicKey.go api_op_ListServers.go api_op_ListTagsForResource.go api_op_ListUsers.go api_op_StartServer.go api_op_StopServer.go api_op_TagResource.go api_op_TestIdentityProvider.go api_op_UntagResource.go api_op_UpdateServer.go api_op_UpdateUser.go deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.1.0
- Published
- Sep 29, 2020
- Platform
- windows/amd64
- Imports
- 26 packages
- Last checked
- 2 weeks ago –
Tools for package owners.