Package com.pulumi.aws.transfer

Class UserArgs

  • public final class UserArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UserArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static UserArgs Empty  

    • Field Detail

      • Empty

        public static final UserArgs Empty

    • Method Detail

      • homeDirectory

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> homeDirectory()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.util.List<UserHomeDirectoryMappingArgs>>> homeDirectoryMappings()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> homeDirectoryType()
        Returns:
        The type of landing directory (folder) you mapped for your users' home directory. Valid values are `PATH` and `LOGICAL`.

      • policy

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> policy()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<UserPosixProfileArgs>> posixProfile()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> role()
        Returns:
        Amazon Resource Name (ARN) of an IAM role that allows the service to control your user’s access to your Amazon S3 bucket.

      • serverId

        public com.pulumi.core.Output<java.lang.String> serverId()
        Returns:
        The Server ID of the Transfer Server (e.g., `s-12345678`)

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • userName

        public com.pulumi.core.Output<java.lang.String> userName()
        Returns:
        The name used for log in to your SFTP server.