public static interface CfnListener.ActionProperty
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("sessionTimeout") .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("sessionTimeout") .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()) .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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnListener.ActionProperty.Builder
A builder for
CfnListener.ActionProperty |
static class |
CfnListener.ActionProperty.Jsii$Proxy
An implementation for
CfnListener.ActionProperty |
Modifier and Type | Method and Description |
---|---|
static CfnListener.ActionProperty.Builder |
builder() |
default java.lang.Object |
getAuthenticateCognitoConfig()
[HTTPS listeners] Information for using Amazon Cognito to authenticate users.
|
default java.lang.Object |
getAuthenticateOidcConfig()
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).
|
default java.lang.Object |
getFixedResponseConfig()
[Application Load Balancer] Information for creating an action that returns a custom HTTP response.
|
default java.lang.Object |
getForwardConfig()
Information for creating an action that distributes requests among one or more target groups.
|
default java.lang.Number |
getOrder()
The order for the action.
|
default java.lang.Object |
getRedirectConfig()
[Application Load Balancer] Information for creating a redirect action.
|
default java.lang.String |
getTargetGroupArn()
The Amazon Resource Name (ARN) of the target group.
|
java.lang.String |
getType()
The type of action.
|
java.lang.String getType()
default java.lang.Object getAuthenticateCognitoConfig()
Specify only when Type
is authenticate-cognito
.
default java.lang.Object getAuthenticateOidcConfig()
Specify only when Type
is authenticate-oidc
.
default java.lang.Object getFixedResponseConfig()
Specify only when Type
is fixed-response
.
default java.lang.Object getForwardConfig()
For Network Load Balancers, you can specify a single target group. Specify only when Type
is forward
. If you specify both ForwardConfig
and TargetGroupArn
, you can specify only one target group using ForwardConfig
and it must be the same target group specified in TargetGroupArn
.
default java.lang.Number getOrder()
This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
default java.lang.Object getRedirectConfig()
Specify only when Type
is redirect
.
default java.lang.String getTargetGroupArn()
Specify only when Type
is forward
and you want to route to a single target group. To route to one or more target groups, use ForwardConfig
instead.
static CfnListener.ActionProperty.Builder builder()
CfnListener.ActionProperty.Builder
of CfnListener.ActionProperty