All Superinterfaces:

Buildable, CopyableBuilder<AuthenticateOidcActionConfig.Builder,AuthenticateOidcActionConfig>, SdkBuilder<AuthenticateOidcActionConfig.Builder,AuthenticateOidcActionConfig>, SdkPojo

Enclosing class:

AuthenticateOidcActionConfig
```
public static interface AuthenticateOidcActionConfig.Builder
extends SdkPojo, CopyableBuilder<AuthenticateOidcActionConfig.Builder,AuthenticateOidcActionConfig>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AuthenticateOidcActionConfig.Builder`	`authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)`	The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
`AuthenticateOidcActionConfig.Builder`	`authorizationEndpoint(String authorizationEndpoint)`	The authorization endpoint of the IdP.
`AuthenticateOidcActionConfig.Builder`	`clientId(String clientId)`	The OAuth 2.0 client identifier.
`AuthenticateOidcActionConfig.Builder`	`clientSecret(String clientSecret)`	The OAuth 2.0 client secret.
`AuthenticateOidcActionConfig.Builder`	`issuer(String issuer)`	The OIDC issuer identifier of the IdP.
`AuthenticateOidcActionConfig.Builder`	`onUnauthenticatedRequest(String onUnauthenticatedRequest)`	The behavior if the user is not authenticated.
`AuthenticateOidcActionConfig.Builder`	`onUnauthenticatedRequest(AuthenticateOidcActionConditionalBehaviorEnum onUnauthenticatedRequest)`	The behavior if the user is not authenticated.
`AuthenticateOidcActionConfig.Builder`	`scope(String scope)`	The set of user claims to be requested from the IdP.
`AuthenticateOidcActionConfig.Builder`	`sessionCookieName(String sessionCookieName)`	The name of the cookie used to maintain session information.
`AuthenticateOidcActionConfig.Builder`	`sessionTimeout(Long sessionTimeout)`	The maximum duration of the authentication session, in seconds.
`AuthenticateOidcActionConfig.Builder`	`tokenEndpoint(String tokenEndpoint)`	The token endpoint of the IdP.
`AuthenticateOidcActionConfig.Builder`	`useExistingClientSecret(Boolean useExistingClientSecret)`	Indicates whether to use the existing client secret when modifying a rule.
`AuthenticateOidcActionConfig.Builder`	`userInfoEndpoint(String userInfoEndpoint)`	The user info endpoint of the IdP.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields

- Method Detail
  - issuer
```
AuthenticateOidcActionConfig.Builder issuer(String issuer)
```
    The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    issuer - The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - authorizationEndpoint
```
AuthenticateOidcActionConfig.Builder authorizationEndpoint(String authorizationEndpoint)
```
    The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    authorizationEndpoint - The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tokenEndpoint
```
AuthenticateOidcActionConfig.Builder tokenEndpoint(String tokenEndpoint)
```
    The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    tokenEndpoint - The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - userInfoEndpoint
```
AuthenticateOidcActionConfig.Builder userInfoEndpoint(String userInfoEndpoint)
```
    The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Parameters:
    
    userInfoEndpoint - The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - clientId
```
AuthenticateOidcActionConfig.Builder clientId(String clientId)
```
    The OAuth 2.0 client identifier.
    
    Parameters:
    
    clientId - The OAuth 2.0 client identifier.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - clientSecret
```
AuthenticateOidcActionConfig.Builder clientSecret(String clientSecret)
```
    The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
    
    Parameters:
    
    clientSecret - The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sessionCookieName
```
AuthenticateOidcActionConfig.Builder sessionCookieName(String sessionCookieName)
```
    The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
    
    Parameters:
    
    sessionCookieName - The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - scope
```
AuthenticateOidcActionConfig.Builder scope(String scope)
```
    The set of user claims to be requested from the IdP. The default is openid.
    
    To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
    
    Parameters:
    
    scope - The set of user claims to be requested from the IdP. The default is openid.
    
    To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - sessionTimeout
```
AuthenticateOidcActionConfig.Builder sessionTimeout(Long sessionTimeout)
```
    The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
    
    Parameters:
    
    sessionTimeout - The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - authenticationRequestExtraParams
```
AuthenticateOidcActionConfig.Builder authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)
```
    The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
    
    Parameters:
    
    authenticationRequestExtraParams - The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - onUnauthenticatedRequest
```
AuthenticateOidcActionConfig.Builder onUnauthenticatedRequest(String onUnauthenticatedRequest)
```
    The behavior if the user is not authenticated. The following are possible values:
    
    deny- Return an HTTP 401 Unauthorized error.
    allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.
    Parameters: onUnauthenticatedRequest - The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Returns: Returns a reference to this object so that method calls can be chained together. See Also: AuthenticateOidcActionConditionalBehaviorEnum, AuthenticateOidcActionConditionalBehaviorEnum
  onUnauthenticatedRequest AuthenticateOidcActionConfig.Builder onUnauthenticatedRequest(AuthenticateOidcActionConditionalBehaviorEnum onUnauthenticatedRequest) The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Parameters: onUnauthenticatedRequest - The behavior if the user is not authenticated. The following are possible values: deny - Return an HTTP 401 Unauthorized error. allow - Allow the request to be forwarded to the target. authenticate - Redirect the request to the IdP authorization endpoint. This is the default value. Returns: Returns a reference to this object so that method calls can be chained together. See Also: AuthenticateOidcActionConditionalBehaviorEnum, AuthenticateOidcActionConditionalBehaviorEnum useExistingClientSecret AuthenticateOidcActionConfig.Builder useExistingClientSecret(Boolean useExistingClientSecret) Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false. Parameters: useExistingClientSecret - Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false. Returns: Returns a reference to this object so that method calls can be chained together.

Interface AuthenticateOidcActionConfig.Builder

Method Summary

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

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

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Method Detail

issuer

authorizationEndpoint

tokenEndpoint

userInfoEndpoint

clientId

clientSecret

sessionCookieName

scope

sessionTimeout

authenticationRequestExtraParams

onUnauthenticatedRequest

onUnauthenticatedRequest

useExistingClientSecret