1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getByoIpPrefixes
Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

cloudflare.getByoIpPrefixes

Explore with Pulumi AI

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleByoIpPrefixes = cloudflare.getByoIpPrefixes({
    accountId: "258def64c72dae45f3e4c8516e2111f2",
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example_byo_ip_prefixes = cloudflare.get_byo_ip_prefixes(account_id="258def64c72dae45f3e4c8516e2111f2")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

    }
}
Copy
variables:
  exampleByoIpPrefixes:
    fn::invoke:
      function: cloudflare:getByoIpPrefixes
      arguments:
        accountId: 258def64c72dae45f3e4c8516e2111f2
Copy

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>
Copy
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]
Copy
func LookupByoIpPrefixes(ctx *Context, args *LookupByoIpPrefixesArgs, opts ...InvokeOption) (*LookupByoIpPrefixesResult, error)
func LookupByoIpPrefixesOutput(ctx *Context, args *LookupByoIpPrefixesOutputArgs, opts ...InvokeOption) LookupByoIpPrefixesResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetByoIpPrefixesResult> getByoIpPrefixes(GetByoIpPrefixesArgs args, InvokeOptions options)
public static Output<GetByoIpPrefixesResult> getByoIpPrefixes(GetByoIpPrefixesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: cloudflare:index/getByoIpPrefixes:getByoIpPrefixes
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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