Struct OAuth2ClientCredentialConfiguration 

#[non_exhaustive]
pub struct OAuth2ClientCredentialConfiguration {
    pub secret_arn: String,
    pub role_arn: String,
    pub authorization_url: Option<String>,
    pub token_url: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

secret_arn: String

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

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.

authorization_url: Option<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.

token_url: Option<String>

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

Implementations

impl OAuth2ClientCredentialConfiguration

pub fn secret_arn(&self) -> &str

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

pub fn role_arn(&self) -> &str

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.

pub fn authorization_url(&self) -> Option<&str>

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.

pub fn token_url(&self) -> Option<&str>

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

impl OAuth2ClientCredentialConfiguration

pub fn builder() -> OAuth2ClientCredentialConfigurationBuilder

Creates a new builder-style object to manufacture OAuth2ClientCredentialConfiguration.

Trait Implementations

impl Clone for OAuth2ClientCredentialConfiguration

fn clone(&self) -> OAuth2ClientCredentialConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OAuth2ClientCredentialConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for OAuth2ClientCredentialConfiguration

fn eq(&self, other: &OAuth2ClientCredentialConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OAuth2ClientCredentialConfiguration