Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
alicloud.waf.getDomains
Explore with Pulumi AI
Provides a WAF datasource to retrieve domains.
For information about WAF and how to use it, see What is Alibaba Cloud WAF.
NOTE: Available in 1.86.0+ .
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const default = alicloud.waf.getDomains({
    instanceId: "waf-cf-xxxxx",
});
import pulumi
import pulumi_alicloud as alicloud
default = alicloud.waf.get_domains(instance_id="waf-cf-xxxxx")
package main
import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/waf"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := waf.GetDomains(ctx, &waf.GetDomainsArgs{
			InstanceId: "waf-cf-xxxxx",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() => 
{
    var @default = AliCloud.Waf.GetDomains.Invoke(new()
    {
        InstanceId = "waf-cf-xxxxx",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.waf.WafFunctions;
import com.pulumi.alicloud.waf.inputs.GetDomainsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var default = WafFunctions.getDomains(GetDomainsArgs.builder()
            .instanceId("waf-cf-xxxxx")
            .build());
    }
}
variables:
  default:
    fn::invoke:
      Function: alicloud:waf:getDomains
      Arguments:
        instanceId: waf-cf-xxxxx
Using getDomains
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDomains(args: GetDomainsArgs, opts?: InvokeOptions): Promise<GetDomainsResult>
function getDomainsOutput(args: GetDomainsOutputArgs, opts?: InvokeOptions): Output<GetDomainsResult>def get_domains(enable_details: Optional[bool] = None,
                ids: Optional[Sequence[str]] = None,
                instance_id: Optional[str] = None,
                name_regex: Optional[str] = None,
                output_file: Optional[str] = None,
                resource_group_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDomainsResult
def get_domains_output(enable_details: Optional[pulumi.Input[bool]] = None,
                ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                instance_id: Optional[pulumi.Input[str]] = None,
                name_regex: Optional[pulumi.Input[str]] = None,
                output_file: Optional[pulumi.Input[str]] = None,
                resource_group_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDomainsResult]func GetDomains(ctx *Context, args *GetDomainsArgs, opts ...InvokeOption) (*GetDomainsResult, error)
func GetDomainsOutput(ctx *Context, args *GetDomainsOutputArgs, opts ...InvokeOption) GetDomainsResultOutput> Note: This function is named GetDomains in the Go SDK.
public static class GetDomains 
{
    public static Task<GetDomainsResult> InvokeAsync(GetDomainsArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainsResult> Invoke(GetDomainsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDomainsResult> getDomains(GetDomainsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: alicloud:waf/getDomains:getDomains
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Instance
Id string - The Id of waf instance to which waf domain belongs.
 - Enable
Details bool - Default to false and only output 
id,domain_name. Set it to true can output more details. - Ids List<string>
 - A list of WAF domain names. Each item is domain name.
 - Name
Regex string - A regex string to filter results by domain name.
 - Output
File string - File name where to save data source results (after running 
pulumi preview). - Resource
Group stringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
- Instance
Id string - The Id of waf instance to which waf domain belongs.
 - Enable
Details bool - Default to false and only output 
id,domain_name. Set it to true can output more details. - Ids []string
 - A list of WAF domain names. Each item is domain name.
 - Name
Regex string - A regex string to filter results by domain name.
 - Output
File string - File name where to save data source results (after running 
pulumi preview). - Resource
Group stringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
- instance
Id String - The Id of waf instance to which waf domain belongs.
 - enable
Details Boolean - Default to false and only output 
id,domain_name. Set it to true can output more details. - ids List<String>
 - A list of WAF domain names. Each item is domain name.
 - name
Regex String - A regex string to filter results by domain name.
 - output
File String - File name where to save data source results (after running 
pulumi preview). - resource
Group StringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
- instance
Id string - The Id of waf instance to which waf domain belongs.
 - enable
Details boolean - Default to false and only output 
id,domain_name. Set it to true can output more details. - ids string[]
 - A list of WAF domain names. Each item is domain name.
 - name
Regex string - A regex string to filter results by domain name.
 - output
File string - File name where to save data source results (after running 
pulumi preview). - resource
Group stringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
- instance_
id str - The Id of waf instance to which waf domain belongs.
 - enable_
details bool - Default to false and only output 
id,domain_name. Set it to true can output more details. - ids Sequence[str]
 - A list of WAF domain names. Each item is domain name.
 - name_
regex str - A regex string to filter results by domain name.
 - output_
file str - File name where to save data source results (after running 
pulumi preview). - resource_
group_ strid  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
- instance
Id String - The Id of waf instance to which waf domain belongs.
 - enable
Details Boolean - Default to false and only output 
id,domain_name. Set it to true can output more details. - ids List<String>
 - A list of WAF domain names. Each item is domain name.
 - name
Regex String - A regex string to filter results by domain name.
 - output
File String - File name where to save data source results (after running 
pulumi preview). - resource
Group StringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
getDomains Result
The following output properties are available:
- Domains
List<Pulumi.
Ali Cloud. Waf. Outputs. Get Domains Domain>  - A list of Domains. Each element contains the following attributes:
 - Id string
 - The provider-assigned unique ID for this managed resource.
 - Ids List<string>
 - A list of WAF domain self ID, value as 
domain_name. - Instance
Id string - Names List<string>
 - A list of WAF domain names.
 - Enable
Details bool - Name
Regex string - Output
File string - Resource
Group stringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
- Domains
[]Get
Domains Domain  - A list of Domains. Each element contains the following attributes:
 - Id string
 - The provider-assigned unique ID for this managed resource.
 - Ids []string
 - A list of WAF domain self ID, value as 
domain_name. - Instance
Id string - Names []string
 - A list of WAF domain names.
 - Enable
Details bool - Name
Regex string - Output
File string - Resource
Group stringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
- domains
List<Get
Domains Domain>  - A list of Domains. Each element contains the following attributes:
 - id String
 - The provider-assigned unique ID for this managed resource.
 - ids List<String>
 - A list of WAF domain self ID, value as 
domain_name. - instance
Id String - names List<String>
 - A list of WAF domain names.
 - enable
Details Boolean - name
Regex String - output
File String - resource
Group StringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
- domains
Get
Domains Domain[]  - A list of Domains. Each element contains the following attributes:
 - id string
 - The provider-assigned unique ID for this managed resource.
 - ids string[]
 - A list of WAF domain self ID, value as 
domain_name. - instance
Id string - names string[]
 - A list of WAF domain names.
 - enable
Details boolean - name
Regex string - output
File string - resource
Group stringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
- domains
Sequence[Get
Domains Domain]  - A list of Domains. Each element contains the following attributes:
 - id str
 - The provider-assigned unique ID for this managed resource.
 - ids Sequence[str]
 - A list of WAF domain self ID, value as 
domain_name. - instance_
id str - names Sequence[str]
 - A list of WAF domain names.
 - enable_
details bool - name_
regex str - output_
file str - resource_
group_ strid  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
- domains List<Property Map>
 - A list of Domains. Each element contains the following attributes:
 - id String
 - The provider-assigned unique ID for this managed resource.
 - ids List<String>
 - A list of WAF domain self ID, value as 
domain_name. - instance
Id String - names List<String>
 - A list of WAF domain names.
 - enable
Details Boolean - name
Regex String - output
File String - resource
Group StringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 
Supporting Types
GetDomainsDomain  
- Cluster
Type string - The type of the WAF cluster.
 - Cname string
 - The CNAME record assigned by the WAF instance to the specified domain.
 - Connection
Time int - The connection timeout for WAF exclusive clusters. Valid values: 
PhysicalClusterandVirtualCluster. Default toPhysicalCluster. - Domain string
 - Field 
domainhas been deprecated from version 1.94.0. Usedomain_nameinstead. - Domain
Name string - Name of the domain.
 - Http2Ports List<string>
 - List of the HTTP 2.0 ports.
 - Http
Ports List<string> - List of the HTTP ports.
 - Http
To stringUser Ip  - Specifies whether to enable the HTTP back-to-origin feature. After this feature is enabled, the WAF instance can use HTTP to forward HTTPS requests to the origin server.
 - Https
Ports List<string> - List of the HTTPS ports.
 - Https
Redirect string - Specifies whether to redirect HTTP requests as HTTPS requests. Valid values: 
OnandOff. Default toOff. - Id string
 - The ID of domain self ID, value as 
domain_name. - Is
Access stringProduct  - Specifies whether to configure a Layer-7 proxy, such as Anti-DDoS Pro or CDN, to filter the inbound traffic before it is forwarded to WAF. Valid values: 
Onand "Off". Default toOff. - Load
Balancing string - The load balancing algorithm that is used to forward requests to the origin. Valid values: 
IpHashandRoundRobin. Default toIpHash. - Log
Headers List<Pulumi.Ali Cloud. Waf. Inputs. Get Domains Domain Log Header>  - The key-value pair that is used to mark the traffic that flows through WAF to the domain. Each item contains two field:
 - Read
Time int - The read timeout of a WAF exclusive cluster. Unit: seconds.
 - Resource
Group stringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 - Source
Ips List<string> - List of the IP address or domain of the origin server to which the specified domain points.
 - Version int
 - The system data identifier that is used to control optimistic locking.
 - Write
Time int - The timeout period for a WAF exclusive cluster write connection. Unit: seconds.
 
- Cluster
Type string - The type of the WAF cluster.
 - Cname string
 - The CNAME record assigned by the WAF instance to the specified domain.
 - Connection
Time int - The connection timeout for WAF exclusive clusters. Valid values: 
PhysicalClusterandVirtualCluster. Default toPhysicalCluster. - Domain string
 - Field 
domainhas been deprecated from version 1.94.0. Usedomain_nameinstead. - Domain
Name string - Name of the domain.
 - Http2Ports []string
 - List of the HTTP 2.0 ports.
 - Http
Ports []string - List of the HTTP ports.
 - Http
To stringUser Ip  - Specifies whether to enable the HTTP back-to-origin feature. After this feature is enabled, the WAF instance can use HTTP to forward HTTPS requests to the origin server.
 - Https
Ports []string - List of the HTTPS ports.
 - Https
Redirect string - Specifies whether to redirect HTTP requests as HTTPS requests. Valid values: 
OnandOff. Default toOff. - Id string
 - The ID of domain self ID, value as 
domain_name. - Is
Access stringProduct  - Specifies whether to configure a Layer-7 proxy, such as Anti-DDoS Pro or CDN, to filter the inbound traffic before it is forwarded to WAF. Valid values: 
Onand "Off". Default toOff. - Load
Balancing string - The load balancing algorithm that is used to forward requests to the origin. Valid values: 
IpHashandRoundRobin. Default toIpHash. - Log
Headers []GetDomains Domain Log Header  - The key-value pair that is used to mark the traffic that flows through WAF to the domain. Each item contains two field:
 - Read
Time int - The read timeout of a WAF exclusive cluster. Unit: seconds.
 - Resource
Group stringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 - Source
Ips []string - List of the IP address or domain of the origin server to which the specified domain points.
 - Version int
 - The system data identifier that is used to control optimistic locking.
 - Write
Time int - The timeout period for a WAF exclusive cluster write connection. Unit: seconds.
 
- cluster
Type String - The type of the WAF cluster.
 - cname String
 - The CNAME record assigned by the WAF instance to the specified domain.
 - connection
Time Integer - The connection timeout for WAF exclusive clusters. Valid values: 
PhysicalClusterandVirtualCluster. Default toPhysicalCluster. - domain String
 - Field 
domainhas been deprecated from version 1.94.0. Usedomain_nameinstead. - domain
Name String - Name of the domain.
 - http2Ports List<String>
 - List of the HTTP 2.0 ports.
 - http
Ports List<String> - List of the HTTP ports.
 - http
To StringUser Ip  - Specifies whether to enable the HTTP back-to-origin feature. After this feature is enabled, the WAF instance can use HTTP to forward HTTPS requests to the origin server.
 - https
Ports List<String> - List of the HTTPS ports.
 - https
Redirect String - Specifies whether to redirect HTTP requests as HTTPS requests. Valid values: 
OnandOff. Default toOff. - id String
 - The ID of domain self ID, value as 
domain_name. - is
Access StringProduct  - Specifies whether to configure a Layer-7 proxy, such as Anti-DDoS Pro or CDN, to filter the inbound traffic before it is forwarded to WAF. Valid values: 
Onand "Off". Default toOff. - load
Balancing String - The load balancing algorithm that is used to forward requests to the origin. Valid values: 
IpHashandRoundRobin. Default toIpHash. - log
Headers List<GetDomains Domain Log Header>  - The key-value pair that is used to mark the traffic that flows through WAF to the domain. Each item contains two field:
 - read
Time Integer - The read timeout of a WAF exclusive cluster. Unit: seconds.
 - resource
Group StringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 - source
Ips List<String> - List of the IP address or domain of the origin server to which the specified domain points.
 - version Integer
 - The system data identifier that is used to control optimistic locking.
 - write
Time Integer - The timeout period for a WAF exclusive cluster write connection. Unit: seconds.
 
- cluster
Type string - The type of the WAF cluster.
 - cname string
 - The CNAME record assigned by the WAF instance to the specified domain.
 - connection
Time number - The connection timeout for WAF exclusive clusters. Valid values: 
PhysicalClusterandVirtualCluster. Default toPhysicalCluster. - domain string
 - Field 
domainhas been deprecated from version 1.94.0. Usedomain_nameinstead. - domain
Name string - Name of the domain.
 - http2Ports string[]
 - List of the HTTP 2.0 ports.
 - http
Ports string[] - List of the HTTP ports.
 - http
To stringUser Ip  - Specifies whether to enable the HTTP back-to-origin feature. After this feature is enabled, the WAF instance can use HTTP to forward HTTPS requests to the origin server.
 - https
Ports string[] - List of the HTTPS ports.
 - https
Redirect string - Specifies whether to redirect HTTP requests as HTTPS requests. Valid values: 
OnandOff. Default toOff. - id string
 - The ID of domain self ID, value as 
domain_name. - is
Access stringProduct  - Specifies whether to configure a Layer-7 proxy, such as Anti-DDoS Pro or CDN, to filter the inbound traffic before it is forwarded to WAF. Valid values: 
Onand "Off". Default toOff. - load
Balancing string - The load balancing algorithm that is used to forward requests to the origin. Valid values: 
IpHashandRoundRobin. Default toIpHash. - log
Headers GetDomains Domain Log Header[]  - The key-value pair that is used to mark the traffic that flows through WAF to the domain. Each item contains two field:
 - read
Time number - The read timeout of a WAF exclusive cluster. Unit: seconds.
 - resource
Group stringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 - source
Ips string[] - List of the IP address or domain of the origin server to which the specified domain points.
 - version number
 - The system data identifier that is used to control optimistic locking.
 - write
Time number - The timeout period for a WAF exclusive cluster write connection. Unit: seconds.
 
- cluster_
type str - The type of the WAF cluster.
 - cname str
 - The CNAME record assigned by the WAF instance to the specified domain.
 - connection_
time int - The connection timeout for WAF exclusive clusters. Valid values: 
PhysicalClusterandVirtualCluster. Default toPhysicalCluster. - domain str
 - Field 
domainhas been deprecated from version 1.94.0. Usedomain_nameinstead. - domain_
name str - Name of the domain.
 - http2_
ports Sequence[str] - List of the HTTP 2.0 ports.
 - http_
ports Sequence[str] - List of the HTTP ports.
 - http_
to_ struser_ ip  - Specifies whether to enable the HTTP back-to-origin feature. After this feature is enabled, the WAF instance can use HTTP to forward HTTPS requests to the origin server.
 - https_
ports Sequence[str] - List of the HTTPS ports.
 - https_
redirect str - Specifies whether to redirect HTTP requests as HTTPS requests. Valid values: 
OnandOff. Default toOff. - id str
 - The ID of domain self ID, value as 
domain_name. - is_
access_ strproduct  - Specifies whether to configure a Layer-7 proxy, such as Anti-DDoS Pro or CDN, to filter the inbound traffic before it is forwarded to WAF. Valid values: 
Onand "Off". Default toOff. - load_
balancing str - The load balancing algorithm that is used to forward requests to the origin. Valid values: 
IpHashandRoundRobin. Default toIpHash. - log_
headers Sequence[GetDomains Domain Log Header]  - The key-value pair that is used to mark the traffic that flows through WAF to the domain. Each item contains two field:
 - read_
time int - The read timeout of a WAF exclusive cluster. Unit: seconds.
 - resource_
group_ strid  - The ID of the resource group to which the queried domain belongs in Resource Management.
 - source_
ips Sequence[str] - List of the IP address or domain of the origin server to which the specified domain points.
 - version int
 - The system data identifier that is used to control optimistic locking.
 - write_
time int - The timeout period for a WAF exclusive cluster write connection. Unit: seconds.
 
- cluster
Type String - The type of the WAF cluster.
 - cname String
 - The CNAME record assigned by the WAF instance to the specified domain.
 - connection
Time Number - The connection timeout for WAF exclusive clusters. Valid values: 
PhysicalClusterandVirtualCluster. Default toPhysicalCluster. - domain String
 - Field 
domainhas been deprecated from version 1.94.0. Usedomain_nameinstead. - domain
Name String - Name of the domain.
 - http2Ports List<String>
 - List of the HTTP 2.0 ports.
 - http
Ports List<String> - List of the HTTP ports.
 - http
To StringUser Ip  - Specifies whether to enable the HTTP back-to-origin feature. After this feature is enabled, the WAF instance can use HTTP to forward HTTPS requests to the origin server.
 - https
Ports List<String> - List of the HTTPS ports.
 - https
Redirect String - Specifies whether to redirect HTTP requests as HTTPS requests. Valid values: 
OnandOff. Default toOff. - id String
 - The ID of domain self ID, value as 
domain_name. - is
Access StringProduct  - Specifies whether to configure a Layer-7 proxy, such as Anti-DDoS Pro or CDN, to filter the inbound traffic before it is forwarded to WAF. Valid values: 
Onand "Off". Default toOff. - load
Balancing String - The load balancing algorithm that is used to forward requests to the origin. Valid values: 
IpHashandRoundRobin. Default toIpHash. - log
Headers List<Property Map> - The key-value pair that is used to mark the traffic that flows through WAF to the domain. Each item contains two field:
 - read
Time Number - The read timeout of a WAF exclusive cluster. Unit: seconds.
 - resource
Group StringId  - The ID of the resource group to which the queried domain belongs in Resource Management.
 - source
Ips List<String> - List of the IP address or domain of the origin server to which the specified domain points.
 - version Number
 - The system data identifier that is used to control optimistic locking.
 - write
Time Number - The timeout period for a WAF exclusive cluster write connection. Unit: seconds.
 
GetDomainsDomainLogHeader    
Package Details
- Repository
 - Alibaba Cloud pulumi/pulumi-alicloud
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
alicloudTerraform Provider.