AWS SDK for C++  1.9.69
AWS SDK for C++
Public Member Functions | List of all members
Aws::EKS::Model::OidcIdentityProviderConfigRequest Class Reference

#include <OidcIdentityProviderConfigRequest.h>

Public Member Functions

 OidcIdentityProviderConfigRequest ()
 
 OidcIdentityProviderConfigRequest (Aws::Utils::Json::JsonView jsonValue)
 
OidcIdentityProviderConfigRequestoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetIdentityProviderConfigName () const
 
bool IdentityProviderConfigNameHasBeenSet () const
 
void SetIdentityProviderConfigName (const Aws::String &value)
 
void SetIdentityProviderConfigName (Aws::String &&value)
 
void SetIdentityProviderConfigName (const char *value)
 
OidcIdentityProviderConfigRequestWithIdentityProviderConfigName (const Aws::String &value)
 
OidcIdentityProviderConfigRequestWithIdentityProviderConfigName (Aws::String &&value)
 
OidcIdentityProviderConfigRequestWithIdentityProviderConfigName (const char *value)
 
const Aws::StringGetIssuerUrl () const
 
bool IssuerUrlHasBeenSet () const
 
void SetIssuerUrl (const Aws::String &value)
 
void SetIssuerUrl (Aws::String &&value)
 
void SetIssuerUrl (const char *value)
 
OidcIdentityProviderConfigRequestWithIssuerUrl (const Aws::String &value)
 
OidcIdentityProviderConfigRequestWithIssuerUrl (Aws::String &&value)
 
OidcIdentityProviderConfigRequestWithIssuerUrl (const char *value)
 
const Aws::StringGetClientId () const
 
bool ClientIdHasBeenSet () const
 
void SetClientId (const Aws::String &value)
 
void SetClientId (Aws::String &&value)
 
void SetClientId (const char *value)
 
OidcIdentityProviderConfigRequestWithClientId (const Aws::String &value)
 
OidcIdentityProviderConfigRequestWithClientId (Aws::String &&value)
 
OidcIdentityProviderConfigRequestWithClientId (const char *value)
 
const Aws::StringGetUsernameClaim () const
 
bool UsernameClaimHasBeenSet () const
 
void SetUsernameClaim (const Aws::String &value)
 
void SetUsernameClaim (Aws::String &&value)
 
void SetUsernameClaim (const char *value)
 
OidcIdentityProviderConfigRequestWithUsernameClaim (const Aws::String &value)
 
OidcIdentityProviderConfigRequestWithUsernameClaim (Aws::String &&value)
 
OidcIdentityProviderConfigRequestWithUsernameClaim (const char *value)
 
const Aws::StringGetUsernamePrefix () const
 
bool UsernamePrefixHasBeenSet () const
 
void SetUsernamePrefix (const Aws::String &value)
 
void SetUsernamePrefix (Aws::String &&value)
 
void SetUsernamePrefix (const char *value)
 
OidcIdentityProviderConfigRequestWithUsernamePrefix (const Aws::String &value)
 
OidcIdentityProviderConfigRequestWithUsernamePrefix (Aws::String &&value)
 
OidcIdentityProviderConfigRequestWithUsernamePrefix (const char *value)
 
const Aws::StringGetGroupsClaim () const
 
bool GroupsClaimHasBeenSet () const
 
void SetGroupsClaim (const Aws::String &value)
 
void SetGroupsClaim (Aws::String &&value)
 
void SetGroupsClaim (const char *value)
 
OidcIdentityProviderConfigRequestWithGroupsClaim (const Aws::String &value)
 
OidcIdentityProviderConfigRequestWithGroupsClaim (Aws::String &&value)
 
OidcIdentityProviderConfigRequestWithGroupsClaim (const char *value)
 
const Aws::StringGetGroupsPrefix () const
 
bool GroupsPrefixHasBeenSet () const
 
void SetGroupsPrefix (const Aws::String &value)
 
void SetGroupsPrefix (Aws::String &&value)
 
void SetGroupsPrefix (const char *value)
 
OidcIdentityProviderConfigRequestWithGroupsPrefix (const Aws::String &value)
 
OidcIdentityProviderConfigRequestWithGroupsPrefix (Aws::String &&value)
 
