Package software.amazon.awscdk.services.elasticloadbalancingv2

Class AuthenticateOidcOptions.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.AuthenticateOidcOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AuthenticateOidcOptions>

Enclosing interface:

AuthenticateOidcOptions

@Stability(Stable)
public static final class AuthenticateOidcOptions.Builder
extends Object
implements software.amazon.jsii.Builder<AuthenticateOidcOptions>

A builder for AuthenticateOidcOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AuthenticateOidcOptions.Builder	allowHttpsOutbound(Boolean allowHttpsOutbound)	Sets the value of AuthenticateOidcOptions.getAllowHttpsOutbound()
AuthenticateOidcOptions.Builder	authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)	Sets the value of AuthenticateOidcOptions.getAuthenticationRequestExtraParams()
AuthenticateOidcOptions.Builder	authorizationEndpoint(String authorizationEndpoint)	Sets the value of AuthenticateOidcOptions.getAuthorizationEndpoint()
AuthenticateOidcOptions	build()	Builds the configured instance.
AuthenticateOidcOptions.Builder	clientId(String clientId)	Sets the value of AuthenticateOidcOptions.getClientId()
AuthenticateOidcOptions.Builder	clientSecret(SecretValue clientSecret)	Sets the value of AuthenticateOidcOptions.getClientSecret()
AuthenticateOidcOptions.Builder	issuer(String issuer)	Sets the value of AuthenticateOidcOptions.getIssuer()
AuthenticateOidcOptions.Builder	next(ListenerAction next)	Sets the value of AuthenticateOidcOptions.getNext()
AuthenticateOidcOptions.Builder	onUnauthenticatedRequest(UnauthenticatedAction onUnauthenticatedRequest)	Sets the value of AuthenticateOidcOptions.getOnUnauthenticatedRequest()
AuthenticateOidcOptions.Builder	scope(String scope)	Sets the value of AuthenticateOidcOptions.getScope()
AuthenticateOidcOptions.Builder	sessionCookieName(String sessionCookieName)	Sets the value of AuthenticateOidcOptions.getSessionCookieName()
AuthenticateOidcOptions.Builder	sessionTimeout(Duration sessionTimeout)	Sets the value of AuthenticateOidcOptions.getSessionTimeout()
AuthenticateOidcOptions.Builder	tokenEndpoint(String tokenEndpoint)	Sets the value of AuthenticateOidcOptions.getTokenEndpoint()
AuthenticateOidcOptions.Builder	userInfoEndpoint(String userInfoEndpoint)	Sets the value of AuthenticateOidcOptions.getUserInfoEndpoint()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

authorizationEndpoint

@Stability(Stable)
public AuthenticateOidcOptions.Builder authorizationEndpoint(String authorizationEndpoint)

Sets the value of AuthenticateOidcOptions.getAuthorizationEndpoint()

Parameters:

authorizationEndpoint - The authorization endpoint of the IdP. This parameter is required. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Returns:

this

clientId

@Stability(Stable)
public AuthenticateOidcOptions.Builder clientId(String clientId)

Sets the value of AuthenticateOidcOptions.getClientId()

Parameters:

clientId - The OAuth 2.0 client identifier. This parameter is required.

Returns:

this

clientSecret

@Stability(Stable)
public AuthenticateOidcOptions.Builder clientSecret(SecretValue clientSecret)

Sets the value of AuthenticateOidcOptions.getClientSecret()

Parameters:

clientSecret - The OAuth 2.0 client secret. This parameter is required.

Returns:

this

issuer

@Stability(Stable)
public AuthenticateOidcOptions.Builder issuer(String issuer)

Sets the value of AuthenticateOidcOptions.getIssuer()

Parameters:

issuer - The OIDC issuer identifier of the IdP. This parameter is required. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Returns:

this

next

@Stability(Stable)
public AuthenticateOidcOptions.Builder next(ListenerAction next)

Sets the value of AuthenticateOidcOptions.getNext()

Parameters:

next - What action to execute next. This parameter is required.

Returns:

this

tokenEndpoint

@Stability(Stable)
public AuthenticateOidcOptions.Builder tokenEndpoint(String tokenEndpoint)

Sets the value of AuthenticateOidcOptions.getTokenEndpoint()

Parameters:

tokenEndpoint - The token endpoint of the IdP. This parameter is required. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Returns:

this

userInfoEndpoint

@Stability(Stable)
public AuthenticateOidcOptions.Builder userInfoEndpoint(String userInfoEndpoint)

Sets the value of AuthenticateOidcOptions.getUserInfoEndpoint()

Parameters:

userInfoEndpoint - The user info endpoint of the IdP. This parameter is required. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Returns:

this

allowHttpsOutbound

@Stability(Stable)
public AuthenticateOidcOptions.Builder allowHttpsOutbound(Boolean allowHttpsOutbound)

Sets the value of AuthenticateOidcOptions.getAllowHttpsOutbound()

Parameters:

allowHttpsOutbound - Allow HTTPS outbound traffic to communicate with the IdP. Set this property to false if the IP address used for the IdP endpoint is identifiable and you want to control outbound traffic. Then allow HTTPS outbound traffic to the IdP's IP address using the listener's connections property.

Returns:

this

authenticationRequestExtraParams

@Stability(Stable)
public AuthenticateOidcOptions.Builder authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)

Sets the value of AuthenticateOidcOptions.getAuthenticationRequestExtraParams()

Parameters:

authenticationRequestExtraParams - The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

Returns:

this

onUnauthenticatedRequest

@Stability(Stable)
public AuthenticateOidcOptions.Builder onUnauthenticatedRequest(UnauthenticatedAction onUnauthenticatedRequest)

Sets the value of AuthenticateOidcOptions.getOnUnauthenticatedRequest()

Parameters:

onUnauthenticatedRequest - The behavior if the user is not authenticated.

Returns:

this

scope

@Stability(Stable)
public AuthenticateOidcOptions.Builder scope(String scope)

Sets the value of AuthenticateOidcOptions.getScope()

Parameters:

scope - The set of user claims to be requested from the IdP. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

Returns:

this

sessionCookieName

@Stability(Stable)
public AuthenticateOidcOptions.Builder sessionCookieName(String sessionCookieName)

Sets the value of AuthenticateOidcOptions.getSessionCookieName()

Parameters:

sessionCookieName - The name of the cookie used to maintain session information.

Returns:

this

sessionTimeout

@Stability(Stable)
public AuthenticateOidcOptions.Builder sessionTimeout(Duration sessionTimeout)

Sets the value of AuthenticateOidcOptions.getSessionTimeout()

Parameters:

sessionTimeout - The maximum duration of the authentication session.

Returns:

this

build

@Stability(Stable)
public AuthenticateOidcOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AuthenticateOidcOptions>

Returns:

a new instance of AuthenticateOidcOptions

Throws:

NullPointerException - if any required attribute was not provided