Class: Aws::BedrockAgentCoreControl::Types::IncludedOauth2ProviderConfigInput

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCoreControl::Types::IncludedOauth2ProviderConfigInput

Defined in:

gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb

Overview

Configuration settings for connecting to a supported OAuth2 provider. This includes client credentials and OAuth2 discovery information for providers that have built-in support.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:client_secret]

Instance Attribute Summary

• #authorization_endpoint ⇒ String

  OAuth2 authorization endpoint for your isolated OAuth2 application tenant.

• #client_id ⇒ String

  The client ID for the supported OAuth2 provider.

• #client_secret ⇒ String

  The client secret for the supported OAuth2 provider.

• #client_secret_config ⇒ Types::SecretReference

  A reference to the Amazon Web Services Secrets Manager secret that stores the client secret.

• #client_secret_source ⇒ String

  The source type of the client secret.

• #issuer ⇒ String

  Token issuer of your isolated OAuth2 application tenant.

• #token_endpoint ⇒ String

  OAuth2 token endpoint for your isolated OAuth2 application tenant.

Instance Attribute Details

#authorization_endpoint ⇒ String

OAuth2 authorization endpoint for your isolated OAuth2 application tenant. This is where users are redirected to authenticate and authorize access to their resources.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 13023

class IncludedOauth2ProviderConfigInput < Struct.new(
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :issuer,
  :authorization_endpoint,
  :token_endpoint)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#client_id ⇒ String

The client ID for the supported OAuth2 provider. This identifier is assigned by the OAuth2 provider when you register your application.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 13023

class IncludedOauth2ProviderConfigInput < Struct.new(
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :issuer,
  :authorization_endpoint,
  :token_endpoint)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#client_secret ⇒ String

The client secret for the supported OAuth2 provider. This secret is assigned by the OAuth2 provider and used along with the client ID to authenticate your application.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 13023

class IncludedOauth2ProviderConfigInput < Struct.new(
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :issuer,
  :authorization_endpoint,
  :token_endpoint)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#client_secret_config ⇒ Types::SecretReference

A reference to the Amazon Web Services Secrets Manager secret that stores the client secret. This includes the secret ID and the JSON key used to extract the client secret value from the secret. Required when clientSecretSource is set to EXTERNAL.

Returns:

• (Types::SecretReference)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 13023

class IncludedOauth2ProviderConfigInput < Struct.new(
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :issuer,
  :authorization_endpoint,
  :token_endpoint)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#client_secret_source ⇒ String

The source type of the client secret. Use MANAGED if the secret is managed by the service, or EXTERNAL if you manage the secret yourself in Amazon Web Services Secrets Manager.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 13023

class IncludedOauth2ProviderConfigInput < Struct.new(
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :issuer,
  :authorization_endpoint,
  :token_endpoint)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#issuer ⇒ String

Token issuer of your isolated OAuth2 application tenant. This URL identifies the authorization server that issues tokens for this provider.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 13023

class IncludedOauth2ProviderConfigInput < Struct.new(
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :issuer,
  :authorization_endpoint,
  :token_endpoint)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#token_endpoint ⇒ String

OAuth2 token endpoint for your isolated OAuth2 application tenant. This is where authorization codes are exchanged for access tokens.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 13023

class IncludedOauth2ProviderConfigInput < Struct.new(
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :issuer,
  :authorization_endpoint,
  :token_endpoint)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end