Class: Aws::BedrockAgentCoreControl::Types::CustomOauth2ProviderConfigInput

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCoreControl::Types::CustomOauth2ProviderConfigInput

Defined in:

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

Overview

Input configuration for a custom OAuth2 provider.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:client_secret]

Instance Attribute Summary

• #client_authentication_method ⇒ String

  The client authentication method to use when authenticating with the token endpoint.

• #client_id ⇒ String

  The client ID for the custom OAuth2 provider.

• #client_secret ⇒ String

  The client secret for the custom 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.

• #oauth_discovery ⇒ Types::Oauth2Discovery

  The OAuth2 discovery information for the custom provider.

• #on_behalf_of_token_exchange_config ⇒ Types::OnBehalfOfTokenExchangeConfigType

  The configuration for on-behalf-of token exchange.

• #private_endpoint ⇒ Types::PrivateEndpoint

  The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.

• #private_endpoint_overrides ⇒ Array<Types::PrivateEndpointOverride>

  The private endpoint overrides for the custom OAuth2 provider configuration.

• #private_key_jwt_config ⇒ Types::PrivateKeyJwtConfig

  The private_key_jwt client authentication configuration for this credential provider.

Instance Attribute Details

#client_authentication_method ⇒ String

The client authentication method to use when authenticating with the token endpoint.

Returns:

• (String)

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

class CustomOauth2ProviderConfigInput < Struct.new(
  :oauth_discovery,
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :on_behalf_of_token_exchange_config,
  :client_authentication_method,
  :private_key_jwt_config,
  :private_endpoint,
  :private_endpoint_overrides)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#client_id ⇒ String

The client ID for the custom OAuth2 provider.

Returns:

• (String)

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

class CustomOauth2ProviderConfigInput < Struct.new(
  :oauth_discovery,
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :on_behalf_of_token_exchange_config,
  :client_authentication_method,
  :private_key_jwt_config,
  :private_endpoint,
  :private_endpoint_overrides)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#client_secret ⇒ String

The client secret for the custom OAuth2 provider.

Returns:

• (String)

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

class CustomOauth2ProviderConfigInput < Struct.new(
  :oauth_discovery,
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :on_behalf_of_token_exchange_config,
  :client_authentication_method,
  :private_key_jwt_config,
  :private_endpoint,
  :private_endpoint_overrides)
  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 5748

class CustomOauth2ProviderConfigInput < Struct.new(
  :oauth_discovery,
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :on_behalf_of_token_exchange_config,
  :client_authentication_method,
  :private_key_jwt_config,
  :private_endpoint,
  :private_endpoint_overrides)
  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 5748

class CustomOauth2ProviderConfigInput < Struct.new(
  :oauth_discovery,
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :on_behalf_of_token_exchange_config,
  :client_authentication_method,
  :private_key_jwt_config,
  :private_endpoint,
  :private_endpoint_overrides)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#oauth_discovery ⇒ Types::Oauth2Discovery

The OAuth2 discovery information for the custom provider.

Returns:

• (Types::Oauth2Discovery)

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

class CustomOauth2ProviderConfigInput < Struct.new(
  :oauth_discovery,
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :on_behalf_of_token_exchange_config,
  :client_authentication_method,
  :private_key_jwt_config,
  :private_endpoint,
  :private_endpoint_overrides)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#on_behalf_of_token_exchange_config ⇒ Types::OnBehalfOfTokenExchangeConfigType

The configuration for on-behalf-of token exchange. This enables authentication flows that use RFC 8693 token exchange or RFC 7523 JWT authorization grants.

Returns:

• (Types::OnBehalfOfTokenExchangeConfigType)

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

class CustomOauth2ProviderConfigInput < Struct.new(
  :oauth_discovery,
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :on_behalf_of_token_exchange_config,
  :client_authentication_method,
  :private_key_jwt_config,
  :private_endpoint,
  :private_endpoint_overrides)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#private_endpoint ⇒ Types::PrivateEndpoint

The default private endpoint for the custom OAuth2 provider, enabling secure connectivity through a VPC Lattice resource configuration.

Returns:

• (Types::PrivateEndpoint)

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

class CustomOauth2ProviderConfigInput < Struct.new(
  :oauth_discovery,
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :on_behalf_of_token_exchange_config,
  :client_authentication_method,
  :private_key_jwt_config,
  :private_endpoint,
  :private_endpoint_overrides)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#private_endpoint_overrides ⇒ Array<Types::PrivateEndpointOverride>

The private endpoint overrides for the custom OAuth2 provider configuration.

Returns:

• (Array<Types::PrivateEndpointOverride>)

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

class CustomOauth2ProviderConfigInput < Struct.new(
  :oauth_discovery,
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :on_behalf_of_token_exchange_config,
  :client_authentication_method,
  :private_key_jwt_config,
  :private_endpoint,
  :private_endpoint_overrides)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end

#private_key_jwt_config ⇒ Types::PrivateKeyJwtConfig

The private_key_jwt client authentication configuration for this credential provider. When specified, the credential provider uses JWT client assertions to authenticate with the token endpoint.

Returns:

• (Types::PrivateKeyJwtConfig)

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

class CustomOauth2ProviderConfigInput < Struct.new(
  :oauth_discovery,
  :client_id,
  :client_secret,
  :client_secret_config,
  :client_secret_source,
  :on_behalf_of_token_exchange_config,
  :client_authentication_method,
  :private_key_jwt_config,
  :private_endpoint,
  :private_endpoint_overrides)
  SENSITIVE = [:client_secret]
  include Aws::Structure
end