published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
An allowlist is a security measure for database connections. Only IP addresses in the allowlist can access the database. After a PostgreSQL instance is created, it is not bound to any allowlist, and all IP addresses are denied access by default. To connect to the instance via private or public network, you must first configure an allowlist for the instance to ensure connectivity.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
const rdsPostgresqlAllowListDemo = new volcenginecc.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_volcenginecc as volcenginecc
rds_postgresql_allow_list_demo = volcenginecc.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/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/rdspostgresql"
)
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 Volcenginecc = Volcengine.Pulumi.Volcenginecc;
return await Deployment.RunAsync(() =>
{
var rdsPostgresqlAllowListDemo = new Volcenginecc.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.volcengine.volcenginecc.rdspostgresql.AllowList;
import com.volcengine.volcenginecc.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: volcenginecc: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: volcenginecc: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.
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:
- Allow
List stringCategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- Allow
List stringDesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- Allow
List stringName - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- Allow
List stringType - Network protocol type used by the allowlist. Value: IPv4 (default).
- Allow
List List<string>Value - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- Associated
Instance intNum - Number of instances bound to this allowlist.
- Ip
Address string - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- Modify
Mode string - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- Security
Group List<Volcengine.Bind Infos Allow List Security Group Bind Info> - Update
Security boolGroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- User
Allow stringList - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
- Allow
List stringCategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- Allow
List stringDesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- Allow
List stringName - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- Allow
List stringType - Network protocol type used by the allowlist. Value: IPv4 (default).
- Allow
Lists []string - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- Associated
Instance intNum - Number of instances bound to this allowlist.
- Ip
Address string - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- Modify
Mode string - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- Security
Group []AllowBind Infos List Security Group Bind Info Args - Update
Security boolGroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- User
Allow stringList - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
- allow
List StringCategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- allow
List StringDesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- allow
List StringName - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- allow
List StringType - Network protocol type used by the allowlist. Value: IPv4 (default).
- allow
Lists List<String> - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- associated
Instance IntegerNum - Number of instances bound to this allowlist.
- ip
Address String - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- modify
Mode String - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- security
Group List<AllowBind Infos List Security Group Bind Info> - update
Security BooleanGroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- user
Allow StringList - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
- allow
List stringCategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- allow
List stringDesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- allow
List stringName - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- allow
List stringType - Network protocol type used by the allowlist. Value: IPv4 (default).
- allow
Lists string[] - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- associated
Instance numberNum - Number of instances bound to this allowlist.
- ip
Address string - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- modify
Mode string - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- security
Group AllowBind Infos List Security Group Bind Info[] - update
Security booleanGroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- user
Allow stringList - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
- allow_
list_ strcategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- allow_
list_ strdesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- allow_
list_ strname - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- allow_
list_ strtype - Network protocol type used by the allowlist. Value: IPv4 (default).
- allow_
lists Sequence[str] - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- associated_
instance_ intnum - Number of instances bound to this allowlist.
- ip_
address str - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- modify_
mode str - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- security_
group_ Sequence[Allowbind_ infos List Security Group Bind Info Args] - update_
security_ boolgroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- user_
allow_ strlist - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
- allow
List StringCategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- allow
List StringDesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- allow
List StringName - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- allow
List StringType - Network protocol type used by the allowlist. Value: IPv4 (default).
- allow
Lists List<String> - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- associated
Instance NumberNum - Number of instances bound to this allowlist.
- ip
Address String - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- modify
Mode String - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- security
Group List<Property Map>Bind Infos - update
Security BooleanGroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- user
Allow StringList - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
Outputs
All input properties are implicitly available as output properties. Additionally, the AllowList resource produces the following output properties:
- Allow
List stringId - Allowlist ID.
- Allow
List intIp Num - Number of IP addresses or IP segments in the allowlist.
- Associated
Instances List<Volcengine.Allow List Associated Instance> - Id string
- The provider-assigned unique ID for this managed resource.
- Allow
List stringId - Allowlist ID.
- Allow
List intIp Num - Number of IP addresses or IP segments in the allowlist.
- Associated
Instances []AllowList Associated Instance - Id string
- The provider-assigned unique ID for this managed resource.
- allow
List StringId - Allowlist ID.
- allow
List IntegerIp Num - Number of IP addresses or IP segments in the allowlist.
- associated
Instances List<AllowList Associated Instance> - id String
- The provider-assigned unique ID for this managed resource.
- allow
List stringId - Allowlist ID.
- allow
List numberIp Num - Number of IP addresses or IP segments in the allowlist.
- associated
Instances AllowList Associated Instance[] - id string
- The provider-assigned unique ID for this managed resource.
- allow_
list_ strid - Allowlist ID.
- allow_
list_ intip_ num - Number of IP addresses or IP segments in the allowlist.
- associated_
instances Sequence[AllowList Associated Instance] - id str
- The provider-assigned unique ID for this managed resource.
- allow
List StringId - Allowlist ID.
- allow
List NumberIp Num - Number of IP addresses or IP segments in the allowlist.
- associated
Instances 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) -> AllowListfunc 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: volcenginecc: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.
- Allow
List stringCategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- Allow
List stringDesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- Allow
List stringId - Allowlist ID.
- Allow
List intIp Num - Number of IP addresses or IP segments in the allowlist.
- Allow
List stringName - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- Allow
List stringType - Network protocol type used by the allowlist. Value: IPv4 (default).
- Allow
List List<string>Value - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- Associated
Instance intNum - Number of instances bound to this allowlist.
- Associated
Instances List<Volcengine.Allow List Associated Instance> - Ip
Address string - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- Modify
Mode string - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- Security
Group List<Volcengine.Bind Infos Allow List Security Group Bind Info> - Update
Security boolGroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- User
Allow stringList - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
- Allow
List stringCategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- Allow
List stringDesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- Allow
List stringId - Allowlist ID.
- Allow
List intIp Num - Number of IP addresses or IP segments in the allowlist.
- Allow
List stringName - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- Allow
List stringType - Network protocol type used by the allowlist. Value: IPv4 (default).
- Allow
Lists []string - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- Associated
Instance intNum - Number of instances bound to this allowlist.
- Associated
Instances []AllowList Associated Instance Args - Ip
Address string - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- Modify
Mode string - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- Security
Group []AllowBind Infos List Security Group Bind Info Args - Update
Security boolGroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- User
Allow stringList - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
- allow
List StringCategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- allow
List StringDesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- allow
List StringId - Allowlist ID.
- allow
List IntegerIp Num - Number of IP addresses or IP segments in the allowlist.
- allow
List StringName - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- allow
List StringType - Network protocol type used by the allowlist. Value: IPv4 (default).
- allow
Lists List<String> - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- associated
Instance IntegerNum - Number of instances bound to this allowlist.
- associated
Instances List<AllowList Associated Instance> - ip
Address String - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- modify
Mode String - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- security
Group List<AllowBind Infos List Security Group Bind Info> - update
Security BooleanGroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- user
Allow StringList - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
- allow
List stringCategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- allow
List stringDesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- allow
List stringId - Allowlist ID.
- allow
List numberIp Num - Number of IP addresses or IP segments in the allowlist.
- allow
List stringName - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- allow
List stringType - Network protocol type used by the allowlist. Value: IPv4 (default).
- allow
Lists string[] - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- associated
Instance numberNum - Number of instances bound to this allowlist.
- associated
Instances AllowList Associated Instance[] - ip
Address string - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- modify
Mode string - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- security
Group AllowBind Infos List Security Group Bind Info[] - update
Security booleanGroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- user
Allow stringList - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
- allow_
list_ strcategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- allow_
list_ strdesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- allow_
list_ strid - Allowlist ID.
- allow_
list_ intip_ num - Number of IP addresses or IP segments in the allowlist.
- allow_
list_ strname - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- allow_
list_ strtype - Network protocol type used by the allowlist. Value: IPv4 (default).
- allow_
lists Sequence[str] - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- associated_
instance_ intnum - Number of instances bound to this allowlist.
- associated_
instances Sequence[AllowList Associated Instance Args] - ip_
address str - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- modify_
mode str - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- security_
group_ Sequence[Allowbind_ infos List Security Group Bind Info Args] - update_
security_ boolgroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- user_
allow_ strlist - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
- allow
List StringCategory - Allowlist category. Values: Ordinary: ordinary allowlist; Default: default allowlist. Note: This parameter has no default value when used as a request parameter. If not provided, all categories of allowlists are queried.
- allow
List StringDesc - Description of the allowlist. Up to 200 characters. Default value is an empty string.
- allow
List StringId - Allowlist ID.
- allow
List NumberIp Num - Number of IP addresses or IP segments in the allowlist.
- allow
List StringName - Allowlist naming rules: The allowlist name must be unique within the current region. It must start with a Chinese character, letter, or underscore (). It can only contain Chinese characters, letters, numbers, underscores (), and hyphens (-). Length must be 1–128 characters.
- allow
List StringType - Network protocol type used by the allowlist. Value: IPv4 (default).
- allow
Lists List<String> - IP addresses included in the allowlist. Supports the following two formats: IP address format, for example: 10.23.12.24. CIDR IP address range format, for example: 10.23.12.0/24 (Classless Inter-Domain Routing, 24 indicates the prefix length, range is 1–32). Note: Each allowlist can add up to 300 IP addresses or IP ranges. If there are many IPs, it is recommended to merge them into IP ranges, such as 10.23.12.0/24. Do not add IP addresses ending with x.x.x.x/0 except for 0.0.0.0/0 to the allowlist. This field cannot be used together with the UserAllowList field.
- associated
Instance NumberNum - Number of instances bound to this allowlist.
- associated
Instances List<Property Map> - ip
Address String - Query allowlist by IP address. Supports multiple IP addresses separated by commas (,). Note: If the allowlist contains any subset of the provided IP addresses, that allowlist will be returned.
- modify
Mode String - Allowlist modification mode. Values: Cover (default): overwrite, use the value of the AllowList field to overwrite the original allowlist. Append: add, add the IP addresses in the AllowList field to the original allowlist. Delete: remove, remove the IP addresses in the AllowList field from the original allowlist. At least one IP address must remain. Note: If the allowlist to be modified is bound to a security group, or if you need to bind a security group when modifying the allowlist, ModifyMode can only be set to Cover.
- security
Group List<Property Map>Bind Infos - update
Security BooleanGroup - Whether to update the security group bound to the allowlist. Values: true: update; false: do not update. Default value.
- user
Allow StringList - IP addresses outside the security group that need to be added to the allowlist. You can enter IP addresses or CIDR IP ranges. Note: This field cannot be used together with the AllowList field.
Supporting Types
AllowListAssociatedInstance, AllowListAssociatedInstanceArgs
- Instance
Id string - Instance ID.
- Instance
Name string - Instance name.
- Vpc string
- VPC ID to which the instance belongs.
- Instance
Id string - Instance ID.
- Instance
Name string - Instance name.
- Vpc string
- VPC ID to which the instance belongs.
- instance
Id String - Instance ID.
- instance
Name String - Instance name.
- vpc String
- VPC ID to which the instance belongs.
- instance
Id string - Instance ID.
- instance
Name string - Instance name.
- vpc string
- VPC ID to which the instance belongs.
- instance_
id str - Instance ID.
- instance_
name str - Instance name.
- vpc str
- VPC ID to which the instance belongs.
- instance
Id String - Instance ID.
- instance
Name String - Instance name.
- vpc String
- VPC ID to which the instance belongs.
AllowListSecurityGroupBindInfo, AllowListSecurityGroupBindInfoArgs
- Bind
Mode string - Mode for associating security groups. Values: IngressDirectionIp: inbound IP. AssociateEcsIp: associate ECS IP.
- Ip
Lists List<string> - IP address list in the security group.
- Security
Group stringId - Security group ID.
- Security
Group stringName - Security group name.
- Bind
Mode string - Mode for associating security groups. Values: IngressDirectionIp: inbound IP. AssociateEcsIp: associate ECS IP.
- Ip
Lists []string - IP address list in the security group.
- Security
Group stringId - Security group ID.
- Security
Group stringName - Security group name.
- bind
Mode String - Mode for associating security groups. Values: IngressDirectionIp: inbound IP. AssociateEcsIp: associate ECS IP.
- ip
Lists List<String> - IP address list in the security group.
- security
Group StringId - Security group ID.
- security
Group StringName - Security group name.
- bind
Mode string - Mode for associating security groups. Values: IngressDirectionIp: inbound IP. AssociateEcsIp: associate ECS IP.
- ip
Lists string[] - IP address list in the security group.
- security
Group stringId - Security group ID.
- security
Group stringName - Security group name.
- bind_
mode str - Mode for associating security groups. Values: IngressDirectionIp: inbound IP. AssociateEcsIp: associate ECS IP.
- ip_
lists Sequence[str] - IP address list in the security group.
- security_
group_ strid - Security group ID.
- security_
group_ strname - Security group name.
- bind
Mode String - Mode for associating security groups. Values: IngressDirectionIp: inbound IP. AssociateEcsIp: associate ECS IP.
- ip
Lists List<String> - IP address list in the security group.
- security
Group StringId - Security group ID.
- security
Group StringName - Security group name.
Import
$ pulumi import volcenginecc:rdspostgresql/allowList:AllowList example "allow_list_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
