AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Overview

Note:

When making an API call, you may pass CognitoIdentityProvider data as a hash:

{
  provider_name: "CognitoIdentityProviderName",
  client_id: "CognitoIdentityProviderClientId",
  server_side_token_check: false,
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_idString

The client ID for the Amazon Cognito user pool.

Returns:

  • (String)


49
50
51
52
53
54
55
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 49

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

#provider_nameString

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

Returns:

  • (String)


49
50
51
52
53
54
55
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 49

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

#server_side_token_checkBoolean

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)


49
50
51
52
53
54
55
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 49

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