Package com.pulumi.aws.transfer

Class UserArgs.Builder

  • Enclosing class:
    UserArgs
    public static final class UserArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

      • Builder

        public Builder​(UserArgs defaults)

    • Method Detail

      • homeDirectory

        public UserArgs.Builder homeDirectory​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> homeDirectory)
        Parameters:
        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`.
        Returns:
        builder

      • homeDirectory

        public UserArgs.Builder homeDirectory​(java.lang.String homeDirectory)
        Parameters:
        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`.
        Returns:
        builder

      • homeDirectoryMappings

        public UserArgs.Builder homeDirectoryMappings​(@Nullable
                                              com.pulumi.core.Output<java.util.List<UserHomeDirectoryMappingArgs>> homeDirectoryMappings)
        Parameters:
        homeDirectoryMappings - 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.
        Returns:
        builder

      • homeDirectoryMappings

        public UserArgs.Builder homeDirectoryMappings​(java.util.List<UserHomeDirectoryMappingArgs> homeDirectoryMappings)
        Parameters:
        homeDirectoryMappings - 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.
        Returns:
        builder

      • homeDirectoryMappings

        public UserArgs.Builder homeDirectoryMappings​(UserHomeDirectoryMappingArgs... homeDirectoryMappings)
        Parameters:
        homeDirectoryMappings - 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.
        Returns:
        builder

      • homeDirectoryType

        public UserArgs.Builder homeDirectoryType​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> homeDirectoryType)
        Parameters:
        homeDirectoryType - The type of landing directory (folder) you mapped for your users' home directory. Valid values are `PATH` and `LOGICAL`.
        Returns:
        builder

      • homeDirectoryType

        public UserArgs.Builder homeDirectoryType​(java.lang.String homeDirectoryType)
        Parameters:
        homeDirectoryType - The type of landing directory (folder) you mapped for your users' home directory. Valid values are `PATH` and `LOGICAL`.
        Returns:
        builder

      • policy

        public UserArgs.Builder policy​(@Nullable
                               com.pulumi.core.Output<java.lang.String> policy)
        Parameters:
        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.
        Returns:
        builder

      • policy

        public UserArgs.Builder policy​(java.lang.String policy)
        Parameters:
        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.
        Returns:
        builder

      • posixProfile

        public UserArgs.Builder posixProfile​(@Nullable
                                     com.pulumi.core.Output<UserPosixProfileArgs> posixProfile)
        Parameters:
        posixProfile - 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.
        Returns:
        builder

      • posixProfile

        public UserArgs.Builder posixProfile​(UserPosixProfileArgs posixProfile)
        Parameters:
        posixProfile - 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.
        Returns:
        builder

      • role

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

      • role

        public UserArgs.Builder role​(java.lang.String role)
        Parameters:
        role - Amazon Resource Name (ARN) of an IAM role that allows the service to control your user’s access to your Amazon S3 bucket.
        Returns:
        builder

      • serverId

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

      • serverId

        public UserArgs.Builder serverId​(java.lang.String serverId)
        Parameters:
        serverId - The Server ID of the Transfer Server (e.g., `s-12345678`)
        Returns:
        builder

      • tags

        public UserArgs.Builder tags​(@Nullable
                             com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tags

        public UserArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • userName

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

      • userName

        public UserArgs.Builder userName​(java.lang.String userName)
        Parameters:
        userName - The name used for log in to your SFTP server.
        Returns:
        builder