1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. alb
  5. LoadBalancer
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

alicloud.alb.LoadBalancer

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.0 published on Saturday, Jun 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, Any]] = 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.

    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", "any" },
        },
        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.Map{
    		"string": pulumi.Any("any"),
    	},
    	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", "any"))
        .addressIpVersion("string")
        .addressAllocatedMode("string")
        .build());
    
    load_balancer_resource = alicloud.alb.LoadBalancer("loadBalancerResource",
        load_balancer_billing_config=alicloud.alb.LoadBalancerLoadBalancerBillingConfigArgs(
            pay_type="string",
        ),
        zone_mappings=[alicloud.alb.LoadBalancerZoneMappingArgs(
            vswitch_id="string",
            zone_id="string",
            load_balancer_addresses=[alicloud.alb.LoadBalancerZoneMappingLoadBalancerAddressArgs(
                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=alicloud.alb.LoadBalancerAccessLogConfigArgs(
            log_project="string",
            log_store="string",
        ),
        load_balancer_name="string",
        modification_protection_config=alicloud.alb.LoadBalancerModificationProtectionConfigArgs(
            reason="string",
            status="string",
        ),
        resource_group_id="string",
        tags={
            "string": "any",
        },
        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: "any",
        },
        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: any
        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

    The LoadBalancer resource accepts the following input properties:

    AddressType string
    The type of IP address that the SLB instance uses to provide services.
    LoadBalancerBillingConfig Pulumi.AliCloud.Alb.Inputs.LoadBalancerLoadBalancerBillingConfig
    The configuration of the billing method. See load_balancer_billing_config below.
    LoadBalancerEdition string
    The edition of the ALB instance.
    VpcId string
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    ZoneMappings List<Pulumi.AliCloud.Alb.Inputs.LoadBalancerZoneMapping>
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.
    AccessLogConfig Pulumi.AliCloud.Alb.Inputs.LoadBalancerAccessLogConfig
    The Access Logging Configuration Structure. See access_log_config below.
    AddressAllocatedMode string
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    AddressIpVersion string
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    BandwidthPackageId string
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    DeletionProtectionEnabled bool
    Whether to enable delete protection. Value:true: on.false (default): Off.
    DryRun bool
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    Ipv6AddressType string
    The address type of Ipv6.
    LoadBalancerName string
    The name of the resource.
    ModificationProtectionConfig Pulumi.AliCloud.Alb.Inputs.LoadBalancerModificationProtectionConfig
    Modify the Protection Configuration. See modification_protection_config below.
    ResourceGroupId string
    The ID of the resource group.
    Tags Dictionary<string, object>
    The tag of the resource.
    AddressType string
    The type of IP address that the SLB instance uses to provide services.
    LoadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfigArgs
    The configuration of the billing method. See load_balancer_billing_config below.
    LoadBalancerEdition string
    The edition of the ALB instance.
    VpcId string
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    ZoneMappings []LoadBalancerZoneMappingArgs
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.
    AccessLogConfig LoadBalancerAccessLogConfigArgs
    The Access Logging Configuration Structure. See access_log_config below.
    AddressAllocatedMode string
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    AddressIpVersion string
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    BandwidthPackageId string
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    DeletionProtectionEnabled bool
    Whether to enable delete protection. Value:true: on.false (default): Off.
    DryRun bool
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    Ipv6AddressType string
    The address type of Ipv6.
    LoadBalancerName string
    The name of the resource.
    ModificationProtectionConfig LoadBalancerModificationProtectionConfigArgs
    Modify the Protection Configuration. See modification_protection_config below.
    ResourceGroupId string
    The ID of the resource group.
    Tags map[string]interface{}
    The tag of the resource.
    addressType String
    The type of IP address that the SLB instance uses to provide services.
    loadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfig
    The configuration of the billing method. See load_balancer_billing_config below.
    loadBalancerEdition String
    The edition of the ALB instance.
    vpcId String
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    zoneMappings List<LoadBalancerZoneMapping>
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.
    accessLogConfig LoadBalancerAccessLogConfig
    The Access Logging Configuration Structure. See access_log_config below.
    addressAllocatedMode String
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    addressIpVersion String
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    bandwidthPackageId String
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    deletionProtectionEnabled Boolean
    Whether to enable delete protection. Value:true: on.false (default): Off.
    dryRun Boolean
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    ipv6AddressType String
    The address type of Ipv6.
    loadBalancerName String
    The name of the resource.
    modificationProtectionConfig LoadBalancerModificationProtectionConfig
    Modify the Protection Configuration. See modification_protection_config below.
    resourceGroupId String
    The ID of the resource group.
    tags Map<String,Object>
    The tag of the resource.
    addressType string
    The type of IP address that the SLB instance uses to provide services.
    loadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfig
    The configuration of the billing method. See load_balancer_billing_config below.
    loadBalancerEdition string
    The edition of the ALB instance.
    vpcId string
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    zoneMappings LoadBalancerZoneMapping[]
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.
    accessLogConfig LoadBalancerAccessLogConfig
    The Access Logging Configuration Structure. See access_log_config below.
    addressAllocatedMode string
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    addressIpVersion string
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    bandwidthPackageId string
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    deletionProtectionEnabled boolean
    Whether to enable delete protection. Value:true: on.false (default): Off.
    dryRun boolean
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    ipv6AddressType string
    The address type of Ipv6.
    loadBalancerName string
    The name of the resource.
    modificationProtectionConfig LoadBalancerModificationProtectionConfig
    Modify the Protection Configuration. See modification_protection_config below.
    resourceGroupId string
    The ID of the resource group.
    tags {[key: string]: any}
    The tag of the resource.
    address_type str
    The type of IP address that the SLB instance uses to provide services.
    load_balancer_billing_config LoadBalancerLoadBalancerBillingConfigArgs
    The configuration of the billing method. See load_balancer_billing_config below.
    load_balancer_edition str
    The edition of the ALB instance.
    vpc_id str
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    zone_mappings Sequence[LoadBalancerZoneMappingArgs]
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.
    access_log_config LoadBalancerAccessLogConfigArgs
    The Access Logging Configuration Structure. See access_log_config below.
    address_allocated_mode str
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    address_ip_version str
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    bandwidth_package_id str
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    deletion_protection_enabled bool
    Whether to enable delete protection. Value:true: on.false (default): Off.
    dry_run bool
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    ipv6_address_type str
    The address type of Ipv6.
    load_balancer_name str
    The name of the resource.
    modification_protection_config LoadBalancerModificationProtectionConfigArgs
    Modify the Protection Configuration. See modification_protection_config below.
    resource_group_id str
    The ID of the resource group.
    tags Mapping[str, Any]
    The tag of the resource.
    addressType String
    The type of IP address that the SLB instance uses to provide services.
    loadBalancerBillingConfig Property Map
    The configuration of the billing method. See load_balancer_billing_config below.
    loadBalancerEdition String
    The edition of the ALB instance.
    vpcId String
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    zoneMappings List<Property Map>
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.
    accessLogConfig Property Map
    The Access Logging Configuration Structure. See access_log_config below.
    addressAllocatedMode String
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    addressIpVersion String
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    bandwidthPackageId String
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    deletionProtectionEnabled Boolean
    Whether to enable delete protection. Value:true: on.false (default): Off.
    dryRun Boolean
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    ipv6AddressType String
    The address type of Ipv6.
    loadBalancerName String
    The name of the resource.
    modificationProtectionConfig Property Map
    Modify the Protection Configuration. See modification_protection_config below.
    resourceGroupId String
    The ID of the resource group.
    tags Map<Any>
    The tag of the resource.

    Outputs

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

    CreateTime string
    The creation time of the resource.
    DnsName string
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).
    CreateTime string
    The creation time of the resource.
    DnsName string
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).
    createTime String
    The creation time of the resource.
    dnsName String
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).
    createTime string
    The creation time of the resource.
    dnsName string
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).
    create_time str
    The creation time of the resource.
    dns_name str
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).
    createTime String
    The creation time of the resource.
    dnsName String
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).

    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, Any]] = 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 Access Logging Configuration Structure. See access_log_config below.
    AddressAllocatedMode string
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    AddressIpVersion string
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    AddressType string
    The type of IP address that the SLB instance uses to provide services.
    BandwidthPackageId string
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    CreateTime string
    The creation time of the resource.
    DeletionProtectionEnabled bool
    Whether to enable delete protection. Value:true: on.false (default): Off.
    DnsName string
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    DryRun bool
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    Ipv6AddressType string
    The address type of Ipv6.
    LoadBalancerBillingConfig Pulumi.AliCloud.Alb.Inputs.LoadBalancerLoadBalancerBillingConfig
    The configuration of the billing method. See load_balancer_billing_config below.
    LoadBalancerEdition string
    The edition of the ALB instance.
    LoadBalancerName string
    The name of the resource.
    ModificationProtectionConfig Pulumi.AliCloud.Alb.Inputs.LoadBalancerModificationProtectionConfig
    Modify the Protection Configuration. See modification_protection_config below.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).
    Tags Dictionary<string, object>
    The tag of the resource.
    VpcId string
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    ZoneMappings List<Pulumi.AliCloud.Alb.Inputs.LoadBalancerZoneMapping>
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.
    AccessLogConfig LoadBalancerAccessLogConfigArgs
    The Access Logging Configuration Structure. See access_log_config below.
    AddressAllocatedMode string
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    AddressIpVersion string
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    AddressType string
    The type of IP address that the SLB instance uses to provide services.
    BandwidthPackageId string
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    CreateTime string
    The creation time of the resource.
    DeletionProtectionEnabled bool
    Whether to enable delete protection. Value:true: on.false (default): Off.
    DnsName string
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    DryRun bool
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    Ipv6AddressType string
    The address type of Ipv6.
    LoadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfigArgs
    The configuration of the billing method. See load_balancer_billing_config below.
    LoadBalancerEdition string
    The edition of the ALB instance.
    LoadBalancerName string
    The name of the resource.
    ModificationProtectionConfig LoadBalancerModificationProtectionConfigArgs
    Modify the Protection Configuration. See modification_protection_config below.
    ResourceGroupId string
    The ID of the resource group.
    Status string
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).
    Tags map[string]interface{}
    The tag of the resource.
    VpcId string
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    ZoneMappings []LoadBalancerZoneMappingArgs
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.
    accessLogConfig LoadBalancerAccessLogConfig
    The Access Logging Configuration Structure. See access_log_config below.
    addressAllocatedMode String
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    addressIpVersion String
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    addressType String
    The type of IP address that the SLB instance uses to provide services.
    bandwidthPackageId String
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    createTime String
    The creation time of the resource.
    deletionProtectionEnabled Boolean
    Whether to enable delete protection. Value:true: on.false (default): Off.
    dnsName String
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    dryRun Boolean
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    ipv6AddressType String
    The address type of Ipv6.
    loadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfig
    The configuration of the billing method. See load_balancer_billing_config below.
    loadBalancerEdition String
    The edition of the ALB instance.
    loadBalancerName String
    The name of the resource.
    modificationProtectionConfig LoadBalancerModificationProtectionConfig
    Modify the Protection Configuration. See modification_protection_config below.
    resourceGroupId String
    The ID of the resource group.
    status String
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).
    tags Map<String,Object>
    The tag of the resource.
    vpcId String
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    zoneMappings List<LoadBalancerZoneMapping>
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.
    accessLogConfig LoadBalancerAccessLogConfig
    The Access Logging Configuration Structure. See access_log_config below.
    addressAllocatedMode string
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    addressIpVersion string
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    addressType string
    The type of IP address that the SLB instance uses to provide services.
    bandwidthPackageId string
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    createTime string
    The creation time of the resource.
    deletionProtectionEnabled boolean
    Whether to enable delete protection. Value:true: on.false (default): Off.
    dnsName string
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    dryRun boolean
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    ipv6AddressType string
    The address type of Ipv6.
    loadBalancerBillingConfig LoadBalancerLoadBalancerBillingConfig
    The configuration of the billing method. See load_balancer_billing_config below.
    loadBalancerEdition string
    The edition of the ALB instance.
    loadBalancerName string
    The name of the resource.
    modificationProtectionConfig LoadBalancerModificationProtectionConfig
    Modify the Protection Configuration. See modification_protection_config below.
    resourceGroupId string
    The ID of the resource group.
    status string
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).
    tags {[key: string]: any}
    The tag of the resource.
    vpcId string
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    zoneMappings LoadBalancerZoneMapping[]
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.
    access_log_config LoadBalancerAccessLogConfigArgs
    The Access Logging Configuration Structure. See access_log_config below.
    address_allocated_mode str
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    address_ip_version str
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    address_type str
    The type of IP address that the SLB instance uses to provide services.
    bandwidth_package_id str
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    create_time str
    The creation time of the resource.
    deletion_protection_enabled bool
    Whether to enable delete protection. Value:true: on.false (default): Off.
    dns_name str
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    dry_run bool
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    ipv6_address_type str
    The address type of Ipv6.
    load_balancer_billing_config LoadBalancerLoadBalancerBillingConfigArgs
    The configuration of the billing method. See load_balancer_billing_config below.
    load_balancer_edition str
    The edition of the ALB instance.
    load_balancer_name str
    The name of the resource.
    modification_protection_config LoadBalancerModificationProtectionConfigArgs
    Modify the Protection Configuration. See modification_protection_config below.
    resource_group_id str
    The ID of the resource group.
    status str
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).
    tags Mapping[str, Any]
    The tag of the resource.
    vpc_id str
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    zone_mappings Sequence[LoadBalancerZoneMappingArgs]
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.
    accessLogConfig Property Map
    The Access Logging Configuration Structure. See access_log_config below.
    addressAllocatedMode String
    The method in which IP addresses are assigned. Valid values: Fixed: The ALB instance uses a fixed IP address. Dynamic (default): An IP address is dynamically assigned to each zone of the ALB instance.
    addressIpVersion String
    The protocol version. Value:

    • IPv4:IPv4 type.
    • DualStack: the dual-stack type.
    addressType String
    The type of IP address that the SLB instance uses to provide services.
    bandwidthPackageId String
    The ID of the EIP bandwidth plan which is associated with an ALB instance that uses a public IP address.
    createTime String
    The creation time of the resource.
    deletionProtectionEnabled Boolean
    Whether to enable delete protection. Value:true: on.false (default): Off.
    dnsName String
    The domain name of the ALB instance. NOTE: Available in v1.158.0+.
    dryRun Boolean
    Whether to PreCheck only this request, value:true: sends a check request and does not create a resource. Check items include whether required parameters are filled in, request format, and business restrictions. If the check fails, the corresponding error is returned. If the check passes, the error code DryRunOperation is returned.false (default): Sends a normal request, returns the HTTP_2xx status code after the check, and directly performs the operation.
    ipv6AddressType String
    The address type of Ipv6.
    loadBalancerBillingConfig Property Map
    The configuration of the billing method. See load_balancer_billing_config below.
    loadBalancerEdition String
    The edition of the ALB instance.
    loadBalancerName String
    The name of the resource.
    modificationProtectionConfig Property Map
    Modify the Protection Configuration. See modification_protection_config below.
    resourceGroupId String
    The ID of the resource group.
    status String
    Server Load Balancer Instance Status:, indicating that the instance listener will no longer forward traffic.(default).
    tags Map<Any>
    The tag of the resource.
    vpcId String
    The ID of the virtual private cloud (VPC) where the SLB instance is deployed.
    zoneMappings List<Property Map>
    The zones and vSwitches. You must specify at least two zones. See zone_mappings below.

    Supporting Types

    LoadBalancerAccessLogConfig, LoadBalancerAccessLogConfigArgs

    LogProject string
    This Log Storage Project.
    LogStore string
    This Log Storage Method Is Increased.
    LogProject string
    This Log Storage Project.
    LogStore string
    This Log Storage Method Is Increased.
    logProject String
    This Log Storage Project.
    logStore String
    This Log Storage Method Is Increased.
    logProject string
    This Log Storage Project.
    logStore string
    This Log Storage Method Is Increased.
    log_project str
    This Log Storage Project.
    log_store str
    This Log Storage Method Is Increased.
    logProject String
    This Log Storage Project.
    logStore String
    This Log Storage Method Is Increased.

    LoadBalancerLoadBalancerBillingConfig, LoadBalancerLoadBalancerBillingConfigArgs

    PayType string
    Pay Type. Valid values: PayAsYouGo. Note: provider changes the payment type to PayAsYouGo, while the actual parameter on api is PostPay.
    PayType string
    Pay Type. Valid values: PayAsYouGo. Note: provider changes the payment type to PayAsYouGo, while the actual parameter on api is PostPay.
    payType String
    Pay Type. Valid values: PayAsYouGo. Note: provider changes the payment type to PayAsYouGo, while the actual parameter on api is PostPay.
    payType string
    Pay Type. Valid values: PayAsYouGo. Note: provider changes the payment type to PayAsYouGo, while the actual parameter on api is PostPay.
    pay_type str
    Pay Type. Valid values: PayAsYouGo. Note: provider changes the payment type to PayAsYouGo, while the actual parameter on api is PostPay.
    payType String
    Pay Type. Valid values: PayAsYouGo. Note: provider changes the payment type to PayAsYouGo, while the actual parameter on api is PostPay.

    LoadBalancerModificationProtectionConfig, LoadBalancerModificationProtectionConfigArgs

    Reason string
    Managed Instance.
    Status string
    Load Balancing Modify the Protection Status.
    Reason string
    Managed Instance.
    Status string
    Load Balancing Modify the Protection Status.
    reason String
    Managed Instance.
    status String
    Load Balancing Modify the Protection Status.
    reason string
    Managed Instance.
    status string
    Load Balancing Modify the Protection Status.
    reason str
    Managed Instance.
    status str
    Load Balancing Modify the Protection Status.
    reason String
    Managed Instance.
    status String
    Load Balancing Modify the Protection Status.

    LoadBalancerZoneMapping, LoadBalancerZoneMappingArgs

    VswitchId string
    The ID of the vSwitch that corresponds to the zone. Each zone can use only one vSwitch and subnet.
    ZoneId string
    The ID of the zone to which the SLB instance belongs.
    LoadBalancerAddresses List<Pulumi.AliCloud.Alb.Inputs.LoadBalancerZoneMappingLoadBalancerAddress>
    The SLB Instance Address.
    VswitchId string
    The ID of the vSwitch that corresponds to the zone. Each zone can use only one vSwitch and subnet.
    ZoneId string
    The ID of the zone to which the SLB instance belongs.
    LoadBalancerAddresses []LoadBalancerZoneMappingLoadBalancerAddress
    The SLB Instance Address.
    vswitchId String
    The ID of the vSwitch that corresponds to the zone. Each zone can use only one vSwitch and subnet.
    zoneId String
    The ID of the zone to which the SLB instance belongs.
    loadBalancerAddresses List<LoadBalancerZoneMappingLoadBalancerAddress>
    The SLB Instance Address.
    vswitchId string
    The ID of the vSwitch that corresponds to the zone. Each zone can use only one vSwitch and subnet.
    zoneId string
    The ID of the zone to which the SLB instance belongs.
    loadBalancerAddresses LoadBalancerZoneMappingLoadBalancerAddress[]
    The SLB Instance Address.
    vswitch_id str
    The ID of the vSwitch that corresponds to the zone. Each zone can use only one vSwitch and subnet.
    zone_id str
    The ID of the zone to which the SLB instance belongs.
    load_balancer_addresses Sequence[LoadBalancerZoneMappingLoadBalancerAddress]
    The SLB Instance Address.
    vswitchId String
    The ID of the vSwitch that corresponds to the zone. Each zone can use only one vSwitch and subnet.
    zoneId String
    The ID of the zone to which the SLB instance belongs.
    loadBalancerAddresses List<Property Map>
    The SLB Instance Address.

    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 instance.
    EipType string
    The type of the EIP instance.
    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 instance.
    EipType string
    The type of the EIP instance.
    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 instance.
    eipType String
    The type of the EIP instance.
    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 instance.
    eipType string
    The type of the EIP instance.
    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 instance.
    eip_type str
    The type of the EIP instance.
    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 instance.
    eipType String
    The type of the EIP instance.
    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.57.0 published on Saturday, Jun 15, 2024 by Pulumi