Volcengine v0.0.31, May 12 25

Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

volcengine.cloud_firewall.getCfwAddressBooks

Explore with Pulumi AI

Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

Example Usage

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

const foo = volcengine.cloud_firewall.getCfwAddressBooks({
    groupName: "acc-test",
    groupType: "ip",
});

import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.cloud_firewall.get_cfw_address_books(group_name="acc-test",
    group_type="ip")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/cloud_firewall"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloud_firewall.GetCfwAddressBooks(ctx, &cloud_firewall.GetCfwAddressBooksArgs{
			GroupName: pulumi.StringRef("acc-test"),
			GroupType: pulumi.StringRef("ip"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Cloud_firewall.GetCfwAddressBooks.Invoke(new()
    {
        GroupName = "acc-test",
        GroupType = "ip",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.cloud_firewall.Cloud_firewallFunctions;
import com.pulumi.volcengine.cloud_firewall.inputs.GetCfwAddressBooksArgs;
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 foo = Cloud_firewallFunctions.getCfwAddressBooks(GetCfwAddressBooksArgs.builder()
            .groupName("acc-test")
            .groupType("ip")
            .build());

    }
}

variables:
  foo:
    fn::invoke:
      Function: volcengine:cloud_firewall:getCfwAddressBooks
      Arguments:
        groupName: acc-test
        groupType: ip

Using getCfwAddressBooks

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 getCfwAddressBooks(args: GetCfwAddressBooksArgs, opts?: InvokeOptions): Promise<GetCfwAddressBooksResult>
function getCfwAddressBooksOutput(args: GetCfwAddressBooksOutputArgs, opts?: InvokeOptions): Output<GetCfwAddressBooksResult>

def get_cfw_address_books(address: Optional[str] = None,
                          description: Optional[str] = None,
                          group_name: Optional[str] = None,
                          group_type: Optional[str] = None,
                          name_regex: Optional[str] = None,
                          output_file: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCfwAddressBooksResult
def get_cfw_address_books_output(address: Optional[pulumi.Input[str]] = None,
                          description: Optional[pulumi.Input[str]] = None,
                          group_name: Optional[pulumi.Input[str]] = None,
                          group_type: Optional[pulumi.Input[str]] = None,
                          name_regex: Optional[pulumi.Input[str]] = None,
                          output_file: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCfwAddressBooksResult]

func GetCfwAddressBooks(ctx *Context, args *GetCfwAddressBooksArgs, opts ...InvokeOption) (*GetCfwAddressBooksResult, error)
func GetCfwAddressBooksOutput(ctx *Context, args *GetCfwAddressBooksOutputArgs, opts ...InvokeOption) GetCfwAddressBooksResultOutput

> Note: This function is named GetCfwAddressBooks in the Go SDK.

public static class GetCfwAddressBooks 
{
    public static Task<GetCfwAddressBooksResult> InvokeAsync(GetCfwAddressBooksArgs args, InvokeOptions? opts = null)
    public static Output<GetCfwAddressBooksResult> Invoke(GetCfwAddressBooksInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCfwAddressBooksResult> getCfwAddressBooks(GetCfwAddressBooksArgs args, InvokeOptions options)
public static Output<GetCfwAddressBooksResult> getCfwAddressBooks(GetCfwAddressBooksArgs args, InvokeOptions options)

fn::invoke:
  function: volcengine:cloud_firewall/getCfwAddressBooks:getCfwAddressBooks
  arguments:
    # arguments dictionary

The following arguments are supported:

Address string: The group type of address book. This field support fuzzy query.
Description string: The group type of address book. This field support fuzzy query.
GroupName string: The group name of address book. This field support fuzzy query.
GroupType string: The group type of address book. Valid values: ip, port, domain.
NameRegex string: A Name Regex of Resource.
OutputFile string: File name where to save data source results.

Address string: The group type of address book. This field support fuzzy query.
Description string: The group type of address book. This field support fuzzy query.
GroupName string: The group name of address book. This field support fuzzy query.
GroupType string: The group type of address book. Valid values: ip, port, domain.
NameRegex string: A Name Regex of Resource.
OutputFile string: File name where to save data source results.

address String: The group type of address book. This field support fuzzy query.
description String: The group type of address book. This field support fuzzy query.
groupName String: The group name of address book. This field support fuzzy query.
groupType String: The group type of address book. Valid values: ip, port, domain.
nameRegex String: A Name Regex of Resource.
outputFile String: File name where to save data source results.

address string: The group type of address book. This field support fuzzy query.
description string: The group type of address book. This field support fuzzy query.
groupName string: The group name of address book. This field support fuzzy query.
groupType string: The group type of address book. Valid values: ip, port, domain.
nameRegex string: A Name Regex of Resource.
outputFile string: File name where to save data source results.

address str: The group type of address book. This field support fuzzy query.
description str: The group type of address book. This field support fuzzy query.
group_name str: The group name of address book. This field support fuzzy query.
group_type str: The group type of address book. Valid values: ip, port, domain.
name_regex str: A Name Regex of Resource.
output_file str: File name where to save data source results.

address String: The group type of address book. This field support fuzzy query.
description String: The group type of address book. This field support fuzzy query.
groupName String: The group name of address book. This field support fuzzy query.
groupType String: The group type of address book. Valid values: ip, port, domain.
nameRegex String: A Name Regex of Resource.
outputFile String: File name where to save data source results.

getCfwAddressBooks Result

The following output properties are available:

AddressBooks List<GetCfwAddressBooksAddressBook>: The collection of query.
Id string: The provider-assigned unique ID for this managed resource.
TotalCount int: The total count of query.
Address string
Description string: The description of the address book.
GroupName string: The name of the address book.
GroupType string: The type of the address book.
NameRegex string
OutputFile string

AddressBooks []GetCfwAddressBooksAddressBook: The collection of query.
Id string: The provider-assigned unique ID for this managed resource.
TotalCount int: The total count of query.
Address string
Description string: The description of the address book.
GroupName string: The name of the address book.
GroupType string: The type of the address book.
NameRegex string
OutputFile string

addressBooks List<GetCfwAddressBooksAddressBook>: The collection of query.
id String: The provider-assigned unique ID for this managed resource.
totalCount Integer: The total count of query.
address String
description String: The description of the address book.
groupName String: The name of the address book.
groupType String: The type of the address book.
nameRegex String
outputFile String

addressBooks GetCfwAddressBooksAddressBook[]: The collection of query.
id string: The provider-assigned unique ID for this managed resource.
totalCount number: The total count of query.
address string
description string: The description of the address book.
groupName string: The name of the address book.
groupType string: The type of the address book.
nameRegex string
outputFile string

address_books Sequence[GetCfwAddressBooksAddressBook]: The collection of query.
id str: The provider-assigned unique ID for this managed resource.
total_count int: The total count of query.
address str
description str: The description of the address book.
group_name str: The name of the address book.
group_type str: The type of the address book.
name_regex str
output_file str

addressBooks List<Property Map>: The collection of query.
id String: The provider-assigned unique ID for this managed resource.
totalCount Number: The total count of query.
address String
description String: The description of the address book.
groupName String: The name of the address book.
groupType String: The type of the address book.
nameRegex String
outputFile String

Supporting Types

GetCfwAddressBooksAddressBook

AddressLists List<string>: The address list of the address book.
Description string: The group type of address book. This field support fuzzy query.
GroupName string: The group name of address book. This field support fuzzy query.
GroupType string: The group type of address book. Valid values: ip, port, domain.
GroupUuid string: The uuid of the address book.
Id string: The uuid of the address book.
RefCnt int: The reference count of the address book.

AddressLists []string: The address list of the address book.
Description string: The group type of address book. This field support fuzzy query.
GroupName string: The group name of address book. This field support fuzzy query.
GroupType string: The group type of address book. Valid values: ip, port, domain.
GroupUuid string: The uuid of the address book.
Id string: The uuid of the address book.
RefCnt int: The reference count of the address book.

addressLists List<String>: The address list of the address book.
description String: The group type of address book. This field support fuzzy query.
groupName String: The group name of address book. This field support fuzzy query.
groupType String: The group type of address book. Valid values: ip, port, domain.
groupUuid String: The uuid of the address book.
id String: The uuid of the address book.
refCnt Integer: The reference count of the address book.

addressLists string[]: The address list of the address book.
description string: The group type of address book. This field support fuzzy query.
groupName string: The group name of address book. This field support fuzzy query.
groupType string: The group type of address book. Valid values: ip, port, domain.
groupUuid string: The uuid of the address book.
id string: The uuid of the address book.
refCnt number: The reference count of the address book.

address_lists Sequence[str]: The address list of the address book.
description str: The group type of address book. This field support fuzzy query.
group_name str: The group name of address book. This field support fuzzy query.
group_type str: The group type of address book. Valid values: ip, port, domain.
group_uuid str: The uuid of the address book.
id str: The uuid of the address book.
ref_cnt int: The reference count of the address book.

addressLists List<String>: The address list of the address book.
description String: The group type of address book. This field support fuzzy query.
groupName String: The group name of address book. This field support fuzzy query.
groupType String: The group type of address book. Valid values: ip, port, domain.
groupUuid String: The uuid of the address book.
id String: The uuid of the address book.
refCnt Number: The reference count of the address book.

Package Details

Repository: volcengine volcengine/pulumi-volcengine
License: Apache-2.0
Notes: This Pulumi package is based on the volcengine Terraform Provider.

Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine

volcengine/pulumi-volcengine

volcengine.cloud_firewall.getCfwAddressBooks

On this page

On this page

Example Usage

Using getCfwAddressBooks

getCfwAddressBooks Result

Supporting Types

GetCfwAddressBooksAddressBook

Package Details

On this page

On this page