Try AWS Native preview for resources not in the classic version.
aws.appstream.User
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides an AppStream user.
Example Usage
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",
FirstName = "FIRST NAME",
LastName = "LAST NAME",
UserName = "EMAIL",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/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"),
FirstName: pulumi.String("FIRST NAME"),
LastName: pulumi.String("LAST NAME"),
UserName: pulumi.String("EMAIL"),
})
if err != nil {
return err
}
return nil
})
}
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")
.firstName("FIRST NAME")
.lastName("LAST NAME")
.userName("EMAIL")
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.appstream.User("example",
authentication_type="USERPOOL",
first_name="FIRST NAME",
last_name="LAST NAME",
user_name="EMAIL")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.appstream.User("example", {
authenticationType: "USERPOOL",
firstName: "FIRST NAME",
lastName: "LAST NAME",
userName: "EMAIL",
});
resources:
example:
type: aws:appstream:User
properties:
authenticationType: USERPOOL
firstName: FIRST NAME
lastName: LAST NAME
userName: EMAIL
Create User Resource
new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
opts: Optional[ResourceOptions] = None,
authentication_type: 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)
@overload
def User(resource_name: str,
args: UserArgs,
opts: Optional[ResourceOptions] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
type: aws:appstream:User
properties: # The arguments to resource properties.
options: # 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.
- 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.
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:
- Authentication
Type string Authentication type for the user. You must specify USERPOOL. Valid values:
API
,SAML
,USERPOOL
- User
Name string Email address of the user.
- Enabled bool
Whether the user in the user pool is enabled.
- First
Name string First name, or given name, of the user.
- Last
Name string Last name, or surname, of the user.
- Send
Email boolNotification Send an email notification.
- Authentication
Type string Authentication type for the user. You must specify USERPOOL. Valid values:
API
,SAML
,USERPOOL
- User
Name string Email address of the user.
- Enabled bool
Whether the user in the user pool is enabled.
- First
Name string First name, or given name, of the user.
- Last
Name string Last name, or surname, of the user.
- Send
Email boolNotification Send an email notification.
- authentication
Type String Authentication type for the user. You must specify USERPOOL. Valid values:
API
,SAML
,USERPOOL
- user
Name String Email address of the user.
- enabled Boolean
Whether the user in the user pool is enabled.
- first
Name String First name, or given name, of the user.
- last
Name String Last name, or surname, of the user.
- send
Email BooleanNotification Send an email notification.
- authentication
Type string Authentication type for the user. You must specify USERPOOL. Valid values:
API
,SAML
,USERPOOL
- user
Name string Email address of the user.
- enabled boolean
Whether the user in the user pool is enabled.
- first
Name string First name, or given name, of the user.
- last
Name string Last name, or surname, of the user.
- send
Email booleanNotification 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.
- 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_ boolnotification Send an email notification.
- authentication
Type String Authentication type for the user. You must specify USERPOOL. Valid values:
API
,SAML
,USERPOOL
- user
Name String Email address of the user.
- enabled Boolean
Whether the user in the user pool is enabled.
- first
Name String First name, or given name, of the user.
- last
Name String Last name, or surname, of the user.
- send
Email BooleanNotification 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.
- Created
Time 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.
- Created
Time 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.
- created
Time 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.
- created
Time 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.
- created
Time 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.
- Arn string
ARN of the appstream user.
- Authentication
Type string Authentication type for the user. You must specify USERPOOL. Valid values:
API
,SAML
,USERPOOL
- Created
Time 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.
- First
Name string First name, or given name, of the user.
- Last
Name string Last name, or surname, of the user.
- Send
Email boolNotification Send an email notification.
- User
Name string Email address of the user.
- Arn string
ARN of the appstream user.
- Authentication
Type string Authentication type for the user. You must specify USERPOOL. Valid values:
API
,SAML
,USERPOOL
- Created
Time 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.
- First
Name string First name, or given name, of the user.
- Last
Name string Last name, or surname, of the user.
- Send
Email boolNotification Send an email notification.
- User
Name string Email address of the user.
- arn String
ARN of the appstream user.
- authentication
Type String Authentication type for the user. You must specify USERPOOL. Valid values:
API
,SAML
,USERPOOL
- created
Time 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.
- first
Name String First name, or given name, of the user.
- last
Name String Last name, or surname, of the user.
- send
Email BooleanNotification Send an email notification.
- user
Name String Email address of the user.
- arn string
ARN of the appstream user.
- authentication
Type string Authentication type for the user. You must specify USERPOOL. Valid values:
API
,SAML
,USERPOOL
- created
Time 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.
- first
Name string First name, or given name, of the user.
- last
Name string Last name, or surname, of the user.
- send
Email booleanNotification Send an email notification.
- user
Name string Email address of the user.
- 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_ boolnotification Send an email notification.
- user_
name str Email address of the user.
- arn String
ARN of the appstream user.
- authentication
Type String Authentication type for the user. You must specify USERPOOL. Valid values:
API
,SAML
,USERPOOL
- created
Time 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.
- first
Name String First name, or given name, of the user.
- last
Name String Last name, or surname, of the user.
- send
Email BooleanNotification Send an email notification.
- user
Name String Email address of the user.
Import
aws_appstream_user
can be imported using the user_name
and authentication_type
separated by a slash (/
), e.g.,
$ pulumi import aws:appstream/user:User example UserName/AuthenticationType
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.