Class: Aws::CognitoIdentityProvider::Types::ProviderDescription

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::ProviderDescription

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The details of a user pool identity provider (IdP), including name and type.

This data type is a response parameter of [ListIdentityProviders].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListIdentityProviders.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_date ⇒ Time

  The date and time when the item was created.

• #last_modified_date ⇒ Time

  The date and time when the item was modified.

• #provider_name ⇒ String

  The name of the IdP, for example ‘MySAMLProvider`.

• #provider_type ⇒ String

  The type of the provider, for example ‘SAML`.

Instance Attribute Details

#creation_date ⇒ Time

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ‘Date` object.

Returns:

• (Time)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8819

class ProviderDescription < Struct.new(
  :provider_name,
  :provider_type,
  :last_modified_date,
  :creation_date)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Time

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ‘Date` object.

Returns:

• (Time)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8819

class ProviderDescription < Struct.new(
  :provider_name,
  :provider_type,
  :last_modified_date,
  :creation_date)
  SENSITIVE = []
  include Aws::Structure
end

#provider_name ⇒ String

The name of the IdP, for example ‘MySAMLProvider`.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8819

class ProviderDescription < Struct.new(
  :provider_name,
  :provider_type,
  :last_modified_date,
  :creation_date)
  SENSITIVE = []
  include Aws::Structure
end

#provider_type ⇒ String

The type of the provider, for example ‘SAML`. Amazon Cognito supports SAML 2.0, OIDC, and social IdPs. User pools list supported social IdPs by name in this response parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8819

class ProviderDescription < Struct.new(
  :provider_name,
  :provider_type,
  :last_modified_date,
  :creation_date)
  SENSITIVE = []
  include Aws::Structure
end