Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. alb
  5. Listener
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.alb.Listener

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

Provides a resource to manage alb listener

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";

const fooCustomizedCfg = new volcengine.alb.CustomizedCfg("fooCustomizedCfg", {
    customizedCfgName: "acc-test-cfg1",
    description: "This is a test modify",
    customizedCfgContent: "proxy_connect_timeout 4s;proxy_request_buffering on;",
    projectName: "default",
});
const fooListener = new volcengine.alb.Listener("fooListener", {
    loadBalancerId: "alb-1iidd17v3klj474adhfrunyz9",
    listenerName: "acc-test-listener-1",
    protocol: "HTTPS",
    port: 6666,
    enabled: "on",
    certificateId: "cert-1iidd2pahdyio74adhfr9ajwg",
    caCertificateId: "cert-1iidd2r9ii0hs74adhfeodxo1",
    serverGroupId: "rsp-1g72w74y4umf42zbhq4k4hnln",
    enableHttp2: "on",
    enableQuic: "off",
    aclStatus: "on",
    aclType: "white",
    aclIds: [
        "acl-1g72w6z11ighs2zbhq4v3rvh4",
        "acl-1g72xvtt7kg002zbhq5diim3s",
    ],
    description: "acc test listener",
    customizedCfgId: fooCustomizedCfg.id,
});
Copy
import pulumi
import pulumi_volcengine as volcengine

foo_customized_cfg = volcengine.alb.CustomizedCfg("fooCustomizedCfg",
    customized_cfg_name="acc-test-cfg1",
    description="This is a test modify",
    customized_cfg_content="proxy_connect_timeout 4s;proxy_request_buffering on;",
    project_name="default")
