#[non_exhaustive]pub struct OidcIdentityProviderConfig {
pub identity_provider_config_name: Option<String>,
pub identity_provider_config_arn: Option<String>,
pub cluster_name: Option<String>,
pub issuer_url: Option<String>,
pub client_id: Option<String>,
pub username_claim: Option<String>,
pub username_prefix: Option<String>,
pub groups_claim: Option<String>,
pub groups_prefix: Option<String>,
pub required_claims: Option<HashMap<String, String>>,
pub tags: Option<HashMap<String, String>>,
pub status: Option<ConfigStatus>,
}
Expand description
An object representing the configuration for an OpenID Connect (OIDC) identity provider.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.identity_provider_config_name: Option<String>
The name of the configuration.
identity_provider_config_arn: Option<String>
The ARN of the configuration.
cluster_name: Option<String>
The name of your cluster.
issuer_url: Option<String>
The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.
client_id: Option<String>
This is also known as audience. The ID of the client application that makes authentication requests to the OIDC identity provider.
username_claim: Option<String>
The JSON Web token (JWT) claim that is used as the username.
username_prefix: Option<String>
The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system:
groups_claim: Option<String>
The JSON web token (JWT) claim that the provider uses to return your groups.
groups_prefix: Option<String>
The prefix that is prepended to group claims to prevent clashes with existing names (such as system:
groups). For example, the value oidc:
creates group names like oidc:engineering
and oidc:infra
. The prefix can't contain system:
required_claims: Option<HashMap<String, String>>
The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
status: Option<ConfigStatus>
The status of the OIDC identity provider.
Implementations§
Source§impl OidcIdentityProviderConfig
impl OidcIdentityProviderConfig
Sourcepub fn identity_provider_config_name(&self) -> Option<&str>
pub fn identity_provider_config_name(&self) -> Option<&str>
The name of the configuration.
Sourcepub fn identity_provider_config_arn(&self) -> Option<&str>
pub fn identity_provider_config_arn(&self) -> Option<&str>
The ARN of the configuration.
Sourcepub fn cluster_name(&self) -> Option<&str>
pub fn cluster_name(&self) -> Option<&str>
The name of your cluster.
Sourcepub fn issuer_url(&self) -> Option<&str>
pub fn issuer_url(&self) -> Option<&str>
The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.
Sourcepub fn client_id(&self) -> Option<&str>
pub fn client_id(&self) -> Option<&str>
This is also known as audience. The ID of the client application that makes authentication requests to the OIDC identity provider.
Sourcepub fn username_claim(&self) -> Option<&str>
pub fn username_claim(&self) -> Option<&str>
The JSON Web token (JWT) claim that is used as the username.
Sourcepub fn username_prefix(&self) -> Option<&str>
pub fn username_prefix(&self) -> Option<&str>
The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system:
Sourcepub fn groups_claim(&self) -> Option<&str>
pub fn groups_claim(&self) -> Option<&str>
The JSON web token (JWT) claim that the provider uses to return your groups.
Sourcepub fn groups_prefix(&self) -> Option<&str>
pub fn groups_prefix(&self) -> Option<&str>
The prefix that is prepended to group claims to prevent clashes with existing names (such as system:
groups). For example, the value oidc:
creates group names like oidc:engineering
and oidc:infra
. The prefix can't contain system:
Sourcepub fn required_claims(&self) -> Option<&HashMap<String, String>>
pub fn required_claims(&self) -> Option<&HashMap<String, String>>
The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
Sourcepub fn status(&self) -> Option<&ConfigStatus>
pub fn status(&self) -> Option<&ConfigStatus>
The status of the OIDC identity provider.
Source§impl OidcIdentityProviderConfig
impl OidcIdentityProviderConfig
Sourcepub fn builder() -> OidcIdentityProviderConfigBuilder
pub fn builder() -> OidcIdentityProviderConfigBuilder
Creates a new builder-style object to manufacture OidcIdentityProviderConfig
.
Trait Implementations§
Source§impl Clone for OidcIdentityProviderConfig
impl Clone for OidcIdentityProviderConfig
Source§fn clone(&self) -> OidcIdentityProviderConfig
fn clone(&self) -> OidcIdentityProviderConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OidcIdentityProviderConfig
impl Debug for OidcIdentityProviderConfig
impl StructuralPartialEq for OidcIdentityProviderConfig
Auto Trait Implementations§
impl Freeze for OidcIdentityProviderConfig
impl RefUnwindSafe for OidcIdentityProviderConfig
impl Send for OidcIdentityProviderConfig
impl Sync for OidcIdentityProviderConfig
impl Unpin for OidcIdentityProviderConfig
impl UnwindSafe for OidcIdentityProviderConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);