Struct aws_sdk_eks::types::OidcIdentityProviderConfigRequest

#[non_exhaustive]
pub struct OidcIdentityProviderConfigRequest {
    pub identity_provider_config_name: String,
    pub issuer_url: String,
    pub client_id: 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>>,
}

An object representing an OpenID Connect (OIDC) configuration. Before associating an OIDC identity provider to your cluster, review the considerations in Authenticating users for your cluster from an OIDC identity provider in the Amazon EKS User Guide.

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: String

The name of the OIDC provider configuration.

issuer_url: String

The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens. The URL must begin with https:// and should correspond to the iss claim in the provider's OIDC ID tokens. Based on the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. This URL should point to the level below .well-known/openid-configuration and must be publicly accessible over the internet.

client_id: String

This is also known as audience. The ID for the client application that makes authentication requests to the OIDC identity provider.

username_claim: Option<String>

The JSON Web Token (JWT) claim to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OIDC identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

username_prefix: Option<String>

The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.

groups_claim: Option<String>

The 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: will create group names like oidc:engineering and oidc:infra.

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. For the maximum number of claims that you can require, see Amazon EKS service quotas in the Amazon EKS User Guide.

Implementations

impl OidcIdentityProviderConfigRequest

pub fn identity_provider_config_name(&self) -> &str

The name of the OIDC provider configuration.

pub fn issuer_url(&self) -> &str

The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens. The URL must begin with https:// and should correspond to the iss claim in the provider's OIDC ID tokens. Based on the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com. This URL should point to the level below .well-known/openid-configuration and must be publicly accessible over the internet.

pub fn client_id(&self) -> &str

This is also known as audience. The ID for 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 to use as the username. The default is sub, which is expected to be a unique identifier of the end user. You can choose other claims, such as email or name, depending on the OIDC identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

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

The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and username is a value other than email, the prefix defaults to issuerurl#. You can use the value - to disable all prefixing.

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

The 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: will create group names like oidc:engineering and oidc:infra.

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. For the maximum number of claims that you can require, see Amazon EKS service quotas in the Amazon EKS User Guide.

impl OidcIdentityProviderConfigRequest

pub fn builder() -> OidcIdentityProviderConfigRequestBuilder

Creates a new builder-style object to manufacture OidcIdentityProviderConfigRequest.

Trait Implementations

impl Clone for OidcIdentityProviderConfigRequest

fn clone(&self) -> OidcIdentityProviderConfigRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OidcIdentityProviderConfigRequest

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

Formats the value using the given formatter.

impl PartialEq for OidcIdentityProviderConfigRequest

fn eq(&self, other: &OidcIdentityProviderConfigRequest) -> 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 OidcIdentityProviderConfigRequest