cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/CreateTermsRequest

CreateTermsRequest

class CreateTermsRequest

Types

Builder

class Builder

Companion

object Companion

Properties

clientId

val clientId: String?

The ID of the app client where you want to create terms documents. Must be an app client in the requested user pool.

enforcement

val enforcement: TermsEnforcementType?

This parameter is reserved for future use and currently accepts only one value.

links

val links: Map<String, String>?

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.

termsName

val termsName: String?

A friendly name for the document that you want to create in the current request. Must begin with terms-of-use or privacy-policy as identification of the document type. Provide URLs for both terms-of-use and privacy-policy in separate requests.

termsSource

val termsSource: TermsSourceType?

This parameter is reserved for future use and currently accepts only one value.

userPoolId

val userPoolId: String?

The ID of the user pool where you want to create terms documents.

Functions

copy

inline fun copy(block: CreateTermsRequest.Builder.() -> Unit = {}): CreateTermsRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String