Class: AWSCDK::Cognito::UserPoolClientIdentityProvider

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

Overview

Identity providers supported by the UserPoolClient.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ UserPoolClientIdentityProvider

Returns a new instance of UserPoolClientIdentityProvider.

Raises:

  • (NoMethodError) 


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

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_cognito.UserPoolClientIdentityProvider does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.AMAZON ⇒ AWSCDK::Cognito::UserPoolClientIdentityProvider

Allow users to sign in using 'Login With Amazon'.

A UserPoolIdentityProviderAmazon must be attached to the user pool.

Returns:

  • (AWSCDK::Cognito::UserPoolClientIdentityProvider) 


32
33
34
 
# File 'cognito/user_pool_client_identity_provider.rb', line 32

def self.AMAZON()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolClientIdentityProvider", "AMAZON")
end

.APPLE ⇒ AWSCDK::Cognito::UserPoolClientIdentityProvider

Allow users to sign in using 'Sign In With Apple'.

A UserPoolIdentityProviderApple must be attached to the user pool.

Returns:

  • (AWSCDK::Cognito::UserPoolClientIdentityProvider) 


41
42
43
 
# File 'cognito/user_pool_client_identity_provider.rb', line 41

def self.APPLE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolClientIdentityProvider", "APPLE")
end

.COGNITO ⇒ AWSCDK::Cognito::UserPoolClientIdentityProvider

Allow users to sign in directly as a user of the User Pool.

Returns:

  • (AWSCDK::Cognito::UserPoolClientIdentityProvider) 


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

def self.COGNITO()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolClientIdentityProvider", "COGNITO")
end

.custom(name) ⇒ AWSCDK::Cognito::UserPoolClientIdentityProvider

Specify a provider not yet supported by the CDK.

Parameters:

  • name (String) —

    name of the identity provider as recognized by CloudFormation property SupportedIdentityProviders.

Returns:

  • (AWSCDK::Cognito::UserPoolClientIdentityProvider) 


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

def self.custom(name)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.UserPoolClientIdentityProvider", "custom", [name])
end

.FACEBOOK ⇒ AWSCDK::Cognito::UserPoolClientIdentityProvider

Allow users to sign in using 'Facebook Login'.

A UserPoolIdentityProviderFacebook must be attached to the user pool.

Returns:

  • (AWSCDK::Cognito::UserPoolClientIdentityProvider) 


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

def self.FACEBOOK()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolClientIdentityProvider", "FACEBOOK")
end

.GOOGLE ⇒ AWSCDK::Cognito::UserPoolClientIdentityProvider

Allow users to sign in using 'Google Login'.

A UserPoolIdentityProviderGoogle must be attached to the user pool.

Returns:

  • (AWSCDK::Cognito::UserPoolClientIdentityProvider) 


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

def self.GOOGLE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPoolClientIdentityProvider", "GOOGLE")
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
 
# File 'cognito/user_pool_client_identity_provider.rb', line 12

def self.jsii_overridable_methods
  {
    :name => { kind: :property, name: "name", is_optional: false },
  }
end

Instance Method Details

#name ⇒ String

The name of the identity provider as recognized by CloudFormation property SupportedIdentityProviders.

Returns:

  • (String) 


73
74
75
 
# File 'cognito/user_pool_client_identity_provider.rb', line 73

def name()
  jsii_get_property("name")
end