transfer

package
v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 12, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

nolint: lll Package transfer exports types, functions, subpackages for provisioning transfer resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-aws) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-aws` repo](https://github.com/pulumi/pulumi-aws/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-aws` repo](https://github.com/terraform-providers/terraform-provider-aws/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetServerArgs added in v0.18.1 

type GetServerArgs struct {
	// ID for an SFTP server.
	ServerId interface{}
}

A collection of arguments for invoking getServer.

type GetServerResult added in v0.18.1 

type GetServerResult struct {
	// Amazon Resource Name (ARN) of Transfer Server
	Arn interface{}
	// The endpoint of the Transfer Server (e.g. `s-12345678.server.transfer.REGION.amazonaws.com`)
	Endpoint interface{}
	// The mode of authentication enabled for this service. The default value is `SERVICE_MANAGED`, which allows you to store and access SFTP user credentials within the service. `API_GATEWAY` indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.
	IdentityProviderType interface{}
	// Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an `identityProviderType` of `API_GATEWAY`.
	InvocationRole interface{}
	// Amazon Resource Name (ARN) of an IAM role that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
	LoggingRole interface{}
	ServerId    interface{}
	// URL of the service endpoint used to authenticate users with an `identityProviderType` of `API_GATEWAY`.
	Url interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getServer.

func LookupServer added in v0.18.1 

func LookupServer(ctx *pulumi.Context, args *GetServerArgs) (*GetServerResult, error)

Use this data source to get the ARN of an AWS Transfer Server for use in other resources.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/transfer_server.html.markdown.

type Server 

type Server struct {
	// contains filtered or unexported fields
}

Provides a AWS Transfer Server resource.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/transfer_server.html.markdown.

func GetServer 

func GetServer(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ServerState, opts ...pulumi.ResourceOpt) (*Server, error)

GetServer gets an existing Server resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServer 

func NewServer(ctx *pulumi.Context,
	name string, args *ServerArgs, opts ...pulumi.ResourceOpt) (*Server, error)

NewServer registers a new resource with the given unique name, arguments, and options.

func (*Server) Arn 

func (r *Server) Arn() *pulumi.StringOutput

Amazon Resource Name (ARN) of Transfer Server

func (*Server) Endpoint 

func (r *Server) Endpoint() *pulumi.StringOutput

The endpoint of the Transfer Server (e.g. `s-12345678.server.transfer.REGION.amazonaws.com`)

func (*Server) EndpointDetails added in v0.18.2 

func (r *Server) EndpointDetails() *pulumi.Output

The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. Fields documented below.

func (*Server) EndpointType added in v0.18.2 

func (r *Server) EndpointType() *pulumi.StringOutput

The type of endpoint that you want your SFTP server connect to. If you connect to a `VPC_ENDPOINT`, your SFTP server isn't accessible over the public internet. If you want to connect your SFTP server via public internet, set `PUBLIC`.

func (*Server) ForceDestroy added in v0.16.5 

func (r *Server) ForceDestroy() *pulumi.BoolOutput

A boolean that indicates all users associated with the server should be deleted so that the Server can be destroyed without error. The default value is `false`.

func (*Server) ID 

func (r *Server) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Server) IdentityProviderType 

func (r *Server) IdentityProviderType() *pulumi.StringOutput

The mode of authentication enabled for this service. The default value is `SERVICE_MANAGED`, which allows you to store and access SFTP user credentials within the service. `API_GATEWAY` indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.

func (*Server) InvocationRole 

func (r *Server) InvocationRole() *pulumi.StringOutput

Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an `identityProviderType` of `API_GATEWAY`.

func (*Server) LoggingRole 

func (r *Server) LoggingRole() *pulumi.StringOutput

Amazon Resource Name (ARN) of an IAM role that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

func (*Server) Tags 

func (r *Server) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*Server) URN 

func (r *Server) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Server) Url 

func (r *Server) Url() *pulumi.StringOutput

- URL of the service endpoint used to authenticate users with an `identityProviderType` of `API_GATEWAY`.

type ServerArgs 

