Class: Aws::CognitoIdentity::Types::CognitoIdentityProvider

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentity/types.rb

Overview

A provider representing an Amazon Cognito user pool and its client ID.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_id ⇒ String

The client ID for the Amazon Cognito user pool.

Returns:

  • (String) 


40
41
42
43
44
45
46
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 40

class CognitoIdentityProvider < Struct.new(
  :provider_name,
  :client_id,
  :server_side_token_check)
  SENSITIVE = []
  include Aws::Structure
end

#provider_name ⇒ String

The provider name for an Amazon Cognito user pool. For example, ‘cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789`.

Returns:

  • (String) 


40
41
42
43
44
45
46
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 40

class CognitoIdentityProvider < Struct.new(
  :provider_name,
  :client_id,
  :server_side_token_check)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_token_check ⇒ Boolean

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ‘ServerSideTokenCheck` to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

Returns:

  • (Boolean) 


40
41
42
43
44
45
46
 
# File 'lib/aws-sdk-cognitoidentity/types.rb', line 40

class CognitoIdentityProvider < Struct.new(
  :provider_name,
  :client_id,
  :server_side_token_check)
  SENSITIVE = []
  include Aws::Structure
end