software.amazon.awscdk.services.elasticloadbalancingv2

Interface CfnListenerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnListenerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:06.454Z")
 @Stability(value=Stable)
public interface CfnListenerProps
extends software.amazon.jsii.JsiiSerializable

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

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.*;
 CfnListenerProps cfnListenerProps = CfnListenerProps.builder()
         .defaultActions(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("sessionTimeout")
                         .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("sessionTimeout")
                         .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()))
         .loadBalancerArn("loadBalancerArn")
         // the properties below are optional
         .alpnPolicy(List.of("alpnPolicy"))
         .certificates(List.of(CertificateProperty.builder()
                 .certificateArn("certificateArn")
                 .build()))
         .port(123)
         .protocol("protocol")
         .sslPolicy("sslPolicy")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnListenerProps.Builder	builder()
default List<String>	getAlpnPolicy() `AWS::ElasticLoadBalancingV2::Listener.AlpnPolicy`.
default Object	getCertificates() `AWS::ElasticLoadBalancingV2::Listener.Certificates`.
Object	getDefaultActions() `AWS::ElasticLoadBalancingV2::Listener.DefaultActions`.
String	getLoadBalancerArn() `AWS::ElasticLoadBalancingV2::Listener.LoadBalancerArn`.
default Number	getPort() `AWS::ElasticLoadBalancingV2::Listener.Port`.
default String	getProtocol() `AWS::ElasticLoadBalancingV2::Listener.Protocol`.
default String	getSslPolicy() `AWS::ElasticLoadBalancingV2::Listener.SslPolicy`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAlpnPolicy

@Stability(value=Stable)
 @Nullable
default List<String> getAlpnPolicy()

`AWS::ElasticLoadBalancingV2::Listener.AlpnPolicy`.

getCertificates

@Stability(value=Stable)
 @Nullable
default Object getCertificates()

`AWS::ElasticLoadBalancingV2::Listener.Certificates`.

getDefaultActions

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

`AWS::ElasticLoadBalancingV2::Listener.DefaultActions`.

getLoadBalancerArn

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

`AWS::ElasticLoadBalancingV2::Listener.LoadBalancerArn`.

getPort

@Stability(value=Stable)
 @Nullable
default Number getPort()

`AWS::ElasticLoadBalancingV2::Listener.Port`.

getProtocol

@Stability(value=Stable)
 @Nullable
default String getProtocol()

`AWS::ElasticLoadBalancingV2::Listener.Protocol`.

getSslPolicy

@Stability(value=Stable)
 @Nullable
default String getSslPolicy()

`AWS::ElasticLoadBalancingV2::Listener.SslPolicy`.

builder

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

Returns:

a CfnListenerProps.Builder of CfnListenerProps