You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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 Identity User Pool and its client ID.

Instance Attribute Summary collapse

Instance Attribute Details

#client_idString

The client ID for the Amazon Cognito Identity User Pool.

Returns:

  • (String)


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

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

#provider_nameString

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

Returns:

  • (String)


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

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

#server_side_token_checkBoolean

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

Returns:

  • (Boolean)


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

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