Class: Aws::CognitoIdentityProvider::Types::ResourceServerType

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

A container for information about a resource server for a user pool.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#identifierString

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 `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)


7296
7297
7298
7299
7300
7301
7302
7303
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7296

class ResourceServerType < Struct.new(
  :user_pool_id,
  :identifier,
  :name,
  :scopes)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the resource server.

Returns:

  • (String)


7296
7297
7298
7299
7300
7301
7302
7303
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7296

class ResourceServerType < Struct.new(
  :user_pool_id,
  :identifier,
  :name,
  :scopes)
  SENSITIVE = []
  include Aws::Structure
end

#scopesArray<Types::ResourceServerScopeType>

A list of scopes that are defined for the resource server.

Returns:



7296
7297
7298
7299
7300
7301
7302
7303
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7296

class ResourceServerType < Struct.new(
  :user_pool_id,
  :identifier,
  :name,
  :scopes)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_idString

The user pool ID for the user pool that hosts the resource server.

Returns:

  • (String)


7296
7297
7298
7299
7300
7301
7302
7303
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7296

class ResourceServerType < Struct.new(
  :user_pool_id,
  :identifier,
  :name,
  :scopes)
  SENSITIVE = []
  include Aws::Structure
end