Class: AWSCDK::Cognito::UserPoolIdentityProviderAppleProps

Inherits:
UserPoolIdentityProviderProps
  • Object
show all
Defined in:
cognito/user_pool_identity_provider_apple_props.rb

Overview

Properties to initialize UserPoolAppleIdentityProvider.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_pool:, attribute_mapping: nil, client_id:, key_id:, team_id:, private_key: nil, private_key_value: nil, scopes: nil) ⇒ UserPoolIdentityProviderAppleProps

Returns a new instance of UserPoolIdentityProviderAppleProps.

Parameters:

  • user_pool (AWSCDK::Cognito::IUserPool) —

    The user pool to which this construct provides identities.

  • attribute_mapping (AWSCDK::Cognito::AttributeMapping, nil) (defaults to: nil) —

    Mapping attributes from the identity provider to standard and custom attributes of the user pool.

  • client_id (String) —

    The client id recognized by Apple APIs.

  • key_id (String) —

    The keyId (of the same key, which content has to be later supplied as privateKey) for Apple APIs to authenticate the client.

  • team_id (String) —

    The teamId for Apple APIs to authenticate the client.

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

    The privateKey content for Apple APIs to authenticate the client.

  • private_key_value (AWSCDK::SecretValue, nil) (defaults to: nil) —

    The privateKey content for Apple APIs to authenticate the client.

  • scopes (Array<String>, nil) (defaults to: nil) —

    The list of apple permissions to obtain for getting access to the apple profile.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'cognito/user_pool_identity_provider_apple_props.rb', line 15

def initialize(user_pool:, attribute_mapping: nil, client_id:, key_id:, team_id:, private_key: nil, private_key_value: nil, scopes: nil)
  @user_pool = user_pool
  Jsii::Type.check_type(@user_pool, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5JVXNlclBvb2wifQ==")), "userPool")
  @attribute_mapping = attribute_mapping.is_a?(Hash) ? ::AWSCDK::Cognito::AttributeMapping.new(**attribute_mapping.transform_keys(&:to_sym)) : attribute_mapping
  Jsii::Type.check_type(@attribute_mapping, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5BdHRyaWJ1dGVNYXBwaW5nIn0=")), "attributeMapping") unless @attribute_mapping.nil?
  @client_id = client_id
  Jsii::Type.check_type(@client_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientId")
  @key_id = key_id
  Jsii::Type.check_type(@key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyId")
  @team_id = team_id
  Jsii::Type.check_type(@team_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "teamId")
  @private_key = private_key
  Jsii::Type.check_type(@private_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "privateKey") unless @private_key.nil?
  @private_key_value = private_key_value
  Jsii::Type.check_type(@private_key_value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TZWNyZXRWYWx1ZSJ9")), "privateKeyValue") unless @private_key_value.nil?
  @scopes = scopes
  Jsii::Type.check_type(@scopes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "scopes") unless @scopes.nil?
end

Instance Attribute Details

#attribute_mapping ⇒ AWSCDK::Cognito::AttributeMapping? (readonly)

Note:

Default: - no attribute mapping

Mapping attributes from the identity provider to standard and custom attributes of the user pool.

Returns:



42
43
44
 
# File 'cognito/user_pool_identity_provider_apple_props.rb', line 42

def attribute_mapping
  @attribute_mapping
end

#client_id ⇒ String (readonly)

The client id recognized by Apple APIs.

Returns:

  • (String)

See Also:



47
48
49
 
# File 'cognito/user_pool_identity_provider_apple_props.rb', line 47

def client_id
  @client_id
end

#key_id ⇒ String (readonly)

The keyId (of the same key, which content has to be later supplied as privateKey) for Apple APIs to authenticate the client.

Returns:

  • (String) 


51
52
53
 
# File 'cognito/user_pool_identity_provider_apple_props.rb', line 51

def key_id
  @key_id
end

#private_key ⇒ String? (readonly)

Deprecated.

use privateKeyValue

Note:

Default: none

The privateKey content for Apple APIs to authenticate the client.

Returns:

  • (String, nil) 


61
62
63
 
# File 'cognito/user_pool_identity_provider_apple_props.rb', line 61

def private_key
  @private_key
end

#private_key_value ⇒ AWSCDK::SecretValue? (readonly)

Note:

Default: none

The privateKey content for Apple APIs to authenticate the client.

Returns:



66
67
68
 
# File 'cognito/user_pool_identity_provider_apple_props.rb', line 66

def private_key_value
  @private_key_value
end

#scopes ⇒ Array<String>? (readonly)

Note:

Default: [ name ]

The list of apple permissions to obtain for getting access to the apple profile.

Returns:

  • (Array<String>, nil)

See Also:



72
73
74
 
# File 'cognito/user_pool_identity_provider_apple_props.rb', line 72

def scopes
  @scopes
end

#team_id ⇒ String (readonly)

The teamId for Apple APIs to authenticate the client.

Returns:

  • (String) 


55
56
57
 
# File 'cognito/user_pool_identity_provider_apple_props.rb', line 55

def team_id
  @team_id
end

#user_pool ⇒ AWSCDK::Cognito::IUserPool (readonly)

The user pool to which this construct provides identities.

Returns:



37
38
39
 
# File 'cognito/user_pool_identity_provider_apple_props.rb', line 37

def user_pool
  @user_pool
end

Class Method Details

.jsii_properties ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'cognito/user_pool_identity_provider_apple_props.rb', line 74

def self.jsii_properties
  {
    :user_pool => "userPool",
    :attribute_mapping => "attributeMapping",
    :client_id => "clientId",
    :key_id => "keyId",
    :team_id => "teamId",
    :private_key => "privateKey",
    :private_key_value => "privateKeyValue",
    :scopes => "scopes",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'cognito/user_pool_identity_provider_apple_props.rb', line 87

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "userPool" => @user_pool,
    "attributeMapping" => @attribute_mapping,
    "clientId" => @client_id,
    "keyId" => @key_id,
    "teamId" => @team_id,
    "privateKey" => @private_key,
    "privateKeyValue" => @private_key_value,
    "scopes" => @scopes,
  })
  result.compact
end