Class: Aws::CognitoIdentityProvider::Types::DescribeResourceServerRequest

Inherits:

Struct

Object
Struct
Aws::CognitoIdentityProvider::Types::DescribeResourceServerRequest

show all

Defined in:: gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#identifier ⇒ String
A unique resource server identifier for the resource server.
#user_pool_id ⇒ String
The ID of the user pool that hosts the resource server.

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)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5211

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

#user_pool_id ⇒ `String`

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