1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. alb
  5. LoadBalancer
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

alicloud.alb.LoadBalancer

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

    Provides a ALB Load Balancer resource.

    For information about ALB Load Balancer and how to use it, see What is Load Balancer.

    NOTE: Available since v1.132.0.

    Create LoadBalancer Resource

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

    Constructor syntax

    new LoadBalancer(name: string, args: LoadBalancerArgs, opts?: CustomResourceOptions);
    @overload
    def LoadBalancer(resource_name: str,
                     args: LoadBalancerArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def LoadBalancer(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     load_balancer_billing_config: Optional[LoadBalancerLoadBalancerBillingConfigArgs] = None,
                     zone_mappings: Optional[Sequence[LoadBalancerZoneMappingArgs]] = None,
                     vpc_id: Optional[str] = None,
                     address_type: Optional[str] = None,
                     load_balancer_edition: Optional[str] = None,
                     bandwidth_package_id: Optional[str] = None,
                     dry_run: Optional[bool] = None,
                     ipv6_address_type: Optional[str] = None,
                     deletion_protection_enabled: Optional[bool] = None,
                     access_log_config: Optional[LoadBalancerAccessLogConfigArgs] = None,
                     load_balancer_name: Optional[str] = None,
                     modification_protection_config: Optional[LoadBalancerModificationProtectionConfigArgs] = None,
                     resource_group_id: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     address_ip_version: Optional[str] = None,
                     address_allocated_mode: Optional[str] = None)
    func NewLoadBalancer(ctx *Context, name string, args LoadBalancerArgs, opts ...ResourceOption) (*LoadBalancer, error)
    public LoadBalancer(string name, LoadBalancerArgs args, CustomResourceOptions? opts = null)
    public LoadBalancer(String name, LoadBalancerArgs args)
    public LoadBalancer(String name, LoadBalancerArgs args, CustomResourceOptions options)
    
    type: alicloud:alb:LoadBalancer
    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 LoadBalancerArgs
    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 LoadBalancerArgs
    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 LoadBalancerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LoadBalancerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LoadBalancerArgs
    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 loadBalancerResource = new AliCloud.Alb.LoadBalancer("loadBalancerResource", new()
    {
        LoadBalancerBillingConfig = new AliCloud.Alb.Inputs.LoadBalancerLoadBalancerBillingConfigArgs
        {
            PayType = "string",
        },
        ZoneMappings = new[]
        {
            new AliCloud.Alb.Inputs.LoadBalancerZoneMappingArgs
            {
                VswitchId = "string",
                ZoneId = "string",
                LoadBalancerAddresses = new[]
                {
                    new AliCloud.Alb.Inputs.LoadBalancerZoneMappingLoadBalancerAddressArgs
                    {
                        Address = "string",
                        AllocationId = "string",
                        EipType = "string",
                        Ipv6Address = "string",
                    },
                },
            },
        },
        VpcId = "string",
        AddressType = "string",
        LoadBalancerEdition = "string",
        BandwidthPackageId = "string",
        DryRun = false,
        Ipv6AddressType = "string",
        DeletionProtectionEnabled = false,
        AccessLogConfig = new AliCloud.Alb.Inputs.LoadBalancerAccessLogConfigArgs
        {
            LogProject = "string",
            LogStore = "string",
        },
        LoadBalancerName = "string",
        ModificationProtectionConfig = new AliCloud.Alb.Inputs.LoadBalancerModificationProtectionConfigArgs
        {
            Reason = "string",
            Status = "string",
        },
        ResourceGroupId = "string",
        Tags = 
        {
            { "string", "string" },
        },
        AddressIpVersion = "string",
        AddressAllocatedMode = "string",
    });
    
    example, err := alb.NewLoadBalancer(ctx, "loadBalancerResource", &alb.LoadBalancerArgs{
    	LoadBalancerBillingConfig: &alb.LoadBalancerLoadBalancerBillingConfigArgs{
    		PayType: pulumi.String("string"),
    	},
    	ZoneMappings: alb.LoadBalancerZoneMappingArray{
    		&alb.LoadBalancerZoneMappingArgs{
    			VswitchId: pulumi.String("string"),
    			ZoneId:    pulumi.String("string"),
    			LoadBalancerAddresses: alb.LoadBalancerZoneMappingLoadBalancerAddressArray{
    				&alb.LoadBalancerZoneMappingLoadBalancerAddressArgs{
    					Address:      pulumi.String("string"),
    					AllocationId: pulumi.String("string"),
    					EipType:      pulumi.String("string"),
    					Ipv6Address:  pulumi.String("string"),
    				},
    			},
    		},
    	},
    	VpcId:                     pulumi.String("string"),
    	AddressType:               pulumi.String("string"),
    	LoadBalancerEdition:       pulumi.String("string"),
    	BandwidthPackageId:        pulumi.String("string"),
    	DryRun:                    pulumi.Bool(false),
    	Ipv6AddressType:           pulumi.String("string"),
    	DeletionProtectionEnabled: pulumi.Bool(false),
    	AccessLogConfig: &alb.LoadBalancerAccessLogConfigArgs{
    		LogProject: pulumi.String("string"),
    		LogStore:   pulumi.String("string"),
    	},
    	LoadBalancerName: pulumi.String("string"),
    	ModificationProtectionConfig: &alb.LoadBalancerModificationProtectionConfigArgs{
    		Reason: pulumi.String("string"),
    		Status: pulumi.String("string"),
    	},
    	ResourceGroupId: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	AddressIpVersion:     pulumi.String("string"),
    	AddressAllocatedMode: pulumi.String("string"),
    })
    
    var loadBalancerResource = new LoadBalancer("loadBalancerResource", LoadBalancerArgs.builder()
        .loadBalancerBillingConfig(LoadBalancerLoadBalancerBillingConfigArgs.builder()
            .payType("string")
            .build())
        .zoneMappings(LoadBalancerZoneMappingArgs.builder()
            .vswitchId("string")
            .zoneId("string")
            .loadBalancerAddresses(LoadBalancerZoneMappingLoadBalancerAddressArgs.builder()
                .address("string")
                .allocationId("string")
                .eipType("string")
                .ipv6Address("string")
                .build())
            .build())
        .vpcId("string")
        .addressType("string")
        .loadBalancerEdition("string")
        .bandwidthPackageId("string")
        .dryRun(false)
        .ipv6AddressType("string")
        .deletionProtectionEnabled(false)
        .accessLogConfig(LoadBalancerAccessLogConfigArgs.builder()
            .logProject("string")
            .logStore("string")
            .build())
        .loadBalancerName("string")
        .modificationProtectionConfig(LoadBalancerModificationProtectionConfigArgs.builder()
            .reason("string")
            .status("string")
            .build())
        .resourceGroupId("string")
        .tags(Map.of("string", "string"))
        .addressIpVersion("string")
        .addressAllocatedMode("string")
        .build());
    
    load_balancer_resource = alicloud.alb.LoadBalancer("loadBalancerResource",
        load_balancer_billing_config={
            "pay_type": "string",
        },
        zone_mappings=[{
            "vswitch_id": "string",
            "zone_id": "string",
            "load_balancer_addresses": [{
                "address": "string",
                "allocation_id": "string",
                "eip_type": "string",
                "ipv6_address": "string",
            }],
        }],
        vpc_id="string",
        address_type="string",
        load_balancer_edition="string",
        bandwidth_package_id="string",
        dry_run=False,
        ipv6_address_type="string",
        deletion_protection_enabled=False,
        access_log_config={
            "log_project": "string",
            "log_store": "string",
        },
        load_balancer_name="string",
        modification_protection_config={
            "reason": "string",
            "status": "string",
        },
        resource_group_id="string",
        tags={
            "string": "string",
        },
        address_ip_version="string",
        address_allocated_mode="string")
    
    const loadBalancerResource = new alicloud.alb.LoadBalancer("loadBalancerResource", {
        loadBalancerBillingConfig: {
            payType: "string",
        },
        zoneMappings: [{
            vswitchId: "string",
            zoneId: "string",
            loadBalancerAddresses: [{
                address: "string",
                allocationId: "string",
                eipType: "string",
                ipv6Address: "string",
            }],
        }],
        vpcId: "string",
        addressType: "string",
        loadBalancerEdition: "string",
        bandwidthPackageId: "string",
        dryRun: false,
        ipv6AddressType: "string",
        deletionProtectionEnabled: false,
        accessLogConfig: {
            logProject: "string",
            logStore: "string",
        },
        loadBalancerName: "string",
        modificationProtectionConfig: {
            reason: "string",
            status: "string",
        },
        resourceGroupId: "string",
        tags: {
            string: "string",
        },
        addressIpVersion: "string",
        addressAllocatedMode: "string",
    });
    
    type: alicloud:alb:LoadBalancer
    properties:
        accessLogConfig:
            logProject: string
            logStore: string
        addressAllocatedMode: string
        addressIpVersion: string
        addressType: string
        bandwidthPackageId: string
        deletionProtectionEnabled: false
        dryRun: false
        ipv6AddressType: string
        loadBalancerBillingConfig:
            payType: string
        loadBalancerEdition: string
        loadBalancerName: string
        modificationProtectionConfig:
            reason: string
            status: string
        resourceGroupId: string
        tags:
            string: string
        vpcId: string
        zoneMappings:
            - loadBalancerAddresses:
                - address: string
                  allocationId: string
                  eipType: string
                  ipv6Address: string
              vswitchId: string
              zoneId: string
    

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

    AddressType string
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    LoadBalancerBillingConfig Pulumi.AliCloud.Alb.Inputs.LoadBalancerLoadBalancerBillingConfig
    The billing method of the ALB instance. See load_balancer_billing_config below.
    LoadBalancerEdition string
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    VpcId string
    The ID of the VPC.
    ZoneMappings List<Pulumi.AliCloud.Alb.Inputs.LoadBalancerZoneMapping>
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.
    AccessLogConfig Pulumi.AliCloud.Alb.Inputs.LoadBalancerAccessLogConfig
    The configuration of the access log. See access_log_config below.
    AddressAllocatedMode string
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    AddressIpVersion string
    The protocol version. Valid values: IPv4, DualStack.
    BandwidthPackageId string
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    DeletionProtectionEnabled bool
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    DryRun bool
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    Ipv6AddressType string
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    LoadBalancerName string
    The name of the ALB instance.
    ModificationProtectionConfig Pulumi.AliCloud.Alb.Inputs.LoadBalancerModificationProtectionConfig
    The configuration of the read-only mode. See modification_protection_config below.
    ResourceGroupId string
    The ID of the resource group.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    AddressType string
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    LoadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfigArgs
    The billing method of the ALB instance. See load_balancer_billing_config below.
    LoadBalancerEdition string
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    VpcId string
    The ID of the VPC.
    ZoneMappings []LoadBalancerZoneMappingArgs
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.
    AccessLogConfig LoadBalancerAccessLogConfigArgs
    The configuration of the access log. See access_log_config below.
    AddressAllocatedMode string
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    AddressIpVersion string
    The protocol version. Valid values: IPv4, DualStack.
    BandwidthPackageId string
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    DeletionProtectionEnabled bool
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    DryRun bool
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    Ipv6AddressType string
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    LoadBalancerName string
    The name of the ALB instance.
    ModificationProtectionConfig LoadBalancerModificationProtectionConfigArgs
    The configuration of the read-only mode. See modification_protection_config below.
    ResourceGroupId string
    The ID of the resource group.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    addressType String
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    loadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfig
    The billing method of the ALB instance. See load_balancer_billing_config below.
    loadBalancerEdition String
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    vpcId String
    The ID of the VPC.
    zoneMappings List<LoadBalancerZoneMapping>
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.
    accessLogConfig LoadBalancerAccessLogConfig
    The configuration of the access log. See access_log_config below.
    addressAllocatedMode String
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    addressIpVersion String
    The protocol version. Valid values: IPv4, DualStack.
    bandwidthPackageId String
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    deletionProtectionEnabled Boolean
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    dryRun Boolean
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    ipv6AddressType String
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    loadBalancerName String
    The name of the ALB instance.
    modificationProtectionConfig LoadBalancerModificationProtectionConfig
    The configuration of the read-only mode. See modification_protection_config below.
    resourceGroupId String
    The ID of the resource group.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    addressType string
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    loadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfig
    The billing method of the ALB instance. See load_balancer_billing_config below.
    loadBalancerEdition string
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    vpcId string
    The ID of the VPC.
    zoneMappings LoadBalancerZoneMapping[]
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.
    accessLogConfig LoadBalancerAccessLogConfig
    The configuration of the access log. See access_log_config below.
    addressAllocatedMode string
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    addressIpVersion string
    The protocol version. Valid values: IPv4, DualStack.
    bandwidthPackageId string
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    deletionProtectionEnabled boolean
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    dryRun boolean
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    ipv6AddressType string
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    loadBalancerName string
    The name of the ALB instance.
    modificationProtectionConfig LoadBalancerModificationProtectionConfig
    The configuration of the read-only mode. See modification_protection_config below.
    resourceGroupId string
    The ID of the resource group.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    address_type str
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    load_balancer_billing_config LoadBalancerLoadBalancerBillingConfigArgs
    The billing method of the ALB instance. See load_balancer_billing_config below.
    load_balancer_edition str
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    vpc_id str
    The ID of the VPC.
    zone_mappings Sequence[LoadBalancerZoneMappingArgs]
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.
    access_log_config LoadBalancerAccessLogConfigArgs
    The configuration of the access log. See access_log_config below.
    address_allocated_mode str
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    address_ip_version str
    The protocol version. Valid values: IPv4, DualStack.
    bandwidth_package_id str
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    deletion_protection_enabled bool
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    dry_run bool
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    ipv6_address_type str
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    load_balancer_name str
    The name of the ALB instance.
    modification_protection_config LoadBalancerModificationProtectionConfigArgs
    The configuration of the read-only mode. See modification_protection_config below.
    resource_group_id str
    The ID of the resource group.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    addressType String
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    loadBalancerBillingConfig Property Map
    The billing method of the ALB instance. See load_balancer_billing_config below.
    loadBalancerEdition String
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    vpcId String
    The ID of the VPC.
    zoneMappings List<Property Map>
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.
    accessLogConfig Property Map
    The configuration of the access log. See access_log_config below.
    addressAllocatedMode String
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    addressIpVersion String
    The protocol version. Valid values: IPv4, DualStack.
    bandwidthPackageId String
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    deletionProtectionEnabled Boolean
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    dryRun Boolean
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    ipv6AddressType String
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    loadBalancerName String
    The name of the ALB instance.
    modificationProtectionConfig Property Map
    The configuration of the read-only mode. See modification_protection_config below.
    resourceGroupId String
    The ID of the resource group.
    tags Map<String>
    A mapping of tags to assign to the resource.

    Outputs

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

    CreateTime string
    The time when the resource was created.
    DnsName string
    (Available since v1.158.0) The domain name of the ALB instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the Load Balancer.
    CreateTime string
    The time when the resource was created.
    DnsName string
    (Available since v1.158.0) The domain name of the ALB instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the Load Balancer.
    createTime String
    The time when the resource was created.
    dnsName String
    (Available since v1.158.0) The domain name of the ALB instance.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the Load Balancer.
    createTime string
    The time when the resource was created.
    dnsName string
    (Available since v1.158.0) The domain name of the ALB instance.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the Load Balancer.
    create_time str
    The time when the resource was created.
    dns_name str
    (Available since v1.158.0) The domain name of the ALB instance.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the Load Balancer.
    createTime String
    The time when the resource was created.
    dnsName String
    (Available since v1.158.0) The domain name of the ALB instance.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the Load Balancer.

    Look up Existing LoadBalancer Resource

    Get an existing LoadBalancer 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?: LoadBalancerState, opts?: CustomResourceOptions): LoadBalancer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_log_config: Optional[LoadBalancerAccessLogConfigArgs] = None,
            address_allocated_mode: Optional[str] = None,
            address_ip_version: Optional[str] = None,
            address_type: Optional[str] = None,
            bandwidth_package_id: Optional[str] = None,
            create_time: Optional[str] = None,
            deletion_protection_enabled: Optional[bool] = None,
            dns_name: Optional[str] = None,
            dry_run: Optional[bool] = None,
            ipv6_address_type: Optional[str] = None,
            load_balancer_billing_config: Optional[LoadBalancerLoadBalancerBillingConfigArgs] = None,
            load_balancer_edition: Optional[str] = None,
            load_balancer_name: Optional[str] = None,
            modification_protection_config: Optional[LoadBalancerModificationProtectionConfigArgs] = None,
            resource_group_id: Optional[str] = None,
            status: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            vpc_id: Optional[str] = None,
            zone_mappings: Optional[Sequence[LoadBalancerZoneMappingArgs]] = None) -> LoadBalancer
    func GetLoadBalancer(ctx *Context, name string, id IDInput, state *LoadBalancerState, opts ...ResourceOption) (*LoadBalancer, error)
    public static LoadBalancer Get(string name, Input<string> id, LoadBalancerState? state, CustomResourceOptions? opts = null)
    public static LoadBalancer get(String name, Output<String> id, LoadBalancerState 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:
    AccessLogConfig Pulumi.AliCloud.Alb.Inputs.LoadBalancerAccessLogConfig
    The configuration of the access log. See access_log_config below.
    AddressAllocatedMode string
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    AddressIpVersion string
    The protocol version. Valid values: IPv4, DualStack.
    AddressType string
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    BandwidthPackageId string
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    CreateTime string
    The time when the resource was created.
    DeletionProtectionEnabled bool
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    DnsName string
    (Available since v1.158.0) The domain name of the ALB instance.
    DryRun bool
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    Ipv6AddressType string
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    LoadBalancerBillingConfig Pulumi.AliCloud.Alb.Inputs.LoadBalancerLoadBalancerBillingConfig
    The billing method of the ALB instance. See load_balancer_billing_config below.
    LoadBalancerEdition string
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    LoadBalancerName string
    The name of the ALB instance.
    ModificationProtectionConfig Pulumi.AliCloud.Alb.Inputs.LoadBalancerModificationProtectionConfig
    The configuration of the read-only mode. See modification_protection_config below.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    The status of the Load Balancer.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    VpcId string
    The ID of the VPC.
    ZoneMappings List<Pulumi.AliCloud.Alb.Inputs.LoadBalancerZoneMapping>
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.
    AccessLogConfig LoadBalancerAccessLogConfigArgs
    The configuration of the access log. See access_log_config below.
    AddressAllocatedMode string
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    AddressIpVersion string
    The protocol version. Valid values: IPv4, DualStack.
    AddressType string
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    BandwidthPackageId string
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    CreateTime string
    The time when the resource was created.
    DeletionProtectionEnabled bool
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    DnsName string
    (Available since v1.158.0) The domain name of the ALB instance.
    DryRun bool
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    Ipv6AddressType string
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    LoadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfigArgs
    The billing method of the ALB instance. See load_balancer_billing_config below.
    LoadBalancerEdition string
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    LoadBalancerName string
    The name of the ALB instance.
    ModificationProtectionConfig LoadBalancerModificationProtectionConfigArgs
    The configuration of the read-only mode. See modification_protection_config below.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    The status of the Load Balancer.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    VpcId string
    The ID of the VPC.
    ZoneMappings []LoadBalancerZoneMappingArgs
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.
    accessLogConfig LoadBalancerAccessLogConfig
    The configuration of the access log. See access_log_config below.
    addressAllocatedMode String
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    addressIpVersion String
    The protocol version. Valid values: IPv4, DualStack.
    addressType String
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    bandwidthPackageId String
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    createTime String
    The time when the resource was created.
    deletionProtectionEnabled Boolean
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    dnsName String
    (Available since v1.158.0) The domain name of the ALB instance.
    dryRun Boolean
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    ipv6AddressType String
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    loadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfig
    The billing method of the ALB instance. See load_balancer_billing_config below.
    loadBalancerEdition String
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    loadBalancerName String
    The name of the ALB instance.
    modificationProtectionConfig LoadBalancerModificationProtectionConfig
    The configuration of the read-only mode. See modification_protection_config below.
    resourceGroupId String
    The ID of the resource group.
    status String
    The status of the Load Balancer.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    vpcId String
    The ID of the VPC.
    zoneMappings List<LoadBalancerZoneMapping>
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.
    accessLogConfig LoadBalancerAccessLogConfig
    The configuration of the access log. See access_log_config below.
    addressAllocatedMode string
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    addressIpVersion string
    The protocol version. Valid values: IPv4, DualStack.
    addressType string
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    bandwidthPackageId string
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    createTime string
    The time when the resource was created.
    deletionProtectionEnabled boolean
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    dnsName string
    (Available since v1.158.0) The domain name of the ALB instance.
    dryRun boolean
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    ipv6AddressType string
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    loadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfig
    The billing method of the ALB instance. See load_balancer_billing_config below.
    loadBalancerEdition string
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    loadBalancerName string
    The name of the ALB instance.
    modificationProtectionConfig LoadBalancerModificationProtectionConfig
    The configuration of the read-only mode. See modification_protection_config below.
    resourceGroupId string
    The ID of the resource group.
    status string
    The status of the Load Balancer.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    vpcId string
    The ID of the VPC.
    zoneMappings LoadBalancerZoneMapping[]
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.
    access_log_config LoadBalancerAccessLogConfigArgs
    The configuration of the access log. See access_log_config below.
    address_allocated_mode str
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    address_ip_version str
    The protocol version. Valid values: IPv4, DualStack.
    address_type str
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    bandwidth_package_id str
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    create_time str
    The time when the resource was created.
    deletion_protection_enabled bool
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    dns_name str
    (Available since v1.158.0) The domain name of the ALB instance.
    dry_run bool
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    ipv6_address_type str
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    load_balancer_billing_config LoadBalancerLoadBalancerBillingConfigArgs
    The billing method of the ALB instance. See load_balancer_billing_config below.
    load_balancer_edition str
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    load_balancer_name str
    The name of the ALB instance.
    modification_protection_config LoadBalancerModificationProtectionConfigArgs
    The configuration of the read-only mode. See modification_protection_config below.
    resource_group_id str
    The ID of the resource group.
    status str
    The status of the Load Balancer.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    vpc_id str
    The ID of the VPC.
    zone_mappings Sequence[LoadBalancerZoneMappingArgs]
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.
    accessLogConfig Property Map
    The configuration of the access log. See access_log_config below.
    addressAllocatedMode String
    The mode in which IP addresses are allocated. Valid values: Fixed, Dynamic.
    addressIpVersion String
    The protocol version. Valid values: IPv4, DualStack.
    addressType String
    The type of the address of the ALB instance. Valid values: Internet, Intranet.
    bandwidthPackageId String
    The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.
    createTime String
    The time when the resource was created.
    deletionProtectionEnabled Boolean
    Specifies whether to enable deletion protection. Default value: false. Valid values:
    dnsName String
    (Available since v1.158.0) The domain name of the ALB instance.
    dryRun Boolean
    Specifies whether to perform a dry run. Default value: false. Valid values: true, false.
    ipv6AddressType String
    The address type of the Ipv6 address. Valid values: Internet, Intranet.
    loadBalancerBillingConfig Property Map
    The billing method of the ALB instance. See load_balancer_billing_config below.
    loadBalancerEdition String
    The edition of the ALB instance. The features and billing rules vary based on the edition of the ALB instance. Valid values: Basic, Standard, StandardWithWaf.
    loadBalancerName String
    The name of the ALB instance.
    modificationProtectionConfig Property Map
    The configuration of the read-only mode. See modification_protection_config below.
    resourceGroupId String
    The ID of the resource group.
    status String
    The status of the Load Balancer.
    tags Map<String>
    A mapping of tags to assign to the resource.
    vpcId String
    The ID of the VPC.
    zoneMappings List<Property Map>
    The list of zones and vSwitch mappings. You must specify at least two zones. See zone_mappings below.

    Supporting Types

    LoadBalancerAccessLogConfig, LoadBalancerAccessLogConfigArgs

    LogProject string
    The project to which the access log is shipped.
    LogStore string
    The Logstore to which the access log is shipped.
    LogProject string
    The project to which the access log is shipped.
    LogStore string
    The Logstore to which the access log is shipped.
    logProject String
    The project to which the access log is shipped.
    logStore String
    The Logstore to which the access log is shipped.
    logProject string
    The project to which the access log is shipped.
    logStore string
    The Logstore to which the access log is shipped.
    log_project str
    The project to which the access log is shipped.
    log_store str
    The Logstore to which the access log is shipped.
    logProject String
    The project to which the access log is shipped.
    logStore String
    The Logstore to which the access log is shipped.

    LoadBalancerLoadBalancerBillingConfig, LoadBalancerLoadBalancerBillingConfigArgs

    PayType string
    The billing method of the ALB instance. Valid values: PayAsYouGo.
    PayType string
    The billing method of the ALB instance. Valid values: PayAsYouGo.
    payType String
    The billing method of the ALB instance. Valid values: PayAsYouGo.
    payType string
    The billing method of the ALB instance. Valid values: PayAsYouGo.
    pay_type str
    The billing method of the ALB instance. Valid values: PayAsYouGo.
    payType String
    The billing method of the ALB instance. Valid values: PayAsYouGo.

    LoadBalancerModificationProtectionConfig, LoadBalancerModificationProtectionConfigArgs

    Reason string
    The reason for enabling the configuration read-only mode. NOTE: reason takes effect only if status is set to ConsoleProtection.
    Status string
    Specifies whether to enable the configuration read-only mode. Valid values: ConsoleProtection, NonProtection.
    Reason string
    The reason for enabling the configuration read-only mode. NOTE: reason takes effect only if status is set to ConsoleProtection.
    Status string
    Specifies whether to enable the configuration read-only mode. Valid values: ConsoleProtection, NonProtection.
    reason String
    The reason for enabling the configuration read-only mode. NOTE: reason takes effect only if status is set to ConsoleProtection.
    status String
    Specifies whether to enable the configuration read-only mode. Valid values: ConsoleProtection, NonProtection.
    reason string
    The reason for enabling the configuration read-only mode. NOTE: reason takes effect only if status is set to ConsoleProtection.
    status string
    Specifies whether to enable the configuration read-only mode. Valid values: ConsoleProtection, NonProtection.
    reason str
    The reason for enabling the configuration read-only mode. NOTE: reason takes effect only if status is set to ConsoleProtection.
    status str
    Specifies whether to enable the configuration read-only mode. Valid values: ConsoleProtection, NonProtection.
    reason String
    The reason for enabling the configuration read-only mode. NOTE: reason takes effect only if status is set to ConsoleProtection.
    status String
    Specifies whether to enable the configuration read-only mode. Valid values: ConsoleProtection, NonProtection.

    LoadBalancerZoneMapping, LoadBalancerZoneMappingArgs

    VswitchId string
    The ID of the VSwitch.
    ZoneId string
    The zone ID of the ALB instance.
    LoadBalancerAddresses List<Pulumi.AliCloud.Alb.Inputs.LoadBalancerZoneMappingLoadBalancerAddress>
    The IP address of the ALB instance.
    VswitchId string
    The ID of the VSwitch.
    ZoneId string
    The zone ID of the ALB instance.
    LoadBalancerAddresses []LoadBalancerZoneMappingLoadBalancerAddress
    The IP address of the ALB instance.
    vswitchId String
    The ID of the VSwitch.
    zoneId String
    The zone ID of the ALB instance.
    loadBalancerAddresses List<LoadBalancerZoneMappingLoadBalancerAddress>
    The IP address of the ALB instance.
    vswitchId string
    The ID of the VSwitch.
    zoneId string
    The zone ID of the ALB instance.
    loadBalancerAddresses LoadBalancerZoneMappingLoadBalancerAddress[]
    The IP address of the ALB instance.
    vswitch_id str
    The ID of the VSwitch.
    zone_id str
    The zone ID of the ALB instance.
    load_balancer_addresses Sequence[LoadBalancerZoneMappingLoadBalancerAddress]
    The IP address of the ALB instance.
    vswitchId String
    The ID of the VSwitch.
    zoneId String
    The zone ID of the ALB instance.
    loadBalancerAddresses List<Property Map>
    The IP address of the ALB instance.

    LoadBalancerZoneMappingLoadBalancerAddress, LoadBalancerZoneMappingLoadBalancerAddressArgs

    Address string
    IP address. The Public IP Address, and Private IP Address from the Address Type.
    AllocationId string
    The ID of the EIP.
    EipType string
    The type of the EIP.
    Ipv6Address string
    Ipv6 address.
    Address string
    IP address. The Public IP Address, and Private IP Address from the Address Type.
    AllocationId string
    The ID of the EIP.
    EipType string
    The type of the EIP.
    Ipv6Address string
    Ipv6 address.
    address String
    IP address. The Public IP Address, and Private IP Address from the Address Type.
    allocationId String
    The ID of the EIP.
    eipType String
    The type of the EIP.
    ipv6Address String
    Ipv6 address.
    address string
    IP address. The Public IP Address, and Private IP Address from the Address Type.
    allocationId string
    The ID of the EIP.
    eipType string
    The type of the EIP.
    ipv6Address string
    Ipv6 address.
    address str
    IP address. The Public IP Address, and Private IP Address from the Address Type.
    allocation_id str
    The ID of the EIP.
    eip_type str
    The type of the EIP.
    ipv6_address str
    Ipv6 address.
    address String
    IP address. The Public IP Address, and Private IP Address from the Address Type.
    allocationId String
    The ID of the EIP.
    eipType String
    The type of the EIP.
    ipv6Address String
    Ipv6 address.

    Import

    Alb Load Balancer can be imported using the id, e.g.

    $ pulumi import alicloud:alb/loadBalancer:LoadBalancer example <id>
    

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi