Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-idp ]

create-resource-server

Description

Creates a new OAuth2.0 resource server and defines custom scopes in it.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-resource-server
--user-pool-id <value>
--identifier <value>
--name <value>
[--scopes <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

The user pool ID for the user pool.

--identifier (string)

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 .

--name (string)

A friendly name for the resource server.

--scopes (list)

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

Shorthand Syntax:

ScopeName=string,ScopeDescription=string ...

JSON Syntax:

[
  {
    "ScopeName": "string",
    "ScopeDescription": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ResourceServer -> (structure)

The newly created resource server.

UserPoolId -> (string)

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

Identifier -> (string)

The identifier for the resource server.

Name -> (string)

The name of the resource server.

Scopes -> (list)

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

(structure)

A resource server scope.

ScopeName -> (string)

The name of the scope.

ScopeDescription -> (string)

A description of the scope.