Package software.amazon.awscdk.services.elasticloadbalancingv2

Class CfnListenerRule.AuthenticateOidcConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerRule.AuthenticateOidcConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnListenerRule.AuthenticateOidcConfigProperty>

Enclosing interface:

CfnListenerRule.AuthenticateOidcConfigProperty

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

A builder for CfnListenerRule.AuthenticateOidcConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getAuthenticationRequestExtraParams()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	authenticationRequestExtraParams(IResolvable authenticationRequestExtraParams)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getAuthenticationRequestExtraParams()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	authorizationEndpoint(String authorizationEndpoint)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getAuthorizationEndpoint()
CfnListenerRule.AuthenticateOidcConfigProperty	build()	Builds the configured instance.
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	clientId(String clientId)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getClientId()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	clientSecret(String clientSecret)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getClientSecret()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	issuer(String issuer)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getIssuer()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	onUnauthenticatedRequest(String onUnauthenticatedRequest)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getOnUnauthenticatedRequest()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	scope(String scope)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getScope()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	sessionCookieName(String sessionCookieName)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getSessionCookieName()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	sessionTimeout(Number sessionTimeout)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getSessionTimeout()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	tokenEndpoint(String tokenEndpoint)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getTokenEndpoint()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	useExistingClientSecret(Boolean useExistingClientSecret)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getUseExistingClientSecret()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	useExistingClientSecret(IResolvable useExistingClientSecret)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getUseExistingClientSecret()
CfnListenerRule.AuthenticateOidcConfigProperty.Builder	userInfoEndpoint(String userInfoEndpoint)	Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.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 CfnListenerRule.AuthenticateOidcConfigProperty.Builder authorizationEndpoint(String authorizationEndpoint)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.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 CfnListenerRule.AuthenticateOidcConfigProperty.Builder clientId(String clientId)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getClientId()

Parameters:

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

Returns:

this

issuer

@Stability(Stable)
public CfnListenerRule.AuthenticateOidcConfigProperty.Builder issuer(String issuer)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.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

tokenEndpoint

@Stability(Stable)
public CfnListenerRule.AuthenticateOidcConfigProperty.Builder tokenEndpoint(String tokenEndpoint)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.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 CfnListenerRule.AuthenticateOidcConfigProperty.Builder userInfoEndpoint(String userInfoEndpoint)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.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

authenticationRequestExtraParams

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

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getAuthenticationRequestExtraParams()

Parameters:

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

Returns:

this

authenticationRequestExtraParams

@Stability(Stable)
public CfnListenerRule.AuthenticateOidcConfigProperty.Builder authenticationRequestExtraParams(IResolvable authenticationRequestExtraParams)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getAuthenticationRequestExtraParams()

Parameters:

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

Returns:

this

clientSecret

@Stability(Stable)
public CfnListenerRule.AuthenticateOidcConfigProperty.Builder clientSecret(String clientSecret)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getClientSecret()

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:

this

onUnauthenticatedRequest

@Stability(Stable)
public CfnListenerRule.AuthenticateOidcConfigProperty.Builder onUnauthenticatedRequest(String onUnauthenticatedRequest)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getOnUnauthenticatedRequest()

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:

this

scope

@Stability(Stable)
public CfnListenerRule.AuthenticateOidcConfigProperty.Builder scope(String scope)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getScope()

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:

this

sessionCookieName

@Stability(Stable)
public CfnListenerRule.AuthenticateOidcConfigProperty.Builder sessionCookieName(String sessionCookieName)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getSessionCookieName()

Parameters:

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

Returns:

this

sessionTimeout

@Stability(Stable)
public CfnListenerRule.AuthenticateOidcConfigProperty.Builder sessionTimeout(Number sessionTimeout)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getSessionTimeout()

Parameters:

sessionTimeout - The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

Returns:

this

useExistingClientSecret

@Stability(Stable)
public CfnListenerRule.AuthenticateOidcConfigProperty.Builder useExistingClientSecret(Boolean useExistingClientSecret)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getUseExistingClientSecret()

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:

this

useExistingClientSecret

@Stability(Stable)
public CfnListenerRule.AuthenticateOidcConfigProperty.Builder useExistingClientSecret(IResolvable useExistingClientSecret)

Sets the value of CfnListenerRule.AuthenticateOidcConfigProperty.getUseExistingClientSecret()

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:

this

build

@Stability(Stable)
public CfnListenerRule.AuthenticateOidcConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnListenerRule.AuthenticateOidcConfigProperty>

Returns:

a new instance of CfnListenerRule.AuthenticateOidcConfigProperty

Throws:

NullPointerException - if any required attribute was not provided