type ServerArgs struct {
	// The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. Fields documented below.
	EndpointDetails interface{}
	// The type of endpoint that you want your SFTP server connect to. If you connect to a `VPC_ENDPOINT`, your SFTP server isn't accessible over the public internet. If you want to connect your SFTP server via public internet, set `PUBLIC`.
	EndpointType interface{}
	// A boolean that indicates all users associated with the server should be deleted so that the Server can be destroyed without error. The default value is `false`.
	ForceDestroy interface{}
	// The mode of authentication enabled for this service. The default value is `SERVICE_MANAGED`, which allows you to store and access SFTP user credentials within the service. `API_GATEWAY` indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.
	IdentityProviderType interface{}
	// Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an `identityProviderType` of `API_GATEWAY`.
	InvocationRole interface{}
	// Amazon Resource Name (ARN) of an IAM role that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
	LoggingRole interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// - URL of the service endpoint used to authenticate users with an `identityProviderType` of `API_GATEWAY`.
	Url interface{}
}

The set of arguments for constructing a Server resource.

type ServerState 

type ServerState struct {
	// Amazon Resource Name (ARN) of Transfer Server
	Arn interface{}
	// The endpoint of the Transfer Server (e.g. `s-12345678.server.transfer.REGION.amazonaws.com`)
	Endpoint interface{}
	// The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. Fields documented below.
	EndpointDetails interface{}
	// The type of endpoint that you want your SFTP server connect to. If you connect to a `VPC_ENDPOINT`, your SFTP server isn't accessible over the public internet. If you want to connect your SFTP server via public internet, set `PUBLIC`.
	EndpointType interface{}
	// A boolean that indicates all users associated with the server should be deleted so that the Server can be destroyed without error. The default value is `false`.
	ForceDestroy interface{}
	// The mode of authentication enabled for this service. The default value is `SERVICE_MANAGED`, which allows you to store and access SFTP user credentials within the service. `API_GATEWAY` indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.
	IdentityProviderType interface{}
	// Amazon Resource Name (ARN) of the IAM role used to authenticate the user account with an `identityProviderType` of `API_GATEWAY`.
	InvocationRole interface{}
	// Amazon Resource Name (ARN) of an IAM role that allows the service to write your SFTP users’ activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
	LoggingRole interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// - URL of the service endpoint used to authenticate users with an `identityProviderType` of `API_GATEWAY`.
	Url interface{}
}

Input properties used for looking up and filtering Server resources.

type SshKey added in v0.16.5 

type SshKey struct {
	// contains filtered or unexported fields
}

Provides a AWS Transfer User SSH Key resource.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/transfer_ssh_key.html.markdown.

func GetSshKey added in v0.16.5 

func GetSshKey(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SshKeyState, opts ...pulumi.ResourceOpt) (*SshKey, error)

GetSshKey gets an existing SshKey resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSshKey added in v0.16.5 

func NewSshKey(ctx *pulumi.Context,
	name string, args *SshKeyArgs, opts ...pulumi.ResourceOpt) (*SshKey, error)

NewSshKey registers a new resource with the given unique name, arguments, and options.

func (*SshKey) Body added in v0.16.5 

func (r *SshKey) Body() *pulumi.StringOutput

The public key portion of an SSH key pair.

func (*SshKey) ID added in v0.16.5 

func (r *SshKey) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*SshKey) ServerId added in v0.16.5 

func (r *SshKey) ServerId() *pulumi.StringOutput

The Server ID of the Transfer Server (e.g. `s-12345678`)

func (*SshKey) URN added in v0.16.5 

func (r *SshKey) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*SshKey) UserName added in v0.16.5 

func (r *SshKey) UserName() *pulumi.StringOutput

The name of the user account that is assigned to one or more servers.

type SshKeyArgs added in v0.16.5 

type SshKeyArgs struct {
	// The public key portion of an SSH key pair.
	Body interface{}
	// The Server ID of the Transfer Server (e.g. `s-12345678`)
	ServerId interface{}
	// The name of the user account that is assigned to one or more servers.
	UserName interface{}
}

The set of arguments for constructing a SshKey resource.

type SshKeyState added in v0.16.5 

type SshKeyState struct {
	// The public key portion of an SSH key pair.
	Body interface{}
	// The Server ID of the Transfer Server (e.g. `s-12345678`)
	ServerId interface{}
	// The name of the user account that is assigned to one or more servers.
	UserName interface{}
}

