Class 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",
});
}
}
Inherited Members
Namespace: Pulumi.Cloudflare
Assembly: Pulumi.Cloudflare.dll
Syntax
public class ByoIpPrefix : CustomResource
Constructors
View SourceByoIpPrefix(String, ByoIpPrefixArgs, CustomResourceOptions)
Create a ByoIpPrefix resource with the given unique name, arguments, and options.
Declaration
public ByoIpPrefix(string name, ByoIpPrefixArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| ByoIpPrefixArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceAdvertisement
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.
Declaration
public Output<string> Advertisement { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Description
The description of the prefix.
Declaration
public Output<string> Description { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrefixId
The assigned Bring-Your-Own-IP prefix ID.
Declaration
public Output<string> PrefixId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, ByoIpPrefixState, CustomResourceOptions)
Get an existing ByoIpPrefix resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static ByoIpPrefix Get(string name, Input<string> id, ByoIpPrefixState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| ByoIpPrefixState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| ByoIpPrefix |