1. Packages
  2. Volcengine
  3. API Docs
  4. clb
  5. Rule
Volcengine v0.0.25 published on Tuesday, Jul 2, 2024 by Volcengine

volcengine.clb.Rule

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.25 published on Tuesday, Jul 2, 2024 by Volcengine

    Provides a resource to manage clb rule

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var fooZones = Volcengine.Ecs.Zones.Invoke();
    
        var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
        {
            VpcName = "acc-test-vpc",
            CidrBlock = "172.16.0.0/16",
        });
    
        var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
        {
            SubnetName = "acc-test-subnet",
            CidrBlock = "172.16.0.0/24",
            ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
            VpcId = fooVpc.Id,
        });
    
        var fooClb = new Volcengine.Clb.Clb("fooClb", new()
        {
            Type = "public",
            SubnetId = fooSubnet.Id,
            LoadBalancerSpec = "small_1",
            Description = "acc0Demo",
            LoadBalancerName = "acc-test-create",
            EipBillingConfig = new Volcengine.Clb.Inputs.ClbEipBillingConfigArgs
            {
                Isp = "BGP",
                EipBillingType = "PostPaidByBandwidth",
                Bandwidth = 1,
            },
        });
    
        var fooServerGroup = new Volcengine.Clb.ServerGroup("fooServerGroup", new()
        {
            LoadBalancerId = fooClb.Id,
            ServerGroupName = "acc-test-create",
            Description = "hello demo11",
        });
    
        var fooListener = new Volcengine.Clb.Listener("fooListener", new()
        {
            LoadBalancerId = fooClb.Id,
            ListenerName = "acc-test-listener",
            Protocol = "HTTP",
            Port = 90,
            ServerGroupId = fooServerGroup.Id,
            HealthCheck = new Volcengine.Clb.Inputs.ListenerHealthCheckArgs
            {
                Enabled = "on",
                Interval = 10,
                Timeout = 3,
                HealthyThreshold = 5,
                UnHealthyThreshold = 2,
                Domain = "volcengine.com",
                HttpCode = "http_2xx",
                Method = "GET",
                Uri = "/",
            },
            Enabled = "on",
        });
    
        var fooRule = new Volcengine.Clb.Rule("fooRule", new()
        {
            ListenerId = fooListener.Id,
            ServerGroupId = fooServerGroup.Id,
            Domain = "test-volc123.com",
            Url = "/tftest",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/clb"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		fooZones, err := ecs.Zones(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
    			VpcName:   pulumi.String("acc-test-vpc"),
    			CidrBlock: pulumi.String("172.16.0.0/16"),
    		})
    		if err != nil {
    			return err
    		}
    		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
    			SubnetName: pulumi.String("acc-test-subnet"),
    			CidrBlock:  pulumi.String("172.16.0.0/24"),
    			ZoneId:     *pulumi.String(fooZones.Zones[0].Id),
    			VpcId:      fooVpc.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		fooClb, err := clb.NewClb(ctx, "fooClb", &clb.ClbArgs{
    			Type:             pulumi.String("public"),
    			SubnetId:         fooSubnet.ID(),
    			LoadBalancerSpec: pulumi.String("small_1"),
    			Description:      pulumi.String("acc0Demo"),
    			LoadBalancerName: pulumi.String("acc-test-create"),
    			EipBillingConfig: &clb.ClbEipBillingConfigArgs{
    				Isp:            pulumi.String("BGP"),
    				EipBillingType: pulumi.String("PostPaidByBandwidth"),
    				Bandwidth:      pulumi.Int(1),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		fooServerGroup, err := clb.NewServerGroup(ctx, "fooServerGroup", &clb.ServerGroupArgs{
    			LoadBalancerId:  fooClb.ID(),
    			ServerGroupName: pulumi.String("acc-test-create"),
    			Description:     pulumi.String("hello demo11"),
    		})
    		if err != nil {
    			return err
    		}
    		fooListener, err := clb.NewListener(ctx, "fooListener", &clb.ListenerArgs{
    			LoadBalancerId: fooClb.ID(),
    			ListenerName:   pulumi.String("acc-test-listener"),
    			Protocol:       pulumi.String("HTTP"),
    			Port:           pulumi.Int(90),
    			ServerGroupId:  fooServerGroup.ID(),
    			HealthCheck: &clb.ListenerHealthCheckArgs{
    				Enabled:            pulumi.String("on"),
    				Interval:           pulumi.Int(10),
    				Timeout:            pulumi.Int(3),
    				HealthyThreshold:   pulumi.Int(5),
    				UnHealthyThreshold: pulumi.Int(2),
    				Domain:             pulumi.String("volcengine.com"),
    				HttpCode:           pulumi.String("http_2xx"),
    				Method:             pulumi.String("GET"),
    				Uri:                pulumi.String("/"),
    			},
    			Enabled: pulumi.String("on"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = clb.NewRule(ctx, "fooRule", &clb.RuleArgs{
    			ListenerId:    fooListener.ID(),
    			ServerGroupId: fooServerGroup.ID(),
    			Domain:        pulumi.String("test-volc123.com"),
    			Url:           pulumi.String("/tftest"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.ecs.EcsFunctions;
    import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
    import com.pulumi.volcengine.vpc.Vpc;
    import com.pulumi.volcengine.vpc.VpcArgs;
    import com.pulumi.volcengine.vpc.Subnet;
    import com.pulumi.volcengine.vpc.SubnetArgs;
    import com.pulumi.volcengine.clb.Clb;
    import com.pulumi.volcengine.clb.ClbArgs;
    import com.pulumi.volcengine.clb.inputs.ClbEipBillingConfigArgs;
    import com.pulumi.volcengine.clb.ServerGroup;
    import com.pulumi.volcengine.clb.ServerGroupArgs;
    import com.pulumi.volcengine.clb.Listener;
    import com.pulumi.volcengine.clb.ListenerArgs;
    import com.pulumi.volcengine.clb.inputs.ListenerHealthCheckArgs;
    import com.pulumi.volcengine.clb.Rule;
    import com.pulumi.volcengine.clb.RuleArgs;
    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) {
            final var fooZones = EcsFunctions.Zones();
    
            var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
                .vpcName("acc-test-vpc")
                .cidrBlock("172.16.0.0/16")
                .build());
    
            var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
                .subnetName("acc-test-subnet")
                .cidrBlock("172.16.0.0/24")
                .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
                .vpcId(fooVpc.id())
                .build());
    
            var fooClb = new Clb("fooClb", ClbArgs.builder()        
                .type("public")
                .subnetId(fooSubnet.id())
                .loadBalancerSpec("small_1")
                .description("acc0Demo")
                .loadBalancerName("acc-test-create")
                .eipBillingConfig(ClbEipBillingConfigArgs.builder()
                    .isp("BGP")
                    .eipBillingType("PostPaidByBandwidth")
                    .bandwidth(1)
                    .build())
                .build());
    
            var fooServerGroup = new ServerGroup("fooServerGroup", ServerGroupArgs.builder()        
                .loadBalancerId(fooClb.id())
                .serverGroupName("acc-test-create")
                .description("hello demo11")
                .build());
    
            var fooListener = new Listener("fooListener", ListenerArgs.builder()        
                .loadBalancerId(fooClb.id())
                .listenerName("acc-test-listener")
                .protocol("HTTP")
                .port(90)
                .serverGroupId(fooServerGroup.id())
                .healthCheck(ListenerHealthCheckArgs.builder()
                    .enabled("on")
                    .interval(10)
                    .timeout(3)
                    .healthyThreshold(5)
                    .unHealthyThreshold(2)
                    .domain("volcengine.com")
                    .httpCode("http_2xx")
                    .method("GET")
                    .uri("/")
                    .build())
                .enabled("on")
                .build());
    
            var fooRule = new Rule("fooRule", RuleArgs.builder()        
                .listenerId(fooListener.id())
                .serverGroupId(fooServerGroup.id())
                .domain("test-volc123.com")
                .url("/tftest")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo_zones = volcengine.ecs.zones()
    foo_vpc = volcengine.vpc.Vpc("fooVpc",
        vpc_name="acc-test-vpc",
        cidr_block="172.16.0.0/16")
    foo_subnet = volcengine.vpc.Subnet("fooSubnet",
        subnet_name="acc-test-subnet",
        cidr_block="172.16.0.0/24",
        zone_id=foo_zones.zones[0].id,
        vpc_id=foo_vpc.id)
    foo_clb = volcengine.clb.Clb("fooClb",
        type="public",
        subnet_id=foo_subnet.id,
        load_balancer_spec="small_1",
        description="acc0Demo",
        load_balancer_name="acc-test-create",
        eip_billing_config=volcengine.clb.ClbEipBillingConfigArgs(
            isp="BGP",
            eip_billing_type="PostPaidByBandwidth",
            bandwidth=1,
        ))
    foo_server_group = volcengine.clb.ServerGroup("fooServerGroup",
        load_balancer_id=foo_clb.id,
        server_group_name="acc-test-create",
        description="hello demo11")
    foo_listener = volcengine.clb.Listener("fooListener",
        load_balancer_id=foo_clb.id,
        listener_name="acc-test-listener",
        protocol="HTTP",
        port=90,
        server_group_id=foo_server_group.id,
        health_check=volcengine.clb.ListenerHealthCheckArgs(
            enabled="on",
            interval=10,
            timeout=3,
            healthy_threshold=5,
            un_healthy_threshold=2,
            domain="volcengine.com",
            http_code="http_2xx",
            method="GET",
            uri="/",
        ),
        enabled="on")
    foo_rule = volcengine.clb.Rule("fooRule",
        listener_id=foo_listener.id,
        server_group_id=foo_server_group.id,
        domain="test-volc123.com",
        url="/tftest")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    import * as volcengine from "@volcengine/pulumi";
    
    const fooZones = volcengine.ecs.Zones({});
    const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
        vpcName: "acc-test-vpc",
        cidrBlock: "172.16.0.0/16",
    });
    const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
        subnetName: "acc-test-subnet",
        cidrBlock: "172.16.0.0/24",
        zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        vpcId: fooVpc.id,
    });
    const fooClb = new volcengine.clb.Clb("fooClb", {
        type: "public",
        subnetId: fooSubnet.id,
        loadBalancerSpec: "small_1",
        description: "acc0Demo",
        loadBalancerName: "acc-test-create",
        eipBillingConfig: {
            isp: "BGP",
            eipBillingType: "PostPaidByBandwidth",
            bandwidth: 1,
        },
    });
    const fooServerGroup = new volcengine.clb.ServerGroup("fooServerGroup", {
        loadBalancerId: fooClb.id,
        serverGroupName: "acc-test-create",
        description: "hello demo11",
    });
    const fooListener = new volcengine.clb.Listener("fooListener", {
        loadBalancerId: fooClb.id,
        listenerName: "acc-test-listener",
        protocol: "HTTP",
        port: 90,
        serverGroupId: fooServerGroup.id,
        healthCheck: {
            enabled: "on",
            interval: 10,
            timeout: 3,
            healthyThreshold: 5,
            unHealthyThreshold: 2,
            domain: "volcengine.com",
            httpCode: "http_2xx",
            method: "GET",
            uri: "/",
        },
        enabled: "on",
    });
    const fooRule = new volcengine.clb.Rule("fooRule", {
        listenerId: fooListener.id,
        serverGroupId: fooServerGroup.id,
        domain: "test-volc123.com",
        url: "/tftest",
    });
    
    resources:
      fooVpc:
        type: volcengine:vpc:Vpc
        properties:
          vpcName: acc-test-vpc
          cidrBlock: 172.16.0.0/16
      fooSubnet:
        type: volcengine:vpc:Subnet
        properties:
          subnetName: acc-test-subnet
          cidrBlock: 172.16.0.0/24
          zoneId: ${fooZones.zones[0].id}
          vpcId: ${fooVpc.id}
      fooClb:
        type: volcengine:clb:Clb
        properties:
          type: public
          subnetId: ${fooSubnet.id}
          loadBalancerSpec: small_1
          description: acc0Demo
          loadBalancerName: acc-test-create
          eipBillingConfig:
            isp: BGP
            eipBillingType: PostPaidByBandwidth
            bandwidth: 1
      fooServerGroup:
        type: volcengine:clb:ServerGroup
        properties:
          loadBalancerId: ${fooClb.id}
          serverGroupName: acc-test-create
          description: hello demo11
      fooListener:
        type: volcengine:clb:Listener
        properties:
          loadBalancerId: ${fooClb.id}
          listenerName: acc-test-listener
          protocol: HTTP
          port: 90
          serverGroupId: ${fooServerGroup.id}
          healthCheck:
            enabled: on
            interval: 10
            timeout: 3
            healthyThreshold: 5
            unHealthyThreshold: 2
            domain: volcengine.com
            httpCode: http_2xx
            method: GET
            uri: /
          enabled: on
      fooRule:
        type: volcengine:clb:Rule
        properties:
          listenerId: ${fooListener.id}
          serverGroupId: ${fooServerGroup.id}
          domain: test-volc123.com
          url: /tftest
    variables:
      fooZones:
        fn::invoke:
          Function: volcengine:ecs:Zones
          Arguments: {}
    

    Create Rule Resource

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

    Constructor syntax

    new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
    @overload
    def Rule(resource_name: str,
             args: RuleArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Rule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             listener_id: Optional[str] = None,
             server_group_id: Optional[str] = None,
             description: Optional[str] = None,
             domain: Optional[str] = None,
             url: Optional[str] = None)
    func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
    public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
    public Rule(String name, RuleArgs args)
    public Rule(String name, RuleArgs args, CustomResourceOptions options)
    
    type: volcengine:clb:Rule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RuleArgs
    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 volcengineRuleResource = new Volcengine.Clb.Rule("volcengineRuleResource", new()
    {
        ListenerId = "string",
        ServerGroupId = "string",
        Description = "string",
        Domain = "string",
        Url = "string",
    });
    
    example, err := clb.NewRule(ctx, "volcengineRuleResource", &clb.RuleArgs{
    	ListenerId:    pulumi.String("string"),
    	ServerGroupId: pulumi.String("string"),
    	Description:   pulumi.String("string"),
    	Domain:        pulumi.String("string"),
    	Url:           pulumi.String("string"),
    })
    
    var volcengineRuleResource = new Rule("volcengineRuleResource", RuleArgs.builder()
        .listenerId("string")
        .serverGroupId("string")
        .description("string")
        .domain("string")
        .url("string")
        .build());
    
    volcengine_rule_resource = volcengine.clb.Rule("volcengineRuleResource",
        listener_id="string",
        server_group_id="string",
        description="string",
        domain="string",
        url="string")
    
    const volcengineRuleResource = new volcengine.clb.Rule("volcengineRuleResource", {
        listenerId: "string",
        serverGroupId: "string",
        description: "string",
        domain: "string",
        url: "string",
    });
    
    type: volcengine:clb:Rule
    properties:
        description: string
        domain: string
        listenerId: string
        serverGroupId: string
        url: string
    

    Rule Resource Properties

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

    Inputs

    The Rule resource accepts the following input properties:

    ListenerId string
    The ID of listener.
    ServerGroupId string
    Server Group Id.
    Description string
    The description of the Rule.
    Domain string
    The domain of Rule.
    Url string
    The Url of Rule.
    ListenerId string
    The ID of listener.
    ServerGroupId string
    Server Group Id.
    Description string
    The description of the Rule.
    Domain string
    The domain of Rule.
    Url string
    The Url of Rule.
    listenerId String
    The ID of listener.
    serverGroupId String
    Server Group Id.
    description String
    The description of the Rule.
    domain String
    The domain of Rule.
    url String
    The Url of Rule.
    listenerId string
    The ID of listener.
    serverGroupId string
    Server Group Id.
    description string
    The description of the Rule.
    domain string
    The domain of Rule.
    url string
    The Url of Rule.
    listener_id str
    The ID of listener.
    server_group_id str
    Server Group Id.
    description str
    The description of the Rule.
    domain str
    The domain of Rule.
    url str
    The Url of Rule.
    listenerId String
    The ID of listener.
    serverGroupId String
    Server Group Id.
    description String
    The description of the Rule.
    domain String
    The domain of Rule.
    url String
    The Url of Rule.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Rule Resource

    Get an existing Rule 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?: RuleState, opts?: CustomResourceOptions): Rule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            domain: Optional[str] = None,
            listener_id: Optional[str] = None,
            server_group_id: Optional[str] = None,
            url: Optional[str] = None) -> Rule
    func GetRule(ctx *Context, name string, id IDInput, state *RuleState, opts ...ResourceOption) (*Rule, error)
    public static Rule Get(string name, Input<string> id, RuleState? state, CustomResourceOptions? opts = null)
    public static Rule get(String name, Output<String> id, RuleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Description string
    The description of the Rule.
    Domain string
    The domain of Rule.
    ListenerId string
    The ID of listener.
    ServerGroupId string
    Server Group Id.
    Url string
    The Url of Rule.
    Description string
    The description of the Rule.
    Domain string
    The domain of Rule.
    ListenerId string
    The ID of listener.
    ServerGroupId string
    Server Group Id.
    Url string
    The Url of Rule.
    description String
    The description of the Rule.
    domain String
    The domain of Rule.
    listenerId String
    The ID of listener.
    serverGroupId String
    Server Group Id.
    url String
    The Url of Rule.
    description string
    The description of the Rule.
    domain string
    The domain of Rule.
    listenerId string
    The ID of listener.
    serverGroupId string
    Server Group Id.
    url string
    The Url of Rule.
    description str
    The description of the Rule.
    domain str
    The domain of Rule.
    listener_id str
    The ID of listener.
    server_group_id str
    Server Group Id.
    url str
    The Url of Rule.
    description String
    The description of the Rule.
    domain String
    The domain of Rule.
    listenerId String
    The ID of listener.
    serverGroupId String
    Server Group Id.
    url String
    The Url of Rule.

    Import

    Rule can be imported using the id, e.g. NoticeresourceId is ruleId, due to the lack of describeRuleAttributes in openapi, for import resources, please use ruleId:listenerId to import. we will fix this problem later.

     $ pulumi import volcengine:clb/rule:Rule foo rule-273zb9hzi1gqo7fap8u1k3utb:lsn-273ywvnmiu70g7fap8u2xzg9d
    

    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 logo
    Volcengine v0.0.25 published on Tuesday, Jul 2, 2024 by Volcengine