@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)
57 lines (56 loc) • 1.88 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as enums from "../types/enums";
/**
* Resource Type definition for AWS::Cognito::Terms
*/
export declare function getTerms(args: GetTermsArgs, opts?: pulumi.InvokeOptions): Promise<GetTermsResult>;
export interface GetTermsArgs {
/**
* The ID of the terms documents.
*/
termsId: string;
/**
* The ID of the user pool that contains the terms documents.
*/
userPoolId: string;
}
export interface GetTermsResult {
/**
* This parameter is reserved for future use and currently accepts one value.
*/
readonly enforcement?: enums.cognito.TermsEnforcementType;
/**
* A map of URLs to languages. For each localized language that will view the requested `TermsName` , assign a URL. A selection of `cognito:default` displays for all languages that don't have a language-specific URL.
*
* For example, `"cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es"` .
*/
readonly links?: {
[key: string]: string;
};
/**
* The ID of the terms documents.
*/
readonly termsId?: string;
/**
* The type and friendly name of the terms documents.
*/
readonly termsName?: string;
/**
* This parameter is reserved for future use and currently accepts one value.
*/
readonly termsSource?: enums.cognito.TermsSourceType;
}
/**
* Resource Type definition for AWS::Cognito::Terms
*/
export declare function getTermsOutput(args: GetTermsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTermsResult>;
export interface GetTermsOutputArgs {
/**
* The ID of the terms documents.
*/
termsId: pulumi.Input<string>;
/**
* The ID of the user pool that contains the terms documents.
*/
userPoolId: pulumi.Input<string>;
}