86 lines
2.5 KiB
TypeScript
86 lines
2.5 KiB
TypeScript
import type { Construct } from 'constructs';
|
|
import type { IResource } from '../../core';
|
|
import { Resource } from '../../core';
|
|
import type { IUserPoolRef, IUserPoolResourceServerRef, UserPoolResourceServerReference } from '../../interfaces/generated/aws-cognito-interfaces.generated';
|
|
/**
|
|
* Represents a Cognito user pool resource server
|
|
*/
|
|
export interface IUserPoolResourceServer extends IResource, IUserPoolResourceServerRef {
|
|
/**
|
|
* Resource server id
|
|
* @attribute
|
|
*/
|
|
readonly userPoolResourceServerId: string;
|
|
}
|
|
/**
|
|
* Props to initialize ResourceServerScope
|
|
*/
|
|
export interface ResourceServerScopeProps {
|
|
/**
|
|
* The name of the scope
|
|
*/
|
|
readonly scopeName: string;
|
|
/**
|
|
* A description of the scope.
|
|
*/
|
|
readonly scopeDescription: string;
|
|
}
|
|
/**
|
|
* A scope for ResourceServer
|
|
*/
|
|
export declare class ResourceServerScope {
|
|
/**
|
|
* The name of the scope
|
|
*/
|
|
readonly scopeName: string;
|
|
/**
|
|
* A description of the scope.
|
|
*/
|
|
readonly scopeDescription: string;
|
|
constructor(props: ResourceServerScopeProps);
|
|
}
|
|
/**
|
|
* Options to create a UserPoolResourceServer
|
|
*/
|
|
export interface UserPoolResourceServerOptions {
|
|
/**
|
|
* A unique resource server identifier for the resource server.
|
|
*/
|
|
readonly identifier: string;
|
|
/**
|
|
* A friendly name for the resource server.
|
|
* @default - same as `identifier`
|
|
*/
|
|
readonly userPoolResourceServerName?: string;
|
|
/**
|
|
* Oauth scopes
|
|
* @default - No scopes will be added
|
|
*/
|
|
readonly scopes?: ResourceServerScope[];
|
|
}
|
|
/**
|
|
* Properties for the UserPoolResourceServer construct
|
|
*/
|
|
export interface UserPoolResourceServerProps extends UserPoolResourceServerOptions {
|
|
/**
|
|
* The user pool to add this resource server to
|
|
*/
|
|
readonly userPool: IUserPoolRef;
|
|
}
|
|
/**
|
|
* Defines a User Pool OAuth2.0 Resource Server
|
|
*/
|
|
export declare class UserPoolResourceServer extends Resource implements IUserPoolResourceServer {
|
|
/** Uniquely identifies this class. */
|
|
static readonly PROPERTY_INJECTION_ID: string;
|
|
/**
|
|
* Import a user pool resource client given its id.
|
|
*/
|
|
static fromUserPoolResourceServerId(scope: Construct, id: string, userPoolResourceServerId: string): IUserPoolResourceServer;
|
|
readonly userPoolResourceServerId: string;
|
|
private readonly _userPool;
|
|
private readonly identifier;
|
|
get userPoolResourceServerRef(): UserPoolResourceServerReference;
|
|
constructor(scope: Construct, id: string, props: UserPoolResourceServerProps);
|
|
}
|