cloudflare logo
Cloudflare v4.15.0, Jan 10 23

cloudflare.ByoIpPrefix

Provides the ability to manage Bring-Your-Own-IP prefixes (BYOIP) which are used with or without Magic Transit.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var example = new Cloudflare.ByoIpPrefix("example", new()
    {
        AccountId = "f037e56e89293a057740de681ac9abbe",
        Advertisement = "on",
        Description = "Example IP Prefix",
        PrefixId = "d41d8cd98f00b204e9800998ecf8427e",
    });

});
package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v4/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.NewByoIpPrefix(ctx, "example", &cloudflare.ByoIpPrefixArgs{
			AccountId:     pulumi.String("f037e56e89293a057740de681ac9abbe"),
			Advertisement: pulumi.String("on"),
			Description:   pulumi.String("Example IP Prefix"),
			PrefixId:      pulumi.String("d41d8cd98f00b204e9800998ecf8427e"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.ByoIpPrefix;
import com.pulumi.cloudflare.ByoIpPrefixArgs;
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) {
        var example = new ByoIpPrefix("example", ByoIpPrefixArgs.builder()        
            .accountId("f037e56e89293a057740de681ac9abbe")
            .advertisement("on")
            .description("Example IP Prefix")
            .prefixId("d41d8cd98f00b204e9800998ecf8427e")
            .build());

    }
}
import pulumi
import pulumi_cloudflare as cloudflare

example = cloudflare.ByoIpPrefix("example",
    account_id="f037e56e89293a057740de681ac9abbe",
    advertisement="on",
    description="Example IP Prefix",
    prefix_id="d41d8cd98f00b204e9800998ecf8427e")
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const example = new cloudflare.ByoIpPrefix("example", {
    accountId: "f037e56e89293a057740de681ac9abbe",
    advertisement: "on",
    description: "Example IP Prefix",
    prefixId: "d41d8cd98f00b204e9800998ecf8427e",
});
resources:
  example:
    type: cloudflare:ByoIpPrefix
    properties:
      accountId: f037e56e89293a057740de681ac9abbe
      advertisement: on
      description: Example IP Prefix
      prefixId: d41d8cd98f00b204e9800998ecf8427e

Create ByoIpPrefix Resource

new ByoIpPrefix(name: string, args: ByoIpPrefixArgs, opts?: CustomResourceOptions);
@overload
def ByoIpPrefix(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                account_id: Optional[str] = None,
                advertisement: Optional[str] = None,
                description: Optional[str] = None,
                prefix_id: Optional[str] = None)
@overload
def ByoIpPrefix(resource_name: str,
                args: ByoIpPrefixArgs,
                opts: Optional[ResourceOptions] = None)
func NewByoIpPrefix(ctx *Context, name string, args ByoIpPrefixArgs, opts ...ResourceOption) (*ByoIpPrefix, error)
public ByoIpPrefix(string name, ByoIpPrefixArgs args, CustomResourceOptions? opts = null)
public ByoIpPrefix(String name, ByoIpPrefixArgs args)
public ByoIpPrefix(String name, ByoIpPrefixArgs args, CustomResourceOptions options)
type: cloudflare:ByoIpPrefix
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ByoIpPrefixArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ByoIpPrefixArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ByoIpPrefixArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ByoIpPrefixArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ByoIpPrefixArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ByoIpPrefix Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ByoIpPrefix resource accepts the following input properties:

AccountId string

The account identifier to target for the resource.

PrefixId string

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

string

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

Description string

Description of the BYO IP prefix.

AccountId string

The account identifier to target for the resource.

PrefixId string

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

string

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

Description string

Description of the BYO IP prefix.

accountId String

The account identifier to target for the resource.

prefixId String

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

String

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

description String

Description of the BYO IP prefix.

accountId string

The account identifier to target for the resource.

prefixId string

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

string

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

description string

Description of the BYO IP prefix.

account_id str

The account identifier to target for the resource.

prefix_id str

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

str

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

description str

Description of the BYO IP prefix.

accountId String

The account identifier to target for the resource.

prefixId String

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

String

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

description String

Description of the BYO IP prefix.

Outputs

All input properties are implicitly available as output properties. Additionally, the ByoIpPrefix resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing ByoIpPrefix Resource

Get an existing ByoIpPrefix resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ByoIpPrefixState, opts?: CustomResourceOptions): ByoIpPrefix
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        advertisement: Optional[str] = None,
        description: Optional[str] = None,
        prefix_id: Optional[str] = None) -> ByoIpPrefix
func GetByoIpPrefix(ctx *Context, name string, id IDInput, state *ByoIpPrefixState, opts ...ResourceOption) (*ByoIpPrefix, error)
public static ByoIpPrefix Get(string name, Input<string> id, ByoIpPrefixState? state, CustomResourceOptions? opts = null)
public static ByoIpPrefix get(String name, Output<String> id, ByoIpPrefixState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountId string

The account identifier to target for the resource.

Advertisement string

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

Description string

Description of the BYO IP prefix.

PrefixId string

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

AccountId string

The account identifier to target for the resource.

Advertisement string

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

Description string

Description of the BYO IP prefix.

PrefixId string

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

accountId String

The account identifier to target for the resource.

advertisement String

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

description String

Description of the BYO IP prefix.

prefixId String

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

accountId string

The account identifier to target for the resource.

advertisement string

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

description string

Description of the BYO IP prefix.

prefixId string

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

account_id str

The account identifier to target for the resource.

advertisement str

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

description str

Description of the BYO IP prefix.

prefix_id str

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

accountId String

The account identifier to target for the resource.

advertisement String

Whether or not the prefix shall be announced. A prefix can be activated or deactivated once every 15 minutes (attempting more regular updates will trigger rate limiting). Available values: on, off.

description String

Description of the BYO IP prefix.

prefixId String

The assigned Bring-Your-Own-IP prefix ID. Modifying this attribute will force creation of a new resource.

Import

 $ pulumi import cloudflare:index/byoIpPrefix:ByoIpPrefix example <account_id>/<prefix_id>

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes

This Pulumi package is based on the cloudflare Terraform Provider.