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

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

Overview

The details of a resource server configuration and associated custom scopes in a user pool.

This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#identifier ⇒ String

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) 


9102
9103
9104
9105
9106
9107
9108
9109
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9102

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

#name ⇒ String

The name of the resource server.

Returns:

  • (String) 


9102
9103
9104
9105
9106
9107
9108
9109
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9102

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

#scopes ⇒ Array<Types::ResourceServerScopeType>

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

Returns:



9102
9103
9104
9105
9106
9107
9108
9109
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9102

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

#user_pool_id ⇒ String

The ID of the user pool that contains the resource server configuration.

Returns:

  • (String) 


9102
9103
9104
9105
9106
9107
9108
9109
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9102

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