1. Packages
  2. Cloudflare
  3. API Docs
  4. ByoIpPrefix
Cloudflare v5.31.0 published on Wednesday, Jun 12, 2024 by Pulumi

cloudflare.ByoIpPrefix

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.31.0 published on Wednesday, Jun 12, 2024 by Pulumi

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const example = new cloudflare.ByoIpPrefix("example", {
        accountId: "f037e56e89293a057740de681ac9abbe",
        prefixId: "d41d8cd98f00b204e9800998ecf8427e",
        description: "Example IP Prefix",
        advertisement: "on",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.ByoIpPrefix("example",
        account_id="f037e56e89293a057740de681ac9abbe",
        prefix_id="d41d8cd98f00b204e9800998ecf8427e",
        description="Example IP Prefix",
        advertisement="on")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v5/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"),
    			PrefixId:      pulumi.String("d41d8cd98f00b204e9800998ecf8427e"),
    			Description:   pulumi.String("Example IP Prefix"),
    			Advertisement: pulumi.String("on"),
    		})
    		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 example = new Cloudflare.ByoIpPrefix("example", new()
        {
            AccountId = "f037e56e89293a057740de681ac9abbe",
            PrefixId = "d41d8cd98f00b204e9800998ecf8427e",
            Description = "Example IP Prefix",
            Advertisement = "on",
        });
    
    });
    
    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")
                .prefixId("d41d8cd98f00b204e9800998ecf8427e")
                .description("Example IP Prefix")
                .advertisement("on")
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:ByoIpPrefix
        properties:
          accountId: f037e56e89293a057740de681ac9abbe
          prefixId: d41d8cd98f00b204e9800998ecf8427e
          description: Example IP Prefix
          advertisement: on
    

    Create ByoIpPrefix Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ByoIpPrefix(name: string, args: ByoIpPrefixArgs, opts?: CustomResourceOptions);
    @overload
    def ByoIpPrefix(resource_name: str,
                    args: ByoIpPrefixArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def ByoIpPrefix(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    account_id: Optional[str] = None,
                    prefix_id: Optional[str] = None,
                    advertisement: Optional[str] = None,
                    description: Optional[str] = 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.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var byoIpPrefixResource = new Cloudflare.ByoIpPrefix("byoIpPrefixResource", new()
    {
        AccountId = "string",
        PrefixId = "string",
        Advertisement = "string",
        Description = "string",
    });
    
    example, err := cloudflare.NewByoIpPrefix(ctx, "byoIpPrefixResource", &cloudflare.ByoIpPrefixArgs{
    	AccountId:     pulumi.String("string"),
    	PrefixId:      pulumi.String("string"),
    	Advertisement: pulumi.String("string"),
    	Description:   pulumi.String("string"),
    })
    
    var byoIpPrefixResource = new ByoIpPrefix("byoIpPrefixResource", ByoIpPrefixArgs.builder()
        .accountId("string")
        .prefixId("string")
        .advertisement("string")
        .description("string")
        .build());
    
    byo_ip_prefix_resource = cloudflare.ByoIpPrefix("byoIpPrefixResource",
        account_id="string",
        prefix_id="string",
        advertisement="string",
        description="string")
    
    const byoIpPrefixResource = new cloudflare.ByoIpPrefix("byoIpPrefixResource", {
        accountId: "string",
        prefixId: "string",
        advertisement: "string",
        description: "string",
    });
    
    type: cloudflare:ByoIpPrefix
    properties:
        accountId: string
        advertisement: string
        description: string
        prefixId: string
    

    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>
    

    To learn more about importing existing cloud resources, see Importing resources.

    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 v5.31.0 published on Wednesday, Jun 12, 2024 by Pulumi