Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. fwcenter
  6. getAddressBook
Viewing docs for volcenginecc v0.0.49
published on Thursday, Jul 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.fwcenter.getAddressBook

volcenginecc logo
Viewing docs for volcenginecc v0.0.49
published on Thursday, Jul 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::FWCenter::AddressBook

    Using getAddressBook

    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 getAddressBook(args: GetAddressBookArgs, opts?: InvokeOptions): Promise<GetAddressBookResult>
function getAddressBookOutput(args: GetAddressBookOutputArgs, opts?: InvokeOptions): Output<GetAddressBookResult>
    def get_address_book(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAddressBookResult
def get_address_book_output(id: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAddressBookResult]
    func LookupAddressBook(ctx *Context, args *LookupAddressBookArgs, opts ...InvokeOption) (*LookupAddressBookResult, error)
func LookupAddressBookOutput(ctx *Context, args *LookupAddressBookOutputArgs, opts ...InvokeOption) LookupAddressBookResultOutput

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

    public static class GetAddressBook 
{
    public static Task<GetAddressBookResult> InvokeAsync(GetAddressBookArgs args, InvokeOptions? opts = null)
    public static Output<GetAddressBookResult> Invoke(GetAddressBookInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAddressBookResult> getAddressBook(GetAddressBookArgs args, InvokeOptions options)
public static Output<GetAddressBookResult> getAddressBook(GetAddressBookArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:fwcenter/getAddressBook:getAddressBook
  arguments:
    # arguments dictionary
    data "volcenginecc_fwcenter_getaddressbook" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getAddressBook Result

    The following output properties are available:

    AddressDetailLists List<Volcengine.GetAddressBookAddressDetailList>
    Address list with detailed address information. Effective when AutoUpdateType is Manual.
    AddressLists List<string>
    Address list in the address book. The specific content depends on the address book type. Effective when AutoUpdateType is Manual and AddressDetailList is not empty. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    AutoUpdateType string
    Address book auto-update type. Default is Manual. Manual: manual update; Tag: tag address book. Assets with new matching tags are automatically added to the current address book. This feature is currently only supported for the internet boundary.
    CloudFirewallId string
    The unique identifier of the cloud firewall instance, used to specify which cloud firewall instance the address book belongs to.
    Description string
    Detailed description of the address book, used to explain its purpose or other relevant information.
    GroupName string
    Name of the address book. Supports Chinese characters, uppercase and lowercase English letters, -, and _, with a maximum length of 64 characters.
    GroupType string
    The type of the address book, used to specify the type of addresses stored in the address book. ip: IPv4 address; ipv6: IPv6 address; port: port information; domain: domain name information.
    GroupUuid string
    Unique identifier for the address book, generated by the system after the address book is created. Used to uniquely identify the address book within the system.
    Id string
    Uniquely identifies the resource.
    InstanceTypeLists List<string>
    Asset type list, used to specify the types of assets included in the address book. Takes effect when AutoUpdateType is set to Tag. Supported values: EcsInstance (cloud server), NetworkInterface (network interface), HaVip (high-availability virtual IP), Nat (NAT gateway), ClbInstance (load balancer), AlbInstance (application load balancer), VpnGateway (VPN gateway).
    RefCnt int
    Reference count for the address book, indicating how many times it has been referenced.
    ResourceType string
    Tag type, used to specify the resource type in the address book. Effective when AutoUpdateType is Tag. Eip: public IP; InternetAsset: public asset.
    TagRelation string
    Logical relationship between tags, used to specify how multiple tags are combined. Effective when AutoUpdateType is Tag. And: all tags must be satisfied; Or: any tag can be satisfied.
    Tags List<Volcengine.GetAddressBookTag>
    Tag list for the address book, used for categorization or marking. Effective when AutoUpdateType is Tag.
    Updated int
    Last update timestamp for the address book, represented in Unix timestamp format.
    AddressDetailLists []GetAddressBookAddressDetailList
    Address list with detailed address information. Effective when AutoUpdateType is Manual.
    AddressLists []string
    Address list in the address book. The specific content depends on the address book type. Effective when AutoUpdateType is Manual and AddressDetailList is not empty. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    AutoUpdateType string
    Address book auto-update type. Default is Manual. Manual: manual update; Tag: tag address book. Assets with new matching tags are automatically added to the current address book. This feature is currently only supported for the internet boundary.
    CloudFirewallId string
    The unique identifier of the cloud firewall instance, used to specify which cloud firewall instance the address book belongs to.
    Description string
    Detailed description of the address book, used to explain its purpose or other relevant information.
    GroupName string
    Name of the address book. Supports Chinese characters, uppercase and lowercase English letters, -, and _, with a maximum length of 64 characters.
    GroupType string
    The type of the address book, used to specify the type of addresses stored in the address book. ip: IPv4 address; ipv6: IPv6 address; port: port information; domain: domain name information.
    GroupUuid string
    Unique identifier for the address book, generated by the system after the address book is created. Used to uniquely identify the address book within the system.
    Id string
    Uniquely identifies the resource.
    InstanceTypeLists []string
    Asset type list, used to specify the types of assets included in the address book. Takes effect when AutoUpdateType is set to Tag. Supported values: EcsInstance (cloud server), NetworkInterface (network interface), HaVip (high-availability virtual IP), Nat (NAT gateway), ClbInstance (load balancer), AlbInstance (application load balancer), VpnGateway (VPN gateway).
    RefCnt int
    Reference count for the address book, indicating how many times it has been referenced.
    ResourceType string
    Tag type, used to specify the resource type in the address book. Effective when AutoUpdateType is Tag. Eip: public IP; InternetAsset: public asset.
    TagRelation string
    Logical relationship between tags, used to specify how multiple tags are combined. Effective when AutoUpdateType is Tag. And: all tags must be satisfied; Or: any tag can be satisfied.
    Tags []GetAddressBookTag
    Tag list for the address book, used for categorization or marking. Effective when AutoUpdateType is Tag.
    Updated int
    Last update timestamp for the address book, represented in Unix timestamp format.
    address_detail_lists list(object)
    Address list with detailed address information. Effective when AutoUpdateType is Manual.
    address_lists list(string)
    Address list in the address book. The specific content depends on the address book type. Effective when AutoUpdateType is Manual and AddressDetailList is not empty. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    auto_update_type string
    Address book auto-update type. Default is Manual. Manual: manual update; Tag: tag address book. Assets with new matching tags are automatically added to the current address book. This feature is currently only supported for the internet boundary.
    cloud_firewall_id string
    The unique identifier of the cloud firewall instance, used to specify which cloud firewall instance the address book belongs to.
    description string
    Detailed description of the address book, used to explain its purpose or other relevant information.
    group_name string
    Name of the address book. Supports Chinese characters, uppercase and lowercase English letters, -, and _, with a maximum length of 64 characters.
    group_type string
    The type of the address book, used to specify the type of addresses stored in the address book. ip: IPv4 address; ipv6: IPv6 address; port: port information; domain: domain name information.
    group_uuid string
    Unique identifier for the address book, generated by the system after the address book is created. Used to uniquely identify the address book within the system.
    id string
    Uniquely identifies the resource.
    instance_type_lists list(string)
    Asset type list, used to specify the types of assets included in the address book. Takes effect when AutoUpdateType is set to Tag. Supported values: EcsInstance (cloud server), NetworkInterface (network interface), HaVip (high-availability virtual IP), Nat (NAT gateway), ClbInstance (load balancer), AlbInstance (application load balancer), VpnGateway (VPN gateway).
    ref_cnt number
    Reference count for the address book, indicating how many times it has been referenced.
    resource_type string
    Tag type, used to specify the resource type in the address book. Effective when AutoUpdateType is Tag. Eip: public IP; InternetAsset: public asset.
    tag_relation string
    Logical relationship between tags, used to specify how multiple tags are combined. Effective when AutoUpdateType is Tag. And: all tags must be satisfied; Or: any tag can be satisfied.
    tags list(object)
    Tag list for the address book, used for categorization or marking. Effective when AutoUpdateType is Tag.
    updated number
    Last update timestamp for the address book, represented in Unix timestamp format.
    addressDetailLists List<GetAddressBookAddressDetailList>
    Address list with detailed address information. Effective when AutoUpdateType is Manual.
    addressLists List<String>
    Address list in the address book. The specific content depends on the address book type. Effective when AutoUpdateType is Manual and AddressDetailList is not empty. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    autoUpdateType String
    Address book auto-update type. Default is Manual. Manual: manual update; Tag: tag address book. Assets with new matching tags are automatically added to the current address book. This feature is currently only supported for the internet boundary.
    cloudFirewallId String
    The unique identifier of the cloud firewall instance, used to specify which cloud firewall instance the address book belongs to.
    description String
    Detailed description of the address book, used to explain its purpose or other relevant information.
    groupName String
    Name of the address book. Supports Chinese characters, uppercase and lowercase English letters, -, and _, with a maximum length of 64 characters.
    groupType String
    The type of the address book, used to specify the type of addresses stored in the address book. ip: IPv4 address; ipv6: IPv6 address; port: port information; domain: domain name information.
    groupUuid String
    Unique identifier for the address book, generated by the system after the address book is created. Used to uniquely identify the address book within the system.
    id String
    Uniquely identifies the resource.
    instanceTypeLists List<String>
    Asset type list, used to specify the types of assets included in the address book. Takes effect when AutoUpdateType is set to Tag. Supported values: EcsInstance (cloud server), NetworkInterface (network interface), HaVip (high-availability virtual IP), Nat (NAT gateway), ClbInstance (load balancer), AlbInstance (application load balancer), VpnGateway (VPN gateway).
    refCnt Integer
    Reference count for the address book, indicating how many times it has been referenced.
    resourceType String
    Tag type, used to specify the resource type in the address book. Effective when AutoUpdateType is Tag. Eip: public IP; InternetAsset: public asset.
    tagRelation String
    Logical relationship between tags, used to specify how multiple tags are combined. Effective when AutoUpdateType is Tag. And: all tags must be satisfied; Or: any tag can be satisfied.
    tags List<GetAddressBookTag>
    Tag list for the address book, used for categorization or marking. Effective when AutoUpdateType is Tag.
    updated Integer
    Last update timestamp for the address book, represented in Unix timestamp format.
    addressDetailLists GetAddressBookAddressDetailList[]
    Address list with detailed address information. Effective when AutoUpdateType is Manual.
    addressLists string[]
    Address list in the address book. The specific content depends on the address book type. Effective when AutoUpdateType is Manual and AddressDetailList is not empty. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    autoUpdateType string
    Address book auto-update type. Default is Manual. Manual: manual update; Tag: tag address book. Assets with new matching tags are automatically added to the current address book. This feature is currently only supported for the internet boundary.
    cloudFirewallId string
    The unique identifier of the cloud firewall instance, used to specify which cloud firewall instance the address book belongs to.
    description string
    Detailed description of the address book, used to explain its purpose or other relevant information.
    groupName string
    Name of the address book. Supports Chinese characters, uppercase and lowercase English letters, -, and _, with a maximum length of 64 characters.
    groupType string
    The type of the address book, used to specify the type of addresses stored in the address book. ip: IPv4 address; ipv6: IPv6 address; port: port information; domain: domain name information.
    groupUuid string
    Unique identifier for the address book, generated by the system after the address book is created. Used to uniquely identify the address book within the system.
    id string
    Uniquely identifies the resource.
    instanceTypeLists string[]
    Asset type list, used to specify the types of assets included in the address book. Takes effect when AutoUpdateType is set to Tag. Supported values: EcsInstance (cloud server), NetworkInterface (network interface), HaVip (high-availability virtual IP), Nat (NAT gateway), ClbInstance (load balancer), AlbInstance (application load balancer), VpnGateway (VPN gateway).
    refCnt number
    Reference count for the address book, indicating how many times it has been referenced.
    resourceType string
    Tag type, used to specify the resource type in the address book. Effective when AutoUpdateType is Tag. Eip: public IP; InternetAsset: public asset.
    tagRelation string
    Logical relationship between tags, used to specify how multiple tags are combined. Effective when AutoUpdateType is Tag. And: all tags must be satisfied; Or: any tag can be satisfied.
    tags GetAddressBookTag[]
    Tag list for the address book, used for categorization or marking. Effective when AutoUpdateType is Tag.
    updated number
    Last update timestamp for the address book, represented in Unix timestamp format.
    address_detail_lists Sequence[GetAddressBookAddressDetailList]
    Address list with detailed address information. Effective when AutoUpdateType is Manual.
    address_lists Sequence[str]
    Address list in the address book. The specific content depends on the address book type. Effective when AutoUpdateType is Manual and AddressDetailList is not empty. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    auto_update_type str
    Address book auto-update type. Default is Manual. Manual: manual update; Tag: tag address book. Assets with new matching tags are automatically added to the current address book. This feature is currently only supported for the internet boundary.
    cloud_firewall_id str
    The unique identifier of the cloud firewall instance, used to specify which cloud firewall instance the address book belongs to.
    description str
    Detailed description of the address book, used to explain its purpose or other relevant information.
    group_name str
    Name of the address book. Supports Chinese characters, uppercase and lowercase English letters, -, and _, with a maximum length of 64 characters.
    group_type str
    The type of the address book, used to specify the type of addresses stored in the address book. ip: IPv4 address; ipv6: IPv6 address; port: port information; domain: domain name information.
    group_uuid str
    Unique identifier for the address book, generated by the system after the address book is created. Used to uniquely identify the address book within the system.
    id str
    Uniquely identifies the resource.
    instance_type_lists Sequence[str]
    Asset type list, used to specify the types of assets included in the address book. Takes effect when AutoUpdateType is set to Tag. Supported values: EcsInstance (cloud server), NetworkInterface (network interface), HaVip (high-availability virtual IP), Nat (NAT gateway), ClbInstance (load balancer), AlbInstance (application load balancer), VpnGateway (VPN gateway).
    ref_cnt int
    Reference count for the address book, indicating how many times it has been referenced.
    resource_type str
    Tag type, used to specify the resource type in the address book. Effective when AutoUpdateType is Tag. Eip: public IP; InternetAsset: public asset.
    tag_relation str
    Logical relationship between tags, used to specify how multiple tags are combined. Effective when AutoUpdateType is Tag. And: all tags must be satisfied; Or: any tag can be satisfied.
    tags Sequence[GetAddressBookTag]
    Tag list for the address book, used for categorization or marking. Effective when AutoUpdateType is Tag.
    updated int
    Last update timestamp for the address book, represented in Unix timestamp format.
    addressDetailLists List<Property Map>
    Address list with detailed address information. Effective when AutoUpdateType is Manual.
    addressLists List<String>
    Address list in the address book. The specific content depends on the address book type. Effective when AutoUpdateType is Manual and AddressDetailList is not empty. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    autoUpdateType String
    Address book auto-update type. Default is Manual. Manual: manual update; Tag: tag address book. Assets with new matching tags are automatically added to the current address book. This feature is currently only supported for the internet boundary.
    cloudFirewallId String
    The unique identifier of the cloud firewall instance, used to specify which cloud firewall instance the address book belongs to.
    description String
    Detailed description of the address book, used to explain its purpose or other relevant information.
    groupName String
    Name of the address book. Supports Chinese characters, uppercase and lowercase English letters, -, and _, with a maximum length of 64 characters.
    groupType String
    The type of the address book, used to specify the type of addresses stored in the address book. ip: IPv4 address; ipv6: IPv6 address; port: port information; domain: domain name information.
    groupUuid String
    Unique identifier for the address book, generated by the system after the address book is created. Used to uniquely identify the address book within the system.
    id String
    Uniquely identifies the resource.
    instanceTypeLists List<String>
    Asset type list, used to specify the types of assets included in the address book. Takes effect when AutoUpdateType is set to Tag. Supported values: EcsInstance (cloud server), NetworkInterface (network interface), HaVip (high-availability virtual IP), Nat (NAT gateway), ClbInstance (load balancer), AlbInstance (application load balancer), VpnGateway (VPN gateway).
    refCnt Number
    Reference count for the address book, indicating how many times it has been referenced.
    resourceType String
    Tag type, used to specify the resource type in the address book. Effective when AutoUpdateType is Tag. Eip: public IP; InternetAsset: public asset.
    tagRelation String
    Logical relationship between tags, used to specify how multiple tags are combined. Effective when AutoUpdateType is Tag. And: all tags must be satisfied; Or: any tag can be satisfied.
    tags List<Property Map>
    Tag list for the address book, used for categorization or marking. Effective when AutoUpdateType is Tag.
    updated Number
    Last update timestamp for the address book, represented in Unix timestamp format.

    Supporting Types

    GetAddressBookAddressDetailList

    Address string
    Detailed information about the address in the address book. The specific content depends on the address book type. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    Description string
    Detailed description of a single address in the address book, used to explain the specific purpose or other relevant information for that address.
    Type string
    Address type, returned during queries. ip: IPv4 address; ipv6: IPv6 address; domain: domain name; port: port.
    Address string
    Detailed information about the address in the address book. The specific content depends on the address book type. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    Description string
    Detailed description of a single address in the address book, used to explain the specific purpose or other relevant information for that address.
    Type string
    Address type, returned during queries. ip: IPv4 address; ipv6: IPv6 address; domain: domain name; port: port.
    address string
    Detailed information about the address in the address book. The specific content depends on the address book type. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    description string
    Detailed description of a single address in the address book, used to explain the specific purpose or other relevant information for that address.
    type string
    Address type, returned during queries. ip: IPv4 address; ipv6: IPv6 address; domain: domain name; port: port.
    address String
    Detailed information about the address in the address book. The specific content depends on the address book type. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    description String
    Detailed description of a single address in the address book, used to explain the specific purpose or other relevant information for that address.
    type String
    Address type, returned during queries. ip: IPv4 address; ipv6: IPv6 address; domain: domain name; port: port.
    address string
    Detailed information about the address in the address book. The specific content depends on the address book type. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    description string
    Detailed description of a single address in the address book, used to explain the specific purpose or other relevant information for that address.
    type string
    Address type, returned during queries. ip: IPv4 address; ipv6: IPv6 address; domain: domain name; port: port.
    address str
    Detailed information about the address in the address book. The specific content depends on the address book type. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    description str
    Detailed description of a single address in the address book, used to explain the specific purpose or other relevant information for that address.
    type str
    Address type, returned during queries. ip: IPv4 address; ipv6: IPv6 address; domain: domain name; port: port.
    address String
    Detailed information about the address in the address book. The specific content depends on the address book type. If GroupType is ip, enter an IPv4 address or CIDRv4; if ipv6, enter an IPv6 address or CIDRv6; if port, enter port information (a single port such as 22 or a port range such as 100/200); if domain, enter domain information.
    description String
    Detailed description of a single address in the address book, used to explain the specific purpose or other relevant information for that address.
    type String
    Address type, returned during queries. ip: IPv4 address; ipv6: IPv6 address; domain: domain name; port: port.

    GetAddressBookTag

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.49
    published on Thursday, Jul 16, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial