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

volcengine.alb.ListenerDomainExtension

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 domain extension

Example Usage

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

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"],
    description: "acc test listener",
});
const fooListenerDomainExtension = new volcengine.alb.ListenerDomainExtension("fooListenerDomainExtension", {
    listenerId: fooListener.id,
    domain: "test-modify.com",
    certificateId: "cert-1iidd2pahdyio74adhfr9ajwg",
});
Copy
import pulumi
import pulumi_volcengine as volcengine

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"],
    description="acc test listener")
foo_listener_domain_extension = volcengine.alb.ListenerDomainExtension("fooListenerDomainExtension",
    listener_id=foo_listener.id,
    domain="test-modify.com",
    certificate_id="cert-1iidd2pahdyio74adhfr9ajwg")
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 {
		fooListener, 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"),
			},
			Description: pulumi.String("acc test listener"),
		})
		if err != nil {
			return err
		}
		_, err = alb.NewListenerDomainExtension(ctx, "fooListenerDomainExtension", &alb.ListenerDomainExtensionArgs{
			ListenerId:    fooListener.ID(),
			Domain:        pulumi.String("test-modify.com"),
			CertificateId: pulumi.String("cert-1iidd2pahdyio74adhfr9ajwg"),
		})
		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 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",
        },
        Description = "acc test listener",
    });

    var fooListenerDomainExtension = new Volcengine.Alb.ListenerDomainExtension("fooListenerDomainExtension", new()
    {
        ListenerId = fooListener.Id,
        Domain = "test-modify.com",
        CertificateId = "cert-1iidd2pahdyio74adhfr9ajwg",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.alb.Listener;
import com.pulumi.volcengine.alb.ListenerArgs;
import com.pulumi.volcengine.alb.ListenerDomainExtension;
import com.pulumi.volcengine.alb.ListenerDomainExtensionArgs;
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 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")
            .description("acc test listener")
            .build());

        var fooListenerDomainExtension = new ListenerDomainExtension("fooListenerDomainExtension", ListenerDomainExtensionArgs.builder()        
            .listenerId(fooListener.id())
            .domain("test-modify.com")
            .certificateId("cert-1iidd2pahdyio74adhfr9ajwg")
            .build());

    }
}
Copy
resources:
  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
      description: acc test listener
  fooListenerDomainExtension:
    type: volcengine:alb:ListenerDomainExtension
    properties:
      listenerId: ${fooListener.id}
      domain: test-modify.com
      certificateId: cert-1iidd2pahdyio74adhfr9ajwg
Copy

Create ListenerDomainExtension Resource

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

Constructor syntax

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

@overload
def ListenerDomainExtension(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            certificate_id: Optional[str] = None,
                            domain: Optional[str] = None,
                            listener_id: Optional[str] = None)
func NewListenerDomainExtension(ctx *Context, name string, args ListenerDomainExtensionArgs, opts ...ResourceOption) (*ListenerDomainExtension, error)
public ListenerDomainExtension(string name, ListenerDomainExtensionArgs args, CustomResourceOptions? opts = null)
public ListenerDomainExtension(String name, ListenerDomainExtensionArgs args)
public ListenerDomainExtension(String name, ListenerDomainExtensionArgs args, CustomResourceOptions options)

type: volcengine:alb:ListenerDomainExtension
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. ListenerDomainExtensionArgs
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. ListenerDomainExtensionArgs
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. ListenerDomainExtensionArgs
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. ListenerDomainExtensionArgs
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. ListenerDomainExtensionArgs
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 listenerDomainExtensionResource = new Volcengine.Alb.ListenerDomainExtension("listenerDomainExtensionResource", new()
{
    CertificateId = "string",
    Domain = "string",
    ListenerId = "string",
});
Copy
example, err := alb.NewListenerDomainExtension(ctx, "listenerDomainExtensionResource", &alb.ListenerDomainExtensionArgs{
	CertificateId: pulumi.String("string"),
	Domain:        pulumi.String("string"),
	ListenerId:    pulumi.String("string"),
})
Copy
var listenerDomainExtensionResource = new ListenerDomainExtension("listenerDomainExtensionResource", ListenerDomainExtensionArgs.builder()
    .certificateId("string")
    .domain("string")
    .listenerId("string")
    .build());
Copy
listener_domain_extension_resource = volcengine.alb.ListenerDomainExtension("listenerDomainExtensionResource",
    certificate_id="string",
    domain="string",
    listener_id="string")
Copy
const listenerDomainExtensionResource = new volcengine.alb.ListenerDomainExtension("listenerDomainExtensionResource", {
    certificateId: "string",
    domain: "string",
    listenerId: "string",
});
Copy
type: volcengine:alb:ListenerDomainExtension
properties:
    certificateId: string
    domain: string
    listenerId: string
Copy

ListenerDomainExtension 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 ListenerDomainExtension resource accepts the following input properties:

CertificateId This property is required. string
Server certificate used for the domain name.
Domain This property is required. string
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
ListenerId
This property is required.
Changes to this property will trigger replacement.
string
The listener id. Only HTTPS listener is effective.
CertificateId This property is required. string
Server certificate used for the domain name.
Domain This property is required. string
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
ListenerId
This property is required.
Changes to this property will trigger replacement.
string
The listener id. Only HTTPS listener is effective.
certificateId This property is required. String
Server certificate used for the domain name.
domain This property is required. String
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
listenerId
This property is required.
Changes to this property will trigger replacement.
String
The listener id. Only HTTPS listener is effective.
certificateId This property is required. string
Server certificate used for the domain name.
domain This property is required. string
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
listenerId
This property is required.
Changes to this property will trigger replacement.
string
The listener id. Only HTTPS listener is effective.
certificate_id This property is required. str
Server certificate used for the domain name.
domain This property is required. str
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
listener_id
This property is required.
Changes to this property will trigger replacement.
str
The listener id. Only HTTPS listener is effective.
certificateId This property is required. String
Server certificate used for the domain name.
domain This property is required. String
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
listenerId
This property is required.
Changes to this property will trigger replacement.
String
The listener id. Only HTTPS listener is effective.

Outputs

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

DomainExtensionId string
The id of the domain extension.
Id string
The provider-assigned unique ID for this managed resource.
DomainExtensionId string
The id of the domain extension.
Id string
The provider-assigned unique ID for this managed resource.
domainExtensionId String
The id of the domain extension.
id String
The provider-assigned unique ID for this managed resource.
domainExtensionId string
The id of the domain extension.
id string
The provider-assigned unique ID for this managed resource.
domain_extension_id str
The id of the domain extension.
id str
The provider-assigned unique ID for this managed resource.
domainExtensionId String
The id of the domain extension.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ListenerDomainExtension Resource

Get an existing ListenerDomainExtension 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?: ListenerDomainExtensionState, opts?: CustomResourceOptions): ListenerDomainExtension
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_id: Optional[str] = None,
        domain: Optional[str] = None,
        domain_extension_id: Optional[str] = None,
        listener_id: Optional[str] = None) -> ListenerDomainExtension
func GetListenerDomainExtension(ctx *Context, name string, id IDInput, state *ListenerDomainExtensionState, opts ...ResourceOption) (*ListenerDomainExtension, error)
public static ListenerDomainExtension Get(string name, Input<string> id, ListenerDomainExtensionState? state, CustomResourceOptions? opts = null)
public static ListenerDomainExtension get(String name, Output<String> id, ListenerDomainExtensionState state, CustomResourceOptions options)
resources:  _:    type: volcengine:alb:ListenerDomainExtension    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:
CertificateId string
Server certificate used for the domain name.
Domain string
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
DomainExtensionId string
The id of the domain extension.
ListenerId Changes to this property will trigger replacement. string
The listener id. Only HTTPS listener is effective.
CertificateId string
Server certificate used for the domain name.
Domain string
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
DomainExtensionId string
The id of the domain extension.
ListenerId Changes to this property will trigger replacement. string
The listener id. Only HTTPS listener is effective.
certificateId String
Server certificate used for the domain name.
domain String
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
domainExtensionId String
The id of the domain extension.
listenerId Changes to this property will trigger replacement. String
The listener id. Only HTTPS listener is effective.
certificateId string
Server certificate used for the domain name.
domain string
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
domainExtensionId string
The id of the domain extension.
listenerId Changes to this property will trigger replacement. string
The listener id. Only HTTPS listener is effective.
certificate_id str
Server certificate used for the domain name.
domain str
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
domain_extension_id str
The id of the domain extension.
listener_id Changes to this property will trigger replacement. str
The listener id. Only HTTPS listener is effective.
certificateId String
Server certificate used for the domain name.
domain String
The domain name. The maximum number of associated domain names for an HTTPS listener is 20, with a value range of 1 to 20.
domainExtensionId String
The id of the domain extension.
listenerId Changes to this property will trigger replacement. String
The listener id. Only HTTPS listener is effective.

Import

AlbListenerDomainExtension can be imported using the listener id and domain extension id, e.g.

$ pulumi import volcengine:alb/listenerDomainExtension:ListenerDomainExtension default listenerId:extensionId
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