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

bytepluscc.rdsmysql.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 地址才能访问数据库。

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  rdsMysqlAllowListDemo:
    type: bytepluscc:rdsmysql:AllowList
    name: RdsMysqlAllowListDemo
    properties:
      userAllowLists:
        - 1.2.3.4
      allowListCategory: Default
      allowListDesc: this is a test
      allowListName: ccapi-test-2
      allowListType: IPv4
      projectName: default
      securityGroupBindInfos:
        - bind_mode: AssociateEcsIp
          ip_list: null
          security_group_id: sg-1a10axxxxxvepkdgqgnu
          security_group_name: Default
        - bind_mode: IngressDirectionIp
          ip_list:
            - 100.70.0.0/16
            - 100.72.0.0/16
            - 0.0.0.0/0
          security_group_id: sg-3nqt4kwxxxxx931ebkntmrc
          security_group_name: Default

    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,
              ignore_instance_status: Optional[bool] = None,
              instance_id: Optional[str] = None,
              modify_mode: Optional[str] = None,
              project_name: Optional[str] = None,
              security_group_bind_infos: Optional[Sequence[AllowListSecurityGroupBindInfoArgs]] = None,
              security_group_ids: Optional[Sequence[str]] = None,
              update_security_group: Optional[bool] = None,
              user_allow_lists: Optional[Sequence[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:rdsmysql: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 byteplusccAllowListResource = new Bytepluscc.Rdsmysql.AllowList("byteplusccAllowListResource", new()
{
    AllowListCategory = "string",
    AllowListDesc = "string",
    AllowListName = "string",
    AllowListType = "string",
    AllowListValue = new[]
    {
        "string",
    },
    AssociatedInstanceNum = 0,
    IgnoreInstanceStatus = false,
    InstanceId = "string",
    ModifyMode = "string",
    ProjectName = "string",
    SecurityGroupBindInfos = new[]
    {
        new Bytepluscc.Rdsmysql.Inputs.AllowListSecurityGroupBindInfoArgs
        {
            BindMode = "string",
            IpLists = new[]
            {
                "string",
            },
            SecurityGroupId = "string",
            SecurityGroupName = "string",
        },
    },
    SecurityGroupIds = new[]
    {
        "string",
    },
    UpdateSecurityGroup = false,
    UserAllowLists = new[]
    {
        "string",
    },
});

    example, err := rdsmysql.NewAllowList(ctx, "byteplusccAllowListResource", &rdsmysql.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),
	IgnoreInstanceStatus:  pulumi.Bool(false),
	InstanceId:            pulumi.String("string"),
	ModifyMode:            pulumi.String("string"),
	ProjectName:           pulumi.String("string"),
	SecurityGroupBindInfos: rdsmysql.AllowListSecurityGroupBindInfoArray{
		&rdsmysql.AllowListSecurityGroupBindInfoArgs{
			BindMode: pulumi.String("string"),
			IpLists: pulumi.StringArray{
				pulumi.String("string"),
			},
			SecurityGroupId:   pulumi.String("string"),
			SecurityGroupName: pulumi.String("string"),
		},
	},
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	UpdateSecurityGroup: pulumi.Bool(false),
	UserAllowLists: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var byteplusccAllowListResource = new com.byteplus.bytepluscc.rdsmysql.AllowList("byteplusccAllowListResource", com.byteplus.bytepluscc.rdsmysql.AllowListArgs.builder()
    .allowListCategory("string")
    .allowListDesc("string")
    .allowListName("string")
    .allowListType("string")
    .allowLists("string")
    .associatedInstanceNum(0)
    .ignoreInstanceStatus(false)
    .instanceId("string")
    .modifyMode("string")
    .projectName("string")
    .securityGroupBindInfos(AllowListSecurityGroupBindInfoArgs.builder()
        .bindMode("string")
        .ipLists("string")
        .securityGroupId("string")
        .securityGroupName("string")
        .build())
    .securityGroupIds("string")
    .updateSecurityGroup(false)
    .userAllowLists("string")
    .build());

    bytepluscc_allow_list_resource = bytepluscc.rdsmysql.AllowList("byteplusccAllowListResource",
    allow_list_category="string",
    allow_list_desc="string",
    allow_list_name="string",
    allow_list_type="string",
    allow_lists=["string"],
    associated_instance_num=0,
    ignore_instance_status=False,
    instance_id="string",
    modify_mode="string",
    project_name="string",
    security_group_bind_infos=[{
        "bind_mode": "string",
        "ip_lists": ["string"],
        "security_group_id": "string",
        "security_group_name": "string",
    }],
    security_group_ids=["string"],
    update_security_group=False,
    user_allow_lists=["string"])

    const byteplusccAllowListResource = new bytepluscc.rdsmysql.AllowList("byteplusccAllowListResource", {
    allowListCategory: "string",
    allowListDesc: "string",
    allowListName: "string",
    allowListType: "string",
    allowLists: ["string"],
    associatedInstanceNum: 0,
    ignoreInstanceStatus: false,
    instanceId: "string",
    modifyMode: "string",
    projectName: "string",
    securityGroupBindInfos: [{
        bindMode: "string",
        ipLists: ["string"],
        securityGroupId: "string",
        securityGroupName: "string",
    }],
    securityGroupIds: ["string"],
    updateSecurityGroup: false,
    userAllowLists: ["string"],
});

    type: bytepluscc:rdsmysql:AllowList
properties:
    allowListCategory: string
    allowListDesc: string
    allowListName: string
    allowListType: string
    allowLists:
        - string
    associatedInstanceNum: 0
    ignoreInstanceStatus: false
    instanceId: string
    modifyMode: string
    projectName: string
    securityGroupBindInfos:
        - bindMode: string
          ipLists:
            - string
          securityGroupId: string
          securityGroupName: string
    securityGroupIds:
        - string
    updateSecurityGroup: false
    userAllowLists:
        - 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：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    AllowListDesc string
    白名单的备注。
    AllowListName string
    白名单名称。
    AllowListType string
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    AllowListValue List<string>
    白名单内的 IP 地址列表
    AssociatedInstanceNum int
    白名单下绑定的实例总数。
    IgnoreInstanceStatus bool
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    InstanceId string
    实例 ID。
    ModifyMode string
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    ProjectName string
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    SecurityGroupBindInfos List<Byteplus.AllowListSecurityGroupBindInfo>
    SecurityGroupIds List<string>
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    UpdateSecurityGroup bool
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    UserAllowLists List<string>
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
    AllowListCategory string
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    AllowListDesc string
    白名单的备注。
    AllowListName string
    白名单名称。
    AllowListType string
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    AllowLists []string
    白名单内的 IP 地址列表
    AssociatedInstanceNum int
    白名单下绑定的实例总数。
    IgnoreInstanceStatus bool
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    InstanceId string
    实例 ID。
    ModifyMode string
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    ProjectName string
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    SecurityGroupBindInfos []AllowListSecurityGroupBindInfoArgs
    SecurityGroupIds []string
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    UpdateSecurityGroup bool
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    UserAllowLists []string
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
    allowListCategory String
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    allowListDesc String
    白名单的备注。
    allowListName String
    白名单名称。
    allowListType String
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allowLists List<String>
    白名单内的 IP 地址列表
    associatedInstanceNum Integer
    白名单下绑定的实例总数。
    ignoreInstanceStatus Boolean
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    instanceId String
    实例 ID。
    modifyMode String
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    projectName String
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    securityGroupBindInfos List<AllowListSecurityGroupBindInfo>
    securityGroupIds List<String>
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    updateSecurityGroup Boolean
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    userAllowLists List<String>
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
    allowListCategory string
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    allowListDesc string
    白名单的备注。
    allowListName string
    白名单名称。
    allowListType string
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allowLists string[]
    白名单内的 IP 地址列表
    associatedInstanceNum number
    白名单下绑定的实例总数。
    ignoreInstanceStatus boolean
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    instanceId string
    实例 ID。
    modifyMode string
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    projectName string
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    securityGroupBindInfos AllowListSecurityGroupBindInfo[]
    securityGroupIds string[]
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    updateSecurityGroup boolean
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    userAllowLists string[]
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
    allow_list_category str
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    allow_list_desc str
    白名单的备注。
    allow_list_name str
    白名单名称。
    allow_list_type str
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allow_lists Sequence[str]
    白名单内的 IP 地址列表
    associated_instance_num int
    白名单下绑定的实例总数。
    ignore_instance_status bool
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    instance_id str
    实例 ID。
    modify_mode str
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    project_name str
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    security_group_bind_infos Sequence[AllowListSecurityGroupBindInfoArgs]
    security_group_ids Sequence[str]
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    update_security_group bool
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    user_allow_lists Sequence[str]
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
    allowListCategory String
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    allowListDesc String
    白名单的备注。
    allowListName String
    白名单名称。
    allowListType String
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allowLists List<String>
    白名单内的 IP 地址列表
    associatedInstanceNum Number
    白名单下绑定的实例总数。
    ignoreInstanceStatus Boolean
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    instanceId String
    实例 ID。
    modifyMode String
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    projectName String
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    securityGroupBindInfos List<Property Map>
    securityGroupIds List<String>
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    updateSecurityGroup Boolean
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    userAllowLists List<String>
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。

    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 地址（或地址段）总数。
    AssociatedInstances List<Byteplus.AllowListAssociatedInstance>
    Id string
    The provider-assigned unique ID for this managed resource.
    IpLists List<string>
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
    AllowListId string
    白名单 ID 。
    AllowListIpNum int
    白名单内的 IP 地址（或地址段）总数。
    AssociatedInstances []AllowListAssociatedInstance
    Id string
    The provider-assigned unique ID for this managed resource.
    IpLists []string
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
    allowListId String
    白名单 ID 。
    allowListIpNum Integer
    白名单内的 IP 地址（或地址段）总数。
    associatedInstances List<AllowListAssociatedInstance>
    id String
    The provider-assigned unique ID for this managed resource.
    ipLists List<String>
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
    allowListId string
    白名单 ID 。
    allowListIpNum number
    白名单内的 IP 地址（或地址段）总数。
    associatedInstances AllowListAssociatedInstance[]
    id string
    The provider-assigned unique ID for this managed resource.
    ipLists string[]
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
    allow_list_id str
    白名单 ID 。
    allow_list_ip_num int
    白名单内的 IP 地址（或地址段）总数。
    associated_instances Sequence[AllowListAssociatedInstance]
    id str
    The provider-assigned unique ID for this managed resource.
    ip_lists Sequence[str]
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
    allowListId String
    白名单 ID 。
    allowListIpNum Number
    白名单内的 IP 地址（或地址段）总数。
    associatedInstances List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    ipLists List<String>
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。

    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,
        ignore_instance_status: Optional[bool] = None,
        instance_id: Optional[str] = None,
        ip_lists: Optional[Sequence[str]] = None,
        modify_mode: Optional[str] = None,
        project_name: Optional[str] = None,
        security_group_bind_infos: Optional[Sequence[AllowListSecurityGroupBindInfoArgs]] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        update_security_group: Optional[bool] = None,
        user_allow_lists: Optional[Sequence[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:rdsmysql: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：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    AllowListDesc string
    白名单的备注。
    AllowListId string
    白名单 ID 。
    AllowListIpNum int
    白名单内的 IP 地址（或地址段）总数。
    AllowListName string
    白名单名称。
    AllowListType string
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    AllowListValue List<string>
    白名单内的 IP 地址列表
    AssociatedInstanceNum int
    白名单下绑定的实例总数。
    AssociatedInstances List<Byteplus.AllowListAssociatedInstance>
    IgnoreInstanceStatus bool
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    InstanceId string
    实例 ID。
    IpLists List<string>
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
    ModifyMode string
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    ProjectName string
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    SecurityGroupBindInfos List<Byteplus.AllowListSecurityGroupBindInfo>
    SecurityGroupIds List<string>
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    UpdateSecurityGroup bool
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    UserAllowLists List<string>
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
    AllowListCategory string
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    AllowListDesc string
    白名单的备注。
    AllowListId string
    白名单 ID 。
    AllowListIpNum int
    白名单内的 IP 地址（或地址段）总数。
    AllowListName string
    白名单名称。
    AllowListType string
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    AllowLists []string
    白名单内的 IP 地址列表
    AssociatedInstanceNum int
    白名单下绑定的实例总数。
    AssociatedInstances []AllowListAssociatedInstanceArgs
    IgnoreInstanceStatus bool
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    InstanceId string
    实例 ID。
    IpLists []string
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
    ModifyMode string
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    ProjectName string
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    SecurityGroupBindInfos []AllowListSecurityGroupBindInfoArgs
    SecurityGroupIds []string
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    UpdateSecurityGroup bool
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    UserAllowLists []string
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
    allowListCategory String
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    allowListDesc String
    白名单的备注。
    allowListId String
    白名单 ID 。
    allowListIpNum Integer
    白名单内的 IP 地址（或地址段）总数。
    allowListName String
    白名单名称。
    allowListType String
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allowLists List<String>
    白名单内的 IP 地址列表
    associatedInstanceNum Integer
    白名单下绑定的实例总数。
    associatedInstances List<AllowListAssociatedInstance>
    ignoreInstanceStatus Boolean
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    instanceId String
    实例 ID。
    ipLists List<String>
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
    modifyMode String
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    projectName String
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    securityGroupBindInfos List<AllowListSecurityGroupBindInfo>
    securityGroupIds List<String>
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    updateSecurityGroup Boolean
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    userAllowLists List<String>
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
    allowListCategory string
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    allowListDesc string
    白名单的备注。
    allowListId string
    白名单 ID 。
    allowListIpNum number
    白名单内的 IP 地址（或地址段）总数。
    allowListName string
    白名单名称。
    allowListType string
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allowLists string[]
    白名单内的 IP 地址列表
    associatedInstanceNum number
    白名单下绑定的实例总数。
    associatedInstances AllowListAssociatedInstance[]
    ignoreInstanceStatus boolean
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    instanceId string
    实例 ID。
    ipLists string[]
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
    modifyMode string
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    projectName string
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    securityGroupBindInfos AllowListSecurityGroupBindInfo[]
    securityGroupIds string[]
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    updateSecurityGroup boolean
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    userAllowLists string[]
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
    allow_list_category str
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    allow_list_desc str
    白名单的备注。
    allow_list_id str
    白名单 ID 。
    allow_list_ip_num int
    白名单内的 IP 地址（或地址段）总数。
    allow_list_name str
    白名单名称。
    allow_list_type str
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allow_lists Sequence[str]
    白名单内的 IP 地址列表
    associated_instance_num int
    白名单下绑定的实例总数。
    associated_instances Sequence[AllowListAssociatedInstanceArgs]
    ignore_instance_status bool
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    instance_id str
    实例 ID。
    ip_lists Sequence[str]
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
    modify_mode str
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    project_name str
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    security_group_bind_infos Sequence[AllowListSecurityGroupBindInfoArgs]
    security_group_ids Sequence[str]
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    update_security_group bool
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    user_allow_lists Sequence[str]
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。
    allowListCategory String
    白名单分类。取值：Ordinary：普通白名单。Default：默认白名单。说明该参数作为请求参数时，默认值为 Ordinary。
    allowListDesc String
    白名单的备注。
    allowListId String
    白名单 ID 。
    allowListIpNum Number
    白名单内的 IP 地址（或地址段）总数。
    allowListName String
    白名单名称。
    allowListType String
    白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
    allowLists List<String>
    白名单内的 IP 地址列表
    associatedInstanceNum Number
    白名单下绑定的实例总数。
    associatedInstances List<Property Map>
    ignoreInstanceStatus Boolean
    是否忽略实例状态校验。取值：true：是。false：否。默认值。
    instanceId String
    实例 ID。
    ipLists List<String>
    白名单包含的 IP 地址和 IP 地址段的列表。在请求参数 WithIpList 取值为 true 时返回，在取值为 false 或不为其传值时返回为 null。
    modifyMode String
    修改方式，取值范围如下：Cover（默认值）：使用 AllowList 参数中的值覆盖原白名单。Append：在原白名单中增加 AllowList 参数中输入的 IP 地址。Delete：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
    projectName String
    所属的项目。说明如您调用接口使用的 AK/SK 属于某个子账号，且该子账号只拥有某个项目的权限，需要传入该请求参数。
    securityGroupBindInfos List<Property Map>
    securityGroupIds List<String>
    需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。
    updateSecurityGroup Boolean
    是否更新白名单所绑定的安全组。true：更新。false：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。
    userAllowLists List<String>
    该名单中由用户输入的 IP 地址。AllowList 字段中的 IP 为 UserAllowList 和 SecurityGroupBindInfos 包含的 IP 的并集。

    Supporting Types

    AllowListAssociatedInstance, AllowListAssociatedInstanceArgs

    InstanceId string
    已绑定当前白名单的实例 ID。
    InstanceName string
    已绑定当前白名单的实例名称。
    InstanceStatus string
    实例状态。
    IsLatest bool
    是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
    Vpc string
    实例所属的私有网络 ID。
    InstanceId string
    已绑定当前白名单的实例 ID。
    InstanceName string
    已绑定当前白名单的实例名称。
    InstanceStatus string
    实例状态。
    IsLatest bool
    是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
    Vpc string
    实例所属的私有网络 ID。
    instanceId String
    已绑定当前白名单的实例 ID。
    instanceName String
    已绑定当前白名单的实例名称。
    instanceStatus String
    实例状态。
    isLatest Boolean
    是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
    vpc String
    实例所属的私有网络 ID。
    instanceId string
    已绑定当前白名单的实例 ID。
    instanceName string
    已绑定当前白名单的实例名称。
    instanceStatus string
    实例状态。
    isLatest boolean
    是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
    vpc string
    实例所属的私有网络 ID。
    instance_id str
    已绑定当前白名单的实例 ID。
    instance_name str
    已绑定当前白名单的实例名称。
    instance_status str
    实例状态。
    is_latest bool
    是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
    vpc str
    实例所属的私有网络 ID。
    instanceId String
    已绑定当前白名单的实例 ID。
    instanceName String
    已绑定当前白名单的实例名称。
    instanceStatus String
    实例状态。
    isLatest Boolean
    是否已同步最新的白名单。取值：true：是。false：否。说明在修改白名单时，如实例状态未处于运行中，白名单的修改不会立即同步到实例。
    vpc String
    实例所属的私有网络 ID。

    AllowListSecurityGroupBindInfo, AllowListSecurityGroupBindInfoArgs

    BindMode string
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
    IpLists List<string>
    安全组的 IP 地址列表。
    SecurityGroupId string
    安全组 ID。
    SecurityGroupName string
    安全组名称。
    BindMode string
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
    IpLists []string
    安全组的 IP 地址列表。
    SecurityGroupId string
    安全组 ID。
    SecurityGroupName string
    安全组名称。
    bindMode String
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
    ipLists List<String>
    安全组的 IP 地址列表。
    securityGroupId String
    安全组 ID。
    securityGroupName String
    安全组名称。
    bindMode string
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
    ipLists string[]
    安全组的 IP 地址列表。
    securityGroupId string
    安全组 ID。
    securityGroupName string
    安全组名称。
    bind_mode str
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
    ip_lists Sequence[str]
    安全组的 IP 地址列表。
    security_group_id str
    安全组 ID。
    security_group_name str
    安全组名称。
    bindMode String
    关联安全组的模式。取值：IngressDirectionIp：入方向 IP。AssociateEcsIp：关联 ECSIP。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
    ipLists List<String>
    安全组的 IP 地址列表。
    securityGroupId String
    安全组 ID。
    securityGroupName String
    安全组名称。

    Import

    $ pulumi import bytepluscc:rdsmysql/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.