Class CfnListener
Creates a listener for a service.
Inherited Members
Namespace: Amazon.CDK.AWS.VpcLattice
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnListener : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnListener
Inherits CfnResource
Implements IInspectable, 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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnListener(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnListener(Construct, String, ICfnListenerProps) |
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 | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags for the listener. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnListener(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnListener(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnListener(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnListener(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnListener(Construct, String, ICfnListenerProps)
public CfnListener(Construct scope, string id, ICfnListenerProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnListenerProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the listener.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The ID of the listener.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrServiceArn
The Amazon Resource Name (ARN) of the service.
public virtual string AttrServiceArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ServiceArn
AttrServiceId
The ID of the service.
public virtual string AttrServiceId { get; }
Property Value
System.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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DefaultAction
The action for the default rule.
public virtual object DefaultAction { get; set; }
Property Value
System.Object
Name
The name of the listener.
public virtual string Name { get; set; }
Property Value
System.String
Port
The listener port.
public virtual Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
Protocol
The listener protocol.
public virtual string Protocol { get; set; }
Property Value
System.String
ServiceIdentifier
The ID or Amazon Resource Name (ARN) of the service.
public virtual string ServiceIdentifier { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>