Class: AWSCDK::Cognito::CfnUserPoolResourceServerProps

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

Overview

Properties for defining a CfnUserPoolResourceServer.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identifier:, name:, user_pool_id:, scopes: nil) ⇒ CfnUserPoolResourceServerProps

Returns a new instance of CfnUserPoolResourceServerProps.

Parameters:



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

def initialize(identifier:, name:, user_pool_id:, scopes: nil)
  @identifier = identifier
  Jsii::Type.check_type(@identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identifier")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @user_pool_id = user_pool_id
  Jsii::Type.check_type(@user_pool_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2duaXRvLklVc2VyUG9vbFJlZiJ9XX19")), "userPoolId")
  @scopes = scopes
  Jsii::Type.check_type(@scopes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5DZm5Vc2VyUG9vbFJlc291cmNlU2VydmVyLlJlc291cmNlU2VydmVyU2NvcGVUeXBlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "scopes") unless @scopes.nil?
end

Instance Attribute Details

#identifier ⇒ String (readonly)

A unique resource server identifier for the resource server.

The identifier can be an API friendly name like solar-system-data . You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope . Longer scope-identifier strings increase the size of your access tokens.

Returns:

  • (String)

See Also:



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

def identifier
  @identifier
end

#name ⇒ String (readonly)

A friendly name for the resource server.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'cognito/cfn_user_pool_resource_server_props.rb', line 37

def name
  @name
end

#scopes ⇒ AWSCDK::IResolvable, ... (readonly)

A list of scopes.

Each scope is a map with keys ScopeName and ScopeDescription .

Returns:

See Also:



49
50
51
 
# File 'cognito/cfn_user_pool_resource_server_props.rb', line 49

def scopes
  @scopes
end

#user_pool_id ⇒ String, AWSCDK::Interfaces::AWSCognito::IUserPoolRef (readonly)

The ID of the user pool where you want to create a resource server.

Returns:

See Also:



42
43
44
 
# File 'cognito/cfn_user_pool_resource_server_props.rb', line 42

def user_pool_id
  @user_pool_id
end

Class Method Details

.jsii_properties ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'cognito/cfn_user_pool_resource_server_props.rb', line 51

def self.jsii_properties
  {
    :identifier => "identifier",
    :name => "name",
    :user_pool_id => "userPoolId",
    :scopes => "scopes",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



60
61
62
63
64
65
66
67
68
69
 
# File 'cognito/cfn_user_pool_resource_server_props.rb', line 60

def to_jsii
  result = {}
  result.merge!({
    "identifier" => @identifier,
    "name" => @name,
    "userPoolId" => @user_pool_id,
    "scopes" => @scopes,
  })
  result.compact
end