Class: Aws::CognitoIdentityProvider::Types::CreateResourceServerRequest

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

Overview

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) 


3811
3812
3813
3814
3815
3816
3817
3818
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3811

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

#name ⇒ String

A friendly name for the resource server.

Returns:

  • (String) 


3811
3812
3813
3814
3815
3816
3817
3818
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3811

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

#scopes ⇒ Array<Types::ResourceServerScopeType>

A list of custom scopes. Each scope is a key-value map with the keys ScopeName and ScopeDescription. The name of a custom scope is a combination of ScopeName and the resource server Name in this request, for example MyResourceServerName/MyScopeName.

Returns:



3811
3812
3813
3814
3815
3816
3817
3818
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3811

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

#user_pool_id ⇒ String

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

Returns:

  • (String) 


3811
3812
3813
3814
3815
3816
3817
3818
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3811

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