UserState class
Input properties used for looking up and filtering User resources.
Constructors
-
UserState({Input<
String?> ? arn, Input<String?> ? awsAccountId, Input<String?> ? email, Input<String?> ? iamArn, Input<String?> ? identityType, Input<String?> ? namespace, Input<String?> ? region, Input<String?> ? sessionName, Input<String?> ? userInvitationUrl, Input<String?> ? userName, Input<String?> ? userRole}) -
Creates a new UserState.
arnARN for the user.awsAccountIdAWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.emailEmail address of the user that you want to register.iamArnARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type ofIAM.identityTypeIdentity type that your Amazon QuickSight account uses to manage the identity of users. Valid values:IAM,QUICKSIGHT,IAM_IDENTITY_CENTER.namespaceThe Amazon Quicksight namespace to create the user in. Defaults todefault.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.sessionNameName of the IAM session to use when assuming roles that can embed QuickSight dashboards. Only valid for registering users using an assumed IAM role. Additionally, if registering multiple users using the same IAM role, each user needs to have a unique session name.userInvitationUrlURL the user visits to complete registration and provide a password. Returned only for users with an identity type ofQUICKSIGHT.userNameAmazon QuickSight user name that you want to create for the user you are registering. Required only for users with an identity type ofQUICKSIGHT.userRoleAmazon QuickSight role for the user. Valid values:READER,AUTHOR,ADMIN,READER_PRO,AUTHOR_PRO,ADMIN_PRO,RESTRICTED_AUTHOR,RESTRICTED_READER.const -
UserState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN for the user.
final
-
awsAccountId
→ Input<
String?> ? -
AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
final
-
email
→ Input<
String?> ? -
Email address of the user that you want to register.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
iamArn
→ Input<
String?> ? -
ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of
IAM.final -
identityType
→ Input<
String?> ? -
Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values:
IAM,QUICKSIGHT,IAM_IDENTITY_CENTER.final -
namespace
→ Input<
String?> ? -
The Amazon Quicksight namespace to create the user in. Defaults to
default.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sessionName
→ Input<
String?> ? -
Name of the IAM session to use when assuming roles that can embed QuickSight dashboards. Only valid for registering users using an assumed IAM role. Additionally, if registering multiple users using the same IAM role, each user needs to have a unique session name.
final
-
userInvitationUrl
→ Input<
String?> ? -
URL the user visits to complete registration and provide a password. Returned only for users with an identity type of
QUICKSIGHT.final -
userName
→ Input<
String?> ? -
Amazon QuickSight user name that you want to create for the user you are registering. Required only for users with an identity type of
QUICKSIGHT.final -
userRole
→ Input<
String?> ? -
Amazon QuickSight role for the user. Valid values:
READER,AUTHOR,ADMIN,READER_PRO,AUTHOR_PRO,ADMIN_PRO,RESTRICTED_AUTHOR,RESTRICTED_READER.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