Class: AWSCDK::AppStream::CfnStackUserAssociationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_stream/cfn_stack_user_association_props.rb

Overview

Properties for defining a CfnStackUserAssociation.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(authentication_type:, stack_name:, user_name:, send_email_notification: nil) ⇒ CfnStackUserAssociationProps

Returns a new instance of CfnStackUserAssociationProps.

Parameters:

  • authentication_type (String) —

    The authentication type for the user who is associated with the stack.

  • stack_name (String) —

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

  • user_name (String) —

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

  • send_email_notification (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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



13
14
15
16
17
18
19
20
21
22
 
# File 'app_stream/cfn_stack_user_association_props.rb', line 13

def initialize(authentication_type:, stack_name:, user_name:, send_email_notification: nil)
  @authentication_type = authentication_type
  Jsii::Type.check_type(@authentication_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "authenticationType")
  @stack_name = stack_name
  Jsii::Type.check_type(@stack_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stackName")
  @user_name = user_name
  Jsii::Type.check_type(@user_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userName")
  @send_email_notification = send_email_notification
  Jsii::Type.check_type(@send_email_notification, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "sendEmailNotification") unless @send_email_notification.nil?
end

Instance Attribute Details

#authentication_type ⇒ String (readonly)

The authentication type for the user who is associated with the stack.

You must specify USERPOOL.

Returns:

  • (String)

See Also:



30
31
32
 
# File 'app_stream/cfn_stack_user_association_props.rb', line 30

def authentication_type
  @authentication_type
end

#send_email_notification ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



47
48
49
 
# File 'app_stream/cfn_stack_user_association_props.rb', line 47

def send_email_notification
  @send_email_notification
end

#stack_name ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



35
36
37
 
# File 'app_stream/cfn_stack_user_association_props.rb', line 35

def stack_name
  @stack_name
end

#user_name ⇒ String (readonly)

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

Users' email addresses are case-sensitive.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'app_stream/cfn_stack_user_association_props.rb', line 42

def user_name
  @user_name
end

Class Method Details

.jsii_properties ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'app_stream/cfn_stack_user_association_props.rb', line 49

def self.jsii_properties
  {
    :authentication_type => "authenticationType",
    :stack_name => "stackName",
    :user_name => "userName",
    :send_email_notification => "sendEmailNotification",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'app_stream/cfn_stack_user_association_props.rb', line 58

def to_jsii
  result = {}
  result.merge!({
    "authenticationType" => @authentication_type,
    "stackName" => @stack_name,
    "userName" => @user_name,
    "sendEmailNotification" => @send_email_notification,
  })
  result.compact
end