Class: AWSCDK::Cognito::ClientAttributes

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

Overview

A set of attributes, useful to set Read and Write attributes.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeClientAttributes

Returns a new instance of ClientAttributes.



8
9
10
# File 'cognito/client_attributes.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.jsii_overridable_methodsObject



12
13
14
15
16
17
18
# File 'cognito/client_attributes.rb', line 12

def self.jsii_overridable_methods
  {
    :attributes => { kind: :method, name: "attributes", is_optional: false },
    :with_custom_attributes => { kind: :method, name: "withCustomAttributes", is_optional: false },
    :with_standard_attributes => { kind: :method, name: "withStandardAttributes", is_optional: false },
  }
end

Instance Method Details

#attributesArray<String>

The list of attributes represented by this ClientAttributes.

Returns:

  • (Array<String>)


23
24
25
# File 'cognito/client_attributes.rb', line 23

def attributes()
  jsii_call_method("attributes", [])
end

#with_custom_attributes(*attributes) ⇒ AWSCDK::Cognito::ClientAttributes

Creates a custom ClientAttributes with the specified attributes.

Parameters:

  • attributes (Array<String>)

    a list of custom attributes to add to the set.

Returns:

  • (AWSCDK::Cognito::ClientAttributes)


31
32
33
34
35
36
# File 'cognito/client_attributes.rb', line 31

def with_custom_attributes(*attributes)
  attributes.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributes[#{index}]")
  end
  jsii_call_method("withCustomAttributes", [*attributes])
end

#with_standard_attributes(attributes) ⇒ AWSCDK::Cognito::ClientAttributes

Creates a custom ClientAttributes with the specified attributes.

Parameters:

Returns:

  • (AWSCDK::Cognito::ClientAttributes)


42
43
44
45
46
# File 'cognito/client_attributes.rb', line 42

def with_standard_attributes(attributes)
  attributes = attributes.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttributesMask.new(**attributes.transform_keys(&:to_sym)) : attributes
  Jsii::Type.check_type(attributes, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZXNNYXNrIn0=")), "attributes")
  jsii_call_method("withStandardAttributes", [attributes])
end