Package software.amazon.awscdk.services.elasticloadbalancingv2

Interface CfnListenerRule.AuthenticateOidcConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnListenerRule.AuthenticateOidcConfigProperty.Jsii$Proxy

Enclosing class:

CfnListenerRule

@Stability(Stable)
public static interface CfnListenerRule.AuthenticateOidcConfigProperty
extends software.amazon.jsii.JsiiSerializable

Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 AuthenticateOidcConfigProperty authenticateOidcConfigProperty = AuthenticateOidcConfigProperty.builder()
         .authorizationEndpoint("authorizationEndpoint")
         .clientId("clientId")
         .issuer("issuer")
         .tokenEndpoint("tokenEndpoint")
         .userInfoEndpoint("userInfoEndpoint")
         // the properties below are optional
         .authenticationRequestExtraParams(Map.of(
                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
         .clientSecret("clientSecret")
         .onUnauthenticatedRequest("onUnauthenticatedRequest")
         .scope("scope")
         .sessionCookieName("sessionCookieName")
         .sessionTimeout(123)
         .useExistingClientSecret(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnListenerRule.AuthenticateOidcConfigProperty.Builder	A builder for CfnListenerRule.AuthenticateOidcConfigProperty
static final class	CfnListenerRule.AuthenticateOidcConfigProperty.Jsii$Proxy	An implementation for CfnListenerRule.AuthenticateOidcConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnListenerRule.AuthenticateOidcConfigProperty.Builder	builder()
default Object	getAuthenticationRequestExtraParams()	The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
String	getAuthorizationEndpoint()	The authorization endpoint of the IdP.
String	getClientId()	The OAuth 2.0 client identifier.
default String	getClientSecret()	The OAuth 2.0 client secret.
String	getIssuer()	The OIDC issuer identifier of the IdP.
default String	getOnUnauthenticatedRequest()	The behavior if the user is not authenticated.
default String	getScope()	The set of user claims to be requested from the IdP.
default String	getSessionCookieName()	The name of the cookie used to maintain session information.
default Number	getSessionTimeout()	The maximum duration of the authentication session, in seconds.
String	getTokenEndpoint()	The token endpoint of the IdP.
default Object	getUseExistingClientSecret()	Indicates whether to use the existing client secret when modifying a rule.
String	getUserInfoEndpoint()	The user info endpoint of the IdP.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizationEndpoint

@Stability(Stable)
@NotNull
String getAuthorizationEndpoint()

The authorization endpoint of the IdP.

This must be a full URL, including the HTTPS protocol, the domain, and the path.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-authorizationendpoint

getClientId

@Stability(Stable)
@NotNull
String getClientId()

The OAuth 2.0 client identifier.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-clientid

getIssuer

@Stability(Stable)
@NotNull
String getIssuer()

The OIDC issuer identifier of the IdP.

This must be a full URL, including the HTTPS protocol, the domain, and the path.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-issuer

getTokenEndpoint

@Stability(Stable)
@NotNull
String getTokenEndpoint()

The token endpoint of the IdP.

This must be a full URL, including the HTTPS protocol, the domain, and the path.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-tokenendpoint

getUserInfoEndpoint

@Stability(Stable)
@NotNull
String getUserInfoEndpoint()

The user info endpoint of the IdP.

This must be a full URL, including the HTTPS protocol, the domain, and the path.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-userinfoendpoint

getAuthenticationRequestExtraParams

@Stability(Stable)
@Nullable
default Object getAuthenticationRequestExtraParams()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-authenticationrequestextraparams

getClientSecret

@Stability(Stable)
@Nullable
default String getClientSecret()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-clientsecret

getOnUnauthenticatedRequest

@Stability(Stable)
@Nullable
default String getOnUnauthenticatedRequest()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-onunauthenticatedrequest

getScope

@Stability(Stable)
@Nullable
default String getScope()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-scope

getSessionCookieName

@Stability(Stable)
@Nullable
default String getSessionCookieName()

The name of the cookie used to maintain session information.

The default is AWSELBAuthSessionCookie.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-sessioncookiename

getSessionTimeout

@Stability(Stable)
@Nullable
default Number getSessionTimeout()

The maximum duration of the authentication session, in seconds.

The default is 604800 seconds (7 days).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-sessiontimeout

getUseExistingClientSecret

@Stability(Stable)
@Nullable
default Object getUseExistingClientSecret()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listenerrule-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listenerrule-authenticateoidcconfig-useexistingclientsecret

builder

@Stability(Stable)
static CfnListenerRule.AuthenticateOidcConfigProperty.Builder builder()

Returns:

a CfnListenerRule.AuthenticateOidcConfigProperty.Builder of CfnListenerRule.AuthenticateOidcConfigProperty