Input properties used for looking up and filtering SshKey resources.

type User added in v0.16.5 

type User struct {
	// contains filtered or unexported fields
}

Provides a AWS Transfer User resource. Managing SSH keys can be accomplished with the [`transfer.SshKey` resource](https://www.terraform.io/docs/providers/aws/r/transfer_ssh_key.html).

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/transfer_user.html.markdown.

func GetUser added in v0.16.5 

func GetUser(ctx *pulumi.Context,
	name string, id pulumi.ID, state *UserState, opts ...pulumi.ResourceOpt) (*User, error)

GetUser gets an existing User resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUser added in v0.16.5 

func NewUser(ctx *pulumi.Context,
	name string, args *UserArgs, opts ...pulumi.ResourceOpt) (*User, error)

NewUser registers a new resource with the given unique name, arguments, and options.

func (*User) Arn added in v0.16.5 

func (r *User) Arn() *pulumi.StringOutput

Amazon Resource Name (ARN) of Transfer User

func (*User) HomeDirectory added in v0.16.5 

func (r *User) HomeDirectory() *pulumi.StringOutput

The landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a `/`. The first item in the path is the name of the home bucket (accessible as `${Transfer:HomeBucket}` in the policy) and the rest is the home directory (accessible as `${Transfer:HomeDirectory}` in the policy). For example, `/example-bucket-1234/username` would set the home bucket to `example-bucket-1234` and the home directory to `username`.

func (*User) ID added in v0.16.5 

func (r *User) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*User) Policy added in v0.16.5 

func (r *User) Policy() *pulumi.StringOutput

An IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and `${Transfer:HomeBucket}`. These are evaluated on-the-fly when navigating the bucket.

func (*User) Role added in v0.16.5 

func (r *User) Role() *pulumi.StringOutput

Amazon Resource Name (ARN) of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.

func (*User) ServerId added in v0.16.5 

func (r *User) ServerId() *pulumi.StringOutput

The Server ID of the Transfer Server (e.g. `s-12345678`)

func (*User) Tags added in v0.16.5 

func (r *User) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*User) URN added in v0.16.5 

func (r *User) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*User) UserName added in v0.16.5 

func (r *User) UserName() *pulumi.StringOutput

The name used for log in to your SFTP server.

type UserArgs added in v0.16.5 

type UserArgs struct {
	// The landing directory (folder) for a user when they log in to the server using their SFTP client.  It should begin with a `/`.  The first item in the path is the name of the home bucket (accessible as `${Transfer:HomeBucket}` in the policy) and the rest is the home directory (accessible as `${Transfer:HomeDirectory}` in the policy). For example, `/example-bucket-1234/username` would set the home bucket to `example-bucket-1234` and the home directory to `username`.
	HomeDirectory interface{}
	// An IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and `${Transfer:HomeBucket}`. These are evaluated on-the-fly when navigating the bucket.
	Policy interface{}
	// Amazon Resource Name (ARN) of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
	Role interface{}
	// The Server ID of the Transfer Server (e.g. `s-12345678`)
	ServerId interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// The name used for log in to your SFTP server.
	UserName interface{}
}

The set of arguments for constructing a User resource.

type UserState added in v0.16.5 

type UserState struct {
	// Amazon Resource Name (ARN) of Transfer User
	Arn interface{}
	// The landing directory (folder) for a user when they log in to the server using their SFTP client.  It should begin with a `/`.  The first item in the path is the name of the home bucket (accessible as `${Transfer:HomeBucket}` in the policy) and the rest is the home directory (accessible as `${Transfer:HomeDirectory}` in the policy). For example, `/example-bucket-1234/username` would set the home bucket to `example-bucket-1234` and the home directory to `username`.
	HomeDirectory interface{}
	// An IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include `${Transfer:UserName}`, `${Transfer:HomeDirectory}`, and `${Transfer:HomeBucket}`. These are evaluated on-the-fly when navigating the bucket.
	Policy interface{}
	// Amazon Resource Name (ARN) of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
	Role interface{}
	// The Server ID of the Transfer Server (e.g. `s-12345678`)
	ServerId interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// The name used for log in to your SFTP server.
	UserName interface{}
}

Input properties used for looking up and filtering User resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.