Class UserState

Inheritance
System.Object
InputArgs
ResourceArgs
UserState
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.Transfer
Assembly: Pulumi.Aws.dll
Syntax
public sealed class UserState : ResourceArgs

Constructors

View Source

UserState()

Declaration
public UserState()

Properties

View Source

Arn

Amazon Resource Name (ARN) of Transfer User

Declaration
public Input<string> Arn { get; set; }
Property Value
Type Description
Input<System.String>
View Source

HomeDirectory

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.

Declaration
public Input<string> HomeDirectory { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Policy

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.

Declaration
public Input<string> Policy { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Role

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

Declaration
public Input<string> Role { get; set; }
Property Value
Type Description
Input<System.String>
View Source

ServerId

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

Declaration
public Input<string> ServerId { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Tags

A map of tags to assign to the resource.

Declaration
public InputMap<object> Tags { get; set; }
Property Value
Type Description
InputMap<System.Object>
View Source

UserName

The name used for log in to your SFTP server.

Declaration
public Input<string> UserName { get; set; }
Property Value
Type Description
Input<System.String>