User class
Resource for managing QuickSight User
Example Usage
Create User With IAM Identity Type Using an IAM Role
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.User("example", {
email: "author1@example.com",
identityType: "IAM",
userRole: "AUTHOR",
iamArn: "arn:aws:iam::123456789012:role/AuthorRole",
sessionName: "author1",
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.User("example",
email="author1@example.com",
identity_type="IAM",
user_role="AUTHOR",
iam_arn="arn:aws:iam::123456789012:role/AuthorRole",
session_name="author1")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Quicksight.User("example", new()
{
Email = "author1@example.com",
IdentityType = "IAM",
UserRole = "AUTHOR",
IamArn = "arn:aws:iam::123456789012:role/AuthorRole",
SessionName = "author1",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewUser(ctx, "example", &quicksight.UserArgs{
Email: pulumi.String("author1@example.com"),
IdentityType: pulumi.String("IAM"),
UserRole: pulumi.String("AUTHOR"),
IamArn: pulumi.String("arn:aws:iam::123456789012:role/AuthorRole"),
SessionName: pulumi.String("author1"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_user" "example" {
email = "author1@example.com"
identity_type = "IAM"
user_role = "AUTHOR"
iam_arn = "arn:aws:iam::123456789012:role/AuthorRole"
session_name = "author1"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.User;
import com.pulumi.aws.quicksight.UserArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new User("example", UserArgs.builder()
.email("author1@example.com")
.identityType("IAM")
.userRole("AUTHOR")
.iamArn("arn:aws:iam::123456789012:role/AuthorRole")
.sessionName("author1")
.build());
}
}
resources:
example:
type: aws:quicksight:User
properties:
email: author1@example.com
identityType: IAM
userRole: AUTHOR
iamArn: arn:aws:iam::123456789012:role/AuthorRole
sessionName: author1
Create User With IAM Identity Type Using an IAM User
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.User("example", {
email: "authorpro1@example.com",
identityType: "IAM",
userRole: "AUTHOR_PRO",
iamArn: "arn:aws:iam::123456789012:user/authorpro1",
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.User("example",
email="authorpro1@example.com",
identity_type="IAM",
user_role="AUTHOR_PRO",
iam_arn="arn:aws:iam::123456789012:user/authorpro1")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Quicksight.User("example", new()
{
Email = "authorpro1@example.com",
IdentityType = "IAM",
UserRole = "AUTHOR_PRO",
IamArn = "arn:aws:iam::123456789012:user/authorpro1",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewUser(ctx, "example", &quicksight.UserArgs{
Email: pulumi.String("authorpro1@example.com"),
IdentityType: pulumi.String("IAM"),
UserRole: pulumi.String("AUTHOR_PRO"),
IamArn: pulumi.String("arn:aws:iam::123456789012:user/authorpro1"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_user" "example" {
email = "authorpro1@example.com"
identity_type = "IAM"
user_role = "AUTHOR_PRO"
iam_arn = "arn:aws:iam::123456789012:user/authorpro1"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.User;
import com.pulumi.aws.quicksight.UserArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new User("example", UserArgs.builder()
.email("authorpro1@example.com")
.identityType("IAM")
.userRole("AUTHOR_PRO")
.iamArn("arn:aws:iam::123456789012:user/authorpro1")
.build());
}
}
resources:
example:
type: aws:quicksight:User
properties:
email: authorpro1@example.com
identityType: IAM
userRole: AUTHOR_PRO
iamArn: arn:aws:iam::123456789012:user/authorpro1
Create User With QuickSight Identity Type in Non-Default Namespace
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.quicksight.User("example", {
email: "reader1@example.com",
identityType: "QUICKSIGHT",
userRole: "READER",
namespace: "example",
userName: "reader1",
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.User("example",
email="reader1@example.com",
identity_type="QUICKSIGHT",
user_role="READER",
namespace="example",
user_name="reader1")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Quicksight.User("example", new()
{
Email = "reader1@example.com",
IdentityType = "QUICKSIGHT",
UserRole = "READER",
Namespace = "example",
UserName = "reader1",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.NewUser(ctx, "example", &quicksight.UserArgs{
Email: pulumi.String("reader1@example.com"),
IdentityType: pulumi.String("QUICKSIGHT"),
UserRole: pulumi.String("READER"),
Namespace: pulumi.String("example"),
UserName: pulumi.String("reader1"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_user" "example" {
email = "reader1@example.com"
identity_type = "QUICKSIGHT"
user_role = "READER"
namespace = "example"
user_name = "reader1"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.User;
import com.pulumi.aws.quicksight.UserArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new User("example", UserArgs.builder()
.email("reader1@example.com")
.identityType("QUICKSIGHT")
.userRole("READER")
.namespace("example")
.userName("reader1")
.build());
}
}
resources:
example:
type: aws:quicksight:User
properties:
email: reader1@example.com
identityType: QUICKSIGHT
userRole: READER
namespace: example
userName: reader1
Import
You cannot import this resource.
Constructors
- User(String name, {UserArgs? args, CustomResourceOptions? options})
-
Creates a new User.
nameThe Pulumi resource name.argsArguments used to configure this User. The set of arguments for User.optionsResource options controlling this resource's behavior. - User.reference(String urn)
- Creates a typed reference to an existing User resource.
Properties
-
arn
↔ Output<
String> -
ARN for the user.
latefinal
-
awsAccountId
↔ Output<
String> -
AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
email
↔ Output<
String> -
Email address of the user that you want to register.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
iamArn
↔ Output<
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.latefinal -
id
↔ Output<
String> -
getter/setter pairinherited
-
identityType
↔ Output<
String> -
Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values:
IAM,QUICKSIGHT,IAM_IDENTITY_CENTER.latefinal - isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
namespace
↔ Output<
String?> -
The Amazon Quicksight namespace to create the user in. Defaults to
default.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sessionName
↔ Output<
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.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
userInvitationUrl
↔ Output<
String> -
URL the user visits to complete registration and provide a password. Returned only for users with an identity type of
QUICKSIGHT.latefinal -
userName
↔ Output<
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.latefinal -
userRole
↔ Output<
String> -
Amazon QuickSight role for the user. Valid values:
READER,AUTHOR,ADMIN,READER_PRO,AUTHOR_PRO,ADMIN_PRO,RESTRICTED_AUTHOR,RESTRICTED_READER.latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited