software.amazon.awscdk.services.elasticloadbalancingv2

Interface CfnListenerRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnListenerRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.547Z")
 @Stability(value=Stable)
public interface CfnListenerRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::ElasticLoadBalancingV2::ListenerRule`.

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.*;
 CfnListenerRuleProps cfnListenerRuleProps = CfnListenerRuleProps.builder()
         .actions(List.of(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")
                         .clientSecret("clientSecret")
                         .issuer("issuer")
                         .tokenEndpoint("tokenEndpoint")
                         .userInfoEndpoint("userInfoEndpoint")
                         // the properties below are optional
                         .authenticationRequestExtraParams(Map.of(
                                 "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams"))
                         .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())
                 .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()))
         .conditions(List.of(RuleConditionProperty.builder()
                 .field("field")
                 .hostHeaderConfig(HostHeaderConfigProperty.builder()
                         .values(List.of("values"))
                         .build())
                 .httpHeaderConfig(HttpHeaderConfigProperty.builder()
                         .httpHeaderName("httpHeaderName")
                         .values(List.of("values"))
                         .build())
                 .httpRequestMethodConfig(HttpRequestMethodConfigProperty.builder()
                         .values(List.of("values"))
                         .build())
                 .pathPatternConfig(PathPatternConfigProperty.builder()
                         .values(List.of("values"))
                         .build())
                 .queryStringConfig(QueryStringConfigProperty.builder()
                         .values(List.of(QueryStringKeyValueProperty.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build())
                 .sourceIpConfig(SourceIpConfigProperty.builder()
                         .values(List.of("values"))
                         .build())
                 .values(List.of("values"))
                 .build()))
         .listenerArn("listenerArn")
         .priority(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnListenerRuleProps.Builder	builder()
Object	getActions() `AWS::ElasticLoadBalancingV2::ListenerRule.Actions`.
Object	getConditions() `AWS::ElasticLoadBalancingV2::ListenerRule.Conditions`.
String	getListenerArn() `AWS::ElasticLoadBalancingV2::ListenerRule.ListenerArn`.
Number	getPriority() `AWS::ElasticLoadBalancingV2::ListenerRule.Priority`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getActions

@Stability(value=Stable)
 @NotNull
Object getActions()

`AWS::ElasticLoadBalancingV2::ListenerRule.Actions`.

getConditions

@Stability(value=Stable)
 @NotNull
Object getConditions()

`AWS::ElasticLoadBalancingV2::ListenerRule.Conditions`.

getListenerArn

@Stability(value=Stable)
 @NotNull
String getListenerArn()

`AWS::ElasticLoadBalancingV2::ListenerRule.ListenerArn`.

getPriority

@Stability(value=Stable)
 @NotNull
Number getPriority()

`AWS::ElasticLoadBalancingV2::ListenerRule.Priority`.

builder

@Stability(value=Stable)
static CfnListenerRuleProps.Builder builder()

Returns:

a CfnListenerRuleProps.Builder of CfnListenerRuleProps