user_pool_resource_servers

Creates, updates, deletes or gets an user_pool_resource_server resource or lists user_pool_resource_servers in a region

Overview

Name	user_pool_resource_servers
Type	Resource
Description	Resource Type definition for AWS::Cognito::UserPoolResourceServer
Id	aws.cognito.user_pool_resource_servers

Fields

Name	Datatype	Description
user_pool_id	string
identifier	string
name	string
scopes	array
region	string	AWS region.

For more information, see AWS::Cognito::UserPoolResourceServer.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	UserPoolId, Identifier, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all user_pool_resource_servers in a region.

SELECT
region,
user_pool_id,
identifier,
name,
scopes
FROM aws.cognito.user_pool_resource_servers
WHERE region = 'us-east-1';

Gets all properties from an individual user_pool_resource_server.

SELECT
region,
user_pool_id,
identifier,
name,
scopes
FROM aws.cognito.user_pool_resource_servers
WHERE region = 'us-east-1' AND data__Identifier = '<UserPoolId>|<Identifier>';

INSERT example

Use the following StackQL query and manifest file to create a new user_pool_resource_server resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.cognito.user_pool_resource_servers (
 UserPoolId,
 Identifier,
 Name,
 region
)
SELECT 
'{{ UserPoolId }}',
 '{{ Identifier }}',
 '{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cognito.user_pool_resource_servers (
 UserPoolId,
 Identifier,
 Name,
 Scopes,
 region
)
SELECT 
 '{{ UserPoolId }}',
 '{{ Identifier }}',
 '{{ Name }}',
 '{{ Scopes }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_pool_resource_server
    props:
      - name: UserPoolId
        value: '{{ UserPoolId }}'
      - name: Identifier
        value: '{{ Identifier }}'
      - name: Name
        value: '{{ Name }}'
      - name: Scopes
        value:
          - ScopeDescription: '{{ ScopeDescription }}'
            ScopeName: '{{ ScopeName }}'

DELETE example

/*+ delete */
DELETE FROM aws.cognito.user_pool_resource_servers
WHERE data__Identifier = '<UserPoolId|Identifier>'
AND region = 'us-east-1';

Permissions

To operate on the user_pool_resource_servers resource, the following permissions are required:

Create

cognito-idp:CreateResourceServer

Read

cognito-idp:DescribeResourceServer

Update

cognito-idp:UpdateResourceServer

Delete

cognito-idp:DeleteResourceServer

List

cognito-idp:ListResourceServers