Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. transfer
  5. User

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

aws.transfer.User

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

    Provides a AWS Transfer User resource. Managing SSH keys can be accomplished with the aws.transfer.SshKey resource.

    Create User Resource

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         home_directory: Optional[str] = None,
         home_directory_mappings: Optional[Sequence[UserHomeDirectoryMappingArgs]] = None,
         home_directory_type: Optional[str] = None,
         policy: Optional[str] = None,
         posix_profile: Optional[UserPosixProfileArgs] = None,
         role: Optional[str] = None,
         server_id: Optional[str] = None,
         tags: Optional[Mapping[str, str]] = None,
         user_name: Optional[str] = None)
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: aws:transfer:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    User Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The User resource accepts the following input properties:

    Role string

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

    ServerId string

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

    UserName string

    The name used for log in to your SFTP server.

    HomeDirectory string

    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.

    HomeDirectoryMappings List<UserHomeDirectoryMappingArgs>

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    HomeDirectoryType string

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    Policy string

    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.

    PosixProfile UserPosixProfileArgs

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    Tags Dictionary<string, string>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    Role string

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

    ServerId string

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

    UserName string

    The name used for log in to your SFTP server.

    HomeDirectory string

    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.

    HomeDirectoryMappings []UserHomeDirectoryMappingArgs

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    HomeDirectoryType string

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    Policy string

    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.

    PosixProfile UserPosixProfileArgs

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    Tags map[string]string

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    role String

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

    serverId String

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

    userName String

    The name used for log in to your SFTP server.

    homeDirectory String

    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.

    homeDirectoryMappings List<UserHomeDirectoryMappingArgs>

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    homeDirectoryType String

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    policy String

    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.

    posixProfile UserPosixProfileArgs

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    tags Map<String,String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    role string

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

    serverId string

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

    userName string

    The name used for log in to your SFTP server.

    homeDirectory string

    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.

    homeDirectoryMappings UserHomeDirectoryMappingArgs[]

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    homeDirectoryType string

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    policy string

    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.

    posixProfile UserPosixProfileArgs

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    tags {[key: string]: string}

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    role str

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

    server_id str

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

    user_name str

    The name used for log in to your SFTP server.

    home_directory str

    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.

    home_directory_mappings Sequence[UserHomeDirectoryMappingArgs]

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    home_directory_type str

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    policy str

    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.

    posix_profile UserPosixProfileArgs

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    tags Mapping[str, str]

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    role String

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

    serverId String

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

    userName String

    The name used for log in to your SFTP server.

    homeDirectory String

    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.

    homeDirectoryMappings List<Property Map>

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    homeDirectoryType String

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    policy String

    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.

    posixProfile Property Map

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    tags Map<String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

    Arn string

    Amazon Resource Name (ARN) of Transfer User

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Arn string

    Amazon Resource Name (ARN) of Transfer User

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn String

    Amazon Resource Name (ARN) of Transfer User

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn string

    Amazon Resource Name (ARN) of Transfer User

    id string

    The provider-assigned unique ID for this managed resource.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn str

    Amazon Resource Name (ARN) of Transfer User

    id str

    The provider-assigned unique ID for this managed resource.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn String

    Amazon Resource Name (ARN) of Transfer User

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Look up Existing User Resource

    Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        home_directory: Optional[str] = None,
        home_directory_mappings: Optional[Sequence[UserHomeDirectoryMappingArgs]] = None,
        home_directory_type: Optional[str] = None,
        policy: Optional[str] = None,
        posix_profile: Optional[UserPosixProfileArgs] = None,
        role: Optional[str] = None,
        server_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        user_name: Optional[str] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string

    Amazon Resource Name (ARN) of Transfer User

    HomeDirectory string

    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.

    HomeDirectoryMappings List<UserHomeDirectoryMappingArgs>

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    HomeDirectoryType string

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    Policy string

    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.

    PosixProfile UserPosixProfileArgs

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    Role string

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

    ServerId string

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

    Tags Dictionary<string, string>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    UserName string

    The name used for log in to your SFTP server.

    Arn string

    Amazon Resource Name (ARN) of Transfer User

    HomeDirectory string

    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.

    HomeDirectoryMappings []UserHomeDirectoryMappingArgs

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    HomeDirectoryType string

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    Policy string

    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.

    PosixProfile UserPosixProfileArgs

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    Role string

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

    ServerId string

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

    Tags map[string]string

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    UserName string

    The name used for log in to your SFTP server.

    arn String

    Amazon Resource Name (ARN) of Transfer User

    homeDirectory String

    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.

    homeDirectoryMappings List<UserHomeDirectoryMappingArgs>

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    homeDirectoryType String

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    policy String

    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.

    posixProfile UserPosixProfileArgs

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    role String

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

    serverId String

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

    tags Map<String,String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    userName String

    The name used for log in to your SFTP server.

    arn string

    Amazon Resource Name (ARN) of Transfer User

    homeDirectory string

    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.

    homeDirectoryMappings UserHomeDirectoryMappingArgs[]

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    homeDirectoryType string

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    policy string

    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.

    posixProfile UserPosixProfileArgs

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    role string

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

    serverId string

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

    tags {[key: string]: string}

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    userName string

    The name used for log in to your SFTP server.

    arn str

    Amazon Resource Name (ARN) of Transfer User

    home_directory str

    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.

    home_directory_mappings Sequence[UserHomeDirectoryMappingArgs]

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    home_directory_type str

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    policy str

    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.

    posix_profile UserPosixProfileArgs

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    role str

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

    server_id str

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

    tags Mapping[str, str]

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    user_name str

    The name used for log in to your SFTP server.

    arn String

    Amazon Resource Name (ARN) of Transfer User

    homeDirectory String

    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.

    homeDirectoryMappings List<Property Map>

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See Home Directory Mappings below.

    homeDirectoryType String

    The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

    policy String

    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.

    posixProfile Property Map

    Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See Posix Profile below.

    role String

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

    serverId String

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

    tags Map<String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    userName String

    The name used for log in to your SFTP server.

    Supporting Types

    UserHomeDirectoryMapping

    Entry string

    Represents an entry and a target.

    Target string

    Represents the map target.

    Entry string

    Represents an entry and a target.

    Target string

    Represents the map target.

    entry String

    Represents an entry and a target.

    target String

    Represents the map target.

    entry string

    Represents an entry and a target.

    target string

    Represents the map target.

    entry str

    Represents an entry and a target.

    target str

    Represents the map target.

    entry String

    Represents an entry and a target.

    target String

    Represents the map target.

    UserPosixProfile

    Gid int

    The POSIX group ID used for all EFS operations by this user.

    Uid int

    The POSIX user ID used for all EFS operations by this user.

    SecondaryGids List<int>

    The secondary POSIX group IDs used for all EFS operations by this user.

    Gid int

    The POSIX group ID used for all EFS operations by this user.

    Uid int

    The POSIX user ID used for all EFS operations by this user.

    SecondaryGids []int

    The secondary POSIX group IDs used for all EFS operations by this user.

    gid Integer

    The POSIX group ID used for all EFS operations by this user.

    uid Integer

    The POSIX user ID used for all EFS operations by this user.

    secondaryGids List<Integer>

    The secondary POSIX group IDs used for all EFS operations by this user.

    gid number

    The POSIX group ID used for all EFS operations by this user.

    uid number

    The POSIX user ID used for all EFS operations by this user.

    secondaryGids number[]

    The secondary POSIX group IDs used for all EFS operations by this user.

    gid int

    The POSIX group ID used for all EFS operations by this user.

    uid int

    The POSIX user ID used for all EFS operations by this user.

    secondary_gids Sequence[int]

    The secondary POSIX group IDs used for all EFS operations by this user.

    gid Number

    The POSIX group ID used for all EFS operations by this user.

    uid Number

    The POSIX user ID used for all EFS operations by this user.

    secondaryGids List<Number>

    The secondary POSIX group IDs used for all EFS operations by this user.

    Import

    Transfer Users can be imported using the server_id and user_name separated by /.

     $ pulumi import aws:transfer/user:User bar s-12345678/test-username

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
    pulumi/pulumi-aws