1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. rdspostgresql
  5. AllowList
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.rdspostgresql.AllowList

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    白名单是数据库连接的安全防控手段，只有白名单内的 IP 地址才能访问数据库。PostgreSQL 实例在创建后，不会绑定任何白名单，默认禁止所有 IP 地址访问实例。因此无论是通过私网还是通过公网连接访问实例，都需要先为实例配置白名单，才能保证实例可连接。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const rdsPostgresqlAllowListDemo = new bytepluscc.rdspostgresql.AllowList("RdsPostgresqlAllowListDemo", {
    allowLists: [
        "1.2.3.4/32",
        "5.6.7.8/32",
    ],
    allowListCategory: "Ordinary",
    allowListDesc: "test",
    allowListName: "ccapi-test-1",
    allowListType: "IPv4",
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

rds_postgresql_allow_list_demo = bytepluscc.rdspostgresql.AllowList("RdsPostgresqlAllowListDemo",
    allow_lists=[
        "1.2.3.4/32",
        "5.6.7.8/32",
    ],
    allow_list_category="Ordinary",
    allow_list_desc="test",
    allow_list_name="ccapi-test-1",
    allow_list_type="IPv4")

    package main

import (
	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/rdspostgresql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rdspostgresql.NewAllowList(ctx, "RdsPostgresqlAllowListDemo", &rdspostgresql.AllowListArgs{
			AllowLists: pulumi.StringArray{
				pulumi.String("1.2.3.4/32"),
				pulumi.String("5.6.7.8/32"),
			},
			AllowListCategory: pulumi.String("Ordinary"),
			AllowListDesc:     pulumi.String("test"),
			AllowListName:     pulumi.String("ccapi-test-1"),
			AllowListType:     pulumi.String("IPv4"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var rdsPostgresqlAllowListDemo = new Bytepluscc.Rdspostgresql.AllowList("RdsPostgresqlAllowListDemo", new()
    {
        AllowListValue = new[]
        {
            "1.2.3.4/32",
            "5.6.7.8/32",
        },
        AllowListCategory = "Ordinary",
        AllowListDesc = "test",
        AllowListName = "ccapi-test-1",
        AllowListType = "IPv4",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.rdspostgresql.AllowList;
import com.byteplus.bytepluscc.rdspostgresql.AllowListArgs;
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) {
        var rdsPostgresqlAllowListDemo = new AllowList("rdsPostgresqlAllowListDemo", AllowListArgs.builder()
            .allowLists(            
                "1.2.3.4/32",
                "5.6.7.8/32")
            .allowListCategory("Ordinary")
            .allowListDesc("test")
            .allowListName("ccapi-test-1")
            .allowListType("IPv4")
            .build());

    }
}

    resources:
  rdsPostgresqlAllowListDemo:
    type: bytepluscc:rdspostgresql:AllowList
    name: RdsPostgresqlAllowListDemo
    properties:
      allowLists:
        - 1.2.3.4/32
        - 5.6.7.8/32
      allowListCategory: Ordinary
      allowListDesc: test
      allowListName: ccapi-test-1
      allowListType: IPv4

    Create AllowList Resource

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

    Constructor syntax

    new AllowList(name: string, args?: AllowListArgs, opts?: CustomResourceOptions);
    @overload
def AllowList(resource_name: str,
              args: Optional[AllowListArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def AllowList(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              allow_list_category: Optional[str] = None,
              allow_list_desc: Optional[str] = None,
              allow_list_name: Optional[str] = None,
              allow_list_type: Optional[str] = None,
              allow_lists: Optional[Sequence[str]] = None,
              associated_instance_num: Optional[int] = None,
              ip_address: Optional[str] = None,
              modify_mode: Optional[str] = None,
              security_group_bind_infos: Optional[Sequence[AllowListSecurityGroupBindInfoArgs]] = None,
              update_security_group: Optional[bool] = None,
              user_allow_list: Optional[str] = None)
    func NewAllowList(ctx *Context, name string, args *AllowListArgs, opts ...ResourceOption) (*AllowList, error)
    public AllowList(string name, AllowListArgs? args = null, CustomResourceOptions? opts = null)
    public AllowList(String name, AllowListArgs args)
public AllowList(String name, AllowListArgs args, CustomResourceOptions options)

    type: bytepluscc:rdspostgresql:AllowList
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 AllowListArgs
    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 AllowListArgs
    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 AllowListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AllowListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AllowListArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleallowListResourceResourceFromRdspostgresqlallowList = new Bytepluscc.Rdspostgresql.AllowList("exampleallowListResourceResourceFromRdspostgresqlallowList", new()
{
    AllowListCategory = "string",
    AllowListDesc = "string",
    AllowListName = "string",
    AllowListType = "string",
    AllowListValue = new[]
    {
        "string",
    },
    AssociatedInstanceNum = 0,
    IpAddress = "string",
    ModifyMode = "string",
    SecurityGroupBindInfos = new[]
    {
        new Bytepluscc.Rdspostgresql.Inputs.AllowListSecurityGroupBindInfoArgs
        {
            BindMode = "string",
            IpLists = new[]
            {
                "string",
            },
            SecurityGroupId = "string",
            SecurityGroupName = "string",
        },
    },
    UpdateSecurityGroup = false,
    UserAllowList = "string",
});

    example, err := rdspostgresql.NewAllowList(ctx, "exampleallowListResourceResourceFromRdspostgresqlallowList", &rdspostgresql.AllowListArgs{
	AllowListCategory: pulumi.String("string"),
	AllowListDesc:     pulumi.String("string"),
	AllowListName:     pulumi.String("string"),
	AllowListType:     pulumi.String("string"),
	AllowLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	AssociatedInstanceNum: pulumi.Int(0),
	IpAddress:             pulumi.String("string"),
	ModifyMode:            pulumi.String("string"),
	SecurityGroupBindInfos: rdspostgresql.AllowListSecurityGroupBindInfoArray{
		&rdspostgresql.AllowListSecurityGroupBindInfoArgs{
			BindMode: pulumi.String("string"),
			IpLists: pulumi.StringArray{
				pulumi.String("string"),
			},
			SecurityGroupId:   pulumi.String("string"),
			SecurityGroupName: pulumi.String("string"),
		},
	},
	UpdateSecurityGroup: pulumi.Bool(false),
	UserAllowList:       pulumi.String("string"),
})

    var exampleallowListResourceResourceFromRdspostgresqlallowList = new com.byteplus.bytepluscc.rdspostgresql.AllowList("exampleallowListResourceResourceFromRdspostgresqlallowList", com.byteplus.bytepluscc.rdspostgresql.AllowListArgs.builder()
    .allowListCategory("string")
    .allowListDesc("string")
    .allowListName("string")
    .allowListType("string")
    .allowLists("string")
    .associatedInstanceNum(0)
    .ipAddress("string")
    .modifyMode("string")
    .securityGroupBindInfos(AllowListSecurityGroupBindInfoArgs.builder()
        .bindMode("string")
        .ipLists("string")
        .securityGroupId("string")
        .securityGroupName("string")
        .build())
    .updateSecurityGroup(false)
    .userAllowList("string")
    .build());

    exampleallow_list_resource_resource_from_rdspostgresqlallow_list = bytepluscc.rdspostgresql.AllowList("exampleallowListResourceResourceFromRdspostgresqlallowList",
    allow_list_category="string",
    allow_list_desc="string",
    allow_list_name="string",
    allow_list_type="string",
    allow_lists=["string"],
    associated_instance_num=0,
    ip_address="string",
    modify_mode="string",
    security_group_bind_infos=[{
        "bind_mode": "string",
        "ip_lists": ["string"],
        "security_group_id": "string",
        "security_group_name": "string",
    }],
    update_security_group=False,
    user_allow_list="string")

    const exampleallowListResourceResourceFromRdspostgresqlallowList = new bytepluscc.rdspostgresql.AllowList("exampleallowListResourceResourceFromRdspostgresqlallowList", {
    allowListCategory: "string",
    allowListDesc: "string",
    allowListName: "string",
    allowListType: "string",
    allowLists: ["string"],
    associatedInstanceNum: 0,
    ipAddress: "string",
    modifyMode: "string",
    securityGroupBindInfos: [{
        bindMode: "string",
        ipLists: ["string"],
        securityGroupId: "string",
        securityGroupName: "string",
    }],
    updateSecurityGroup: false,
    userAllowList: "string",
});

    type: bytepluscc:rdspostgresql:AllowList
properties:
    allowListCategory: string
    allowListDesc: string
    allowListName: string
    allowListType: string
    allowLists:
        - string
    associatedInstanceNum: 0
    ipAddress: string
    modifyMode: string
    securityGroupBindInfos:
        - bindMode: string
          ipLists:
            - string
          securityGroupId: string
          securityGroupName: string
    updateSecurityGroup: false
    userAllowList: string

    AllowList Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AllowList resource accepts the following input properties:

    AllowListCategory string
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    AllowListDesc string
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    AllowListName string
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    AllowListType string
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    AllowListValue List<string>
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    AssociatedInstanceNum int
    该白名单绑定的实例数量。
    IpAddress string
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    ModifyMode string
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    SecurityGroupBindInfos List<Byteplus.AllowListSecurityGroupBindInfo>
    UpdateSecurityGroup bool
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    UserAllowList string
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。
    AllowListCategory string
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    AllowListDesc string
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    AllowListName string
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    AllowListType string
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    AllowLists []string
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    AssociatedInstanceNum int
    该白名单绑定的实例数量。
    IpAddress string
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    ModifyMode string
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    SecurityGroupBindInfos []AllowListSecurityGroupBindInfoArgs
    UpdateSecurityGroup bool
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    UserAllowList string
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。
    allowListCategory String
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    allowListDesc String
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    allowListName String
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    allowListType String
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    allowLists List<String>
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    associatedInstanceNum Integer
    该白名单绑定的实例数量。
    ipAddress String
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    modifyMode String
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    securityGroupBindInfos List<AllowListSecurityGroupBindInfo>
    updateSecurityGroup Boolean
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    userAllowList String
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。
    allowListCategory string
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    allowListDesc string
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    allowListName string
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    allowListType string
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    allowLists string[]
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    associatedInstanceNum number
    该白名单绑定的实例数量。
    ipAddress string
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    modifyMode string
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    securityGroupBindInfos AllowListSecurityGroupBindInfo[]
    updateSecurityGroup boolean
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    userAllowList string
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。
    allow_list_category str
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    allow_list_desc str
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    allow_list_name str
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    allow_list_type str
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    allow_lists Sequence[str]
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    associated_instance_num int
    该白名单绑定的实例数量。
    ip_address str
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    modify_mode str
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    security_group_bind_infos Sequence[AllowListSecurityGroupBindInfoArgs]
    update_security_group bool
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    user_allow_list str
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。
    allowListCategory String
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    allowListDesc String
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    allowListName String
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    allowListType String
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    allowLists List<String>
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    associatedInstanceNum Number
    该白名单绑定的实例数量。
    ipAddress String
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    modifyMode String
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    securityGroupBindInfos List<Property Map>
    updateSecurityGroup Boolean
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    userAllowList String
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。

    Outputs

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

    AllowListId string
    白名单 ID。
    AllowListIpNum int
    白名单中 IP 地址或 IP 地址段的数量。
    AssociatedInstances List<Byteplus.AllowListAssociatedInstance>
    Id string
    The provider-assigned unique ID for this managed resource.
    AllowListId string
    白名单 ID。
    AllowListIpNum int
    白名单中 IP 地址或 IP 地址段的数量。
    AssociatedInstances []AllowListAssociatedInstance
    Id string
    The provider-assigned unique ID for this managed resource.
    allowListId String
    白名单 ID。
    allowListIpNum Integer
    白名单中 IP 地址或 IP 地址段的数量。
    associatedInstances List<AllowListAssociatedInstance>
    id String
    The provider-assigned unique ID for this managed resource.
    allowListId string
    白名单 ID。
    allowListIpNum number
    白名单中 IP 地址或 IP 地址段的数量。
    associatedInstances AllowListAssociatedInstance[]
    id string
    The provider-assigned unique ID for this managed resource.
    allow_list_id str
    白名单 ID。
    allow_list_ip_num int
    白名单中 IP 地址或 IP 地址段的数量。
    associated_instances Sequence[AllowListAssociatedInstance]
    id str
    The provider-assigned unique ID for this managed resource.
    allowListId String
    白名单 ID。
    allowListIpNum Number
    白名单中 IP 地址或 IP 地址段的数量。
    associatedInstances List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AllowList Resource

    Get an existing AllowList 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?: AllowListState, opts?: CustomResourceOptions): AllowList
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_list_category: Optional[str] = None,
        allow_list_desc: Optional[str] = None,
        allow_list_id: Optional[str] = None,
        allow_list_ip_num: Optional[int] = None,
        allow_list_name: Optional[str] = None,
        allow_list_type: Optional[str] = None,
        allow_lists: Optional[Sequence[str]] = None,
        associated_instance_num: Optional[int] = None,
        associated_instances: Optional[Sequence[AllowListAssociatedInstanceArgs]] = None,
        ip_address: Optional[str] = None,
        modify_mode: Optional[str] = None,
        security_group_bind_infos: Optional[Sequence[AllowListSecurityGroupBindInfoArgs]] = None,
        update_security_group: Optional[bool] = None,
        user_allow_list: Optional[str] = None) -> AllowList
    func GetAllowList(ctx *Context, name string, id IDInput, state *AllowListState, opts ...ResourceOption) (*AllowList, error)
    public static AllowList Get(string name, Input<string> id, AllowListState? state, CustomResourceOptions? opts = null)
    public static AllowList get(String name, Output<String> id, AllowListState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:rdspostgresql:AllowList    get:      id: ${id}
    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:
    AllowListCategory string
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    AllowListDesc string
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    AllowListId string
    白名单 ID。
    AllowListIpNum int
    白名单中 IP 地址或 IP 地址段的数量。
    AllowListName string
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    AllowListType string
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    AllowListValue List<string>
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    AssociatedInstanceNum int
    该白名单绑定的实例数量。
    AssociatedInstances List<Byteplus.AllowListAssociatedInstance>
    IpAddress string
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    ModifyMode string
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    SecurityGroupBindInfos List<Byteplus.AllowListSecurityGroupBindInfo>
    UpdateSecurityGroup bool
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    UserAllowList string
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。
    AllowListCategory string
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    AllowListDesc string
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    AllowListId string
    白名单 ID。
    AllowListIpNum int
    白名单中 IP 地址或 IP 地址段的数量。
    AllowListName string
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    AllowListType string
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    AllowLists []string
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    AssociatedInstanceNum int
    该白名单绑定的实例数量。
    AssociatedInstances []AllowListAssociatedInstanceArgs
    IpAddress string
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    ModifyMode string
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    SecurityGroupBindInfos []AllowListSecurityGroupBindInfoArgs
    UpdateSecurityGroup bool
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    UserAllowList string
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。
    allowListCategory String
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    allowListDesc String
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    allowListId String
    白名单 ID。
    allowListIpNum Integer
    白名单中 IP 地址或 IP 地址段的数量。
    allowListName String
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    allowListType String
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    allowLists List<String>
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    associatedInstanceNum Integer
    该白名单绑定的实例数量。
    associatedInstances List<AllowListAssociatedInstance>
    ipAddress String
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    modifyMode String
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    securityGroupBindInfos List<AllowListSecurityGroupBindInfo>
    updateSecurityGroup Boolean
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    userAllowList String
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。
    allowListCategory string
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    allowListDesc string
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    allowListId string
    白名单 ID。
    allowListIpNum number
    白名单中 IP 地址或 IP 地址段的数量。
    allowListName string
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    allowListType string
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    allowLists string[]
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    associatedInstanceNum number
    该白名单绑定的实例数量。
    associatedInstances AllowListAssociatedInstance[]
    ipAddress string
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    modifyMode string
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    securityGroupBindInfos AllowListSecurityGroupBindInfo[]
    updateSecurityGroup boolean
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    userAllowList string
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。
    allow_list_category str
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    allow_list_desc str
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    allow_list_id str
    白名单 ID。
    allow_list_ip_num int
    白名单中 IP 地址或 IP 地址段的数量。
    allow_list_name str
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    allow_list_type str
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    allow_lists Sequence[str]
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    associated_instance_num int
    该白名单绑定的实例数量。
    associated_instances Sequence[AllowListAssociatedInstanceArgs]
    ip_address str
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    modify_mode str
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    security_group_bind_infos Sequence[AllowListSecurityGroupBindInfoArgs]
    update_security_group bool
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    user_allow_list str
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。
    allowListCategory String
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
    allowListDesc String
    白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
    allowListId String
    白名单 ID。
    allowListIpNum Number
    白名单中 IP 地址或 IP 地址段的数量。
    allowListName String
    白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（）开头。只能包含中文、字母、数字、下划线（）和中划线（-）。长度为 1~128 个字符。
    allowListType String
    白名单采用的网络协议类型。取值为 IPv4（默认值）。
    allowLists List<String>
    白名单中包含的 IP 地址。支持以下两种格式：IP 地址格式。例如：10.23.12.24。CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
    associatedInstanceNum Number
    该白名单绑定的实例数量。
    associatedInstances List<Property Map>
    ipAddress String
    按 IP 地址查询白名单。支持传入多个 IP 地址，多个 IP 地址使用英文逗号（,）分隔。说明如果白名单包含了多个 IP 地址的任意子集，该白名单就会被返回。
    modifyMode String
    修改白名单的方式。取值：Cover：覆盖，即使用 AllowList 字段的值覆盖原白名单。默认值。Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。注意如需修改的白名单绑定有安全组，或需要在修改白名单时为白名单绑定安全组，则 ModifyMode 只能取值为 Cover。
    securityGroupBindInfos List<Property Map>
    updateSecurityGroup Boolean
    是否更新白名单所绑定的安全组。取值：true：更新。false：不更新。默认值。
    userAllowList String
    安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。

    Supporting Types

    AllowListAssociatedInstance, AllowListAssociatedInstanceArgs

    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。
    Vpc string
    实例所属的 VPC ID。
    InstanceId string
    实例 ID。
    InstanceName string
    实例名称。
    Vpc string
    实例所属的 VPC ID。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。
    vpc String
    实例所属的 VPC ID。
    instanceId string
    实例 ID。
    instanceName string
    实例名称。
    vpc string
    实例所属的 VPC ID。
    instance_id str
    实例 ID。
    instance_name str
    实例名称。
    vpc str
    实例所属的 VPC ID。
    instanceId String
    实例 ID。
    instanceName String
    实例名称。
    vpc String
    实例所属的 VPC ID。

    AllowListSecurityGroupBindInfo, AllowListSecurityGroupBindInfoArgs

    BindMode string
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
    IpLists List<string>
    安全组中的 IP 列表。
    SecurityGroupId string
    安全组 ID。
    SecurityGroupName string
    安全组名称。
    BindMode string
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
    IpLists []string
    安全组中的 IP 列表。
    SecurityGroupId string
    安全组 ID。
    SecurityGroupName string
    安全组名称。
    bindMode String
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
    ipLists List<String>
    安全组中的 IP 列表。
    securityGroupId String
    安全组 ID。
    securityGroupName String
    安全组名称。
    bindMode string
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
    ipLists string[]
    安全组中的 IP 列表。
    securityGroupId string
    安全组 ID。
    securityGroupName string
    安全组名称。
    bind_mode str
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
    ip_lists Sequence[str]
    安全组中的 IP 列表。
    security_group_id str
    安全组 ID。
    security_group_name str
    安全组名称。
    bindMode String
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。
    ipLists List<String>
    安全组中的 IP 列表。
    securityGroupId String
    安全组 ID。
    securityGroupName String
    安全组名称。

    Import

    $ pulumi import bytepluscc:rdspostgresql/allowList:AllowList example "allow_list_id"

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.