UserState class
Input properties used for looking up and filtering User resources.
Constructors
-
UserState({Input<
String?> ? arn, Input<String?> ? homeDirectory, Input<List< ? homeDirectoryMappings, Input<UserHomeDirectoryMapping> ?>String?> ? homeDirectoryType, Input<String?> ? policy, Input<UserPosixProfile?> ? posixProfile, Input<String?> ? region, Input<String?> ? role, Input<String?> ? serverId, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? userName}) -
Creates a new UserState.
arnARN of Transfer UserhomeDirectoryLanding 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/usernamewould set the home bucket toexample-bucket-1234and the home directory tousername.homeDirectoryMappingsLogical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. SeehomeDirectoryMappingsBlock below.homeDirectoryTypeType of landing directory (folder) you mapped for your users' home directory. Valid values arePATHandLOGICAL.policyIAM 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}. Since the IAM variable syntax matches Terraform's interpolation syntax, they must be escaped inside Terraform configuration strings ($${Transfer:UserName}). These are evaluated on-the-fly when navigating the bucket.posixProfileFull 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. SeeposixProfileBlock below.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.roleARN of an IAM role that allows the service to control your user’s access to your Amazon S3 bucket.serverIdServer ID of the Transfer Server (e.g.,s-12345678)tagsMap of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.userNameName used for log in to your SFTP server.const -
UserState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN of Transfer User
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
homeDirectory
→ Input<
String?> ? -
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/usernamewould set the home bucket toexample-bucket-1234and the home directory tousername.final -
homeDirectoryMappings
→ Input<
List< ?UserHomeDirectoryMapping> ?> -
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
homeDirectoryMappingsBlock below.final -
homeDirectoryType
→ Input<
String?> ? -
Type of landing directory (folder) you mapped for your users' home directory. Valid values are
PATHandLOGICAL.final -
policy
→ Input<
String?> ? -
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}. Since the IAM variable syntax matches Terraform's interpolation syntax, they must be escaped inside Terraform configuration strings ($${Transfer:UserName}). These are evaluated on-the-fly when navigating the bucket.final -
posixProfile
→ Input<
UserPosixProfile?> ? -
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
posixProfileBlock below.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
role
→ Input<
String?> ? -
ARN of an IAM role that allows the service to control your user’s access to your Amazon S3 bucket.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serverId
→ Input<
String?> ? -
Server ID of the Transfer Server (e.g.,
s-12345678)final -
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
userName
→ Input<
String?> ? -
Name used for log in to your SFTP server.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited