Class OidcIdentityProviderConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<OidcIdentityProviderConfig.Builder,
OidcIdentityProviderConfig>
An object representing the configuration for an OpenID Connect (OIDC) identity provider.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
clientId()
This is also known as audience.final String
The name of your cluster.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final String
The JSON web token (JWT) claim that the provider uses to return your groups.final String
The prefix that is prepended to group claims to prevent clashes with existing names (such assystem:
groups).final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RequiredClaims property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The ARN of the configuration.final String
The name of the configuration.final String
The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.The key-value pairs that describe required claims in the identity token.static Class
<? extends OidcIdentityProviderConfig.Builder> final ConfigStatus
status()
The status of the OIDC identity provider.final String
The status of the OIDC identity provider.tags()
Metadata that assists with categorization and organization.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The JSON Web token (JWT) claim that is used as the username.final String
The prefix that is prepended to username claims to prevent clashes with existing names.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
identityProviderConfigName
The name of the configuration.
- Returns:
- The name of the configuration.
-
identityProviderConfigArn
The ARN of the configuration.
- Returns:
- The ARN of the configuration.
-
clusterName
The name of your cluster.
- Returns:
- The name of your cluster.
-
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
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
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
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
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
The prefix that is prepended to group claims to prevent clashes with existing names (such as
system:
groups). For example, the valueoidc:
creates group names likeoidc:engineering
andoidc:infra
. The prefix can't containsystem:
- Returns:
- The prefix that is prepended to group claims to prevent clashes with existing names (such as
system:
groups). For example, the valueoidc:
creates group names likeoidc:engineering
andoidc:infra
. The prefix can't containsystem:
-
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 theisEmpty()
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
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 theisEmpty()
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
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.
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:
- 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
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 returnConfigStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the OIDC identity provider.
- See Also:
-
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 returnConfigStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the OIDC identity provider.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<OidcIdentityProviderConfig.Builder,
OidcIdentityProviderConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-