volcenginecc.redis.getAllowList

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getAllowList

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAllowList(args: GetAllowListArgs, opts?: InvokeOptions): Promise<GetAllowListResult>
function getAllowListOutput(args: GetAllowListOutputArgs, opts?: InvokeOptions): Output<GetAllowListResult>

def get_allow_list(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAllowListResult
def get_allow_list_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAllowListResult]

func LookupAllowList(ctx *Context, args *LookupAllowListArgs, opts ...InvokeOption) (*LookupAllowListResult, error)
func LookupAllowListOutput(ctx *Context, args *LookupAllowListOutputArgs, opts ...InvokeOption) LookupAllowListResultOutput

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

public static class GetAllowList 
{
    public static Task<GetAllowListResult> InvokeAsync(GetAllowListArgs args, InvokeOptions? opts = null)
    public static Output<GetAllowListResult> Invoke(GetAllowListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAllowListResult> getAllowList(GetAllowListArgs args, InvokeOptions options)
public static Output<GetAllowListResult> getAllowList(GetAllowListArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:redis/getAllowList:getAllowList
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getAllowList Result

The following output properties are available:

AllowList string: Enter an IP address or an address range in CIDR format. Note: The AllowList and SecurityGroupBindInfos parameters cannot both be empty. Duplicate addresses are not allowed. Separate multiple addresses with commas (,). Setting 0.0.0.0/0 allows access from all addresses. Setting 127.0.0.1 denies access from all addresses. Setting both 0.0.0.0/0 and 127.0.0.1 allows access from all addresses. Setting CIDR 192.168.1.0/24 allows access from IP addresses within that subnet. Setting 192.168.1.1 allows access only from that IP address.
AllowListCategory string: Type of allowlist. The value range is as follows: Ordinary (default): ordinary allowlist. Default: default allowlist. Note: Each account can set at most one default allowlist per region. When a new default allowlist is set, it automatically replaces the original default allowlist, and the original default allowlist becomes a non-default allowlist. For more details, see Constraints and Limitations
AllowListDesc string: Allowlist remarks. The length cannot exceed 200 characters. Note: If this parameter is not set, the remarks for the new allowlist will be empty by default
AllowListId string: Allowlist ID.
AllowListIpNum int: Number of IP addresses in the allowlist
AllowListName string: Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters
AssociatedInstanceNum int: Total number of instances bound to the allowlist
AssociatedInstances List<Volcengine.GetAllowListAssociatedInstance>: List of instances currently bound to this allowlist.
Id string: Uniquely identifies the resource.
InstanceIds List<string>: List of instance IDs bound to the current allowlist
ProjectName string: Project name associated with the allowlist
SecurityGroupBindInfos List<Volcengine.GetAllowListSecurityGroupBindInfo>: Information about the security groups associated with the allowlist. Note: This parameter is returned only if the allowlist contains associated security groups.

AllowList string: Enter an IP address or an address range in CIDR format. Note: The AllowList and SecurityGroupBindInfos parameters cannot both be empty. Duplicate addresses are not allowed. Separate multiple addresses with commas (,). Setting 0.0.0.0/0 allows access from all addresses. Setting 127.0.0.1 denies access from all addresses. Setting both 0.0.0.0/0 and 127.0.0.1 allows access from all addresses. Setting CIDR 192.168.1.0/24 allows access from IP addresses within that subnet. Setting 192.168.1.1 allows access only from that IP address.
AllowListCategory string: Type of allowlist. The value range is as follows: Ordinary (default): ordinary allowlist. Default: default allowlist. Note: Each account can set at most one default allowlist per region. When a new default allowlist is set, it automatically replaces the original default allowlist, and the original default allowlist becomes a non-default allowlist. For more details, see Constraints and Limitations
AllowListDesc string: Allowlist remarks. The length cannot exceed 200 characters. Note: If this parameter is not set, the remarks for the new allowlist will be empty by default
AllowListId string: Allowlist ID.
AllowListIpNum int: Number of IP addresses in the allowlist
AllowListName string: Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters
AssociatedInstanceNum int: Total number of instances bound to the allowlist
AssociatedInstances []GetAllowListAssociatedInstance: List of instances currently bound to this allowlist.
Id string: Uniquely identifies the resource.
InstanceIds []string: List of instance IDs bound to the current allowlist
ProjectName string: Project name associated with the allowlist
SecurityGroupBindInfos []GetAllowListSecurityGroupBindInfo: Information about the security groups associated with the allowlist. Note: This parameter is returned only if the allowlist contains associated security groups.

allowList String: Enter an IP address or an address range in CIDR format. Note: The AllowList and SecurityGroupBindInfos parameters cannot both be empty. Duplicate addresses are not allowed. Separate multiple addresses with commas (,). Setting 0.0.0.0/0 allows access from all addresses. Setting 127.0.0.1 denies access from all addresses. Setting both 0.0.0.0/0 and 127.0.0.1 allows access from all addresses. Setting CIDR 192.168.1.0/24 allows access from IP addresses within that subnet. Setting 192.168.1.1 allows access only from that IP address.
allowListCategory String: Type of allowlist. The value range is as follows: Ordinary (default): ordinary allowlist. Default: default allowlist. Note: Each account can set at most one default allowlist per region. When a new default allowlist is set, it automatically replaces the original default allowlist, and the original default allowlist becomes a non-default allowlist. For more details, see Constraints and Limitations
allowListDesc String: Allowlist remarks. The length cannot exceed 200 characters. Note: If this parameter is not set, the remarks for the new allowlist will be empty by default
allowListId String: Allowlist ID.
allowListIpNum Integer: Number of IP addresses in the allowlist
allowListName String: Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters
associatedInstanceNum Integer: Total number of instances bound to the allowlist
associatedInstances List<GetAllowListAssociatedInstance>: List of instances currently bound to this allowlist.
id String: Uniquely identifies the resource.
instanceIds List<String>: List of instance IDs bound to the current allowlist
projectName String: Project name associated with the allowlist
securityGroupBindInfos List<GetAllowListSecurityGroupBindInfo>: Information about the security groups associated with the allowlist. Note: This parameter is returned only if the allowlist contains associated security groups.

allowList string: Enter an IP address or an address range in CIDR format. Note: The AllowList and SecurityGroupBindInfos parameters cannot both be empty. Duplicate addresses are not allowed. Separate multiple addresses with commas (,). Setting 0.0.0.0/0 allows access from all addresses. Setting 127.0.0.1 denies access from all addresses. Setting both 0.0.0.0/0 and 127.0.0.1 allows access from all addresses. Setting CIDR 192.168.1.0/24 allows access from IP addresses within that subnet. Setting 192.168.1.1 allows access only from that IP address.
allowListCategory string: Type of allowlist. The value range is as follows: Ordinary (default): ordinary allowlist. Default: default allowlist. Note: Each account can set at most one default allowlist per region. When a new default allowlist is set, it automatically replaces the original default allowlist, and the original default allowlist becomes a non-default allowlist. For more details, see Constraints and Limitations
allowListDesc string: Allowlist remarks. The length cannot exceed 200 characters. Note: If this parameter is not set, the remarks for the new allowlist will be empty by default
allowListId string: Allowlist ID.
allowListIpNum number: Number of IP addresses in the allowlist
allowListName string: Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters
associatedInstanceNum number: Total number of instances bound to the allowlist
associatedInstances GetAllowListAssociatedInstance[]: List of instances currently bound to this allowlist.
id string: Uniquely identifies the resource.
instanceIds string[]: List of instance IDs bound to the current allowlist
projectName string: Project name associated with the allowlist
securityGroupBindInfos GetAllowListSecurityGroupBindInfo[]: Information about the security groups associated with the allowlist. Note: This parameter is returned only if the allowlist contains associated security groups.

allow_list str: Enter an IP address or an address range in CIDR format. Note: The AllowList and SecurityGroupBindInfos parameters cannot both be empty. Duplicate addresses are not allowed. Separate multiple addresses with commas (,). Setting 0.0.0.0/0 allows access from all addresses. Setting 127.0.0.1 denies access from all addresses. Setting both 0.0.0.0/0 and 127.0.0.1 allows access from all addresses. Setting CIDR 192.168.1.0/24 allows access from IP addresses within that subnet. Setting 192.168.1.1 allows access only from that IP address.
allow_list_category str: Type of allowlist. The value range is as follows: Ordinary (default): ordinary allowlist. Default: default allowlist. Note: Each account can set at most one default allowlist per region. When a new default allowlist is set, it automatically replaces the original default allowlist, and the original default allowlist becomes a non-default allowlist. For more details, see Constraints and Limitations
allow_list_desc str: Allowlist remarks. The length cannot exceed 200 characters. Note: If this parameter is not set, the remarks for the new allowlist will be empty by default
allow_list_id str: Allowlist ID.
allow_list_ip_num int: Number of IP addresses in the allowlist
allow_list_name str: Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters
associated_instance_num int: Total number of instances bound to the allowlist
associated_instances Sequence[GetAllowListAssociatedInstance]: List of instances currently bound to this allowlist.
id str: Uniquely identifies the resource.
instance_ids Sequence[str]: List of instance IDs bound to the current allowlist
project_name str: Project name associated with the allowlist
security_group_bind_infos Sequence[GetAllowListSecurityGroupBindInfo]: Information about the security groups associated with the allowlist. Note: This parameter is returned only if the allowlist contains associated security groups.

allowList String: Enter an IP address or an address range in CIDR format. Note: The AllowList and SecurityGroupBindInfos parameters cannot both be empty. Duplicate addresses are not allowed. Separate multiple addresses with commas (,). Setting 0.0.0.0/0 allows access from all addresses. Setting 127.0.0.1 denies access from all addresses. Setting both 0.0.0.0/0 and 127.0.0.1 allows access from all addresses. Setting CIDR 192.168.1.0/24 allows access from IP addresses within that subnet. Setting 192.168.1.1 allows access only from that IP address.
allowListCategory String: Type of allowlist. The value range is as follows: Ordinary (default): ordinary allowlist. Default: default allowlist. Note: Each account can set at most one default allowlist per region. When a new default allowlist is set, it automatically replaces the original default allowlist, and the original default allowlist becomes a non-default allowlist. For more details, see Constraints and Limitations
allowListDesc String: Allowlist remarks. The length cannot exceed 200 characters. Note: If this parameter is not set, the remarks for the new allowlist will be empty by default
allowListId String: Allowlist ID.
allowListIpNum Number: Number of IP addresses in the allowlist
allowListName String: Allowlist name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 1–128 characters
associatedInstanceNum Number: Total number of instances bound to the allowlist
associatedInstances List<Property Map>: List of instances currently bound to this allowlist.
id String: Uniquely identifies the resource.
instanceIds List<String>: List of instance IDs bound to the current allowlist
projectName String: Project name associated with the allowlist
securityGroupBindInfos List<Property Map>: Information about the security groups associated with the allowlist. Note: This parameter is returned only if the allowlist contains associated security groups.

Supporting Types

GetAllowListAssociatedInstance

InstanceId string: Instance ID bound to the current allowlist
InstanceName string: Instance names bound to the current allowlist
ProjectName string: Project name associated with the instance
Vpc string: Private network ID associated with the instance

InstanceId string: Instance ID bound to the current allowlist
InstanceName string: Instance names bound to the current allowlist
ProjectName string: Project name associated with the instance
Vpc string: Private network ID associated with the instance

instanceId String: Instance ID bound to the current allowlist
instanceName String: Instance names bound to the current allowlist
projectName String: Project name associated with the instance
vpc String: Private network ID associated with the instance

instanceId string: Instance ID bound to the current allowlist
instanceName string: Instance names bound to the current allowlist
projectName string: Project name associated with the instance
vpc string: Private network ID associated with the instance

instance_id str: Instance ID bound to the current allowlist
instance_name str: Instance names bound to the current allowlist
project_name str: Project name associated with the instance
vpc str: Private network ID associated with the instance

instanceId String: Instance ID bound to the current allowlist
instanceName String: Instance names bound to the current allowlist
projectName String: Project name associated with the instance
vpc String: Private network ID associated with the instance

GetAllowListSecurityGroupBindInfo

BindMode string: Security group association mode. The value range is as follows: IngressDirectionIp: ingress IP, which allows IPs involved in TCP and ALL protocols in the source address of the security group ingress direction to access the database. If the source address is configured as a security group, it will be ignored. AssociateEcsIp: associate ECS IP, which allows cloud servers within the security group to access the database. Currently, only importing IP information of the primary network interface is supported
IpLists List<string>: IP list of security groups associated with the allowlist
SecurityGroupId string: Associated security group ID
SecurityGroupName string: Name of the associated security group

BindMode string: Security group association mode. The value range is as follows: IngressDirectionIp: ingress IP, which allows IPs involved in TCP and ALL protocols in the source address of the security group ingress direction to access the database. If the source address is configured as a security group, it will be ignored. AssociateEcsIp: associate ECS IP, which allows cloud servers within the security group to access the database. Currently, only importing IP information of the primary network interface is supported
IpLists []string: IP list of security groups associated with the allowlist
SecurityGroupId string: Associated security group ID
SecurityGroupName string: Name of the associated security group

bindMode String: Security group association mode. The value range is as follows: IngressDirectionIp: ingress IP, which allows IPs involved in TCP and ALL protocols in the source address of the security group ingress direction to access the database. If the source address is configured as a security group, it will be ignored. AssociateEcsIp: associate ECS IP, which allows cloud servers within the security group to access the database. Currently, only importing IP information of the primary network interface is supported
ipLists List<String>: IP list of security groups associated with the allowlist
securityGroupId String: Associated security group ID
securityGroupName String: Name of the associated security group

bindMode string: Security group association mode. The value range is as follows: IngressDirectionIp: ingress IP, which allows IPs involved in TCP and ALL protocols in the source address of the security group ingress direction to access the database. If the source address is configured as a security group, it will be ignored. AssociateEcsIp: associate ECS IP, which allows cloud servers within the security group to access the database. Currently, only importing IP information of the primary network interface is supported
ipLists string[]: IP list of security groups associated with the allowlist
securityGroupId string: Associated security group ID
securityGroupName string: Name of the associated security group

bind_mode str: Security group association mode. The value range is as follows: IngressDirectionIp: ingress IP, which allows IPs involved in TCP and ALL protocols in the source address of the security group ingress direction to access the database. If the source address is configured as a security group, it will be ignored. AssociateEcsIp: associate ECS IP, which allows cloud servers within the security group to access the database. Currently, only importing IP information of the primary network interface is supported
ip_lists Sequence[str]: IP list of security groups associated with the allowlist
security_group_id str: Associated security group ID
security_group_name str: Name of the associated security group

bindMode String: Security group association mode. The value range is as follows: IngressDirectionIp: ingress IP, which allows IPs involved in TCP and ALL protocols in the source address of the security group ingress direction to access the database. If the source address is configured as a security group, it will be ignored. AssociateEcsIp: associate ECS IP, which allows cloud servers within the security group to access the database. Currently, only importing IP information of the primary network interface is supported
ipLists List<String>: IP list of security groups associated with the allowlist
securityGroupId String: Associated security group ID
securityGroupName String: Name of the associated security group