Class: AWSCDK::Cognito::CfnIdentityPoolProps

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

Overview

Properties for defining a CfnIdentityPool.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allow_unauthenticated_identities:, allow_classic_flow: nil, cognito_events: nil, cognito_identity_providers: nil, cognito_streams: nil, developer_provider_name: nil, identity_pool_name: nil, identity_pool_tags: nil, open_id_connect_provider_arns: nil, push_sync: nil, saml_provider_arns: nil, supported_login_providers: nil) ⇒ CfnIdentityPoolProps

Returns a new instance of CfnIdentityPoolProps.

Parameters:

  • allow_unauthenticated_identities (Boolean, AWSCDK::IResolvable) —

    Specifies whether the identity pool supports unauthenticated logins.

  • allow_classic_flow (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Enables the Basic (Classic) authentication flow.

  • cognito_events (Object, nil) (defaults to: nil) —

    The events to configure.

  • cognito_identity_providers (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Cognito::CfnIdentityPool::CognitoIdentityProviderProperty>, nil) (defaults to: nil) —

    The Amazon Cognito user pools and their client IDs.

  • cognito_streams (AWSCDK::IResolvable, AWSCDK::Cognito::CfnIdentityPool::CognitoStreamsProperty, nil) (defaults to: nil) —

    Configuration options for configuring Amazon Cognito streams.

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

    The "domain" Amazon Cognito uses when referencing your users.

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

    The name of your Amazon Cognito identity pool.

  • identity_pool_tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Tags to assign to the identity pool.

  • open_id_connect_provider_arns (Array<String, AWSCDK::Interfaces::AWSIAM::IOIDCProviderRef>, nil) (defaults to: nil) —

    The Amazon Resource Names (ARNs) of the OpenID connect providers.

  • push_sync (AWSCDK::IResolvable, AWSCDK::Cognito::CfnIdentityPool::PushSyncProperty, nil) (defaults to: nil) —

    The configuration options to be applied to the identity pool.

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

    The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.

  • supported_login_providers (Object, nil) (defaults to: nil) —

    Key-value pairs that map provider names to provider app IDs.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'cognito/cfn_identity_pool_props.rb', line 21

def initialize(allow_unauthenticated_identities:, allow_classic_flow: nil, cognito_events: nil, cognito_identity_providers: nil, cognito_streams: nil, developer_provider_name: nil, identity_pool_name: nil, identity_pool_tags: nil, open_id_connect_provider_arns: nil, push_sync: nil, saml_provider_arns: nil, supported_login_providers: nil)
  @allow_unauthenticated_identities = allow_unauthenticated_identities
  Jsii::Type.check_type(@allow_unauthenticated_identities, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowUnauthenticatedIdentities")
  @allow_classic_flow = allow_classic_flow
  Jsii::Type.check_type(@allow_classic_flow, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowClassicFlow") unless @allow_classic_flow.nil?
  @cognito_events = cognito_events
  Jsii::Type.check_type(@cognito_events, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "cognitoEvents") unless @cognito_events.nil?
  @cognito_identity_providers = cognito_identity_providers
  Jsii::Type.check_type(@cognito_identity_providers, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5DZm5JZGVudGl0eVBvb2wuQ29nbml0b0lkZW50aXR5UHJvdmlkZXJQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "cognitoIdentityProviders") unless @cognito_identity_providers.nil?
  @cognito_streams = cognito_streams.is_a?(Hash) ? ::AWSCDK::Cognito::CfnIdentityPool::CognitoStreamsProperty.new(**cognito_streams.transform_keys(&:to_sym)) : cognito_streams
  Jsii::Type.check_type(@cognito_streams, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmbklkZW50aXR5UG9vbC5Db2duaXRvU3RyZWFtc1Byb3BlcnR5In1dfX0=")), "cognitoStreams") unless @cognito_streams.nil?
  @developer_provider_name = developer_provider_name
  Jsii::Type.check_type(@developer_provider_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "developerProviderName") unless @developer_provider_name.nil?
  @identity_pool_name = identity_pool_name
  Jsii::Type.check_type(@identity_pool_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityPoolName") unless @identity_pool_name.nil?
  @identity_pool_tags = identity_pool_tags.is_a?(Array) ? identity_pool_tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : identity_pool_tags
  Jsii::Type.check_type(@identity_pool_tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "identityPoolTags") unless @identity_pool_tags.nil?
  @open_id_connect_provider_arns = open_id_connect_provider_arns
  Jsii::Type.check_type(@open_id_connect_provider_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLmludGVyZmFjZXMuYXdzX2lhbS5JT0lEQ1Byb3ZpZGVyUmVmIn1dfX0sImtpbmQiOiJhcnJheSJ9fQ==")), "openIdConnectProviderArns") unless @open_id_connect_provider_arns.nil?
  @push_sync = push_sync.is_a?(Hash) ? ::AWSCDK::Cognito::CfnIdentityPool::PushSyncProperty.new(**push_sync.transform_keys(&:to_sym)) : push_sync
  Jsii::Type.check_type(@push_sync, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmbklkZW50aXR5UG9vbC5QdXNoU3luY1Byb3BlcnR5In1dfX0=")), "pushSync") unless @push_sync.nil?
  @saml_provider_arns = saml_provider_arns
  Jsii::Type.check_type(@saml_provider_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "samlProviderArns") unless @saml_provider_arns.nil?
  @supported_login_providers = 
  Jsii::Type.check_type(@supported_login_providers, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "supportedLoginProviders") unless @supported_login_providers.nil?
end

Instance Attribute Details

#allow_classic_flow ⇒ Boolean, ... (readonly)

Enables the Basic (Classic) authentication flow.

Returns:

See Also:



57
58
59
 
# File 'cognito/cfn_identity_pool_props.rb', line 57

def allow_classic_flow
  @allow_classic_flow
end

#allow_unauthenticated_identities ⇒ Boolean, AWSCDK::IResolvable (readonly)

Specifies whether the identity pool supports unauthenticated logins.

Returns:

See Also:



52
53
54
 
# File 'cognito/cfn_identity_pool_props.rb', line 52

def allow_unauthenticated_identities
  @allow_unauthenticated_identities
end

#cognito_events ⇒ Object? (readonly)

The events to configure.

Returns:

  • (Object, nil)

See Also:



62
63
64
 
# File 'cognito/cfn_identity_pool_props.rb', line 62

def cognito_events
  @cognito_events
end

#cognito_identity_providers ⇒ AWSCDK::IResolvable, ... (readonly)

The Amazon Cognito user pools and their client IDs.

Returns:

See Also:



67
68
69
 
# File 'cognito/cfn_identity_pool_props.rb', line 67

def cognito_identity_providers
  @cognito_identity_providers
end

#cognito_streams ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration options for configuring Amazon Cognito streams.

Returns:

See Also:



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

def cognito_streams
  @cognito_streams
end

#developer_provider_name ⇒ String? (readonly)

The "domain" Amazon Cognito uses when referencing your users.

This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName , you can use letters and periods (.), underscores (_), and dashes (-).

Minimum length : 1

Maximum length : 100

Returns:

  • (String, nil)

See Also:



83
84
85
 
# File 'cognito/cfn_identity_pool_props.rb', line 83

def developer_provider_name
  @developer_provider_name
end

#identity_pool_name ⇒ String? (readonly)

The name of your Amazon Cognito identity pool.

Minimum length : 1

Maximum length : 128

Pattern : [\w\s+=,.@-]+

Returns:

  • (String, nil)

See Also:



94
95
96
 
# File 'cognito/cfn_identity_pool_props.rb', line 94

def identity_pool_name
  @identity_pool_name
end

#identity_pool_tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Tags to assign to the identity pool.

A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Returns:

See Also:



101
102
103
 
# File 'cognito/cfn_identity_pool_props.rb', line 101

def identity_pool_tags
  @identity_pool_tags
end

#open_id_connect_provider_arns ⇒ Array<String, AWSCDK::Interfaces::AWSIAM::IOIDCProviderRef>? (readonly)

The Amazon Resource Names (ARNs) of the OpenID connect providers.

Returns:

See Also:



106
107
108
 
# File 'cognito/cfn_identity_pool_props.rb', line 106

def open_id_connect_provider_arns
  @open_id_connect_provider_arns
end

#push_sync ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration options to be applied to the identity pool.

Returns:

See Also:



111
112
113
 
# File 'cognito/cfn_identity_pool_props.rb', line 111

def push_sync
  @push_sync
end

#saml_provider_arns ⇒ Array<String>? (readonly)

The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.

Returns:

  • (Array<String>, nil)

See Also:



116
117
118
 
# File 'cognito/cfn_identity_pool_props.rb', line 116

def saml_provider_arns
  @saml_provider_arns
end

#supported_login_providers ⇒ Object? (readonly)

Key-value pairs that map provider names to provider app IDs.

Returns:

  • (Object, nil)

See Also:



121
122
123
 
# File 'cognito/cfn_identity_pool_props.rb', line 121

def 
  @supported_login_providers
end

Class Method Details

.jsii_properties ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'cognito/cfn_identity_pool_props.rb', line 123

def self.jsii_properties
  {
    :allow_unauthenticated_identities => "allowUnauthenticatedIdentities",
    :allow_classic_flow => "allowClassicFlow",
    :cognito_events => "cognitoEvents",
    :cognito_identity_providers => "cognitoIdentityProviders",
    :cognito_streams => "cognitoStreams",
    :developer_provider_name => "developerProviderName",
    :identity_pool_name => "identityPoolName",
    :identity_pool_tags => "identityPoolTags",
    :open_id_connect_provider_arns => "openIdConnectProviderArns",
    :push_sync => "pushSync",
    :saml_provider_arns => "samlProviderArns",
    :supported_login_providers => "supportedLoginProviders",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'cognito/cfn_identity_pool_props.rb', line 140

def to_jsii
  result = {}
  result.merge!({
    "allowUnauthenticatedIdentities" => @allow_unauthenticated_identities,
    "allowClassicFlow" => @allow_classic_flow,
    "cognitoEvents" => @cognito_events,
    "cognitoIdentityProviders" => @cognito_identity_providers,
    "cognitoStreams" => @cognito_streams,
    "developerProviderName" => @developer_provider_name,
    "identityPoolName" => @identity_pool_name,
    "identityPoolTags" => @identity_pool_tags,
    "openIdConnectProviderArns" => @open_id_connect_provider_arns,
    "pushSync" => @push_sync,
    "samlProviderArns" => @saml_provider_arns,
    "supportedLoginProviders" => @supported_login_providers,
  })
  result.compact
end