Struct aws_sdk_eks::types::OidcIdentityProviderConfig

#[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>,
}

An object representing the configuration for an OpenID Connect (OIDC) identity provider.

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.

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 cluster that the configuration is associated to.

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.

tags: Option<HashMap<String, String>>

The metadata to apply to the provider configuration to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

status: Option<ConfigStatus>

The status of the OIDC identity provider.

Implementations

impl OidcIdentityProviderConfig

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

The name of the configuration.

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

The ARN of the configuration.

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

The cluster that the configuration is associated to.

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.

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.

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

The JSON Web token (JWT) claim that is used as the username.

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:

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

The JSON web token (JWT) claim that the provider uses to return your groups.

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:

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.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The metadata to apply to the provider configuration to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

pub fn status(&self) -> Option<&ConfigStatus>

The status of the OIDC identity provider.

impl OidcIdentityProviderConfig

pub fn builder() -> OidcIdentityProviderConfigBuilder

Creates a new builder-style object to manufacture OidcIdentityProviderConfig.

Trait Implementations

impl Clone for OidcIdentityProviderConfig

fn clone(&self) -> OidcIdentityProviderConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OidcIdentityProviderConfig

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

Formats the value using the given formatter.

impl PartialEq for OidcIdentityProviderConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for OidcIdentityProviderConfig