Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. Cloudflare
  5. ByoIpPrefix

ByoIpPrefix

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

Example Usage

using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Cloudflare.ByoIpPrefix("example", new Cloudflare.ByoIpPrefixArgs
        {
            Advertisement = "on",
            Description = "Example IP Prefix",
            PrefixId = "d41d8cd98f00b204e9800998ecf8427e",
        });
    }

}

package main

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

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

example = cloudflare.ByoIpPrefix("example",
    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", {
    advertisement: "on",
    description: "Example IP Prefix",
    prefixId: "d41d8cd98f00b204e9800998ecf8427e",
});

Create a ByoIpPrefix Resource

new ByoIpPrefix(name: string, args: ByoIpPrefixArgs, opts?: CustomResourceOptions);
def ByoIpPrefix(resource_name: str, opts: Optional[ResourceOptions] = None, advertisement: Optional[str] = None, description: Optional[str] = None, prefix_id: Optional[str] = None)
func NewByoIpPrefix(ctx *Context, name string, args ByoIpPrefixArgs, opts ...ResourceOption) (*ByoIpPrefix, error)
public ByoIpPrefix(string name, ByoIpPrefixArgs args, CustomResourceOptions? opts = null)
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.
opts ResourceOptions
A bag of options that control this 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.

ByoIpPrefix Resource Properties

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

Inputs

The ByoIpPrefix resource accepts the following input properties:

PrefixId string

The assigned Bring-Your-Own-IP prefix ID.

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). Valid values: on or off.

Description string

The description of the prefix.

PrefixId string

The assigned Bring-Your-Own-IP prefix ID.

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). Valid values: on or off.

Description string

The description of the prefix.

prefixId string

The assigned Bring-Your-Own-IP prefix ID.

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). Valid values: on or off.

description string

The description of the prefix.

prefix_id str

The assigned Bring-Your-Own-IP prefix ID.

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). Valid values: on or off.

description str

The description of the 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 str
The provider-assigned unique ID for this managed resource.

Look up an 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, 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)
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.

The following state arguments are supported:

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). Valid values: on or off.

Description string

The description of the prefix.

PrefixId string

The assigned Bring-Your-Own-IP prefix ID.

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). Valid values: on or off.

Description string

The description of the prefix.

PrefixId string

The assigned Bring-Your-Own-IP prefix ID.

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). Valid values: on or off.

description string

The description of the prefix.

prefixId string

The assigned Bring-Your-Own-IP prefix ID.

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). Valid values: on or off.

description str

The description of the prefix.

prefix_id str

The assigned Bring-Your-Own-IP prefix ID.

Import

The current settings for Bring-Your-Own-IP prefixes can be imported using the prefix ID.

 $ pulumi import cloudflare:index/byoIpPrefix:ByoIpPrefix example d41d8cd98f00b204e9800998ecf8427e

Package Details

Repository
https://github.com/pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.