You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AppStream::Types::UserStackAssociation

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb

Overview

Note:

When making an API call, you may pass UserStackAssociation data as a hash:

{
  stack_name: "String", # required
  user_name: "Username", # required
  authentication_type: "API", # required, accepts API, SAML, USERPOOL
  send_email_notification: false,
}

Describes a user in the user pool and the associated stack.

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_typeString

The authentication type for the user.

Returns:

  • (String)


3772
3773
3774
3775
3776
3777
3778
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3772

class UserStackAssociation < Struct.new(
  :stack_name,
  :user_name,
  :authentication_type,
  :send_email_notification)
  include Aws::Structure
end

#send_email_notificationBoolean

Specifies whether a welcome email is sent to a user after the user is created in the user pool.

Returns:

  • (Boolean)


3772
3773
3774
3775
3776
3777
3778
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3772

class UserStackAssociation < Struct.new(
  :stack_name,
  :user_name,
  :authentication_type,
  :send_email_notification)
  include Aws::Structure
end

#stack_nameString

The name of the stack that is associated with the user.

Returns:

  • (String)


3772
3773
3774
3775
3776
3777
3778
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3772

class UserStackAssociation < Struct.new(
  :stack_name,
  :user_name,
  :authentication_type,
  :send_email_notification)
  include Aws::Structure
end

#user_nameString

The email address of the user who is associated with the stack.

Users' email addresses are case-sensitive.

Returns:

  • (String)


3772
3773
3774
3775
3776
3777
3778
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 3772

class UserStackAssociation < Struct.new(
  :stack_name,
  :user_name,
  :authentication_type,
  :send_email_notification)
  include Aws::Structure
end