foo_listener = volcengine.alb.Listener("fooListener",
    load_balancer_id="alb-1iidd17v3klj474adhfrunyz9",
    listener_name="acc-test-listener-1",
    protocol="HTTPS",
    port=6666,
    enabled="on",
    certificate_id="cert-1iidd2pahdyio74adhfr9ajwg",
    ca_certificate_id="cert-1iidd2r9ii0hs74adhfeodxo1",
    server_group_id="rsp-1g72w74y4umf42zbhq4k4hnln",
    enable_http2="on",
    enable_quic="off",
    acl_status="on",
    acl_type="white",
    acl_ids=[
        "acl-1g72w6z11ighs2zbhq4v3rvh4",
        "acl-1g72xvtt7kg002zbhq5diim3s",
    ],
    description="acc test listener",
    customized_cfg_id=foo_customized_cfg.id)
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/alb"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooCustomizedCfg, err := alb.NewCustomizedCfg(ctx, "fooCustomizedCfg", &alb.CustomizedCfgArgs{
			CustomizedCfgName:    pulumi.String("acc-test-cfg1"),
			Description:          pulumi.String("This is a test modify"),
			CustomizedCfgContent: pulumi.String("proxy_connect_timeout 4s;proxy_request_buffering on;"),
			ProjectName:          pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_, err = alb.NewListener(ctx, "fooListener", &alb.ListenerArgs{
			LoadBalancerId:  pulumi.String("alb-1iidd17v3klj474adhfrunyz9"),
			ListenerName:    pulumi.String("acc-test-listener-1"),
			Protocol:        pulumi.String("HTTPS"),
			Port:            pulumi.Int(6666),
			Enabled:         pulumi.String("on"),
			CertificateId:   pulumi.String("cert-1iidd2pahdyio74adhfr9ajwg"),
			CaCertificateId: pulumi.String("cert-1iidd2r9ii0hs74adhfeodxo1"),
			ServerGroupId:   pulumi.String("rsp-1g72w74y4umf42zbhq4k4hnln"),
			EnableHttp2:     pulumi.String("on"),
			EnableQuic:      pulumi.String("off"),
			AclStatus:       pulumi.String("on"),
			AclType:         pulumi.String("white"),
			AclIds: pulumi.StringArray{
				pulumi.String("acl-1g72w6z11ighs2zbhq4v3rvh4"),
				pulumi.String("acl-1g72xvtt7kg002zbhq5diim3s"),
			},
			Description:     pulumi.String("acc test listener"),
			CustomizedCfgId: fooCustomizedCfg.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooCustomizedCfg = new Volcengine.Alb.CustomizedCfg("fooCustomizedCfg", new()
    {
        CustomizedCfgName = "acc-test-cfg1",
        Description = "This is a test modify",
        CustomizedCfgContent = "proxy_connect_timeout 4s;proxy_request_buffering on;",
        ProjectName = "default",
    });

    var fooListener = new Volcengine.Alb.Listener("fooListener", new()
    {
        LoadBalancerId = "alb-1iidd17v3klj474adhfrunyz9",
        ListenerName = "acc-test-listener-1",
        Protocol = "HTTPS",
        Port = 6666,
        Enabled = "on",
        CertificateId = "cert-1iidd2pahdyio74adhfr9ajwg",
        CaCertificateId = "cert-1iidd2r9ii0hs74adhfeodxo1",
        ServerGroupId = "rsp-1g72w74y4umf42zbhq4k4hnln",
        EnableHttp2 = "on",
        EnableQuic = "off",
        AclStatus = "on",
        AclType = "white",
        AclIds = new[]
        {
            "acl-1g72w6z11ighs2zbhq4v3rvh4",
            "acl-1g72xvtt7kg002zbhq5diim3s",
        },
        Description = "acc test listener",
        CustomizedCfgId = fooCustomizedCfg.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.alb.CustomizedCfg;
import com.pulumi.volcengine.alb.CustomizedCfgArgs;
import com.pulumi.volcengine.alb.Listener;
import com.pulumi.volcengine.alb.ListenerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var fooCustomizedCfg = new CustomizedCfg("fooCustomizedCfg", CustomizedCfgArgs.builder()        
            .customizedCfgName("acc-test-cfg1")
            .description("This is a test modify")
            .customizedCfgContent("proxy_connect_timeout 4s;proxy_request_buffering on;")
            .projectName("default")
            .build());

        var fooListener = new Listener("fooListener", ListenerArgs.builder()        
            .loadBalancerId("alb-1iidd17v3klj474adhfrunyz9")
            .listenerName("acc-test-listener-1")
            .protocol("HTTPS")
            .port(6666)
            .enabled("on")
            .certificateId("cert-1iidd2pahdyio74adhfr9ajwg")
            .caCertificateId("cert-1iidd2r9ii0hs74adhfeodxo1")
            .serverGroupId("rsp-1g72w74y4umf42zbhq4k4hnln")
            .enableHttp2("on")
            .enableQuic("off")
            .aclStatus("on")
            .aclType("white")
            .aclIds(            
                "acl-1g72w6z11ighs2zbhq4v3rvh4",
                "acl-1g72xvtt7kg002zbhq5diim3s")
            .description("acc test listener")
            .customizedCfgId(fooCustomizedCfg.id())
            .build());

    }
}
Copy
resources:
  fooCustomizedCfg:
    type: volcengine:alb:CustomizedCfg
    properties:
      customizedCfgName: acc-test-cfg1
      description: This is a test modify
      customizedCfgContent: proxy_connect_timeout 4s;proxy_request_buffering on;
      projectName: default
  fooListener:
    type: volcengine:alb:Listener
    properties:
      loadBalancerId: alb-1iidd17v3klj474adhfrunyz9
      listenerName: acc-test-listener-1
      protocol: HTTPS
      port: 6666
      enabled: on
      certificateId: cert-1iidd2pahdyio74adhfr9ajwg
      caCertificateId: cert-1iidd2r9ii0hs74adhfeodxo1
      serverGroupId: rsp-1g72w74y4umf42zbhq4k4hnln
      enableHttp2: on
      enableQuic: off
      aclStatus: on
      aclType: white
      aclIds:
        - acl-1g72w6z11ighs2zbhq4v3rvh4
        - acl-1g72xvtt7kg002zbhq5diim3s
      description: acc test listener
      customizedCfgId: ${fooCustomizedCfg.id}
Copy

Create Listener Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Listener(name: string, args: ListenerArgs, opts?: CustomResourceOptions);
@overload
def Listener(resource_name: str,
             args: ListenerArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Listener(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             load_balancer_id: Optional[str] = None,
             server_group_id: Optional[str] = None,
             protocol: Optional[str] = None,
             port: Optional[int] = None,
             description: Optional[str] = None,
             customized_cfg_id: Optional[str] = None,
             acl_ids: Optional[Sequence[str]] = None,
             enable_http2: Optional[str] = None,
             enable_quic: Optional[str] = None,
             enabled: Optional[str] = None,
             listener_name: Optional[str] = None,
             certificate_id: Optional[str] = None,
             ca_certificate_id: Optional[str] = None,
             acl_type: Optional[str] = None,
             acl_status: Optional[str] = None)
func NewListener(ctx *Context, name string, args ListenerArgs, opts ...ResourceOption) (*Listener, error)
public Listener(string name, ListenerArgs args, CustomResourceOptions? opts = null)
public Listener(String name, ListenerArgs args)
public Listener(String name, ListenerArgs args, CustomResourceOptions options)

type: volcengine:alb:Listener
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ListenerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ListenerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ListenerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ListenerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ListenerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var listenerResource = new Volcengine.Alb.Listener("listenerResource", new()
{
    LoadBalancerId = "string",
    ServerGroupId = "string",
    Protocol = "string",
    Port = 0,
    Description = "string",
    CustomizedCfgId = "string",
    AclIds = new[]
    {
        "string",
    },
    EnableHttp2 = "string",
    EnableQuic = "string",
    Enabled = "string",
    ListenerName = "string",
    CertificateId = "string",
    CaCertificateId = "string",
    AclType = "string",
    AclStatus = "string",
});
Copy
example, err := alb.NewListener(ctx, "listenerResource", &alb.ListenerArgs{
	LoadBalancerId:  pulumi.String("string"),
	ServerGroupId:   pulumi.String("string"),
	Protocol:        pulumi.String("string"),
	Port:            pulumi.Int(0),
	Description:     pulumi.String("string"),
	CustomizedCfgId: pulumi.String("string"),
	AclIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	EnableHttp2:     pulumi.String("string"),
	EnableQuic:      pulumi.String("string"),
	Enabled:         pulumi.String("string"),
	ListenerName:    pulumi.String("string"),
	CertificateId:   pulumi.String("string"),
	CaCertificateId: pulumi.String("string"),
	AclType:         pulumi.String("string"),
	AclStatus:       pulumi.String("string"),
})
Copy
var listenerResource = new Listener("listenerResource", ListenerArgs.builder()
    .loadBalancerId("string")
    .serverGroupId("string")
    .protocol("string")
    .port(0)
    .description("string")
    .customizedCfgId("string")
    .aclIds("string")
    .enableHttp2("string")
    .enableQuic("string")
    .enabled("string")
    .listenerName("string")
    .certificateId("string")
    .caCertificateId("string")
    .aclType("string")
    .aclStatus("string")
    .build());
Copy
listener_resource = volcengine.alb.Listener("listenerResource",
    load_balancer_id="string",
    server_group_id="string",
    protocol="string",
    port=0,
    description="string",
    customized_cfg_id="string",
    acl_ids=["string"],
    enable_http2="string",
    enable_quic="string",
    enabled="string",
    listener_name="string",
    certificate_id="string",
    ca_certificate_id="string",
    acl_type="string",
    acl_status="string")
Copy
const listenerResource = new volcengine.alb.Listener("listenerResource", {
    loadBalancerId: "string",
    serverGroupId: "string",
    protocol: "string",
    port: 0,
    description: "string",
    customizedCfgId: "string",
    aclIds: ["string"],
    enableHttp2: "string",
    enableQuic: "string",
    enabled: "string",
    listenerName: "string",
    certificateId: "string",
    caCertificateId: "string",
    aclType: "string",
    aclStatus: "string",
});
Copy
type: volcengine:alb:Listener
properties:
    aclIds:
        - string
    aclStatus: string
    aclType: string
    caCertificateId: string
    certificateId: string
    customizedCfgId: string
    description: string
    enableHttp2: string
    enableQuic: string
    enabled: string
    listenerName: string
    loadBalancerId: string
    port: 0
    protocol: string
    serverGroupId: string
Copy

Listener Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Listener resource accepts the following input properties:

LoadBalancerId
This property is required.
Changes to this property will trigger replacement.
string
The Id of the load balancer.
Port
This property is required.
Changes to this property will trigger replacement.
int
The port receiving request of the Listener, the value range in 1~65535.
Protocol
This property is required.
Changes to this property will trigger replacement.
string
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
ServerGroupId This property is required. string
The server group id associated with the listener.
AclIds List<string>
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
AclStatus string
The enable status of Acl. Optional choice contains on, off. Default is off.
AclType string
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
CaCertificateId string
The CA certificate id associated with the listener.
CertificateId string
The certificate id associated with the listener.
CustomizedCfgId string
Personalized configuration ID, with a value of " " when not bound.
Description string
The description of the Listener.
EnableHttp2 string
The HTTP2 feature switch,valid value is on or off. Default is off.
EnableQuic string
The QUIC feature switch,valid value is on or off. Default is off.
Enabled string
The enable status of the Listener. Optional choice contains on, off. Default is on.
ListenerName string
The name of the Listener.
LoadBalancerId
This property is required.
Changes to this property will trigger replacement.
string
The Id of the load balancer.
Port
This property is required.
Changes to this property will trigger replacement.
int
The port receiving request of the Listener, the value range in 1~65535.
Protocol
This property is required.
Changes to this property will trigger replacement.
string
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
ServerGroupId This property is required. string
The server group id associated with the listener.
AclIds []string
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
AclStatus string
The enable status of Acl. Optional choice contains on, off. Default is off.
AclType string
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
CaCertificateId string
The CA certificate id associated with the listener.
CertificateId string
The certificate id associated with the listener.
CustomizedCfgId string
Personalized configuration ID, with a value of " " when not bound.
Description string
The description of the Listener.
EnableHttp2 string
The HTTP2 feature switch,valid value is on or off. Default is off.
EnableQuic string
The QUIC feature switch,valid value is on or off. Default is off.
Enabled string
The enable status of the Listener. Optional choice contains on, off. Default is on.
ListenerName string
The name of the Listener.
loadBalancerId
This property is required.
Changes to this property will trigger replacement.
String
The Id of the load balancer.
port
This property is required.
Changes to this property will trigger replacement.
Integer
The port receiving request of the Listener, the value range in 1~65535.
protocol
This property is required.
Changes to this property will trigger replacement.
String
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
serverGroupId This property is required. String
The server group id associated with the listener.
aclIds List<String>
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
aclStatus String
The enable status of Acl. Optional choice contains on, off. Default is off.
aclType String
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
caCertificateId String
The CA certificate id associated with the listener.
certificateId String
The certificate id associated with the listener.
customizedCfgId String
Personalized configuration ID, with a value of " " when not bound.
description String
The description of the Listener.
enableHttp2 String
The HTTP2 feature switch,valid value is on or off. Default is off.
enableQuic String
The QUIC feature switch,valid value is on or off. Default is off.
enabled String
The enable status of the Listener. Optional choice contains on, off. Default is on.
listenerName String
The name of the Listener.
loadBalancerId
This property is required.
Changes to this property will trigger replacement.
string
The Id of the load balancer.
port
This property is required.
Changes to this property will trigger replacement.
number
The port receiving request of the Listener, the value range in 1~65535.
protocol
This property is required.
Changes to this property will trigger replacement.
string
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
serverGroupId This property is required. string
The server group id associated with the listener.
aclIds string[]
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
aclStatus string
The enable status of Acl. Optional choice contains on, off. Default is off.
aclType string
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
caCertificateId string
The CA certificate id associated with the listener.
certificateId string
The certificate id associated with the listener.
customizedCfgId string
Personalized configuration ID, with a value of " " when not bound.
description string
The description of the Listener.
enableHttp2 string
The HTTP2 feature switch,valid value is on or off. Default is off.
enableQuic string
The QUIC feature switch,valid value is on or off. Default is off.
enabled string
The enable status of the Listener. Optional choice contains on, off. Default is on.
listenerName string
The name of the Listener.
load_balancer_id
This property is required.
Changes to this property will trigger replacement.
str
The Id of the load balancer.
port
This property is required.
Changes to this property will trigger replacement.
int
The port receiving request of the Listener, the value range in 1~65535.
protocol
This property is required.
Changes to this property will trigger replacement.
str
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
server_group_id This property is required. str
The server group id associated with the listener.
acl_ids Sequence[str]
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
acl_status str
The enable status of Acl. Optional choice contains on, off. Default is off.
acl_type str
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
ca_certificate_id str
The CA certificate id associated with the listener.
certificate_id str
The certificate id associated with the listener.
customized_cfg_id str
Personalized configuration ID, with a value of " " when not bound.
description str
The description of the Listener.
enable_http2 str
The HTTP2 feature switch,valid value is on or off. Default is off.
enable_quic str
The QUIC feature switch,valid value is on or off. Default is off.
enabled str
The enable status of the Listener. Optional choice contains on, off. Default is on.
listener_name str
The name of the Listener.
loadBalancerId
This property is required.
Changes to this property will trigger replacement.
String
The Id of the load balancer.
port
This property is required.
Changes to this property will trigger replacement.
Number
The port receiving request of the Listener, the value range in 1~65535.
protocol
This property is required.
Changes to this property will trigger replacement.
String
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
serverGroupId This property is required. String
The server group id associated with the listener.
aclIds List<String>
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
aclStatus String
The enable status of Acl. Optional choice contains on, off. Default is off.
aclType String
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
caCertificateId String
The CA certificate id associated with the listener.
certificateId String
The certificate id associated with the listener.
customizedCfgId String
Personalized configuration ID, with a value of " " when not bound.
description String
The description of the Listener.
enableHttp2 String
The HTTP2 feature switch,valid value is on or off. Default is off.
enableQuic String
The QUIC feature switch,valid value is on or off. Default is off.
enabled String
The enable status of the Listener. Optional choice contains on, off. Default is on.
listenerName String
The name of the Listener.

Outputs

All input properties are implicitly available as output properties. Additionally, the Listener resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
ListenerId string
The ID of the Listener.
Id string
The provider-assigned unique ID for this managed resource.
ListenerId string
The ID of the Listener.
id String
The provider-assigned unique ID for this managed resource.
listenerId String
The ID of the Listener.
id string
The provider-assigned unique ID for this managed resource.
listenerId string
The ID of the Listener.
id str
The provider-assigned unique ID for this managed resource.
listener_id str
The ID of the Listener.
id String
The provider-assigned unique ID for this managed resource.
listenerId String
The ID of the Listener.

Look up Existing Listener Resource

Get an existing Listener resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ListenerState, opts?: CustomResourceOptions): Listener
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl_ids: Optional[Sequence[str]] = None,
        acl_status: Optional[str] = None,
        acl_type: Optional[str] = None,
        ca_certificate_id: Optional[str] = None,
        certificate_id: Optional[str] = None,
        customized_cfg_id: Optional[str] = None,
        description: Optional[str] = None,
        enable_http2: Optional[str] = None,
        enable_quic: Optional[str] = None,
        enabled: Optional[str] = None,
        listener_id: Optional[str] = None,
        listener_name: Optional[str] = None,
        load_balancer_id: Optional[str] = None,
        port: Optional[int] = None,
        protocol: Optional[str] = None,
        server_group_id: Optional[str] = None) -> Listener
func GetListener(ctx *Context, name string, id IDInput, state *ListenerState, opts ...ResourceOption) (*Listener, error)
public static Listener Get(string name, Input<string> id, ListenerState? state, CustomResourceOptions? opts = null)
public static Listener get(String name, Output<String> id, ListenerState state, CustomResourceOptions options)
resources:  _:    type: volcengine:alb:Listener    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AclIds List<string>
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
AclStatus string
The enable status of Acl. Optional choice contains on, off. Default is off.
AclType string
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
CaCertificateId string
The CA certificate id associated with the listener.
CertificateId string
The certificate id associated with the listener.
CustomizedCfgId string
Personalized configuration ID, with a value of " " when not bound.
Description string
The description of the Listener.
EnableHttp2 string
The HTTP2 feature switch,valid value is on or off. Default is off.
EnableQuic string
The QUIC feature switch,valid value is on or off. Default is off.
Enabled string
The enable status of the Listener. Optional choice contains on, off. Default is on.
ListenerId string
The ID of the Listener.
ListenerName string
The name of the Listener.
LoadBalancerId Changes to this property will trigger replacement. string
The Id of the load balancer.
Port Changes to this property will trigger replacement. int
The port receiving request of the Listener, the value range in 1~65535.
Protocol Changes to this property will trigger replacement. string
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
ServerGroupId string
The server group id associated with the listener.
AclIds []string
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
AclStatus string
The enable status of Acl. Optional choice contains on, off. Default is off.
AclType string
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
CaCertificateId string
The CA certificate id associated with the listener.
CertificateId string
The certificate id associated with the listener.
CustomizedCfgId string
Personalized configuration ID, with a value of " " when not bound.
Description string
The description of the Listener.
EnableHttp2 string
The HTTP2 feature switch,valid value is on or off. Default is off.
EnableQuic string
The QUIC feature switch,valid value is on or off. Default is off.
Enabled string
The enable status of the Listener. Optional choice contains on, off. Default is on.
ListenerId string
The ID of the Listener.
ListenerName string
The name of the Listener.
LoadBalancerId Changes to this property will trigger replacement. string
The Id of the load balancer.
Port Changes to this property will trigger replacement. int
The port receiving request of the Listener, the value range in 1~65535.
Protocol Changes to this property will trigger replacement. string
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
ServerGroupId string
The server group id associated with the listener.
aclIds List<String>
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
aclStatus String
The enable status of Acl. Optional choice contains on, off. Default is off.
aclType String
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
caCertificateId String
The CA certificate id associated with the listener.
certificateId String
The certificate id associated with the listener.
customizedCfgId String
Personalized configuration ID, with a value of " " when not bound.
description String
The description of the Listener.
enableHttp2 String
The HTTP2 feature switch,valid value is on or off. Default is off.
enableQuic String
The QUIC feature switch,valid value is on or off. Default is off.
enabled String
The enable status of the Listener. Optional choice contains on, off. Default is on.
listenerId String
The ID of the Listener.
listenerName String
The name of the Listener.
loadBalancerId Changes to this property will trigger replacement. String
The Id of the load balancer.
port Changes to this property will trigger replacement. Integer
The port receiving request of the Listener, the value range in 1~65535.
protocol Changes to this property will trigger replacement. String
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
serverGroupId String
The server group id associated with the listener.
aclIds string[]
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
aclStatus string
The enable status of Acl. Optional choice contains on, off. Default is off.
aclType string
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
caCertificateId string
The CA certificate id associated with the listener.
certificateId string
The certificate id associated with the listener.
customizedCfgId string
Personalized configuration ID, with a value of " " when not bound.
description string
The description of the Listener.
enableHttp2 string
The HTTP2 feature switch,valid value is on or off. Default is off.
enableQuic string
The QUIC feature switch,valid value is on or off. Default is off.
enabled string
The enable status of the Listener. Optional choice contains on, off. Default is on.
listenerId string
The ID of the Listener.
listenerName string
The name of the Listener.
loadBalancerId Changes to this property will trigger replacement. string
The Id of the load balancer.
port Changes to this property will trigger replacement. number
The port receiving request of the Listener, the value range in 1~65535.
protocol Changes to this property will trigger replacement. string
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
serverGroupId string
The server group id associated with the listener.
acl_ids Sequence[str]
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
acl_status str
The enable status of Acl. Optional choice contains on, off. Default is off.
acl_type str
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
ca_certificate_id str
The CA certificate id associated with the listener.
certificate_id str
The certificate id associated with the listener.
customized_cfg_id str
Personalized configuration ID, with a value of " " when not bound.
description str
The description of the Listener.
enable_http2 str
The HTTP2 feature switch,valid value is on or off. Default is off.
enable_quic str
The QUIC feature switch,valid value is on or off. Default is off.
enabled str
The enable status of the Listener. Optional choice contains on, off. Default is on.
listener_id str
The ID of the Listener.
listener_name str
The name of the Listener.
load_balancer_id Changes to this property will trigger replacement. str
The Id of the load balancer.
port Changes to this property will trigger replacement. int
The port receiving request of the Listener, the value range in 1~65535.
protocol Changes to this property will trigger replacement. str
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
server_group_id str
The server group id associated with the listener.
aclIds List<String>
The id list of the Acl. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
aclStatus String
The enable status of Acl. Optional choice contains on, off. Default is off.
aclType String
The type of the Acl. Optional choice contains white, black. When the AclStatus parameter is configured as on, AclType and AclIds.N are required.
caCertificateId String
The CA certificate id associated with the listener.
certificateId String
The certificate id associated with the listener.
customizedCfgId String
Personalized configuration ID, with a value of " " when not bound.
description String
The description of the Listener.
enableHttp2 String
The HTTP2 feature switch,valid value is on or off. Default is off.
enableQuic String
The QUIC feature switch,valid value is on or off. Default is off.
enabled String
The enable status of the Listener. Optional choice contains on, off. Default is on.
listenerId String
The ID of the Listener.
listenerName String
The name of the Listener.
loadBalancerId Changes to this property will trigger replacement. String
The Id of the load balancer.
port Changes to this property will trigger replacement. Number
The port receiving request of the Listener, the value range in 1~65535.
protocol Changes to this property will trigger replacement. String
The protocol of the Listener. Optional choice contains HTTP, HTTPS.
serverGroupId String
The server group id associated with the listener.

Import

AlbListener can be imported using the id, e.g.

$ pulumi import volcengine:alb/listener:Listener default lsn-273yv0mhs5xj47fap8sehiiso
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
volcengine volcengine/pulumi-volcengine
License
Apache-2.0
Notes
This Pulumi package is based on the volcengine Terraform Provider.
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine