@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)
95 lines (94 loc) • 3.84 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as enums from "../types/enums";
/**
* Resource Type definition for AWS::Cognito::Terms
*/
export declare class Terms extends pulumi.CustomResource {
/**
* Get an existing Terms 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): Terms;
/**
* Returns true if the given object is an instance of Terms. 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 Terms;
/**
* The ID of the app client that the terms documents are assigned to.
*/
readonly clientId: pulumi.Output<string | undefined>;
/**
* This parameter is reserved for future use and currently accepts one value.
*/
readonly enforcement: pulumi.Output<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: pulumi.Output<{
[key: string]: string;
}>;
/**
* The ID of the terms documents.
*/
readonly termsId: pulumi.Output<string>;
/**
* The type and friendly name of the terms documents.
*/
readonly termsName: pulumi.Output<string>;
/**
* This parameter is reserved for future use and currently accepts one value.
*/
readonly termsSource: pulumi.Output<enums.cognito.TermsSourceType>;
/**
* The ID of the user pool that contains the terms documents.
*/
readonly userPoolId: pulumi.Output<string>;
/**
* Create a Terms 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: TermsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Terms resource.
*/
export interface TermsArgs {
/**
* The ID of the app client that the terms documents are assigned to.
*/
clientId?: pulumi.Input<string>;
/**
* This parameter is reserved for future use and currently accepts one value.
*/
enforcement: pulumi.Input<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"` .
*/
links: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The type and friendly name of the terms documents.
*/
termsName?: pulumi.Input<string>;
/**
* This parameter is reserved for future use and currently accepts one value.
*/
termsSource: pulumi.Input<enums.cognito.TermsSourceType>;
/**
* The ID of the user pool that contains the terms documents.
*/
userPoolId: pulumi.Input<string>;
}