Package software.amazon.awscdk.services.vpclattice

Class CfnListener

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.vpclattice.CfnListener
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.110.0 (build 336b265)", date="2025-04-22T23:08:22.046Z") @Stability(Stable) public class CfnListener extends CfnResource implements IInspectable, ITaggable
Creates a listener for a service.

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 .

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.vpclattice.*;
 CfnListener cfnListener = CfnListener.Builder.create(this, "MyCfnListener")
         .defaultAction(DefaultActionProperty.builder()
                 .fixedResponse(FixedResponseProperty.builder()
                         .statusCode(123)
                         .build())
                 .forward(ForwardProperty.builder()
                         .targetGroups(List.of(WeightedTargetGroupProperty.builder()
                                 .targetGroupIdentifier("targetGroupIdentifier")
                                 // the properties below are optional
                                 .weight(123)
                                 .build()))
                         .build())
                 .build())
         .protocol("protocol")
         // the properties below are optional
         .name("name")
         .port(123)
         .serviceIdentifier("serviceIdentifier")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnListener

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

    • CfnListener

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

    • CfnListener

      @Stability(Stable) public CfnListener(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnListenerProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the listener.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the listener.

    • getAttrServiceArn

      @Stability(Stable) @NotNull public String getAttrServiceArn()
      The Amazon Resource Name (ARN) of the service.

    • getAttrServiceId

      @Stability(Stable) @NotNull public String getAttrServiceId()
      The ID of the service.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDefaultAction

      @Stability(Stable) @NotNull public Object getDefaultAction()
      The action for the default rule.

    • setDefaultAction

      @Stability(Stable) public void setDefaultAction(@NotNull IResolvable value)
      The action for the default rule.

    • setDefaultAction

      @Stability(Stable) public void setDefaultAction(@NotNull CfnListener.DefaultActionProperty value)
      The action for the default rule.

    • getProtocol

      @Stability(Stable) @NotNull public String getProtocol()
      The listener protocol.

    • setProtocol

      @Stability(Stable) public void setProtocol(@NotNull String value)
      The listener protocol.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the listener.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the listener.

    • getPort

      @Stability(Stable) @Nullable public Number getPort()
      The listener port.

    • setPort

      @Stability(Stable) public void setPort(@Nullable Number value)
      The listener port.

    • getServiceIdentifier

      @Stability(Stable) @Nullable public String getServiceIdentifier()
      The ID or ARN of the service.

    • setServiceIdentifier

      @Stability(Stable) public void setServiceIdentifier(@Nullable String value)
      The ID or ARN of the service.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags for the listener.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags for the listener.