Viewing docs for Cloudflare v6.24.0
published on Thursday, Nov 12, 2026 by Pulumi
published on Thursday, Nov 12, 2026 by Pulumi
Viewing docs for Cloudflare v6.24.0
published on Thursday, Nov 12, 2026 by Pulumi
published on Thursday, Nov 12, 2026 by Pulumi
Accepted Permissions
IP Prefixes: BGP On Demand ReadIP Prefixes: BGP On Demand WriteIP Prefixes: ReadIP Prefixes: WriteMagic Transit ReadMagic Transit Write
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const exampleByoIpPrefix = cloudflare.getByoIpPrefix({
accountId: "258def64c72dae45f3e4c8516e2111f2",
prefixId: "2af39739cc4e3b5910c918468bb89828",
});
import pulumi
import pulumi_cloudflare as cloudflare
example_byo_ip_prefix = cloudflare.get_byo_ip_prefix(account_id="258def64c72dae45f3e4c8516e2111f2",
prefix_id="2af39739cc4e3b5910c918468bb89828")
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.GetByoIpPrefix(ctx, &cloudflare.LookupByoIpPrefixArgs{
AccountId: pulumi.StringRef("258def64c72dae45f3e4c8516e2111f2"),
PrefixId: "2af39739cc4e3b5910c918468bb89828",
}, 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 exampleByoIpPrefix = Cloudflare.GetByoIpPrefix.Invoke(new()
{
AccountId = "258def64c72dae45f3e4c8516e2111f2",
PrefixId = "2af39739cc4e3b5910c918468bb89828",
});
});
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.GetByoIpPrefixArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 exampleByoIpPrefix = CloudflareFunctions.getByoIpPrefix(GetByoIpPrefixArgs.builder()
.accountId("258def64c72dae45f3e4c8516e2111f2")
.prefixId("2af39739cc4e3b5910c918468bb89828")
.build());
}
}
variables:
exampleByoIpPrefix:
fn::invoke:
function: cloudflare:getByoIpPrefix
arguments:
accountId: 258def64c72dae45f3e4c8516e2111f2
prefixId: 2af39739cc4e3b5910c918468bb89828
terraform {
required_providers {
cloudflare = {
source = "pulumi/cloudflare"
}
}
}
data "cloudflare_byo_ip_prefix" "exampleByoIpPrefix" {
account_id = "258def64c72dae45f3e4c8516e2111f2"
prefix_id = "2af39739cc4e3b5910c918468bb89828"
}
Using getByoIpPrefix
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 getByoIpPrefix(args: GetByoIpPrefixArgs, opts?: InvokeOptions): Promise<GetByoIpPrefixResult>
function getByoIpPrefixOutput(args: GetByoIpPrefixOutputArgs, opts?: InvokeOutputOptions): Output<GetByoIpPrefixResult>def get_byo_ip_prefix(account_id: Optional[str] = None,
prefix_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetByoIpPrefixResult
def get_byo_ip_prefix_output(account_id: pulumi.Input[Optional[str]] = None,
prefix_id: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetByoIpPrefixResult]func LookupByoIpPrefix(ctx *Context, args *LookupByoIpPrefixArgs, opts ...InvokeOption) (*LookupByoIpPrefixResult, error)
func LookupByoIpPrefixOutput(ctx *Context, args *LookupByoIpPrefixOutputArgs, opts ...InvokeOption) LookupByoIpPrefixResultOutput> Note: This function is named LookupByoIpPrefix in the Go SDK.
public static class GetByoIpPrefix
{
public static Task<GetByoIpPrefixResult> InvokeAsync(GetByoIpPrefixArgs args, InvokeOptions? opts = null)
public static Output<GetByoIpPrefixResult> Invoke(GetByoIpPrefixInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetByoIpPrefixResult> Invoke(GetByoIpPrefixInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetByoIpPrefixResult> getByoIpPrefix(GetByoIpPrefixArgs args, InvokeOptions options)
public static Output<GetByoIpPrefixResult> getByoIpPrefix(GetByoIpPrefixArgs args, InvokeOptions options)
public static Output<GetByoIpPrefixResult> getByoIpPrefix(GetByoIpPrefixArgs args, InvokeOutputOptions options)
fn::invoke:
function: cloudflare:index/getByoIpPrefix:getByoIpPrefix
arguments:
# arguments dictionarydata "cloudflare_get_byo_ip_prefix" "name" {
# arguments
}The following arguments are supported:
- prefix_
id string - Identifier of an IP Prefix.
- account_
id string - Identifier of a Cloudflare account.
- prefix_
id str - Identifier of an IP Prefix.
- account_
id str - Identifier of a Cloudflare account.
getByoIpPrefix Result
The following output properties are available:
- Advertised bool
- Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
- Advertised
Modified stringAt - 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 = approved). Approval does not advertise the prefix or activate traffic.
- Asn int
- Autonomous System Number (ASN) the prefix will be advertised under. Use 13335 for Cloudflare's ASN, or your own ASN as an integer without the AS prefix. The IRR route and RPKI ROA must authorize this ASN.
- Asn
Ownership stringValidation State - State of ASN ownership validation for a customer-owned Autonomous System Number (ASN). Returned when an ASN ownership validation result exists. Omitted when validation does not apply, such as for Cloudflare-owned ASNs. Verification is reused for prefixes with the same account and ASN. Refer to ASN ownership validation states for state meanings and resolutions. Available values: "pending", "valid", "missing", "invalid".
- Aspa
Validation stringState - State of Autonomous System Provider Authorization (ASPA) validation for a customer-owned ASN. Returned when an ASPA validation result exists. Publishing an ASPA is optional. A published ASPA must authorize AS13335 as a provider. An invalid result blocks approval. If omitted, no ASPA validation result is available. Omission does not indicate successful validation or confirm that no ASPA exists. Refer to ASPA validation states for state meanings and resolutions, and ASPA authorization for publication guidance. Available values: "pending", "valid", "invalid".
- Cidr string
- IP Prefix in Classless Inter-Domain Routing format.
- Created
At string - Delegate
Loa boolCreation - Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
- Description string
- Description of the prefix.
- Id string
- Identifier of an IP Prefix.
- Irr
Validation stringState - State of one kind of validation for an IP prefix.
- Loa
Document stringId - Identifier for the uploaded LOA document.
- Modified
At string - On
Demand boolEnabled - Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
- On
Demand boolLocked - Whether advertisement status of the prefix is locked, meaning it cannot be changed.
- Ownership
Validation stringState - State of one kind of validation for an IP prefix.
- Ownership
Validation stringToken - Token used to verify ownership of the prefix and, when applicable, its ASN. Use the same token for both checks. Refer to the BYOIP onboarding guide for verification instructions.
- Prefix
Id string - Identifier of an IP Prefix.
- Rpki
Validation stringState - State of one kind of validation for an IP prefix.
- Account
Id 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.
- Advertised
Modified stringAt - 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 = approved). Approval does not advertise the prefix or activate traffic.
- Asn int
- Autonomous System Number (ASN) the prefix will be advertised under. Use 13335 for Cloudflare's ASN, or your own ASN as an integer without the AS prefix. The IRR route and RPKI ROA must authorize this ASN.
- Asn
Ownership stringValidation State - State of ASN ownership validation for a customer-owned Autonomous System Number (ASN). Returned when an ASN ownership validation result exists. Omitted when validation does not apply, such as for Cloudflare-owned ASNs. Verification is reused for prefixes with the same account and ASN. Refer to ASN ownership validation states for state meanings and resolutions. Available values: "pending", "valid", "missing", "invalid".
- Aspa
Validation stringState - State of Autonomous System Provider Authorization (ASPA) validation for a customer-owned ASN. Returned when an ASPA validation result exists. Publishing an ASPA is optional. A published ASPA must authorize AS13335 as a provider. An invalid result blocks approval. If omitted, no ASPA validation result is available. Omission does not indicate successful validation or confirm that no ASPA exists. Refer to ASPA validation states for state meanings and resolutions, and ASPA authorization for publication guidance. Available values: "pending", "valid", "invalid".
- Cidr string
- IP Prefix in Classless Inter-Domain Routing format.
- Created
At string - Delegate
Loa boolCreation - Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
- Description string
- Description of the prefix.
- Id string
- Identifier of an IP Prefix.
- Irr
Validation stringState - State of one kind of validation for an IP prefix.
- Loa
Document stringId - Identifier for the uploaded LOA document.
- Modified
At string - On
Demand boolEnabled - Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
- On
Demand boolLocked - Whether advertisement status of the prefix is locked, meaning it cannot be changed.
- Ownership
Validation stringState - State of one kind of validation for an IP prefix.
- Ownership
Validation stringToken - Token used to verify ownership of the prefix and, when applicable, its ASN. Use the same token for both checks. Refer to the BYOIP onboarding guide for verification instructions.
- Prefix
Id string - Identifier of an IP Prefix.
- Rpki
Validation stringState - State of one kind of validation for an IP prefix.
- Account
Id 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.
- advertised_
modified_ stringat - 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 = approved). Approval does not advertise the prefix or activate traffic.
- asn number
- Autonomous System Number (ASN) the prefix will be advertised under. Use 13335 for Cloudflare's ASN, or your own ASN as an integer without the AS prefix. The IRR route and RPKI ROA must authorize this ASN.
- asn_
ownership_ stringvalidation_ state - State of ASN ownership validation for a customer-owned Autonomous System Number (ASN). Returned when an ASN ownership validation result exists. Omitted when validation does not apply, such as for Cloudflare-owned ASNs. Verification is reused for prefixes with the same account and ASN. Refer to ASN ownership validation states for state meanings and resolutions. Available values: "pending", "valid", "missing", "invalid".
- aspa_
validation_ stringstate - State of Autonomous System Provider Authorization (ASPA) validation for a customer-owned ASN. Returned when an ASPA validation result exists. Publishing an ASPA is optional. A published ASPA must authorize AS13335 as a provider. An invalid result blocks approval. If omitted, no ASPA validation result is available. Omission does not indicate successful validation or confirm that no ASPA exists. Refer to ASPA validation states for state meanings and resolutions, and ASPA authorization for publication guidance. Available values: "pending", "valid", "invalid".
- cidr string
- IP Prefix in Classless Inter-Domain Routing format.
- created_
at string - delegate_
loa_ boolcreation - Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
- description string
- Description of the prefix.
- id string
- Identifier of an IP Prefix.
- irr_
validation_ stringstate - State of one kind of validation for an IP prefix.
- loa_
document_ stringid - Identifier for the uploaded LOA document.
- modified_
at string - on_
demand_ boolenabled - Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
- on_
demand_ boollocked - Whether advertisement status of the prefix is locked, meaning it cannot be changed.
- ownership_
validation_ stringstate - State of one kind of validation for an IP prefix.
- ownership_
validation_ stringtoken - Token used to verify ownership of the prefix and, when applicable, its ASN. Use the same token for both checks. Refer to the BYOIP onboarding guide for verification instructions.
- prefix_
id string - Identifier of an IP Prefix.
- rpki_
validation_ stringstate - State of one kind of validation for an IP prefix.
- account_
id 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.
- advertised
Modified StringAt - 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 = approved). Approval does not advertise the prefix or activate traffic.
- asn Integer
- Autonomous System Number (ASN) the prefix will be advertised under. Use 13335 for Cloudflare's ASN, or your own ASN as an integer without the AS prefix. The IRR route and RPKI ROA must authorize this ASN.
- asn
Ownership StringValidation State - State of ASN ownership validation for a customer-owned Autonomous System Number (ASN). Returned when an ASN ownership validation result exists. Omitted when validation does not apply, such as for Cloudflare-owned ASNs. Verification is reused for prefixes with the same account and ASN. Refer to ASN ownership validation states for state meanings and resolutions. Available values: "pending", "valid", "missing", "invalid".
- aspa
Validation StringState - State of Autonomous System Provider Authorization (ASPA) validation for a customer-owned ASN. Returned when an ASPA validation result exists. Publishing an ASPA is optional. A published ASPA must authorize AS13335 as a provider. An invalid result blocks approval. If omitted, no ASPA validation result is available. Omission does not indicate successful validation or confirm that no ASPA exists. Refer to ASPA validation states for state meanings and resolutions, and ASPA authorization for publication guidance. Available values: "pending", "valid", "invalid".
- cidr String
- IP Prefix in Classless Inter-Domain Routing format.
- created
At String - delegate
Loa BooleanCreation - Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
- description String
- Description of the prefix.
- id String
- Identifier of an IP Prefix.
- irr
Validation StringState - State of one kind of validation for an IP prefix.
- loa
Document StringId - Identifier for the uploaded LOA document.
- modified
At String - on
Demand BooleanEnabled - Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
- on
Demand BooleanLocked - Whether advertisement status of the prefix is locked, meaning it cannot be changed.
- ownership
Validation StringState - State of one kind of validation for an IP prefix.
- ownership
Validation StringToken - Token used to verify ownership of the prefix and, when applicable, its ASN. Use the same token for both checks. Refer to the BYOIP onboarding guide for verification instructions.
- prefix
Id String - Identifier of an IP Prefix.
- rpki
Validation StringState - State of one kind of validation for an IP prefix.
- account
Id 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.
- advertised
Modified stringAt - 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 = approved). Approval does not advertise the prefix or activate traffic.
- asn number
- Autonomous System Number (ASN) the prefix will be advertised under. Use 13335 for Cloudflare's ASN, or your own ASN as an integer without the AS prefix. The IRR route and RPKI ROA must authorize this ASN.
- asn
Ownership stringValidation State - State of ASN ownership validation for a customer-owned Autonomous System Number (ASN). Returned when an ASN ownership validation result exists. Omitted when validation does not apply, such as for Cloudflare-owned ASNs. Verification is reused for prefixes with the same account and ASN. Refer to ASN ownership validation states for state meanings and resolutions. Available values: "pending", "valid", "missing", "invalid".
- aspa
Validation stringState - State of Autonomous System Provider Authorization (ASPA) validation for a customer-owned ASN. Returned when an ASPA validation result exists. Publishing an ASPA is optional. A published ASPA must authorize AS13335 as a provider. An invalid result blocks approval. If omitted, no ASPA validation result is available. Omission does not indicate successful validation or confirm that no ASPA exists. Refer to ASPA validation states for state meanings and resolutions, and ASPA authorization for publication guidance. Available values: "pending", "valid", "invalid".
- cidr string
- IP Prefix in Classless Inter-Domain Routing format.
- created
At string - delegate
Loa booleanCreation - Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
- description string
- Description of the prefix.
- id string
- Identifier of an IP Prefix.
- irr
Validation stringState - State of one kind of validation for an IP prefix.
- loa
Document stringId - Identifier for the uploaded LOA document.
- modified
At string - on
Demand booleanEnabled - Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
- on
Demand booleanLocked - Whether advertisement status of the prefix is locked, meaning it cannot be changed.
- ownership
Validation stringState - State of one kind of validation for an IP prefix.
- ownership
Validation stringToken - Token used to verify ownership of the prefix and, when applicable, its ASN. Use the same token for both checks. Refer to the BYOIP onboarding guide for verification instructions.
- prefix
Id string - Identifier of an IP Prefix.
- rpki
Validation stringState - State of one kind of validation for an IP prefix.
- account
Id 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.
- advertised_
modified_ strat - 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 = approved). Approval does not advertise the prefix or activate traffic.
- asn int
- Autonomous System Number (ASN) the prefix will be advertised under. Use 13335 for Cloudflare's ASN, or your own ASN as an integer without the AS prefix. The IRR route and RPKI ROA must authorize this ASN.
- asn_
ownership_ strvalidation_ state - State of ASN ownership validation for a customer-owned Autonomous System Number (ASN). Returned when an ASN ownership validation result exists. Omitted when validation does not apply, such as for Cloudflare-owned ASNs. Verification is reused for prefixes with the same account and ASN. Refer to ASN ownership validation states for state meanings and resolutions. Available values: "pending", "valid", "missing", "invalid".
- aspa_
validation_ strstate - State of Autonomous System Provider Authorization (ASPA) validation for a customer-owned ASN. Returned when an ASPA validation result exists. Publishing an ASPA is optional. A published ASPA must authorize AS13335 as a provider. An invalid result blocks approval. If omitted, no ASPA validation result is available. Omission does not indicate successful validation or confirm that no ASPA exists. Refer to ASPA validation states for state meanings and resolutions, and ASPA authorization for publication guidance. Available values: "pending", "valid", "invalid".
- cidr str
- IP Prefix in Classless Inter-Domain Routing format.
- created_
at str - delegate_
loa_ boolcreation - Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
- description str
- Description of the prefix.
- id str
- Identifier of an IP Prefix.
- irr_
validation_ strstate - State of one kind of validation for an IP prefix.
- loa_
document_ strid - Identifier for the uploaded LOA document.
- modified_
at str - on_
demand_ boolenabled - Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
- on_
demand_ boollocked - Whether advertisement status of the prefix is locked, meaning it cannot be changed.
- ownership_
validation_ strstate - State of one kind of validation for an IP prefix.
- ownership_
validation_ strtoken - Token used to verify ownership of the prefix and, when applicable, its ASN. Use the same token for both checks. Refer to the BYOIP onboarding guide for verification instructions.
- prefix_
id str - Identifier of an IP Prefix.
- rpki_
validation_ strstate - State of one kind of validation for an IP prefix.
- account_
id str - Identifier of a Cloudflare account.
- advertised Boolean
- Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.
- advertised
Modified StringAt - 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 = approved). Approval does not advertise the prefix or activate traffic.
- asn Number
- Autonomous System Number (ASN) the prefix will be advertised under. Use 13335 for Cloudflare's ASN, or your own ASN as an integer without the AS prefix. The IRR route and RPKI ROA must authorize this ASN.
- asn
Ownership StringValidation State - State of ASN ownership validation for a customer-owned Autonomous System Number (ASN). Returned when an ASN ownership validation result exists. Omitted when validation does not apply, such as for Cloudflare-owned ASNs. Verification is reused for prefixes with the same account and ASN. Refer to ASN ownership validation states for state meanings and resolutions. Available values: "pending", "valid", "missing", "invalid".
- aspa
Validation StringState - State of Autonomous System Provider Authorization (ASPA) validation for a customer-owned ASN. Returned when an ASPA validation result exists. Publishing an ASPA is optional. A published ASPA must authorize AS13335 as a provider. An invalid result blocks approval. If omitted, no ASPA validation result is available. Omission does not indicate successful validation or confirm that no ASPA exists. Refer to ASPA validation states for state meanings and resolutions, and ASPA authorization for publication guidance. Available values: "pending", "valid", "invalid".
- cidr String
- IP Prefix in Classless Inter-Domain Routing format.
- created
At String - delegate
Loa BooleanCreation - Whether Cloudflare is allowed to generate the LOA document on behalf of the prefix owner.
- description String
- Description of the prefix.
- id String
- Identifier of an IP Prefix.
- irr
Validation StringState - State of one kind of validation for an IP prefix.
- loa
Document StringId - Identifier for the uploaded LOA document.
- modified
At String - on
Demand BooleanEnabled - Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.
- on
Demand BooleanLocked - Whether advertisement status of the prefix is locked, meaning it cannot be changed.
- ownership
Validation StringState - State of one kind of validation for an IP prefix.
- ownership
Validation StringToken - Token used to verify ownership of the prefix and, when applicable, its ASN. Use the same token for both checks. Refer to the BYOIP onboarding guide for verification instructions.
- prefix
Id String - Identifier of an IP Prefix.
- rpki
Validation StringState - State of one kind of validation for an IP prefix.
- account
Id String - Identifier of a Cloudflare account.
Package Details
- Repository
- Cloudflare pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cloudflareTerraform Provider.
Viewing docs for Cloudflare v6.24.0
published on Thursday, Nov 12, 2026 by Pulumi
published on Thursday, Nov 12, 2026 by Pulumi