Interface OidcIdentityProviderConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OidcIdentityProviderConfig.Builder,OidcIdentityProviderConfig>, SdkBuilder<OidcIdentityProviderConfig.Builder,OidcIdentityProviderConfig>, SdkPojo
Enclosing class:
OidcIdentityProviderConfig

public static interface OidcIdentityProviderConfig.Builder extends SdkPojo, CopyableBuilder<OidcIdentityProviderConfig.Builder,OidcIdentityProviderConfig>
  • Method Details

    • identityProviderConfigName

      OidcIdentityProviderConfig.Builder identityProviderConfigName(String identityProviderConfigName)

      The name of the configuration.

      Parameters:
      identityProviderConfigName - The name of the configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • identityProviderConfigArn

      OidcIdentityProviderConfig.Builder identityProviderConfigArn(String identityProviderConfigArn)

      The ARN of the configuration.

      Parameters:
      identityProviderConfigArn - The ARN of the configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clusterName

      OidcIdentityProviderConfig.Builder clusterName(String clusterName)

      The cluster that the configuration is associated to.

      Parameters:
      clusterName - The cluster that the configuration is associated to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • issuerUrl

      The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.

      Parameters:
      issuerUrl - The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clientId

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

      Parameters:
      clientId - This is also known as audience. The ID of the client application that makes authentication requests to the OIDC identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • usernameClaim

      OidcIdentityProviderConfig.Builder usernameClaim(String usernameClaim)

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

      Parameters:
      usernameClaim - The JSON Web token (JWT) claim that is used as the username.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • usernamePrefix

      OidcIdentityProviderConfig.Builder usernamePrefix(String usernamePrefix)

      The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system:

      Parameters:
      usernamePrefix - The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system:
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • groupsClaim

      OidcIdentityProviderConfig.Builder groupsClaim(String groupsClaim)

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

      Parameters:
      groupsClaim - The JSON web token (JWT) claim that the provider uses to return your groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • groupsPrefix

      OidcIdentityProviderConfig.Builder groupsPrefix(String groupsPrefix)

      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:

      Parameters:
      groupsPrefix - 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:
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • requiredClaims

      OidcIdentityProviderConfig.Builder requiredClaims(Map<String,String> requiredClaims)

      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.

      Parameters:
      requiredClaims - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      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.

      Parameters:
      tags - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The status of the OIDC identity provider.

      Parameters:
      status - The status of the OIDC identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The status of the OIDC identity provider.

      Parameters:
      status - The status of the OIDC identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: