Class: AWSCDK::Cognito::CfnTermsProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/cfn_terms_props.rb

Overview

Properties for defining a CfnTerms.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enforcement:, links:, terms_name:, terms_source:, user_pool_id:, client_id: nil) ⇒ CfnTermsProps

Returns a new instance of CfnTermsProps.

Parameters:

  • enforcement (String) —

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

  • links (AWSCDK::IResolvable, Hash{String => String}) —

    A map of URLs to languages.

  • 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.

  • client_id (String, nil) (defaults to: nil) —

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



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'cognito/cfn_terms_props.rb', line 15

def initialize(enforcement:, links:, terms_name:, terms_source:, user_pool_id:, client_id: nil)
  @enforcement = enforcement
  Jsii::Type.check_type(@enforcement, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "enforcement")
  @links = links
  Jsii::Type.check_type(@links, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "links")
  @terms_name = terms_name
  Jsii::Type.check_type(@terms_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "termsName")
  @terms_source = terms_source
  Jsii::Type.check_type(@terms_source, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "termsSource")
  @user_pool_id = user_pool_id
  Jsii::Type.check_type(@user_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolId")
  @client_id = client_id
  Jsii::Type.check_type(@client_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientId") unless @client_id.nil?
end

Instance Attribute Details

#client_id ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



63
64
65
 
# File 'cognito/cfn_terms_props.rb', line 63

def client_id
  @client_id
end

#enforcement ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



34
35
36
 
# File 'cognito/cfn_terms_props.rb', line 34

def enforcement
  @enforcement
end

#links ⇒ AWSCDK::IResolvable, Hash{String => String} (readonly)

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:

See Also:



43
44
45
 
# File 'cognito/cfn_terms_props.rb', line 43

def links
  @links
end

#terms_name ⇒ String (readonly)

The type and friendly name of the terms documents.

Returns:

  • (String)

See Also:



48
49
50
 
# File 'cognito/cfn_terms_props.rb', line 48

def terms_name
  @terms_name
end

#terms_source ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



53
54
55
 
# File 'cognito/cfn_terms_props.rb', line 53

def terms_source
  @terms_source
end

#user_pool_id ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



58
59
60
 
# File 'cognito/cfn_terms_props.rb', line 58

def user_pool_id
  @user_pool_id
end

Class Method Details

.jsii_properties ⇒ Object 



65
66
67
68
69
70
71
72
73
74
 
# File 'cognito/cfn_terms_props.rb', line 65

def self.jsii_properties
  {
    :enforcement => "enforcement",
    :links => "links",
    :terms_name => "termsName",
    :terms_source => "termsSource",
    :user_pool_id => "userPoolId",
    :client_id => "clientId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'cognito/cfn_terms_props.rb', line 76

def to_jsii
  result = {}
  result.merge!({
    "enforcement" => @enforcement,
    "links" => @links,
    "termsName" => @terms_name,
    "termsSource" => @terms_source,
    "userPoolId" => @user_pool_id,
    "clientId" => @client_id,
  })
  result.compact
end