Class: Aws::CognitoIdentityProvider::Types::TermsType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::TermsType

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The details of a set of terms documents. For more information, see [Terms documents].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html#managed-login-terms-documents

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:client_id]

Instance Attribute Summary

• #client_id ⇒ String

  The ID of the app client that the terms documents are assigned to.

• #creation_date ⇒ Time

  The date and time when the item was created.

• #enforcement ⇒ String

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

• #last_modified_date ⇒ Time

  The date and time when the item was modified.

• #links ⇒ Hash<String,String>

  A map of URLs to languages.

• #terms_id ⇒ String

  The ID of the terms documents.

• #terms_name ⇒ String

  The type and friendly name of the terms documents.

• #terms_source ⇒ String

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

• #user_pool_id ⇒ String

  The ID of the user pool that contains the terms documents.

Instance Attribute Details

#client_id ⇒ String

The ID of the app client that the terms documents are assigned to.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10977

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

#creation_date ⇒ Time

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ‘Date` object.

Returns:

• (Time)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10977

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

#enforcement ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10977

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

#last_modified_date ⇒ Time

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ‘Date` object.

Returns:

• (Time)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10977

class TermsType < Struct.new(
  :terms_id,
  :user_pool_id,
  :client_id,
  :terms_name,
  :terms_source,
  :enforcement,
  :links,
  :creation_date,
  :last_modified_date)
  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”: “terms.example.com”, “cognito:spanish”: “terms.example.com/es”`.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10977

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

#terms_id ⇒ String

The ID of the terms documents.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10977

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

#terms_name ⇒ String

The type and friendly name of the terms documents.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10977

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

#terms_source ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10977

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

#user_pool_id ⇒ String

The ID of the user pool that contains the terms documents.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 10977

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