UserState constructor

const UserState({
  1. Input<String?>? arn,
  2. Input<String?>? homeDirectory,
  3. Input<List<UserHomeDirectoryMapping>?>? homeDirectoryMappings,
  4. Input<String?>? homeDirectoryType,
  5. Input<String?>? policy,
  6. Input<UserPosixProfile?>? posixProfile,
  7. Input<String?>? region,
  8. Input<String?>? role,
  9. Input<String?>? serverId,
  10. Input<Map<String, String>?>? tags,
  11. Input<Map<String, String>?>? tagsAll,
  12. Input<String?>? userName,
})

Creates a new UserState. arn ARN of Transfer User homeDirectory 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 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 homeDirectoryMappings Block below. homeDirectoryType Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL. policy 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. posixProfile 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 posixProfile Block below. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. role ARN of an IAM role that allows the service to control your user’s access to your Amazon S3 bucket. serverId Server ID of the Transfer Server (e.g., s-12345678) tags Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. userName Name used for log in to your SFTP server.

Implementation

const UserState({
  this.arn,
  this.homeDirectory,
  this.homeDirectoryMappings,
  this.homeDirectoryType,
  this.policy,
  this.posixProfile,
  this.region,
  this.role,
  this.serverId,
  this.tags,
  this.tagsAll,
  this.userName,
});