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	awscc.cognito.user_pool_resource_servers

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
user_pool_id	string
identifier	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	user_pool_resource_servers	INSERT	UserPoolId, Identifier, Name, region
delete_resource	user_pool_resource_servers	DELETE	Identifier, region
update_resource	user_pool_resource_servers	UPDATE	Identifier, PatchDocument, region
list_resources	user_pool_resource_servers_list_only	SELECT	region
get_resource	user_pool_resource_servers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual user_pool_resource_server.

SELECT
  region,
  user_pool_id,
  identifier,
  name,
  scopes
FROM awscc.cognito.user_pool_resource_servers
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ user_pool_id }}|{{ identifier }}';

list (identifiers only)

Lists all user_pool_resource_servers in a region.

SELECT
  region,
  user_pool_id,
  identifier
FROM awscc.cognito.user_pool_resource_servers_list_only
WHERE
  region = 'us-east-1';

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 awscc.cognito.user_pool_resource_servers (
  UserPoolId,
  Identifier,
  Name,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ identifier }}',
  '{{ name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cognito.user_pool_resource_servers (
  UserPoolId,
  Identifier,
  Name,
  Scopes,
  region
)
SELECT
  '{{ user_pool_id }}',
  '{{ 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: user_pool_id
        value: '{{ user_pool_id }}'
      - name: identifier
        value: '{{ identifier }}'
      - name: name
        value: '{{ name }}'
      - name: scopes
        value:
          - scope_description: '{{ scope_description }}'
            scope_name: '{{ scope_name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cognito.user_pool_resource_servers
SET PatchDocument = string('{{ {
    "Name": name,
    "Scopes": scopes
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ user_pool_id }}|{{ identifier }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cognito.user_pool_resource_servers
WHERE
  Identifier = '{{ user_pool_id }}|{{ 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