Ipv4 address. Version 2 adds support for assignment from multiple ranges (useful if you get an extra range of ips from the same subnet later on).
Create AddressIpv4V2 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AddressIpv4V2(name: string, args: AddressIpv4V2Args, opts?: CustomResourceOptions);@overload
def AddressIpv4V2(resource_name: str,
args: AddressIpv4V2Args,
opts: Optional[ResourceOptions] = None)
@overload
def AddressIpv4V2(resource_name: str,
opts: Optional[ResourceOptions] = None,
range_ids: Optional[Sequence[str]] = None,
address_ipv4_v2_id: Optional[str] = None,
hardcoded_address: Optional[str] = None,
manage_existing: Optional[bool] = None,
name: Optional[str] = None,
retain_on_delete: Optional[bool] = None)func NewAddressIpv4V2(ctx *Context, name string, args AddressIpv4V2Args, opts ...ResourceOption) (*AddressIpv4V2, error)public AddressIpv4V2(string name, AddressIpv4V2Args args, CustomResourceOptions? opts = null)
public AddressIpv4V2(String name, AddressIpv4V2Args args)
public AddressIpv4V2(String name, AddressIpv4V2Args args, CustomResourceOptions options)
type: netaddr:AddressIpv4V2
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 AddressIpv4V2Args
- 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 AddressIpv4V2Args
- 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 AddressIpv4V2Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AddressIpv4V2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AddressIpv4V2Args
- 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 addressIpv4V2Resource = new Netaddr.AddressIpv4V2("addressIpv4V2Resource", new()
{
RangeIds = new[]
{
"string",
},
AddressIpv4V2Id = "string",
HardcodedAddress = "string",
ManageExisting = false,
Name = "string",
RetainOnDelete = false,
});
example, err := netaddr.NewAddressIpv4V2(ctx, "addressIpv4V2Resource", &netaddr.AddressIpv4V2Args{
RangeIds: pulumi.StringArray{
pulumi.String("string"),
},
AddressIpv4V2Id: pulumi.String("string"),
HardcodedAddress: pulumi.String("string"),
ManageExisting: pulumi.Bool(false),
Name: pulumi.String("string"),
RetainOnDelete: pulumi.Bool(false),
})
var addressIpv4V2Resource = new AddressIpv4V2("addressIpv4V2Resource", AddressIpv4V2Args.builder()
.rangeIds("string")
.addressIpv4V2Id("string")
.hardcodedAddress("string")
.manageExisting(false)
.name("string")
.retainOnDelete(false)
.build());
address_ipv4_v2_resource = netaddr.AddressIpv4V2("addressIpv4V2Resource",
range_ids=["string"],
address_ipv4_v2_id="string",
hardcoded_address="string",
manage_existing=False,
name="string",
retain_on_delete=False)
const addressIpv4V2Resource = new netaddr.AddressIpv4V2("addressIpv4V2Resource", {
rangeIds: ["string"],
addressIpv4V2Id: "string",
hardcodedAddress: "string",
manageExisting: false,
name: "string",
retainOnDelete: false,
});
type: netaddr:AddressIpv4V2
properties:
addressIpv4V2Id: string
hardcodedAddress: string
manageExisting: false
name: string
rangeIds:
- string
retainOnDelete: false
AddressIpv4V2 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 AddressIpv4V2 resource accepts the following input properties:
- Range
Ids List<string> - Identifiers of the address ranges the address is tied to.
- Address
Ipv4V2Id string - The ID of this resource.
- Hardcoded
Address string - An optional input to fixate the address to a specific value.
- Manage
Existing bool - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- Name string
- Name to associate with the address.
- Retain
On boolDelete
- Range
Ids []string - Identifiers of the address ranges the address is tied to.
- Address
Ipv4V2Id string - The ID of this resource.
- Hardcoded
Address string - An optional input to fixate the address to a specific value.
- Manage
Existing bool - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- Name string
- Name to associate with the address.
- Retain
On boolDelete
- range
Ids List<String> - Identifiers of the address ranges the address is tied to.
- address
Ipv4V2Id String - The ID of this resource.
- hardcoded
Address String - An optional input to fixate the address to a specific value.
- manage
Existing Boolean - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- name String
- Name to associate with the address.
- retain
On BooleanDelete
- range
Ids string[] - Identifiers of the address ranges the address is tied to.
- address
Ipv4V2Id string - The ID of this resource.
- hardcoded
Address string - An optional input to fixate the address to a specific value.
- manage
Existing boolean - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- name string
- Name to associate with the address.
- retain
On booleanDelete
- range_
ids Sequence[str] - Identifiers of the address ranges the address is tied to.
- address_
ipv4_ strv2_ id - The ID of this resource.
- hardcoded_
address str - An optional input to fixate the address to a specific value.
- manage_
existing bool - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- name str
- Name to associate with the address.
- retain_
on_ booldelete
- range
Ids List<String> - Identifiers of the address ranges the address is tied to.
- address
Ipv4V2Id String - The ID of this resource.
- hardcoded
Address String - An optional input to fixate the address to a specific value.
- manage
Existing Boolean - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- name String
- Name to associate with the address.
- retain
On BooleanDelete
Outputs
All input properties are implicitly available as output properties. Additionally, the AddressIpv4V2 resource produces the following output properties:
- Address string
- The address that got assigned to the resource.
- Found
In stringRange - Id of the range the address is in.
- Id string
- The provider-assigned unique ID for this managed resource.
- Address string
- The address that got assigned to the resource.
- Found
In stringRange - Id of the range the address is in.
- Id string
- The provider-assigned unique ID for this managed resource.
- address String
- The address that got assigned to the resource.
- found
In StringRange - Id of the range the address is in.
- id String
- The provider-assigned unique ID for this managed resource.
- address string
- The address that got assigned to the resource.
- found
In stringRange - Id of the range the address is in.
- id string
- The provider-assigned unique ID for this managed resource.
- address str
- The address that got assigned to the resource.
- found_
in_ strrange - Id of the range the address is in.
- id str
- The provider-assigned unique ID for this managed resource.
- address String
- The address that got assigned to the resource.
- found
In StringRange - Id of the range the address is in.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing AddressIpv4V2 Resource
Get an existing AddressIpv4V2 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?: AddressIpv4V2State, opts?: CustomResourceOptions): AddressIpv4V2@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
address: Optional[str] = None,
address_ipv4_v2_id: Optional[str] = None,
found_in_range: Optional[str] = None,
hardcoded_address: Optional[str] = None,
manage_existing: Optional[bool] = None,
name: Optional[str] = None,
range_ids: Optional[Sequence[str]] = None,
retain_on_delete: Optional[bool] = None) -> AddressIpv4V2func GetAddressIpv4V2(ctx *Context, name string, id IDInput, state *AddressIpv4V2State, opts ...ResourceOption) (*AddressIpv4V2, error)public static AddressIpv4V2 Get(string name, Input<string> id, AddressIpv4V2State? state, CustomResourceOptions? opts = null)public static AddressIpv4V2 get(String name, Output<String> id, AddressIpv4V2State state, CustomResourceOptions options)resources: _: type: netaddr:AddressIpv4V2 get: id: ${id}- 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.
- Address string
- The address that got assigned to the resource.
- Address
Ipv4V2Id string - The ID of this resource.
- Found
In stringRange - Id of the range the address is in.
- Hardcoded
Address string - An optional input to fixate the address to a specific value.
- Manage
Existing bool - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- Name string
- Name to associate with the address.
- Range
Ids List<string> - Identifiers of the address ranges the address is tied to.
- Retain
On boolDelete
- Address string
- The address that got assigned to the resource.
- Address
Ipv4V2Id string - The ID of this resource.
- Found
In stringRange - Id of the range the address is in.
- Hardcoded
Address string - An optional input to fixate the address to a specific value.
- Manage
Existing bool - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- Name string
- Name to associate with the address.
- Range
Ids []string - Identifiers of the address ranges the address is tied to.
- Retain
On boolDelete
- address String
- The address that got assigned to the resource.
- address
Ipv4V2Id String - The ID of this resource.
- found
In StringRange - Id of the range the address is in.
- hardcoded
Address String - An optional input to fixate the address to a specific value.
- manage
Existing Boolean - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- name String
- Name to associate with the address.
- range
Ids List<String> - Identifiers of the address ranges the address is tied to.
- retain
On BooleanDelete
- address string
- The address that got assigned to the resource.
- address
Ipv4V2Id string - The ID of this resource.
- found
In stringRange - Id of the range the address is in.
- hardcoded
Address string - An optional input to fixate the address to a specific value.
- manage
Existing boolean - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- name string
- Name to associate with the address.
- range
Ids string[] - Identifiers of the address ranges the address is tied to.
- retain
On booleanDelete
- address str
- The address that got assigned to the resource.
- address_
ipv4_ strv2_ id - The ID of this resource.
- found_
in_ strrange - Id of the range the address is in.
- hardcoded_
address str - An optional input to fixate the address to a specific value.
- manage_
existing bool - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- name str
- Name to associate with the address.
- range_
ids Sequence[str] - Identifiers of the address ranges the address is tied to.
- retain_
on_ booldelete
- address String
- The address that got assigned to the resource.
- address
Ipv4V2Id String - The ID of this resource.
- found
In StringRange - Id of the range the address is in.
- hardcoded
Address String - An optional input to fixate the address to a specific value.
- manage
Existing Boolean - Whether the address is possibly present when the resource is created. Setting this to true allows you to import the existing address without error.
- name String
- Name to associate with the address.
- range
Ids List<String> - Identifiers of the address ranges the address is tied to.
- retain
On BooleanDelete
Package Details
- Repository
- netaddr ferlab-ste-justine/terraform-provider-netaddr
- License
- Notes
- This Pulumi package is based on the
netaddrTerraform Provider.
