Class: Aws::CognitoIdentityProvider::Types::CreateTermsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:client_id]

Instance Attribute Summary collapse

Instance Attribute Details

#client_id ⇒ String

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

Returns:

  • (String) 


3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3938

class CreateTermsRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#enforcement ⇒ String

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

Returns:

  • (String) 


3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3938

class CreateTermsRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#links ⇒ Hash<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.

For example, "cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es".

Returns:

  • (Hash<String,String>) 


3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3938

class CreateTermsRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#terms_name ⇒ 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.

Returns:

  • (String) 


3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3938

class CreateTermsRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#terms_source ⇒ String

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

Returns:

  • (String) 


3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3938

class CreateTermsRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = [:client_id]
  include Aws::Structure
end

#user_pool_id ⇒ String

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

Returns:

  • (String) 


3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3938

class CreateTermsRequest < Struct.new(
  :user_pool_id,
  :client_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links)
  SENSITIVE = [:client_id]
  include Aws::Structure
end