1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getByoIpPrefixes
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getByoIpPrefixes

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleByoIpPrefixes = cloudflare.getByoIpPrefixes({
        accountId: "258def64c72dae45f3e4c8516e2111f2",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_byo_ip_prefixes = cloudflare.get_byo_ip_prefixes(account_id="258def64c72dae45f3e4c8516e2111f2")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.LookupByoIpPrefixes(ctx, &cloudflare.LookupByoIpPrefixesArgs{
    			AccountId: "258def64c72dae45f3e4c8516e2111f2",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleByoIpPrefixes = Cloudflare.GetByoIpPrefixes.Invoke(new()
        {
            AccountId = "258def64c72dae45f3e4c8516e2111f2",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.CloudflareFunctions;
    import com.pulumi.cloudflare.inputs.GetByoIpPrefixesArgs;
    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) {
            final var exampleByoIpPrefixes = CloudflareFunctions.getByoIpPrefixes(GetByoIpPrefixesArgs.builder()
                .accountId("258def64c72dae45f3e4c8516e2111f2")
                .build());
    
        }
    }
    
    variables:
      exampleByoIpPrefixes:
        fn::invoke:
          function: cloudflare:getByoIpPrefixes
          arguments:
            accountId: 258def64c72dae45f3e4c8516e2111f2
    

    Using getByoIpPrefixes

    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 getByoIpPrefixes(args: GetByoIpPrefixesArgs, opts?: InvokeOptions): Promise<GetByoIpPrefixesResult>
    function getByoIpPrefixesOutput(args: GetByoIpPrefixesOutputArgs, opts?: InvokeOptions): Output<GetByoIpPrefixesResult>
    def get_byo_ip_prefixes(account_id: Optional[str] = None,
                            max_items: Optional[int] = None,
                            opts: Optional[InvokeOptions] = None) -> GetByoIpPrefixesResult
    def get_byo_ip_prefixes_output(account_id: Optional[pulumi.Input[str]] = None,
                            max_items: Optional[pulumi.Input[int]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetByoIpPrefixesResult]
    func LookupByoIpPrefixes(ctx *Context, args *LookupByoIpPrefixesArgs, opts ...InvokeOption) (*LookupByoIpPrefixesResult, error)
    func LookupByoIpPrefixesOutput(ctx *Context, args *LookupByoIpPrefixesOutputArgs, opts ...InvokeOption) LookupByoIpPrefixesResultOutput

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

    public static class GetByoIpPrefixes 
    {
        public static Task<GetByoIpPrefixesResult> InvokeAsync(GetByoIpPrefixesArgs args, InvokeOptions? opts = null)
        public static Output<GetByoIpPrefixesResult> Invoke(GetByoIpPrefixesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetByoIpPrefixesResult> getByoIpPrefixes(GetByoIpPrefixesArgs args, InvokeOptions options)
    public static Output<GetByoIpPrefixesResult> getByoIpPrefixes(GetByoIpPrefixesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getByoIpPrefixes:getByoIpPrefixes
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    Identifier of a Cloudflare account.
    MaxItems int
    Max items to fetch, default: 1000
    AccountId string
    Identifier of a Cloudflare account.
    MaxItems int
    Max items to fetch, default: 1000
    accountId String
    Identifier of a Cloudflare account.
    maxItems Integer
    Max items to fetch, default: 1000
    accountId string
    Identifier of a Cloudflare account.
    maxItems number
    Max items to fetch, default: 1000
    account_id str
    Identifier of a Cloudflare account.
    max_items int
    Max items to fetch, default: 1000
    accountId String
    Identifier of a Cloudflare account.
    maxItems Number
    Max items to fetch, default: 1000

    getByoIpPrefixes Result

    The following output properties are available:

    AccountId string
    Identifier of a Cloudflare account.
    Id string
    The provider-assigned unique ID for this managed resource.
    Results List<GetByoIpPrefixesResult>
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    AccountId string
    Identifier of a Cloudflare account.
    Id string
    The provider-assigned unique ID for this managed resource.
    Results []GetByoIpPrefixesResult
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    accountId String
    Identifier of a Cloudflare account.
    id String
    The provider-assigned unique ID for this managed resource.
    results List<GetByoIpPrefixesResult>
    The items returned by the data source
    maxItems Integer
    Max items to fetch, default: 1000
    accountId string
    Identifier of a Cloudflare account.
    id string
    The provider-assigned unique ID for this managed resource.
    results GetByoIpPrefixesResult[]
    The items returned by the data source
    maxItems number
    Max items to fetch, default: 1000
    account_id str
    Identifier of a Cloudflare account.
    id str
    The provider-assigned unique ID for this managed resource.
    results Sequence[GetByoIpPrefixesResult]
    The items returned by the data source
    max_items int
    Max items to fetch, default: 1000
    accountId String
    Identifier of a Cloudflare account.
    id String
    The provider-assigned unique ID for this managed resource.
    results List<Property Map>
    The items returned by the data source
    maxItems Number
    Max items to fetch, default: 1000

    Supporting Types

    GetByoIpPrefixesResult

    AccountId string
    Identifier of a Cloudflare account.
    Advertised bool
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
    AdvertisedModifiedAt string
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
    Approved string
    Approval state of the prefix (P = pending, V = active).
    Asn int
    Autonomous System Number (ASN) the prefix will be advertised under.
    Cidr string
    IP Prefix in Classless Inter-Domain Routing format.
    CreatedAt string
    Description string
    Description of the prefix.
    Id string
    Identifier of an IP Prefix.
    LoaDocumentId string
    Identifier for the uploaded LOA document.
    ModifiedAt string
    OnDemandEnabled bool
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
    OnDemandLocked bool
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.
    AccountId string
    Identifier of a Cloudflare account.
    Advertised bool
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
    AdvertisedModifiedAt string
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
    Approved string
    Approval state of the prefix (P = pending, V = active).
    Asn int
    Autonomous System Number (ASN) the prefix will be advertised under.
    Cidr string
    IP Prefix in Classless Inter-Domain Routing format.
    CreatedAt string
    Description string
    Description of the prefix.
    Id string
    Identifier of an IP Prefix.
    LoaDocumentId string
    Identifier for the uploaded LOA document.
    ModifiedAt string
    OnDemandEnabled bool
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
    OnDemandLocked bool
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.
    accountId String
    Identifier of a Cloudflare account.
    advertised Boolean
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
    advertisedModifiedAt String
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
    approved String
    Approval state of the prefix (P = pending, V = active).
    asn Integer
    Autonomous System Number (ASN) the prefix will be advertised under.
    cidr String
    IP Prefix in Classless Inter-Domain Routing format.
    createdAt String
    description String
    Description of the prefix.
    id String
    Identifier of an IP Prefix.
    loaDocumentId String
    Identifier for the uploaded LOA document.
    modifiedAt String
    onDemandEnabled Boolean
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
    onDemandLocked Boolean
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.
    accountId string
    Identifier of a Cloudflare account.
    advertised boolean
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
    advertisedModifiedAt string
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
    approved string
    Approval state of the prefix (P = pending, V = active).
    asn number
    Autonomous System Number (ASN) the prefix will be advertised under.
    cidr string
    IP Prefix in Classless Inter-Domain Routing format.
    createdAt string
    description string
    Description of the prefix.
    id string
    Identifier of an IP Prefix.
    loaDocumentId string
    Identifier for the uploaded LOA document.
    modifiedAt string
    onDemandEnabled boolean
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
    onDemandLocked boolean
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.
    account_id str
    Identifier of a Cloudflare account.
    advertised bool
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
    advertised_modified_at str
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
    approved str
    Approval state of the prefix (P = pending, V = active).
    asn int
    Autonomous System Number (ASN) the prefix will be advertised under.
    cidr str
    IP Prefix in Classless Inter-Domain Routing format.
    created_at str
    description str
    Description of the prefix.
    id str
    Identifier of an IP Prefix.
    loa_document_id str
    Identifier for the uploaded LOA document.
    modified_at str
    on_demand_enabled bool
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
    on_demand_locked bool
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.
    accountId String
    Identifier of a Cloudflare account.
    advertised Boolean
    Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
    advertisedModifiedAt String
    Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.
    approved String
    Approval state of the prefix (P = pending, V = active).
    asn Number
    Autonomous System Number (ASN) the prefix will be advertised under.
    cidr String
    IP Prefix in Classless Inter-Domain Routing format.
    createdAt String
    description String
    Description of the prefix.
    id String
    Identifier of an IP Prefix.
    loaDocumentId String
    Identifier for the uploaded LOA document.
    modifiedAt String
    onDemandEnabled Boolean
    Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
    onDemandLocked Boolean
    Whether advertisement status of the prefix is locked, meaning it cannot be changed.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi