Interface CfnListenerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnListenerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-19T18:25:58.908Z")
@Stability(Stable)
public interface CfnListenerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnListener.

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.*;
 CfnListenerProps cfnListenerProps = CfnListenerProps.builder()
         .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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnListenerProps.Builder	A builder for CfnListenerProps
static final class	CfnListenerProps.Jsii$Proxy	An implementation for CfnListenerProps

Method Summary

Modifier and Type	Method	Description
static CfnListenerProps.Builder	builder()
Object	getDefaultAction()	The action for the default rule.
default String	getName()	The name of the listener.
default Number	getPort()	The listener port.
String	getProtocol()	The listener protocol.
default String	getServiceIdentifier()	The ID or ARN of the service.
default List<CfnTag>	getTags()	The tags for the listener.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultAction

@Stability(Stable)
@NotNull
Object getDefaultAction()

The action for the default rule.

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

See Also:

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

getProtocol

@Stability(Stable)
@NotNull
String getProtocol()

The listener protocol.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the listener.

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 Also:

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

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The listener port.

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

See Also:

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

getServiceIdentifier

@Stability(Stable)
@Nullable
default String getServiceIdentifier()

The ID or ARN of the service.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags for the listener.

See Also:

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

builder

@Stability(Stable)
static CfnListenerProps.Builder builder()

Returns:

a CfnListenerProps.Builder of CfnListenerProps