You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateResourceServerRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  identifier: "ResourceServerIdentifierType", # required
  name: "ResourceServerNameType", # required
  scopes: [
    {
      scope_name: "ResourceServerScopeNameType", # required
      scope_description: "ResourceServerScopeDescriptionType", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#identifierString

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, https://my-weather-api.example.com.

Returns:

  • (String)


1826
1827
1828
1829
1830
1831
1832
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1826

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

#nameString

A friendly name for the resource server.

Returns:

  • (String)


1826
1827
1828
1829
1830
1831
1832
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1826

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

#scopesArray<Types::ResourceServerScopeType>

A list of scopes. Each scope is map, where the keys are name and description.

Returns:



1826
1827
1828
1829
1830
1831
1832
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1826

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

#user_pool_idString

The user pool ID for the user pool.

Returns:

  • (String)


1826
1827
1828
1829
1830
1831
1832
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1826

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