User class
Provides an AppStream user.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.appstream.User("example", {
authenticationType: "USERPOOL",
userName: "EMAIL",
firstName: "FIRST NAME",
lastName: "LAST NAME",
});
import pulumi
import pulumi_aws as aws
example = aws.appstream.User("example",
authentication_type="USERPOOL",
user_name="EMAIL",
first_name="FIRST NAME",
last_name="LAST NAME")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.AppStream.User("example", new()
{
AuthenticationType = "USERPOOL",
UserName = "EMAIL",
FirstName = "FIRST NAME",
LastName = "LAST NAME",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/appstream"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := appstream.NewUser(ctx, "example", &appstream.UserArgs{
AuthenticationType: pulumi.String("USERPOOL"),
UserName: pulumi.String("EMAIL"),
FirstName: pulumi.String("FIRST NAME"),
LastName: pulumi.String("LAST NAME"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_appstream_user" "example" {
authentication_type = "USERPOOL"
user_name = "EMAIL"
first_name = "FIRST NAME"
last_name = "LAST NAME"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appstream.User;
import com.pulumi.aws.appstream.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()
.authenticationType("USERPOOL")
.userName("EMAIL")
.firstName("FIRST NAME")
.lastName("LAST NAME")
.build());
}
}
resources:
example:
type: aws:appstream:User
properties:
authenticationType: USERPOOL
userName: EMAIL
firstName: FIRST NAME
lastName: LAST NAME
Import
Using pulumi import, import aws.appstream.User using the userName and authenticationType separated by a slash (/). For example:
$ pulumi import aws:appstream/user:User example UserName/AuthenticationType
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 of the appstream user.
latefinal
-
authenticationType
↔ Output<
String> -
Authentication type for the user. You must specify USERPOOL. Valid values:
API,SAML,USERPOOLlatefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdTime
↔ Output<
String> -
Date and time, in UTC and extended RFC 3339 format, when the user was created.
latefinal
-
enabled
↔ Output<
bool?> -
Whether the user in the user pool is enabled.
latefinal
-
firstName
↔ Output<
String?> -
First name, or given name, of the user.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- 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
-
lastName
↔ Output<
String?> -
Last name, or surname, of the user.
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
-
sendEmailNotification
↔ Output<
bool?> -
Send an email notification.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
userName
↔ Output<
String> -
Email address of the user.
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