@Stability(value=Stable) public static final class CfnListenerRule.AuthenticateOidcConfigProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnListenerRule.AuthenticateOidcConfigProperty>
CfnListenerRule.AuthenticateOidcConfigProperty
Constructor and Description |
---|
Builder() |
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder authorizationEndpoint(String authorizationEndpoint)
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.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder clientId(String clientId)
CfnListenerRule.AuthenticateOidcConfigProperty.getClientId()
clientId
- The OAuth 2.0 client identifier. This parameter is required.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder issuer(String issuer)
CfnListenerRule.AuthenticateOidcConfigProperty.getIssuer()
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.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder tokenEndpoint(String tokenEndpoint)
CfnListenerRule.AuthenticateOidcConfigProperty.getTokenEndpoint()
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.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder userInfoEndpoint(String userInfoEndpoint)
CfnListenerRule.AuthenticateOidcConfigProperty.getUserInfoEndpoint()
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.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder authenticationRequestExtraParams(IResolvable authenticationRequestExtraParams)
CfnListenerRule.AuthenticateOidcConfigProperty.getAuthenticationRequestExtraParams()
authenticationRequestExtraParams
- The query parameters (up to 10) to include in the redirect request to the authorization endpoint.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder authenticationRequestExtraParams(Map<String,String> authenticationRequestExtraParams)
CfnListenerRule.AuthenticateOidcConfigProperty.getAuthenticationRequestExtraParams()
authenticationRequestExtraParams
- The query parameters (up to 10) to include in the redirect request to the authorization endpoint.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder clientSecret(String clientSecret)
CfnListenerRule.AuthenticateOidcConfigProperty.getClientSecret()
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.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder onUnauthenticatedRequest(String onUnauthenticatedRequest)
onUnauthenticatedRequest
- The behavior if the user is not authenticated. The following are possible values:.
this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder scope(String scope)
CfnListenerRule.AuthenticateOidcConfigProperty.getScope()
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.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder sessionCookieName(String sessionCookieName)
CfnListenerRule.AuthenticateOidcConfigProperty.getSessionCookieName()
sessionCookieName
- The name of the cookie used to maintain session information.
The default is AWSELBAuthSessionCookie.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder sessionTimeout(Number sessionTimeout)
CfnListenerRule.AuthenticateOidcConfigProperty.getSessionTimeout()
sessionTimeout
- The maximum duration of the authentication session, in seconds.
The default is 604800 seconds (7 days).this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder useExistingClientSecret(Boolean useExistingClientSecret)
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.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty.Builder useExistingClientSecret(IResolvable useExistingClientSecret)
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.this
@Stability(value=Stable) public CfnListenerRule.AuthenticateOidcConfigProperty build()
build
in interface software.amazon.jsii.Builder<CfnListenerRule.AuthenticateOidcConfigProperty>
CfnListenerRule.AuthenticateOidcConfigProperty
NullPointerException
- if any required attribute was not providedCopyright © 2023. All rights reserved.