1. Packages
  2. AWS Classic
  3. API Docs
  4. appstream
  5. User

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

aws.appstream.User

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi

    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")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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
    	})
    }
    
    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 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.List;
    import java.util.ArrayList;
    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
    

    Create User Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
    def User(resource_name: str,
             args: UserArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def User(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             authentication_type: Optional[str] = None,
             user_name: Optional[str] = None,
             enabled: Optional[bool] = None,
             first_name: Optional[str] = None,
             last_name: Optional[str] = None,
             send_email_notification: Optional[bool] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
    public User(String name, UserArgs args, CustomResourceOptions options)
    
    type: aws:appstream:User
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userResource = new Aws.AppStream.User("userResource", new()
    {
        AuthenticationType = "string",
        UserName = "string",
        Enabled = false,
        FirstName = "string",
        LastName = "string",
        SendEmailNotification = false,
    });
    
    example, err := appstream.NewUser(ctx, "userResource", &appstream.UserArgs{
    	AuthenticationType:    pulumi.String("string"),
    	UserName:              pulumi.String("string"),
    	Enabled:               pulumi.Bool(false),
    	FirstName:             pulumi.String("string"),
    	LastName:              pulumi.String("string"),
    	SendEmailNotification: pulumi.Bool(false),
    })
    
    var userResource = new User("userResource", UserArgs.builder()
        .authenticationType("string")
        .userName("string")
        .enabled(false)
        .firstName("string")
        .lastName("string")
        .sendEmailNotification(false)
        .build());
    
    user_resource = aws.appstream.User("userResource",
        authentication_type="string",
        user_name="string",
        enabled=False,
        first_name="string",
        last_name="string",
        send_email_notification=False)
    
    const userResource = new aws.appstream.User("userResource", {
        authenticationType: "string",
        userName: "string",
        enabled: false,
        firstName: "string",
        lastName: "string",
        sendEmailNotification: false,
    });
    
    type: aws:appstream:User
    properties:
        authenticationType: string
        enabled: false
        firstName: string
        lastName: string
        sendEmailNotification: false
        userName: string
    

    User Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The User resource accepts the following input properties:

    AuthenticationType string
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    UserName string

    Email address of the user.

    The following arguments are optional:

    Enabled bool
    Whether the user in the user pool is enabled.
    FirstName string
    First name, or given name, of the user.
    LastName string
    Last name, or surname, of the user.
    SendEmailNotification bool
    Send an email notification.
    AuthenticationType string
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    UserName string

    Email address of the user.

    The following arguments are optional:

    Enabled bool
    Whether the user in the user pool is enabled.
    FirstName string
    First name, or given name, of the user.
    LastName string
    Last name, or surname, of the user.
    SendEmailNotification bool
    Send an email notification.
    authenticationType String
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    userName String

    Email address of the user.

    The following arguments are optional:

    enabled Boolean
    Whether the user in the user pool is enabled.
    firstName String
    First name, or given name, of the user.
    lastName String
    Last name, or surname, of the user.
    sendEmailNotification Boolean
    Send an email notification.
    authenticationType string
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    userName string

    Email address of the user.

    The following arguments are optional:

    enabled boolean
    Whether the user in the user pool is enabled.
    firstName string
    First name, or given name, of the user.
    lastName string
    Last name, or surname, of the user.
    sendEmailNotification boolean
    Send an email notification.
    authentication_type str
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    user_name str

    Email address of the user.

    The following arguments are optional:

    enabled bool
    Whether the user in the user pool is enabled.
    first_name str
    First name, or given name, of the user.
    last_name str
    Last name, or surname, of the user.
    send_email_notification bool
    Send an email notification.
    authenticationType String
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    userName String

    Email address of the user.

    The following arguments are optional:

    enabled Boolean
    Whether the user in the user pool is enabled.
    firstName String
    First name, or given name, of the user.
    lastName String
    Last name, or surname, of the user.
    sendEmailNotification Boolean
    Send an email notification.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

    Arn string
    ARN of the appstream user.
    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    ARN of the appstream user.
    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the appstream user.
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    ARN of the appstream user.
    createdTime string
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    ARN of the appstream user.
    created_time str
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    ARN of the appstream user.
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing User Resource

    Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            authentication_type: Optional[str] = None,
            created_time: Optional[str] = None,
            enabled: Optional[bool] = None,
            first_name: Optional[str] = None,
            last_name: Optional[str] = None,
            send_email_notification: Optional[bool] = None,
            user_name: Optional[str] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the appstream user.
    AuthenticationType string
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    Enabled bool
    Whether the user in the user pool is enabled.
    FirstName string
    First name, or given name, of the user.
    LastName string
    Last name, or surname, of the user.
    SendEmailNotification bool
    Send an email notification.
    UserName string

    Email address of the user.

    The following arguments are optional:

    Arn string
    ARN of the appstream user.
    AuthenticationType string
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    Enabled bool
    Whether the user in the user pool is enabled.
    FirstName string
    First name, or given name, of the user.
    LastName string
    Last name, or surname, of the user.
    SendEmailNotification bool
    Send an email notification.
    UserName string

    Email address of the user.

    The following arguments are optional:

    arn String
    ARN of the appstream user.
    authenticationType String
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    enabled Boolean
    Whether the user in the user pool is enabled.
    firstName String
    First name, or given name, of the user.
    lastName String
    Last name, or surname, of the user.
    sendEmailNotification Boolean
    Send an email notification.
    userName String

    Email address of the user.

    The following arguments are optional:

    arn string
    ARN of the appstream user.
    authenticationType string
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    createdTime string
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    enabled boolean
    Whether the user in the user pool is enabled.
    firstName string
    First name, or given name, of the user.
    lastName string
    Last name, or surname, of the user.
    sendEmailNotification boolean
    Send an email notification.
    userName string

    Email address of the user.

    The following arguments are optional:

    arn str
    ARN of the appstream user.
    authentication_type str
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    created_time str
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    enabled bool
    Whether the user in the user pool is enabled.
    first_name str
    First name, or given name, of the user.
    last_name str
    Last name, or surname, of the user.
    send_email_notification bool
    Send an email notification.
    user_name str

    Email address of the user.

    The following arguments are optional:

    arn String
    ARN of the appstream user.
    authenticationType String
    Authentication type for the user. You must specify USERPOOL. Valid values: API, SAML, USERPOOL
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the user was created.
    enabled Boolean
    Whether the user in the user pool is enabled.
    firstName String
    First name, or given name, of the user.
    lastName String
    Last name, or surname, of the user.
    sendEmailNotification Boolean
    Send an email notification.
    userName String

    Email address of the user.

    The following arguments are optional:

    Import

    Using pulumi import, import aws_appstream_user using the user_name and authentication_type separated by a slash (/). For example:

    $ pulumi import aws:appstream/user:User example UserName/AuthenticationType
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.44.0 published on Monday, Jul 8, 2024 by Pulumi