Skip to content

Resource: awsCognitoResourceServer

Provides a Cognito Resource Server.

Example Usage

Create a basic resource server

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsCognitoUserPoolPool = new aws.cognitoUserPool.CognitoUserPool(
  this,
  "pool",
  {
    name: "pool",
  }
);
new aws.cognitoResourceServer.CognitoResourceServer(this, "resource", {
  identifier: "https://example.com",
  name: "example",
  userPoolId: awsCognitoUserPoolPool.id,
});

Create a resource server with sample-scope

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsCognitoUserPoolPool = new aws.cognitoUserPool.CognitoUserPool(
  this,
  "pool",
  {
    name: "pool",
  }
);
new aws.cognitoResourceServer.CognitoResourceServer(this, "resource", {
  identifier: "https://example.com",
  name: "example",
  scope: [
    {
      scopeDescription: "a Sample Scope Description",
      scopeName: "sample-scope",
    },
  ],
  userPoolId: awsCognitoUserPoolPool.id,
});

Argument Reference

The following arguments are supported:

  • identifier - (Required) An identifier for the resource server.
  • name - (Required) A name for the resource server.
  • scope - (Optional) A list of Authorization Scope.

Authorization Scope

  • scopeName - (Required) The scope name.
  • scopeDescription - (Required) The scope description.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • scopeIdentifiers - A list of all scopes configured for this resource server in the format identifier/scope_name.

Import

awsCognitoResourceServer can be imported using their User Pool ID and Identifier, e.g.,

$ terraform import aws_cognito_resource_server.example "us-west-2_abc123|https://example.com"