software.amazon.awscdk.services.elasticloadbalancingv2

Class CfnListenerRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.elasticloadbalancingv2.CfnListenerRule

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.544Z")
 @Stability(value=Stable)
public class CfnListenerRule
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 CfnListenerRule cfnListenerRule = CfnListenerRule.Builder.create(this, "MyCfnListenerRule")
         .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	Class and Description
static interface	CfnListenerRule.ActionProperty Example:
static interface	CfnListenerRule.AuthenticateCognitoConfigProperty Example:
static interface	CfnListenerRule.AuthenticateOidcConfigProperty Example:
static class	CfnListenerRule.Builder A fluent builder for CfnListenerRule.
static interface	CfnListenerRule.FixedResponseConfigProperty Example:
static interface	CfnListenerRule.ForwardConfigProperty Example:
static interface	CfnListenerRule.HostHeaderConfigProperty Example:
static interface	CfnListenerRule.HttpHeaderConfigProperty Example:
static interface	CfnListenerRule.HttpRequestMethodConfigProperty Example:
static interface	CfnListenerRule.PathPatternConfigProperty Example:
static interface	CfnListenerRule.QueryStringConfigProperty Example:
static interface	CfnListenerRule.QueryStringKeyValueProperty Example:
static interface	CfnListenerRule.RedirectConfigProperty Example:
static interface	CfnListenerRule.RuleConditionProperty Example:
static interface	CfnListenerRule.SourceIpConfigProperty Example:
static interface	CfnListenerRule.TargetGroupStickinessConfigProperty Example:
static interface	CfnListenerRule.TargetGroupTupleProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnListenerRule(software.constructs.Construct scope, String id, CfnListenerRuleProps props) Create a new `AWS::ElasticLoadBalancingV2::ListenerRule`.
protected	CfnListenerRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnListenerRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getActions() `AWS::ElasticLoadBalancingV2::ListenerRule.Actions`.
IResolvable	getAttrIsDefault()
String	getAttrRuleArn()
protected Map<String,Object>	getCfnProperties()
Object	getConditions() `AWS::ElasticLoadBalancingV2::ListenerRule.Conditions`.
String	getListenerArn() `AWS::ElasticLoadBalancingV2::ListenerRule.ListenerArn`.
Number	getPriority() `AWS::ElasticLoadBalancingV2::ListenerRule.Priority`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setActions(IResolvable value) `AWS::ElasticLoadBalancingV2::ListenerRule.Actions`.
void	setActions(List<Object> value) `AWS::ElasticLoadBalancingV2::ListenerRule.Actions`.
void	setConditions(IResolvable value) `AWS::ElasticLoadBalancingV2::ListenerRule.Conditions`.
void	setConditions(List<Object> value) `AWS::ElasticLoadBalancingV2::ListenerRule.Conditions`.
void	setListenerArn(String value) `AWS::ElasticLoadBalancingV2::ListenerRule.ListenerArn`.
void	setPriority(Number value) `AWS::ElasticLoadBalancingV2::ListenerRule.Priority`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnListenerRule

protected CfnListenerRule(software.amazon.jsii.JsiiObjectRef objRef)

CfnListenerRule

protected CfnListenerRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnListenerRule

@Stability(value=Stable)
public CfnListenerRule(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnListenerRuleProps props)

Create a new `AWS::ElasticLoadBalancingV2::ListenerRule`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getActions

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

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

setActions

@Stability(value=Stable)
public void setActions(@NotNull
                                                IResolvable value)

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

setActions

@Stability(value=Stable)
public void setActions(@NotNull
                                                List<Object> value)

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

getAttrIsDefault

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrIsDefault()

getAttrRuleArn

@Stability(value=Stable)
 @NotNull
public String getAttrRuleArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConditions

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

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

setConditions

@Stability(value=Stable)
public void setConditions(@NotNull
                                                   IResolvable value)

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

setConditions

@Stability(value=Stable)
public void setConditions(@NotNull
                                                   List<Object> value)

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

getListenerArn

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

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

setListenerArn

@Stability(value=Stable)
public void setListenerArn(@NotNull
                                                    String value)

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

getPriority

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

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

setPriority

@Stability(value=Stable)
public void setPriority(@NotNull
                                                 Number value)

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