@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
72 lines (71 loc) • 3.52 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::Cognito::UserPoolResourceServer
*/
export declare class UserPoolResourceServer extends pulumi.CustomResource {
/**
* Get an existing UserPoolResourceServer resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): UserPoolResourceServer;
/**
* Returns true if the given object is an instance of UserPoolResourceServer. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is UserPoolResourceServer;
/**
* A unique resource server identifier for the resource server. The identifier can be an API friendly name like `solar-system-data` . You can also set an API URL like `https://solar-system-data-api.example.com` as your identifier.
*
* Amazon Cognito represents scopes in the access token in the format `$resource-server-identifier/$scope` . Longer scope-identifier strings increase the size of your access tokens.
*/
readonly identifier: pulumi.Output<string>;
/**
* A friendly name for the resource server.
*/
readonly name: pulumi.Output<string>;
/**
* A list of scopes. Each scope is a map with keys `ScopeName` and `ScopeDescription` .
*/
readonly scopes: pulumi.Output<outputs.cognito.UserPoolResourceServerResourceServerScopeType[] | undefined>;
/**
* The ID of the user pool where you want to create a resource server.
*/
readonly userPoolId: pulumi.Output<string>;
/**
* Create a UserPoolResourceServer resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: UserPoolResourceServerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a UserPoolResourceServer resource.
*/
export interface UserPoolResourceServerArgs {
/**
* A unique resource server identifier for the resource server. The identifier can be an API friendly name like `solar-system-data` . You can also set an API URL like `https://solar-system-data-api.example.com` as your identifier.
*
* Amazon Cognito represents scopes in the access token in the format `$resource-server-identifier/$scope` . Longer scope-identifier strings increase the size of your access tokens.
*/
identifier: pulumi.Input<string>;
/**
* A friendly name for the resource server.
*/
name?: pulumi.Input<string>;
/**
* A list of scopes. Each scope is a map with keys `ScopeName` and `ScopeDescription` .
*/
scopes?: pulumi.Input<pulumi.Input<inputs.cognito.UserPoolResourceServerResourceServerScopeTypeArgs>[]>;
/**
* The ID of the user pool where you want to create a resource server.
*/
userPoolId: pulumi.Input<string>;
}