Class CfnListener

Creates a listener for a service.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnListener
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.VpcLattice
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnListener : CfnResource, IInspectable, IListenerRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnListener Inherits CfnResource Implements IInspectable, IListenerRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

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 cfnListener = new CfnListener(this, "MyCfnListener", 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

Constructors

CfnListener(Construct, string, ICfnListenerProps)

Create a new AWS::VpcLattice::Listener.

Properties

AttrArn

The Amazon Resource Name (ARN) of the listener.
AttrId

The ID of the listener.
AttrServiceArn

The Amazon Resource Name (ARN) of the service.
AttrServiceId

The ID of the service.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

Creates a listener for a service.
DefaultAction

The action for the default rule.
ListenerRef

A reference to a Listener resource.
Name

The name of the listener.
Port

The listener port.
Protocol

The listener protocol.
ServiceIdentifier

The ID or ARN of the service.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

The tags for the listener.

Methods

ArnForListener(IListenerRef)

Creates a listener for a service.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnListener(object)

Checks whether the given object is a CfnListener.
RenderProperties(IDictionary<string, object>)

Creates a listener for a service.

Constructors

CfnListener(Construct, string, ICfnListenerProps)

Create a new AWS::VpcLattice::Listener.

public CfnListener(Construct scope, string id, ICfnListenerProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnListenerProps

Resource properties.

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the listener.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrId

The ID of the listener.

public virtual string AttrId { get; }
Property Value

string

Remarks

CloudformationAttribute: Id

AttrServiceArn

The Amazon Resource Name (ARN) of the service.

public virtual string AttrServiceArn { get; }
Property Value

string

Remarks

CloudformationAttribute: ServiceArn

AttrServiceId

The ID of the service.

public virtual string AttrServiceId { get; }
Property Value

string

Remarks

CloudformationAttribute: ServiceId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

CfnProperties

Creates a listener for a service.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

DefaultAction

The action for the default rule.

public virtual object DefaultAction { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnListener.IDefaultActionProperty

ListenerRef

A reference to a Listener resource.

public virtual IListenerReference ListenerRef { get; }
Property Value

IListenerReference

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

Name

The name of the listener.

public virtual string? Name { get; set; }
Property Value

string

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

Port

The listener port.

public virtual double? Port { get; set; }
Property Value

double?

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

Protocol

The listener protocol.

public virtual string Protocol { get; set; }
Property Value

string

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

ServiceIdentifier

The ID or ARN of the service.

public virtual string? ServiceIdentifier { get; set; }
Property Value

string

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

TagsRaw

The tags for the listener.

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

Methods

ArnForListener(IListenerRef)

Creates a listener for a service.

public static string ArnForListener(IListenerRef resource)
Parameters
resource IListenerRef
Returns

string

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

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 cfnListener = new CfnListener(this, "MyCfnListener", 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"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

IsCfnListener(object)

Checks whether the given object is a CfnListener.

public static bool IsCfnListener(object x)
Parameters
x object
Returns

bool

Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a listener for a service.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide .

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

CloudformationResource: AWS::VpcLattice::Listener

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable