Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Netbox Provider
  3. API Docs
  4. Rir
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

netbox.Rir

Explore with Pulumi AI

netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox

From the official documentation:

Regional Internet registries are responsible for the allocation of globally-routable address space. The five RIRs are ARIN, RIPE, APNIC, LACNIC, and AFRINIC. However, some address space has been set aside for internal use, such as defined in RFCs 1918 and 6598. NetBox considers these RFCs as a sort of RIR as well; that is, an authority which “owns” certain address space. There also exist lower-tier registries which serve particular geographic areas.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";

const test = new netbox.Rir("test", {description: "my description"});
Copy
import pulumi
import pulumi_netbox as netbox

test = netbox.Rir("test", description="my description")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v3/netbox"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netbox.NewRir(ctx, "test", &netbox.RirArgs{
			Description: pulumi.String("my description"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;

return await Deployment.RunAsync(() => 
{
    var test = new Netbox.Rir("test", new()
    {
        Description = "my description",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.Rir;
import com.pulumi.netbox.RirArgs;
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 test = new Rir("test", RirArgs.builder()
            .description("my description")
            .build());

    }
}
Copy
resources:
  test:
    type: netbox:Rir
    properties:
      description: my description
Copy

Create Rir Resource

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

Constructor syntax

new Rir(name: string, args?: RirArgs, opts?: CustomResourceOptions);
@overload
def Rir(resource_name: str,
        args: Optional[RirArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def Rir(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        is_private: Optional[bool] = None,
        name: Optional[str] = None,
        rir_id: Optional[str] = None,
        slug: Optional[str] = None)
func NewRir(ctx *Context, name string, args *RirArgs, opts ...ResourceOption) (*Rir, error)
public Rir(string name, RirArgs? args = null, CustomResourceOptions? opts = null)
public Rir(String name, RirArgs args)
public Rir(String name, RirArgs args, CustomResourceOptions options)

type: netbox:Rir
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var rirResource = new Netbox.Rir("rirResource", new()
{
    Description = "string",
    IsPrivate = false,
    Name = "string",
    RirId = "string",
    Slug = "string",
});
Copy
example, err := netbox.NewRir(ctx, "rirResource", &netbox.RirArgs{
Description: pulumi.String("string"),
IsPrivate: pulumi.Bool(false),
Name: pulumi.String("string"),
RirId: pulumi.String("string"),
Slug: pulumi.String("string"),
})
Copy
var rirResource = new Rir("rirResource", RirArgs.builder()
    .description("string")
    .isPrivate(false)
    .name("string")
    .rirId("string")
    .slug("string")
    .build());
Copy
rir_resource = netbox.Rir("rirResource",
    description="string",
    is_private=False,
    name="string",
    rir_id="string",
    slug="string")
Copy
const rirResource = new netbox.Rir("rirResource", {
    description: "string",
    isPrivate: false,
    name: "string",
    rirId: "string",
    slug: "string",
});
Copy
type: netbox:Rir
properties:
    description: string
    isPrivate: false
    name: string
    rirId: string
    slug: string
Copy

Rir Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Rir resource accepts the following input properties:

Description string
IsPrivate bool
Defaults to false.
Name string
RirId string
The ID of this resource.
Slug string
Description string
IsPrivate bool
Defaults to false.
Name string
RirId string
The ID of this resource.
Slug string
description String
isPrivate Boolean
Defaults to false.
name String
rirId String
The ID of this resource.
slug String
description string
isPrivate boolean
Defaults to false.
name string
rirId string
The ID of this resource.
slug string
description str
is_private bool
Defaults to false.
name str
rir_id str
The ID of this resource.
slug str
description String
isPrivate Boolean
Defaults to false.
name String
rirId String
The ID of this resource.
slug String

Outputs

All input properties are implicitly available as output properties. Additionally, the Rir 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 Rir Resource

Get an existing Rir 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?: RirState, opts?: CustomResourceOptions): Rir
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        is_private: Optional[bool] = None,
        name: Optional[str] = None,
        rir_id: Optional[str] = None,
        slug: Optional[str] = None) -> Rir
func GetRir(ctx *Context, name string, id IDInput, state *RirState, opts ...ResourceOption) (*Rir, error)
public static Rir Get(string name, Input<string> id, RirState? state, CustomResourceOptions? opts = null)
public static Rir get(String name, Output<String> id, RirState state, CustomResourceOptions options)
resources:  _:    type: netbox:Rir    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
IsPrivate bool
Defaults to false.
Name string
RirId string
The ID of this resource.
Slug string
Description string
IsPrivate bool
Defaults to false.
Name string
RirId string
The ID of this resource.
Slug string
description String
isPrivate Boolean
Defaults to false.
name String
rirId String
The ID of this resource.
slug String
description string
isPrivate boolean
Defaults to false.
name string
rirId string
The ID of this resource.
slug string
description str
is_private bool
Defaults to false.
name str
rir_id str
The ID of this resource.
slug str
description String
isPrivate Boolean
Defaults to false.
name String
rirId String
The ID of this resource.
slug String

Package Details

Repository
netbox e-breuninger/terraform-provider-netbox
License
Notes
This Pulumi package is based on the netbox Terraform Provider.
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger
e-breuninger/terraform-provider-netbox