Class: AWSCDK::Cognito::UserPoolResourceServerOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/user_pool_resource_server_options.rb

Overview

Options to create a UserPoolResourceServer.

Direct Known Subclasses

UserPoolResourceServerProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identifier:, scopes: nil, user_pool_resource_server_name: nil) ⇒ UserPoolResourceServerOptions

Returns a new instance of UserPoolResourceServerOptions.

Parameters:

  • identifier (String) —

    A unique resource server identifier for the resource server.

  • scopes (Array<AWSCDK::Cognito::ResourceServerScope>, nil) (defaults to: nil) —

    Oauth scopes.

  • user_pool_resource_server_name (String, nil) (defaults to: nil) —

    A friendly name for the resource server.



10
11
12
13
14
15
16
17
 
# File 'cognito/user_pool_resource_server_options.rb', line 10

def initialize(identifier:, scopes: nil, user_pool_resource_server_name: nil)
  @identifier = identifier
  Jsii::Type.check_type(@identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identifier")
  @scopes = scopes
  Jsii::Type.check_type(@scopes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLlJlc291cmNlU2VydmVyU2NvcGUifSwia2luZCI6ImFycmF5In19")), "scopes") unless @scopes.nil?
  @user_pool_resource_server_name = user_pool_resource_server_name
  Jsii::Type.check_type(@user_pool_resource_server_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolResourceServerName") unless @user_pool_resource_server_name.nil?
end

Instance Attribute Details

#identifier ⇒ String (readonly)

A unique resource server identifier for the resource server.

Returns:

  • (String) 


22
23
24
 
# File 'cognito/user_pool_resource_server_options.rb', line 22

def identifier
  @identifier
end

#scopes ⇒ Array<AWSCDK::Cognito::ResourceServerScope>? (readonly)

Note:

Default: - No scopes will be added

Oauth scopes.

Returns:



27
28
29
 
# File 'cognito/user_pool_resource_server_options.rb', line 27

def scopes
  @scopes
end

#user_pool_resource_server_name ⇒ String? (readonly)

Note:

Default: - same as identifier

A friendly name for the resource server.

Returns:

  • (String, nil) 


32
33
34
 
# File 'cognito/user_pool_resource_server_options.rb', line 32

def user_pool_resource_server_name
  @user_pool_resource_server_name
end

Class Method Details

.jsii_properties ⇒ Object 



34
35
36
37
38
39
40
 
# File 'cognito/user_pool_resource_server_options.rb', line 34

def self.jsii_properties
  {
    :identifier => "identifier",
    :scopes => "scopes",
    :user_pool_resource_server_name => "userPoolResourceServerName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



42
43
44
45
46
47
48
49
50
 
# File 'cognito/user_pool_resource_server_options.rb', line 42

def to_jsii
  result = {}
  result.merge!({
    "identifier" => @identifier,
    "scopes" => @scopes,
    "userPoolResourceServerName" => @user_pool_resource_server_name,
  })
  result.compact
end