OidcIdentityProviderConfigRequestWithGroupsPrefix (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetRequiredClaims () const
 
bool RequiredClaimsHasBeenSet () const
 
void SetRequiredClaims (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRequiredClaims (Aws::Map< Aws::String, Aws::String > &&value)
 
OidcIdentityProviderConfigRequestWithRequiredClaims (const Aws::Map< Aws::String, Aws::String > &value)
 
OidcIdentityProviderConfigRequestWithRequiredClaims (Aws::Map< Aws::String, Aws::String > &&value)
 
OidcIdentityProviderConfigRequestAddRequiredClaims (const Aws::String &key, const Aws::String &value)
 
OidcIdentityProviderConfigRequestAddRequiredClaims (Aws::String &&key, const Aws::String &value)
 
OidcIdentityProviderConfigRequestAddRequiredClaims (const Aws::String &key, Aws::String &&value)
 
OidcIdentityProviderConfigRequestAddRequiredClaims (Aws::String &&key, Aws::String &&value)
 
OidcIdentityProviderConfigRequestAddRequiredClaims (const char *key, Aws::String &&value)
 
OidcIdentityProviderConfigRequestAddRequiredClaims (Aws::String &&key, const char *value)
 
OidcIdentityProviderConfigRequestAddRequiredClaims (const char *key, const char *value)
 

Detailed Description

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 OpenID Connect identity provider in the Amazon EKS User Guide.

See Also:

AWS API Reference

Definition at line 37 of file OidcIdentityProviderConfigRequest.h.

Constructor & Destructor Documentation

◆ OidcIdentityProviderConfigRequest() [1/2]

Aws::EKS::Model::OidcIdentityProviderConfigRequest::OidcIdentityProviderConfigRequest ( )

◆ OidcIdentityProviderConfigRequest() [2/2]

Aws::EKS::Model::OidcIdentityProviderConfigRequest::OidcIdentityProviderConfigRequest ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddRequiredClaims() [1/7]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::AddRequiredClaims ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 589 of file OidcIdentityProviderConfigRequest.h.

◆ AddRequiredClaims() [2/7]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::AddRequiredClaims ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 571 of file OidcIdentityProviderConfigRequest.h.

◆ AddRequiredClaims() [3/7]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::AddRequiredClaims ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 607 of file OidcIdentityProviderConfigRequest.h.

◆ AddRequiredClaims() [4/7]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::AddRequiredClaims ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 580 of file OidcIdentityProviderConfigRequest.h.

◆ AddRequiredClaims() [5/7]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::AddRequiredClaims ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 562 of file OidcIdentityProviderConfigRequest.h.

◆ AddRequiredClaims() [6/7]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::AddRequiredClaims ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 598 of file OidcIdentityProviderConfigRequest.h.

◆ AddRequiredClaims() [7/7]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::AddRequiredClaims ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 616 of file OidcIdentityProviderConfigRequest.h.

◆ ClientIdHasBeenSet()

bool Aws::EKS::Model::OidcIdentityProviderConfigRequest::ClientIdHasBeenSet ( ) const
inline

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

Definition at line 202 of file OidcIdentityProviderConfigRequest.h.

◆ GetClientId()

const Aws::String& Aws::EKS::Model::OidcIdentityProviderConfigRequest::GetClientId ( ) const
inline

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

Definition at line 196 of file OidcIdentityProviderConfigRequest.h.

◆ GetGroupsClaim()

const Aws::String& Aws::EKS::Model::OidcIdentityProviderConfigRequest::GetGroupsClaim ( ) const
inline

The JWT claim that the provider uses to return your groups.

Definition at line 398 of file OidcIdentityProviderConfigRequest.h.

◆ GetGroupsPrefix()

const Aws::String& Aws::EKS::Model::OidcIdentityProviderConfigRequest::GetGroupsPrefix ( ) const
inline

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.

Definition at line 442 of file OidcIdentityProviderConfigRequest.h.

◆ GetIdentityProviderConfigName()

const Aws::String& Aws::EKS::Model::OidcIdentityProviderConfigRequest::GetIdentityProviderConfigName ( ) const
inline

The name of the OIDC provider configuration.

Definition at line 49 of file OidcIdentityProviderConfigRequest.h.

◆ GetIssuerUrl()

const Aws::String& Aws::EKS::Model::OidcIdentityProviderConfigRequest::GetIssuerUrl ( ) const
inline

The URL of the OpenID 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. Per 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.

Definition at line 98 of file OidcIdentityProviderConfigRequest.h.

◆ GetRequiredClaims()

const Aws::Map<Aws::String, Aws::String>& Aws::EKS::Model::OidcIdentityProviderConfigRequest::GetRequiredClaims ( ) const
inline

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.

Definition at line 508 of file OidcIdentityProviderConfigRequest.h.

◆ GetUsernameClaim()

const Aws::String& Aws::EKS::Model::OidcIdentityProviderConfigRequest::GetUsernameClaim ( ) const
inline

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 OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

Definition at line 249 of file OidcIdentityProviderConfigRequest.h.

◆ GetUsernamePrefix()

const Aws::String& Aws::EKS::Model::OidcIdentityProviderConfigRequest::GetUsernamePrefix ( ) const
inline

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.

Definition at line 329 of file OidcIdentityProviderConfigRequest.h.

◆ GroupsClaimHasBeenSet()

bool Aws::EKS::Model::OidcIdentityProviderConfigRequest::GroupsClaimHasBeenSet ( ) const
inline

The JWT claim that the provider uses to return your groups.

Definition at line 403 of file OidcIdentityProviderConfigRequest.h.

◆ GroupsPrefixHasBeenSet()

bool Aws::EKS::Model::OidcIdentityProviderConfigRequest::GroupsPrefixHasBeenSet ( ) const
inline

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.

Definition at line 450 of file OidcIdentityProviderConfigRequest.h.

◆ IdentityProviderConfigNameHasBeenSet()

bool Aws::EKS::Model::OidcIdentityProviderConfigRequest::IdentityProviderConfigNameHasBeenSet ( ) const
inline

The name of the OIDC provider configuration.

Definition at line 54 of file OidcIdentityProviderConfigRequest.h.

◆ IssuerUrlHasBeenSet()

bool Aws::EKS::Model::OidcIdentityProviderConfigRequest::IssuerUrlHasBeenSet ( ) const
inline

The URL of the OpenID 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. Per 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.

Definition at line 111 of file OidcIdentityProviderConfigRequest.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EKS::Model::OidcIdentityProviderConfigRequest::Jsonize ( ) const

◆ operator=()

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RequiredClaimsHasBeenSet()

bool Aws::EKS::Model::OidcIdentityProviderConfigRequest::RequiredClaimsHasBeenSet ( ) const
inline

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.

Definition at line 517 of file OidcIdentityProviderConfigRequest.h.

◆ SetClientId() [1/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetClientId ( Aws::String &&  value)
inline

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

Definition at line 214 of file OidcIdentityProviderConfigRequest.h.

◆ SetClientId() [2/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetClientId ( const Aws::String value)
inline

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

Definition at line 208 of file OidcIdentityProviderConfigRequest.h.

◆ SetClientId() [3/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetClientId ( const char *  value)
inline

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

Definition at line 220 of file OidcIdentityProviderConfigRequest.h.

◆ SetGroupsClaim() [1/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetGroupsClaim ( Aws::String &&  value)
inline

The JWT claim that the provider uses to return your groups.

Definition at line 413 of file OidcIdentityProviderConfigRequest.h.

◆ SetGroupsClaim() [2/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetGroupsClaim ( const Aws::String value)
inline

The JWT claim that the provider uses to return your groups.

Definition at line 408 of file OidcIdentityProviderConfigRequest.h.

◆ SetGroupsClaim() [3/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetGroupsClaim ( const char *  value)
inline

The JWT claim that the provider uses to return your groups.

Definition at line 418 of file OidcIdentityProviderConfigRequest.h.

◆ SetGroupsPrefix() [1/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetGroupsPrefix ( Aws::String &&  value)
inline

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.

Definition at line 466 of file OidcIdentityProviderConfigRequest.h.

◆ SetGroupsPrefix() [2/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetGroupsPrefix ( const Aws::String value)
inline

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.

Definition at line 458 of file OidcIdentityProviderConfigRequest.h.

◆ SetGroupsPrefix() [3/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetGroupsPrefix ( const char *  value)
inline

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.

Definition at line 474 of file OidcIdentityProviderConfigRequest.h.

◆ SetIdentityProviderConfigName() [1/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetIdentityProviderConfigName ( Aws::String &&  value)
inline

The name of the OIDC provider configuration.

Definition at line 64 of file OidcIdentityProviderConfigRequest.h.

◆ SetIdentityProviderConfigName() [2/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetIdentityProviderConfigName ( const Aws::String value)
inline

The name of the OIDC provider configuration.

Definition at line 59 of file OidcIdentityProviderConfigRequest.h.

◆ SetIdentityProviderConfigName() [3/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetIdentityProviderConfigName ( const char *  value)
inline

The name of the OIDC provider configuration.

Definition at line 69 of file OidcIdentityProviderConfigRequest.h.

◆ SetIssuerUrl() [1/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetIssuerUrl ( Aws::String &&  value)
inline

The URL of the OpenID 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. Per 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.

Definition at line 137 of file OidcIdentityProviderConfigRequest.h.

◆ SetIssuerUrl() [2/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetIssuerUrl ( const Aws::String value)
inline

The URL of the OpenID 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. Per 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.

Definition at line 124 of file OidcIdentityProviderConfigRequest.h.

◆ SetIssuerUrl() [3/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetIssuerUrl ( const char *  value)
inline

The URL of the OpenID 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. Per 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.

Definition at line 150 of file OidcIdentityProviderConfigRequest.h.

◆ SetRequiredClaims() [1/2]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetRequiredClaims ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 535 of file OidcIdentityProviderConfigRequest.h.

◆ SetRequiredClaims() [2/2]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetRequiredClaims ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 526 of file OidcIdentityProviderConfigRequest.h.

◆ SetUsernameClaim() [1/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetUsernameClaim ( Aws::String &&  value)
inline

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 OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

Definition at line 279 of file OidcIdentityProviderConfigRequest.h.

◆ SetUsernameClaim() [2/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetUsernameClaim ( const Aws::String value)
inline

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 OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

Definition at line 269 of file OidcIdentityProviderConfigRequest.h.

◆ SetUsernameClaim() [3/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetUsernameClaim ( const char *  value)
inline

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 OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

Definition at line 289 of file OidcIdentityProviderConfigRequest.h.

◆ SetUsernamePrefix() [1/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetUsernamePrefix ( Aws::String &&  value)
inline

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.

Definition at line 356 of file OidcIdentityProviderConfigRequest.h.

◆ SetUsernamePrefix() [2/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetUsernamePrefix ( const Aws::String value)
inline

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.

Definition at line 347 of file OidcIdentityProviderConfigRequest.h.

◆ SetUsernamePrefix() [3/3]

void Aws::EKS::Model::OidcIdentityProviderConfigRequest::SetUsernamePrefix ( const char *  value)
inline

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.

Definition at line 365 of file OidcIdentityProviderConfigRequest.h.

◆ UsernameClaimHasBeenSet()

bool Aws::EKS::Model::OidcIdentityProviderConfigRequest::UsernameClaimHasBeenSet ( ) const
inline

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 OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

Definition at line 259 of file OidcIdentityProviderConfigRequest.h.

◆ UsernamePrefixHasBeenSet()

bool Aws::EKS::Model::OidcIdentityProviderConfigRequest::UsernamePrefixHasBeenSet ( ) const
inline

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.

Definition at line 338 of file OidcIdentityProviderConfigRequest.h.

◆ WithClientId() [1/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithClientId ( Aws::String &&  value)
inline

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

Definition at line 232 of file OidcIdentityProviderConfigRequest.h.

◆ WithClientId() [2/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithClientId ( const Aws::String value)
inline

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

Definition at line 226 of file OidcIdentityProviderConfigRequest.h.

◆ WithClientId() [3/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithClientId ( const char *  value)
inline

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

Definition at line 238 of file OidcIdentityProviderConfigRequest.h.

◆ WithGroupsClaim() [1/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithGroupsClaim ( Aws::String &&  value)
inline

The JWT claim that the provider uses to return your groups.

Definition at line 428 of file OidcIdentityProviderConfigRequest.h.

◆ WithGroupsClaim() [2/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithGroupsClaim ( const Aws::String value)
inline

The JWT claim that the provider uses to return your groups.

Definition at line 423 of file OidcIdentityProviderConfigRequest.h.

◆ WithGroupsClaim() [3/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithGroupsClaim ( const char *  value)
inline

The JWT claim that the provider uses to return your groups.

Definition at line 433 of file OidcIdentityProviderConfigRequest.h.

◆ WithGroupsPrefix() [1/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithGroupsPrefix ( Aws::String &&  value)
inline

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.

Definition at line 490 of file OidcIdentityProviderConfigRequest.h.

◆ WithGroupsPrefix() [2/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithGroupsPrefix ( const Aws::String value)
inline

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.

Definition at line 482 of file OidcIdentityProviderConfigRequest.h.

◆ WithGroupsPrefix() [3/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithGroupsPrefix ( const char *  value)
inline

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.

Definition at line 498 of file OidcIdentityProviderConfigRequest.h.

◆ WithIdentityProviderConfigName() [1/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithIdentityProviderConfigName ( Aws::String &&  value)
inline

The name of the OIDC provider configuration.

Definition at line 79 of file OidcIdentityProviderConfigRequest.h.

◆ WithIdentityProviderConfigName() [2/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithIdentityProviderConfigName ( const Aws::String value)
inline

The name of the OIDC provider configuration.

Definition at line 74 of file OidcIdentityProviderConfigRequest.h.

◆ WithIdentityProviderConfigName() [3/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithIdentityProviderConfigName ( const char *  value)
inline

The name of the OIDC provider configuration.

Definition at line 84 of file OidcIdentityProviderConfigRequest.h.

◆ WithIssuerUrl() [1/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithIssuerUrl ( Aws::String &&  value)
inline

The URL of the OpenID 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. Per 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.

Definition at line 176 of file OidcIdentityProviderConfigRequest.h.

◆ WithIssuerUrl() [2/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithIssuerUrl ( const Aws::String value)
inline

The URL of the OpenID 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. Per 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.

Definition at line 163 of file OidcIdentityProviderConfigRequest.h.

◆ WithIssuerUrl() [3/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithIssuerUrl ( const char *  value)
inline

The URL of the OpenID 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. Per 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.

Definition at line 189 of file OidcIdentityProviderConfigRequest.h.

◆ WithRequiredClaims() [1/2]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithRequiredClaims ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 553 of file OidcIdentityProviderConfigRequest.h.

◆ WithRequiredClaims() [2/2]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithRequiredClaims ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 544 of file OidcIdentityProviderConfigRequest.h.

◆ WithUsernameClaim() [1/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithUsernameClaim ( Aws::String &&  value)
inline

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 OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

Definition at line 309 of file OidcIdentityProviderConfigRequest.h.

◆ WithUsernameClaim() [2/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithUsernameClaim ( const Aws::String value)
inline

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 OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

Definition at line 299 of file OidcIdentityProviderConfigRequest.h.

◆ WithUsernameClaim() [3/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithUsernameClaim ( const char *  value)
inline

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 OpenID identity provider. Claims other than email are prefixed with the issuer URL to prevent naming clashes with other plug-ins.

Definition at line 319 of file OidcIdentityProviderConfigRequest.h.

◆ WithUsernamePrefix() [1/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithUsernamePrefix ( Aws::String &&  value)
inline

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.

Definition at line 383 of file OidcIdentityProviderConfigRequest.h.

◆ WithUsernamePrefix() [2/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithUsernamePrefix ( const Aws::String value)
inline

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.

Definition at line 374 of file OidcIdentityProviderConfigRequest.h.

◆ WithUsernamePrefix() [3/3]

OidcIdentityProviderConfigRequest& Aws::EKS::Model::OidcIdentityProviderConfigRequest::WithUsernamePrefix ( const char *  value)
inline

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.

Definition at line 392 of file OidcIdentityProviderConfigRequest.h.


The documentation for this class was generated from the following file: