nsxt.VpcIpAddressAllocation
Explore with Pulumi AI
Create VpcIpAddressAllocation Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VpcIpAddressAllocation(name: string, args: VpcIpAddressAllocationArgs, opts?: CustomResourceOptions);
@overload
def VpcIpAddressAllocation(resource_name: str,
args: VpcIpAddressAllocationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VpcIpAddressAllocation(resource_name: str,
opts: Optional[ResourceOptions] = None,
context: Optional[VpcIpAddressAllocationContextArgs] = None,
display_name: Optional[str] = None,
allocation_ips: Optional[str] = None,
allocation_size: Optional[float] = None,
description: Optional[str] = None,
ip_address_block_visibility: Optional[str] = None,
ip_address_type: Optional[str] = None,
ip_block: Optional[str] = None,
nsx_id: Optional[str] = None,
tags: Optional[Sequence[VpcIpAddressAllocationTagArgs]] = None,
vpc_ip_address_allocation_id: Optional[str] = None)
func NewVpcIpAddressAllocation(ctx *Context, name string, args VpcIpAddressAllocationArgs, opts ...ResourceOption) (*VpcIpAddressAllocation, error)
public VpcIpAddressAllocation(string name, VpcIpAddressAllocationArgs args, CustomResourceOptions? opts = null)
public VpcIpAddressAllocation(String name, VpcIpAddressAllocationArgs args)
public VpcIpAddressAllocation(String name, VpcIpAddressAllocationArgs args, CustomResourceOptions options)
type: nsxt:VpcIpAddressAllocation
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 VpcIpAddressAllocationArgs
- 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 VpcIpAddressAllocationArgs
- 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 VpcIpAddressAllocationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VpcIpAddressAllocationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VpcIpAddressAllocationArgs
- 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 vpcIpAddressAllocationResource = new Nsxt.VpcIpAddressAllocation("vpcIpAddressAllocationResource", new()
{
Context = new Nsxt.Inputs.VpcIpAddressAllocationContextArgs
{
ProjectId = "string",
VpcId = "string",
},
DisplayName = "string",
AllocationIps = "string",
AllocationSize = 0,
Description = "string",
IpAddressBlockVisibility = "string",
IpAddressType = "string",
IpBlock = "string",
NsxId = "string",
Tags = new[]
{
new Nsxt.Inputs.VpcIpAddressAllocationTagArgs
{
Scope = "string",
Tag = "string",
},
},
VpcIpAddressAllocationId = "string",
});
example, err := nsxt.NewVpcIpAddressAllocation(ctx, "vpcIpAddressAllocationResource", &nsxt.VpcIpAddressAllocationArgs{
Context: &nsxt.VpcIpAddressAllocationContextArgs{
ProjectId: pulumi.String("string"),
VpcId: pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
AllocationIps: pulumi.String("string"),
AllocationSize: pulumi.Float64(0),
Description: pulumi.String("string"),
IpAddressBlockVisibility: pulumi.String("string"),
IpAddressType: pulumi.String("string"),
IpBlock: pulumi.String("string"),
NsxId: pulumi.String("string"),
Tags: nsxt.VpcIpAddressAllocationTagArray{
&nsxt.VpcIpAddressAllocationTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
VpcIpAddressAllocationId: pulumi.String("string"),
})
var vpcIpAddressAllocationResource = new VpcIpAddressAllocation("vpcIpAddressAllocationResource", VpcIpAddressAllocationArgs.builder()
.context(VpcIpAddressAllocationContextArgs.builder()
.projectId("string")
.vpcId("string")
.build())
.displayName("string")
.allocationIps("string")
.allocationSize(0.0)
.description("string")
.ipAddressBlockVisibility("string")
.ipAddressType("string")
.ipBlock("string")
.nsxId("string")
.tags(VpcIpAddressAllocationTagArgs.builder()
.scope("string")
.tag("string")
.build())
.vpcIpAddressAllocationId("string")
.build());
vpc_ip_address_allocation_resource = nsxt.VpcIpAddressAllocation("vpcIpAddressAllocationResource",
context={
"project_id": "string",
"vpc_id": "string",
},
display_name="string",
allocation_ips="string",
allocation_size=0,
description="string",
ip_address_block_visibility="string",
ip_address_type="string",
ip_block="string",
nsx_id="string",
tags=[{
"scope": "string",
"tag": "string",
}],
vpc_ip_address_allocation_id="string")
const vpcIpAddressAllocationResource = new nsxt.VpcIpAddressAllocation("vpcIpAddressAllocationResource", {
context: {
projectId: "string",
vpcId: "string",
},
displayName: "string",
allocationIps: "string",
allocationSize: 0,
description: "string",
ipAddressBlockVisibility: "string",
ipAddressType: "string",
ipBlock: "string",
nsxId: "string",
tags: [{
scope: "string",
tag: "string",
}],
vpcIpAddressAllocationId: "string",
});
type: nsxt:VpcIpAddressAllocation
properties:
allocationIps: string
allocationSize: 0
context:
projectId: string
vpcId: string
description: string
displayName: string
ipAddressBlockVisibility: string
ipAddressType: string
ipBlock: string
nsxId: string
tags:
- scope: string
tag: string
vpcIpAddressAllocationId: string
VpcIpAddressAllocation 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 VpcIpAddressAllocation resource accepts the following input properties:
- Context
Vpc
Ip Address Allocation Context - Resource context
- Display
Name string - Display name of the resource.
- Allocation
Ips string - If specified, IPs have to be within range of respectiveIP blocks.
- Allocation
Size double - The system will allocate IP addresses from unused IP addresses based on allocation size.
- Description string
- Description of the resource.
- Ip
Address stringBlock Visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - Ip
Address stringType - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - Ip
Block string - Policy path for IP Block for the allocation.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- List<Vpc
Ip Address Allocation Tag> - A list of scope + tag pairs to associate with this resource.
- Vpc
Ip stringAddress Allocation Id - ID of the resource.
- Context
Vpc
Ip Address Allocation Context Args - Resource context
- Display
Name string - Display name of the resource.
- Allocation
Ips string - If specified, IPs have to be within range of respectiveIP blocks.
- Allocation
Size float64 - The system will allocate IP addresses from unused IP addresses based on allocation size.
- Description string
- Description of the resource.
- Ip
Address stringBlock Visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - Ip
Address stringType - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - Ip
Block string - Policy path for IP Block for the allocation.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- []Vpc
Ip Address Allocation Tag Args - A list of scope + tag pairs to associate with this resource.
- Vpc
Ip stringAddress Allocation Id - ID of the resource.
- context
Vpc
Ip Address Allocation Context - Resource context
- display
Name String - Display name of the resource.
- allocation
Ips String - If specified, IPs have to be within range of respectiveIP blocks.
- allocation
Size Double - The system will allocate IP addresses from unused IP addresses based on allocation size.
- description String
- Description of the resource.
- ip
Address StringBlock Visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - ip
Address StringType - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - ip
Block String - Policy path for IP Block for the allocation.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- List<Vpc
Ip Address Allocation Tag> - A list of scope + tag pairs to associate with this resource.
- vpc
Ip StringAddress Allocation Id - ID of the resource.
- context
Vpc
Ip Address Allocation Context - Resource context
- display
Name string - Display name of the resource.
- allocation
Ips string - If specified, IPs have to be within range of respectiveIP blocks.
- allocation
Size number - The system will allocate IP addresses from unused IP addresses based on allocation size.
- description string
- Description of the resource.
- ip
Address stringBlock Visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - ip
Address stringType - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - ip
Block string - Policy path for IP Block for the allocation.
- nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Vpc
Ip Address Allocation Tag[] - A list of scope + tag pairs to associate with this resource.
- vpc
Ip stringAddress Allocation Id - ID of the resource.
- context
Vpc
Ip Address Allocation Context Args - Resource context
- display_
name str - Display name of the resource.
- allocation_
ips str - If specified, IPs have to be within range of respectiveIP blocks.
- allocation_
size float - The system will allocate IP addresses from unused IP addresses based on allocation size.
- description str
- Description of the resource.
- ip_
address_ strblock_ visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - ip_
address_ strtype - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - ip_
block str - Policy path for IP Block for the allocation.
- nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Sequence[Vpc
Ip Address Allocation Tag Args] - A list of scope + tag pairs to associate with this resource.
- vpc_
ip_ straddress_ allocation_ id - ID of the resource.
- context Property Map
- Resource context
- display
Name String - Display name of the resource.
- allocation
Ips String - If specified, IPs have to be within range of respectiveIP blocks.
- allocation
Size Number - The system will allocate IP addresses from unused IP addresses based on allocation size.
- description String
- Description of the resource.
- ip
Address StringBlock Visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - ip
Address StringType - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - ip
Block String - Policy path for IP Block for the allocation.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- List<Property Map>
- A list of scope + tag pairs to associate with this resource.
- vpc
Ip StringAddress Allocation Id - ID of the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the VpcIpAddressAllocation resource produces the following output properties:
Look up Existing VpcIpAddressAllocation Resource
Get an existing VpcIpAddressAllocation 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?: VpcIpAddressAllocationState, opts?: CustomResourceOptions): VpcIpAddressAllocation
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allocation_ips: Optional[str] = None,
allocation_size: Optional[float] = None,
context: Optional[VpcIpAddressAllocationContextArgs] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
ip_address_block_visibility: Optional[str] = None,
ip_address_type: Optional[str] = None,
ip_block: Optional[str] = None,
nsx_id: Optional[str] = None,
path: Optional[str] = None,
revision: Optional[float] = None,
tags: Optional[Sequence[VpcIpAddressAllocationTagArgs]] = None,
vpc_ip_address_allocation_id: Optional[str] = None) -> VpcIpAddressAllocation
func GetVpcIpAddressAllocation(ctx *Context, name string, id IDInput, state *VpcIpAddressAllocationState, opts ...ResourceOption) (*VpcIpAddressAllocation, error)
public static VpcIpAddressAllocation Get(string name, Input<string> id, VpcIpAddressAllocationState? state, CustomResourceOptions? opts = null)
public static VpcIpAddressAllocation get(String name, Output<String> id, VpcIpAddressAllocationState state, CustomResourceOptions options)
resources: _: type: nsxt:VpcIpAddressAllocation 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.
- Allocation
Ips string - If specified, IPs have to be within range of respectiveIP blocks.
- Allocation
Size double - The system will allocate IP addresses from unused IP addresses based on allocation size.
- Context
Vpc
Ip Address Allocation Context - Resource context
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Ip
Address stringBlock Visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - Ip
Address stringType - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - Ip
Block string - Policy path for IP Block for the allocation.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Revision double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- List<Vpc
Ip Address Allocation Tag> - A list of scope + tag pairs to associate with this resource.
- Vpc
Ip stringAddress Allocation Id - ID of the resource.
- Allocation
Ips string - If specified, IPs have to be within range of respectiveIP blocks.
- Allocation
Size float64 - The system will allocate IP addresses from unused IP addresses based on allocation size.
- Context
Vpc
Ip Address Allocation Context Args - Resource context
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Ip
Address stringBlock Visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - Ip
Address stringType - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - Ip
Block string - Policy path for IP Block for the allocation.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Revision float64
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- []Vpc
Ip Address Allocation Tag Args - A list of scope + tag pairs to associate with this resource.
- Vpc
Ip stringAddress Allocation Id - ID of the resource.
- allocation
Ips String - If specified, IPs have to be within range of respectiveIP blocks.
- allocation
Size Double - The system will allocate IP addresses from unused IP addresses based on allocation size.
- context
Vpc
Ip Address Allocation Context - Resource context
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- ip
Address StringBlock Visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - ip
Address StringType - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - ip
Block String - Policy path for IP Block for the allocation.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- revision Double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- List<Vpc
Ip Address Allocation Tag> - A list of scope + tag pairs to associate with this resource.
- vpc
Ip StringAddress Allocation Id - ID of the resource.
- allocation
Ips string - If specified, IPs have to be within range of respectiveIP blocks.
- allocation
Size number - The system will allocate IP addresses from unused IP addresses based on allocation size.
- context
Vpc
Ip Address Allocation Context - Resource context
- description string
- Description of the resource.
- display
Name string - Display name of the resource.
- ip
Address stringBlock Visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - ip
Address stringType - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - ip
Block string - Policy path for IP Block for the allocation.
- nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path string
- The NSX path of the policy resource.
- revision number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Vpc
Ip Address Allocation Tag[] - A list of scope + tag pairs to associate with this resource.
- vpc
Ip stringAddress Allocation Id - ID of the resource.
- allocation_
ips str - If specified, IPs have to be within range of respectiveIP blocks.
- allocation_
size float - The system will allocate IP addresses from unused IP addresses based on allocation size.
- context
Vpc
Ip Address Allocation Context Args - Resource context
- description str
- Description of the resource.
- display_
name str - Display name of the resource.
- ip_
address_ strblock_ visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - ip_
address_ strtype - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - ip_
block str - Policy path for IP Block for the allocation.
- nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path str
- The NSX path of the policy resource.
- revision float
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Sequence[Vpc
Ip Address Allocation Tag Args] - A list of scope + tag pairs to associate with this resource.
- vpc_
ip_ straddress_ allocation_ id - ID of the resource.
- allocation
Ips String - If specified, IPs have to be within range of respectiveIP blocks.
- allocation
Size Number - The system will allocate IP addresses from unused IP addresses based on allocation size.
- context Property Map
- Resource context
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- ip
Address StringBlock Visibility - Represents visibility of IP address block. This field is not applicable if IPAddressType at VPC is IPV6. Valid values are
EXTERNAL
,PRIVATE
,PRIVATE_TGW
, default isEXTERNAL
. - ip
Address StringType - This defines the type of IP address block that will be used to allocate IP. This field is applicable only if IP address type at VPC is
DUAL
. Valid values areIPV4
andIPV6
, default isIPV4
. - ip
Block String - Policy path for IP Block for the allocation.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- revision Number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- List<Property Map>
- A list of scope + tag pairs to associate with this resource.
- vpc
Ip StringAddress Allocation Id - ID of the resource.
Supporting Types
VpcIpAddressAllocationContext, VpcIpAddressAllocationContextArgs
- project_
id str - Id of the project which the resource belongs to.
- vpc_
id str - Id of the VPC which the resource belongs to.
VpcIpAddressAllocationTag, VpcIpAddressAllocationTagArgs
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxt
Terraform Provider.