Class: Aws::QBusiness::Types::OAuth2ClientCredentialConfiguration

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

Overview

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authorization_url ⇒ String

The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.

Returns:

  • (String) 

6247
6248
6249
6250
6251
6252
6253
6254
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6247

class OAuth2ClientCredentialConfiguration < Struct.new(
  :secret_arn,
  :role_arn,
  :authorization_url,
  :token_url)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

Returns:

  • (String) 

6247
6248
6249
6250
6251
6252
6253
6254
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6247

class OAuth2ClientCredentialConfiguration < Struct.new(
  :secret_arn,
  :role_arn,
  :authorization_url,
  :token_url)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

Returns:

  • (String) 

6247
6248
6249
6250
6251
6252
6253
6254
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6247

class OAuth2ClientCredentialConfiguration < Struct.new(
  :secret_arn,
  :role_arn,
  :authorization_url,
  :token_url)
  SENSITIVE = []
  include Aws::Structure
end

#token_url ⇒ String

The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.

Returns:

  • (String) 

6247
6248
6249
6250
6251
6252
6253
6254
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6247

class OAuth2ClientCredentialConfiguration < Struct.new(
  :secret_arn,
  :role_arn,
  :authorization_url,
  :token_url)
  SENSITIVE = []
  include Aws::Structure
end