OidcIdentityProviderConfig (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.eks.model.OidcIdentityProviderConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OidcIdentityProviderConfig.Builder,OidcIdentityProviderConfig>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class OidcIdentityProviderConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OidcIdentityProviderConfig.Builder,OidcIdentityProviderConfig>
```
An object representing the configuration for an OpenID Connect (OIDC) identity provider.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface OidcIdentityProviderConfig.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`OidcIdentityProviderConfig.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static OidcIdentityProviderConfig.Builder`	`builder()`
`String`	`clientId()` This is also known as audience.
`String`	`clusterName()` The cluster that the configuration is associated to.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`groupsClaim()` The JSON web token (JWT) claim that the provider uses to return your groups.
`String`	`groupsPrefix()` The prefix that is prepended to group claims to prevent clashes with existing names (such as `system:` groups).
`int`	`hashCode()`
`boolean`	`hasRequiredClaims()` For responses, this returns true if the service returned a value for the RequiredClaims property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`identityProviderConfigArn()` The ARN of the configuration.
`String`	`identityProviderConfigName()` The name of the configuration.
`String`	`issuerUrl()` The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.
`Map<String,String>`	`requiredClaims()` The key-value pairs that describe required claims in the identity token.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends OidcIdentityProviderConfig.Builder>`	`serializableBuilderClass()`
`ConfigStatus`	`status()` The status of the OIDC identity provider.
`String`	`statusAsString()` The status of the OIDC identity provider.
`Map<String,String>`	`tags()` The metadata to apply to the provider configuration to assist with categorization and organization.
`OidcIdentityProviderConfig.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`usernameClaim()` The JSON Web token (JWT) claim that is used as the username.
`String`	`usernamePrefix()` The prefix that is prepended to username claims to prevent clashes with existing names.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - identityProviderConfigName
```
public final String identityProviderConfigName()
```
    The name of the configuration.
    
    Returns:
    
    The name of the configuration.
  - identityProviderConfigArn
```
public final String identityProviderConfigArn()
```
    The ARN of the configuration.
    
    Returns:
    
    The ARN of the configuration.
  - clusterName
```
public final String clusterName()
```
    The cluster that the configuration is associated to.
    
    Returns:
    
    The cluster that the configuration is associated to.
  - issuerUrl
```
public final String issuerUrl()
```
    The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.
    
    Returns:
    
    The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.
  - clientId
```
public final String clientId()
```
    This is also known as audience. The ID of the client application that makes authentication requests to the OIDC identity provider.
    
    Returns:
    
    This is also known as audience. The ID of the client application that makes authentication requests to the OIDC identity provider.
  - usernameClaim
```
public final String usernameClaim()
```
    The JSON Web token (JWT) claim that is used as the username.
    
    Returns:
    
    The JSON Web token (JWT) claim that is used as the username.
  - usernamePrefix
```
public final String usernamePrefix()
```
    The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system:
    
    Returns:
    
    The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain system:
  - groupsClaim
```
public final String groupsClaim()
```
    The JSON web token (JWT) claim that the provider uses to return your groups.
    
    Returns:
    
    The JSON web token (JWT) claim that the provider uses to return your groups.
  - groupsPrefix
```
public final 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:
    
    Returns:
    
    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:
  - hasRequiredClaims
```
public final boolean hasRequiredClaims()
```
    For responses, this returns true if the service returned a value for the RequiredClaims property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - requiredClaims
```
public final 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequiredClaims() method.
    
    Returns:
    
    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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    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
```
public final ConfigStatus status()
```
    The status of the OIDC identity provider.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ConfigStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the OIDC identity provider.
    
    See Also:
    
    ConfigStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the OIDC identity provider.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ConfigStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the OIDC identity provider.
    
    See Also:
    
    ConfigStatus
  - toBuilder
```
public OidcIdentityProviderConfig.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<OidcIdentityProviderConfig.Builder,OidcIdentityProviderConfig>
  - builder
```
public static OidcIdentityProviderConfig.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends OidcIdentityProviderConfig.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class OidcIdentityProviderConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

identityProviderConfigName

identityProviderConfigArn

clusterName

issuerUrl

clientId

usernameClaim

usernamePrefix

groupsClaim

groupsPrefix

hasRequiredClaims

requiredClaims

hasTags

tags

status

statusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields