Interface CfnListenerRule.ActionProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnListenerRule.ActionProperty.Jsii$Proxy
- Enclosing class:
CfnListenerRule
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.*;
ActionProperty actionProperty = ActionProperty.builder()
.type("type")
// the properties below are optional
.authenticateCognitoConfig(AuthenticateCognitoConfigProperty.builder()
.userPoolArn("userPoolArn")
.userPoolClientId("userPoolClientId")
.userPoolDomain("userPoolDomain")
// the properties below are optional
.authenticationRequestExtraParams(Map.of(
"authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
.onUnauthenticatedRequest("onUnauthenticatedRequest")
.scope("scope")
.sessionCookieName("sessionCookieName")
.sessionTimeout(123)
.build())
.authenticateOidcConfig(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())
.fixedResponseConfig(FixedResponseConfigProperty.builder()
.statusCode("statusCode")
// the properties below are optional
.contentType("contentType")
.messageBody("messageBody")
.build())
.forwardConfig(ForwardConfigProperty.builder()
.targetGroups(List.of(TargetGroupTupleProperty.builder()
.targetGroupArn("targetGroupArn")
.weight(123)
.build()))
.targetGroupStickinessConfig(TargetGroupStickinessConfigProperty.builder()
.durationSeconds(123)
.enabled(false)
.build())
.build())
.jwtValidationConfig(JwtValidationConfigProperty.builder()
.issuer("issuer")
.jwksEndpoint("jwksEndpoint")
// the properties below are optional
.additionalClaims(List.of(JwtValidationActionAdditionalClaimProperty.builder()
.format("format")
.name("name")
.values(List.of("values"))
.build()))
.build())
.order(123)
.redirectConfig(RedirectConfigProperty.builder()
.statusCode("statusCode")
// the properties below are optional
.host("host")
.path("path")
.port("port")
.protocol("protocol")
.query("query")
.build())
.targetGroupArn("targetGroupArn")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnListenerRule.ActionPropertystatic final classAn implementation forCfnListenerRule.ActionProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default Object[HTTPS listeners] Information for using Amazon Cognito to authenticate users.default Object[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).default Object[Application Load Balancer] Information for creating an action that returns a custom HTTP response.default ObjectInformation for creating an action that distributes requests among multiple target groups.default Object[HTTPS listeners] Information for validating JWT access tokens in client requests.default NumbergetOrder()The order for the action.default Object[Application Load Balancer] Information for creating a redirect action.default StringThe Amazon Resource Name (ARN) of the target group.getType()The type of action.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getType
The type of action.- See Also:
-
getAuthenticateCognitoConfig
[HTTPS listeners] Information for using Amazon Cognito to authenticate users.Specify only when
Typeisauthenticate-cognito.Returns union: either
IResolvableorCfnListenerRule.AuthenticateCognitoConfigProperty- See Also:
-
getAuthenticateOidcConfig
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).Specify only when
Typeisauthenticate-oidc.Returns union: either
IResolvableorCfnListenerRule.AuthenticateOidcConfigProperty- See Also:
-
getFixedResponseConfig
[Application Load Balancer] Information for creating an action that returns a custom HTTP response.Specify only when
Typeisfixed-response.Returns union: either
IResolvableorCfnListenerRule.FixedResponseConfigProperty- See Also:
-
getForwardConfig
Information for creating an action that distributes requests among multiple target groups. Specify only whenTypeisforward.If you specify both
ForwardConfigandTargetGroupArn, you can specify only one target group usingForwardConfigand it must be the same target group specified inTargetGroupArn.Returns union: either
IResolvableorCfnListenerRule.ForwardConfigProperty- See Also:
-
getJwtValidationConfig
[HTTPS listeners] Information for validating JWT access tokens in client requests.Specify only when
Typeisjwt-validation.Returns union: either
IResolvableorCfnListenerRule.JwtValidationConfigProperty- See Also:
-
getOrder
The order for the action.This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
- See Also:
-
getRedirectConfig
[Application Load Balancer] Information for creating a redirect action.Specify only when
Typeisredirect.Returns union: either
IResolvableorCfnListenerRule.RedirectConfigProperty- See Also:
-
getTargetGroupArn
The Amazon Resource Name (ARN) of the target group.Specify only when
Typeisforwardand you want to route to a single target group. To route to multiple target groups, you must useForwardConfiginstead.- See Also:
-
builder
-