Package software.amazon.awscdk.services.vpclattice

Class CfnListener.Builder

java.lang.Object

software.amazon.awscdk.services.vpclattice.CfnListener.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnListener>

Enclosing class:

CfnListener

@Stability(Stable)
public static final class CfnListener.Builder
extends Object
implements software.amazon.jsii.Builder<CfnListener>

A fluent builder for CfnListener.

Method Summary

Modifier and Type	Method	Description
CfnListener	build()
static CfnListener.Builder	create(software.constructs.Construct scope, String id)
CfnListener.Builder	defaultAction(IResolvable defaultAction)	The action for the default rule.
CfnListener.Builder	defaultAction(CfnListener.DefaultActionProperty defaultAction)	The action for the default rule.
CfnListener.Builder	name(String name)	The name of the listener.
CfnListener.Builder	port(Number port)	The listener port.
CfnListener.Builder	protocol(String protocol)	The listener protocol.
CfnListener.Builder	serviceIdentifier(String serviceIdentifier)	The ID or ARN of the service.
CfnListener.Builder	tags(List<? extends CfnTag> tags)	The tags for the listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnListener.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnListener.Builder.

defaultAction

@Stability(Stable)
public CfnListener.Builder defaultAction(IResolvable defaultAction)

The action for the default rule.

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

Parameters:

defaultAction - The action for the default rule. This parameter is required.

Returns:

this

See Also:

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

defaultAction

@Stability(Stable)
public CfnListener.Builder defaultAction(CfnListener.DefaultActionProperty defaultAction)

The action for the default rule.

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

Parameters:

defaultAction - The action for the default rule. This parameter is required.

Returns:

this

See Also:

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

protocol

@Stability(Stable)
public CfnListener.Builder protocol(String protocol)

The listener protocol.

Parameters:

protocol - The listener protocol. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnListener.Builder name(String name)

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.

Parameters:

name - The name of the listener. This parameter is required.

Returns:

this

See Also:

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

port

@Stability(Stable)
public CfnListener.Builder port(Number port)

The listener port.

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

Parameters:

port - The listener port. This parameter is required.

Returns:

this

See Also:

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

serviceIdentifier

@Stability(Stable)
public CfnListener.Builder serviceIdentifier(String serviceIdentifier)

The ID or ARN of the service.

Parameters:

serviceIdentifier - The ID or ARN of the service. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnListener.Builder tags(List<? extends CfnTag> tags)

The tags for the listener.

Parameters:

tags - The tags for the listener. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnListener build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnListener>

Returns:

a newly built instance of CfnListener.