1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vpc
  6. getPrefixList
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    Data Source schema for Volcengine::VPC::PrefixList

    Using getPrefixList

    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 getPrefixList(args: GetPrefixListArgs, opts?: InvokeOptions): Promise<GetPrefixListResult>
    function getPrefixListOutput(args: GetPrefixListOutputArgs, opts?: InvokeOptions): Output<GetPrefixListResult>
    def get_prefix_list(id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPrefixListResult
    def get_prefix_list_output(id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPrefixListResult]
    func LookupPrefixList(ctx *Context, args *LookupPrefixListArgs, opts ...InvokeOption) (*LookupPrefixListResult, error)
    func LookupPrefixListOutput(ctx *Context, args *LookupPrefixListOutputArgs, opts ...InvokeOption) LookupPrefixListResultOutput

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

    public static class GetPrefixList 
    {
        public static Task<GetPrefixListResult> InvokeAsync(GetPrefixListArgs args, InvokeOptions? opts = null)
        public static Output<GetPrefixListResult> Invoke(GetPrefixListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPrefixListResult> getPrefixList(GetPrefixListArgs args, InvokeOptions options)
    public static Output<GetPrefixListResult> getPrefixList(GetPrefixListArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:vpc/getPrefixList:getPrefixList
      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.

    getPrefixList Result

    The following output properties are available:

    AssociationCount int
    Number of resources associated with the prefix list.
    AssociationsRouteTables List<Volcengine.GetPrefixListAssociationsRouteTable>
    Route table information associated with the prefix list.
    AssociationsSecurityGroups List<Volcengine.GetPrefixListAssociationsSecurityGroup>
    Security group information associated with the prefix list.
    CreatedTime string
    Creation time of the prefix list.
    Description string
    Description of the prefix list. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).
    Id string
    Uniquely identifies the resource.
    IpVersion string
    IP version type. Values: IPv4 (default): IPv4 type. IPv6: IPv6 type.
    MaxEntries int
    Maximum number of entries, that is, the maximum number of entries that can be added to the prefix list. Value range: 1–200.
    PrefixListEntries List<Volcengine.GetPrefixListPrefixListEntry>
    CIDR of the prefix list entry.
    PrefixListId string
    Prefix list ID.
    PrefixListName string
    Name of the prefix list. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    ProjectName string
    Name of the project to which the prefix list belongs. If not specified, it is added to the default project.
    Status string
    Status of the prefix list. Values: Available: available; Creating: creating; Deleting: deleting; Pending: modifying.
    Tags List<Volcengine.GetPrefixListTag>
    Tag list.
    UpdatedTime string
    Last modification time of the prefix list.
    AssociationCount int
    Number of resources associated with the prefix list.
    AssociationsRouteTables []GetPrefixListAssociationsRouteTable
    Route table information associated with the prefix list.
    AssociationsSecurityGroups []GetPrefixListAssociationsSecurityGroup
    Security group information associated with the prefix list.
    CreatedTime string
    Creation time of the prefix list.
    Description string
    Description of the prefix list. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).
    Id string
    Uniquely identifies the resource.
    IpVersion string
    IP version type. Values: IPv4 (default): IPv4 type. IPv6: IPv6 type.
    MaxEntries int
    Maximum number of entries, that is, the maximum number of entries that can be added to the prefix list. Value range: 1–200.
    PrefixListEntries []GetPrefixListPrefixListEntry
    CIDR of the prefix list entry.
    PrefixListId string
    Prefix list ID.
    PrefixListName string
    Name of the prefix list. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    ProjectName string
    Name of the project to which the prefix list belongs. If not specified, it is added to the default project.
    Status string
    Status of the prefix list. Values: Available: available; Creating: creating; Deleting: deleting; Pending: modifying.
    Tags []GetPrefixListTag
    Tag list.
    UpdatedTime string
    Last modification time of the prefix list.
    associationCount Integer
    Number of resources associated with the prefix list.
    associationsRouteTables List<GetPrefixListAssociationsRouteTable>
    Route table information associated with the prefix list.
    associationsSecurityGroups List<GetPrefixListAssociationsSecurityGroup>
    Security group information associated with the prefix list.
    createdTime String
    Creation time of the prefix list.
    description String
    Description of the prefix list. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).
    id String
    Uniquely identifies the resource.
    ipVersion String
    IP version type. Values: IPv4 (default): IPv4 type. IPv6: IPv6 type.
    maxEntries Integer
    Maximum number of entries, that is, the maximum number of entries that can be added to the prefix list. Value range: 1–200.
    prefixListEntries List<GetPrefixListPrefixListEntry>
    CIDR of the prefix list entry.
    prefixListId String
    Prefix list ID.
    prefixListName String
    Name of the prefix list. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    projectName String
    Name of the project to which the prefix list belongs. If not specified, it is added to the default project.
    status String
    Status of the prefix list. Values: Available: available; Creating: creating; Deleting: deleting; Pending: modifying.
    tags List<GetPrefixListTag>
    Tag list.
    updatedTime String
    Last modification time of the prefix list.
    associationCount number
    Number of resources associated with the prefix list.
    associationsRouteTables GetPrefixListAssociationsRouteTable[]
    Route table information associated with the prefix list.
    associationsSecurityGroups GetPrefixListAssociationsSecurityGroup[]
    Security group information associated with the prefix list.
    createdTime string
    Creation time of the prefix list.
    description string
    Description of the prefix list. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).
    id string
    Uniquely identifies the resource.
    ipVersion string
    IP version type. Values: IPv4 (default): IPv4 type. IPv6: IPv6 type.
    maxEntries number
    Maximum number of entries, that is, the maximum number of entries that can be added to the prefix list. Value range: 1–200.
    prefixListEntries GetPrefixListPrefixListEntry[]
    CIDR of the prefix list entry.
    prefixListId string
    Prefix list ID.
    prefixListName string
    Name of the prefix list. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    projectName string
    Name of the project to which the prefix list belongs. If not specified, it is added to the default project.
    status string
    Status of the prefix list. Values: Available: available; Creating: creating; Deleting: deleting; Pending: modifying.
    tags GetPrefixListTag[]
    Tag list.
    updatedTime string
    Last modification time of the prefix list.
    association_count int
    Number of resources associated with the prefix list.
    associations_route_tables Sequence[GetPrefixListAssociationsRouteTable]
    Route table information associated with the prefix list.
    associations_security_groups Sequence[GetPrefixListAssociationsSecurityGroup]
    Security group information associated with the prefix list.
    created_time str
    Creation time of the prefix list.
    description str
    Description of the prefix list. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).
    id str
    Uniquely identifies the resource.
    ip_version str
    IP version type. Values: IPv4 (default): IPv4 type. IPv6: IPv6 type.
    max_entries int
    Maximum number of entries, that is, the maximum number of entries that can be added to the prefix list. Value range: 1–200.
    prefix_list_entries Sequence[GetPrefixListPrefixListEntry]
    CIDR of the prefix list entry.
    prefix_list_id str
    Prefix list ID.
    prefix_list_name str
    Name of the prefix list. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    project_name str
    Name of the project to which the prefix list belongs. If not specified, it is added to the default project.
    status str
    Status of the prefix list. Values: Available: available; Creating: creating; Deleting: deleting; Pending: modifying.
    tags Sequence[GetPrefixListTag]
    Tag list.
    updated_time str
    Last modification time of the prefix list.
    associationCount Number
    Number of resources associated with the prefix list.
    associationsRouteTables List<Property Map>
    Route table information associated with the prefix list.
    associationsSecurityGroups List<Property Map>
    Security group information associated with the prefix list.
    createdTime String
    Creation time of the prefix list.
    description String
    Description of the prefix list. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).
    id String
    Uniquely identifies the resource.
    ipVersion String
    IP version type. Values: IPv4 (default): IPv4 type. IPv6: IPv6 type.
    maxEntries Number
    Maximum number of entries, that is, the maximum number of entries that can be added to the prefix list. Value range: 1–200.
    prefixListEntries List<Property Map>
    CIDR of the prefix list entry.
    prefixListId String
    Prefix list ID.
    prefixListName String
    Name of the prefix list. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    projectName String
    Name of the project to which the prefix list belongs. If not specified, it is added to the default project.
    status String
    Status of the prefix list. Values: Available: available; Creating: creating; Deleting: deleting; Pending: modifying.
    tags List<Property Map>
    Tag list.
    updatedTime String
    Last modification time of the prefix list.

    Supporting Types

    GetPrefixListAssociationsRouteTable

    ResourceId string
    ID of the associated resource.
    ResourceType string
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.
    ResourceId string
    ID of the associated resource.
    ResourceType string
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.
    resourceId String
    ID of the associated resource.
    resourceType String
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.
    resourceId string
    ID of the associated resource.
    resourceType string
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.
    resource_id str
    ID of the associated resource.
    resource_type str
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.
    resourceId String
    ID of the associated resource.
    resourceType String
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.

    GetPrefixListAssociationsSecurityGroup

    ResourceId string
    ID of the associated resource.
    ResourceType string
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.
    ResourceId string
    ID of the associated resource.
    ResourceType string
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.
    resourceId String
    ID of the associated resource.
    resourceType String
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.
    resourceId string
    ID of the associated resource.
    resourceType string
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.
    resource_id str
    ID of the associated resource.
    resource_type str
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.
    resourceId String
    ID of the associated resource.
    resourceType String
    Type of associated resource. VpcRouteTable: route table; VpcSecurityGroup: security group.

    GetPrefixListPrefixListEntry

    Cidr string
    CIDR of the prefix list entry.
    Description string
    Description of the prefix list entry. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).
    Cidr string
    CIDR of the prefix list entry.
    Description string
    Description of the prefix list entry. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).
    cidr String
    CIDR of the prefix list entry.
    description String
    Description of the prefix list entry. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).
    cidr string
    CIDR of the prefix list entry.
    description string
    Description of the prefix list entry. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).
    cidr str
    CIDR of the prefix list entry.
    description str
    Description of the prefix list entry. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).
    cidr String
    CIDR of the prefix list entry.
    description String
    Description of the prefix list entry. Length limit: 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (,), and Chinese period (。).

    GetPrefixListTag

    Key string
    Tag key of the user tag.
    Value string
    Tag value of the user tag.
    Key string
    Tag key of the user tag.
    Value string
    Tag value of the user tag.
    key String
    Tag key of the user tag.
    value String
    Tag value of the user tag.
    key string
    Tag key of the user tag.
    value string
    Tag value of the user tag.
    key str
    Tag key of the user tag.
    value str
    Tag value of the user tag.
    key String
    Tag key of the user tag.
    value String
    Tag value of the user tag.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.