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

Class: Aws::AppSync::Types::AdditionalAuthenticationProvider

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

Overview

Note:

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

{
  authentication_type: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
  open_id_connect_config: {
    issuer: "String", # required
    client_id: "String",
    iat_ttl: 1,
    auth_ttl: 1,
  },
  user_pool_config: {
    user_pool_id: "String", # required
    aws_region: "String", # required
    app_id_client_regex: "String",
  },
}

Describes an additional authentication provider.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_type ⇒ String

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

Returns:

  • (String) 


58
59
60
61
62
63
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 58

class AdditionalAuthenticationProvider < Struct.new(
  :authentication_type,
  :open_id_connect_config,
  :user_pool_config)
  include Aws::Structure
end

#open_id_connect_config ⇒ Types::OpenIDConnectConfig

The OpenID Connect configuration.

Returns:



58
59
60
61
62
63
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 58

class AdditionalAuthenticationProvider < Struct.new(
  :authentication_type,
  :open_id_connect_config,
  :user_pool_config)
  include Aws::Structure
end

#user_pool_config ⇒ Types::CognitoUserPoolConfig

The Amazon Cognito user pool configuration.

Returns:



58
59
60
61
62
63
 
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 58

class AdditionalAuthenticationProvider < Struct.new(
  :authentication_type,
  :open_id_connect_config,
  :user_pool_config)
  include Aws::Structure
end