Interface ICfnListenerProps

Properties for defining a CfnListener.

Namespace: Amazon.CDK.AWS.VpcLattice

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnListenerProps

Syntax (vb)

Public Interface ICfnListenerProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.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.VpcLattice;

var cfnListenerProps = new CfnListenerProps {
    DefaultAction = new DefaultActionProperty {
        FixedResponse = new FixedResponseProperty {
            StatusCode = 123
        },
        Forward = new ForwardProperty {
            TargetGroups = new [] { new WeightedTargetGroupProperty {
                TargetGroupIdentifier = "targetGroupIdentifier",

                // the properties below are optional
                Weight = 123
            } }
        }
    },
    Protocol = "protocol",

    // the properties below are optional
    Name = "name",
    Port = 123,
    ServiceIdentifier = "serviceIdentifier",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Properties

DefaultAction	The action for the default rule.
Name	The name of the listener.
Port	The listener port.
Protocol	The listener protocol.
ServiceIdentifier	The ID or Amazon Resource Name (ARN) of the service.
Tags	The tags for the listener.

Properties

DefaultAction

The action for the default rule.

object DefaultAction { get; }

Property Value

System.Object

Remarks

Each listener has a default rule. The default rule is used if no other rules match.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-defaultaction

Name

The name of the listener.

virtual string Name { get; }

Property Value

System.String

Remarks

A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-name

Port

The listener port.

virtual Nullable<double> Port { get; }

Property Value

System.Nullable<System.Double>

Remarks

You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-port

Protocol

The listener protocol.

string Protocol { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-protocol

ServiceIdentifier

The ID or Amazon Resource Name (ARN) of the service.

virtual string ServiceIdentifier { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-listener.html#cfn-vpclattice-listener-serviceidentifier