Interface CfnListener.IActionProperty

Specifies an action for a listener rule.

Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2

Assembly: Amazon.CDK.AWS.ElasticLoadBalancingV2.dll

Syntax (csharp)

public interface IActionProperty

Syntax (vb)

Public Interface IActionProperty

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElasticLoadBalancingV2;

var actionProperty = new ActionProperty {
    Type = "type",

    // the properties below are optional
    AuthenticateCognitoConfig = new AuthenticateCognitoConfigProperty {
        UserPoolArn = "userPoolArn",
        UserPoolClientId = "userPoolClientId",
        UserPoolDomain = "userPoolDomain",

        // the properties below are optional
        AuthenticationRequestExtraParams = new Dictionary<string, string> {
            { "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams" }
        },
        OnUnauthenticatedRequest = "onUnauthenticatedRequest",
        Scope = "scope",
        SessionCookieName = "sessionCookieName",
        SessionTimeout = "sessionTimeout"
    },
    AuthenticateOidcConfig = new AuthenticateOidcConfigProperty {
        AuthorizationEndpoint = "authorizationEndpoint",
        ClientId = "clientId",
        Issuer = "issuer",
        TokenEndpoint = "tokenEndpoint",
        UserInfoEndpoint = "userInfoEndpoint",

        // the properties below are optional
        AuthenticationRequestExtraParams = new Dictionary<string, string> {
            { "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams" }
        },
        ClientSecret = "clientSecret",
        OnUnauthenticatedRequest = "onUnauthenticatedRequest",
        Scope = "scope",
        SessionCookieName = "sessionCookieName",
        SessionTimeout = "sessionTimeout",
        UseExistingClientSecret = false
    },
    FixedResponseConfig = new FixedResponseConfigProperty {
        StatusCode = "statusCode",

        // the properties below are optional
        ContentType = "contentType",
        MessageBody = "messageBody"
    },
    ForwardConfig = new ForwardConfigProperty {
        TargetGroups = new [] { new TargetGroupTupleProperty {
            TargetGroupArn = "targetGroupArn",
            Weight = 123
        } },
        TargetGroupStickinessConfig = new TargetGroupStickinessConfigProperty {
            DurationSeconds = 123,
            Enabled = false
        }
    },
    Order = 123,
    RedirectConfig = new RedirectConfigProperty {
        StatusCode = "statusCode",

        // the properties below are optional
        Host = "host",
        Path = "path",
        Port = "port",
        Protocol = "protocol",
        Query = "query"
    },
    TargetGroupArn = "targetGroupArn"
};

Synopsis

Properties

AuthenticateCognitoConfig	[HTTPS listeners] Information for using Amazon Cognito to authenticate users.
AuthenticateOidcConfig	[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).
FixedResponseConfig	[Application Load Balancer] Information for creating an action that returns a custom HTTP response.
ForwardConfig	Information for creating an action that distributes requests among one or more target groups.
Order	The order for the action.
RedirectConfig	[Application Load Balancer] Information for creating a redirect action.
TargetGroupArn	The Amazon Resource Name (ARN) of the target group.
Type	The type of action.

Properties

AuthenticateCognitoConfig

[HTTPS listeners] Information for using Amazon Cognito to authenticate users.

virtual object AuthenticateCognitoConfig { get; }

Property Value

System.Object

Remarks

Specify only when Type is authenticate-cognito .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-authenticatecognitoconfig

AuthenticateOidcConfig

[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC).

virtual object AuthenticateOidcConfig { get; }

Property Value

System.Object

Remarks

Specify only when Type is authenticate-oidc .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-authenticateoidcconfig

FixedResponseConfig

[Application Load Balancer] Information for creating an action that returns a custom HTTP response.

virtual object FixedResponseConfig { get; }

Property Value

System.Object

Remarks

Specify only when Type is fixed-response .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-fixedresponseconfig

ForwardConfig

Information for creating an action that distributes requests among one or more target groups.

virtual object ForwardConfig { get; }

Property Value

System.Object

Remarks

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-forwardconfig

Order

The order for the action.

virtual Nullable<double> Order { get; }

Property Value

System.Nullable<System.Double>

Remarks

This value is required for rules with multiple actions. The action with the lowest value for order is performed first.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-order

RedirectConfig

[Application Load Balancer] Information for creating a redirect action.

virtual object RedirectConfig { get; }

Property Value

System.Object

Remarks

Specify only when Type is redirect .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-redirectconfig

TargetGroupArn

The Amazon Resource Name (ARN) of the target group.

virtual string TargetGroupArn { get; }

Property Value

System.String

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-targetgrouparn

Type

The type of action.

string Type { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-action.html#cfn-elasticloadbalancingv2-listener-action-type