Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. ec2
  5. IpamAllocation

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.IpamAllocation

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Schema of AWS::EC2::IPAMAllocation Type

    Create IpamAllocation Resource

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

    Constructor syntax

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

@overload
def IpamAllocation(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   ipam_pool_id: Optional[str] = None,
                   cidr: Optional[str] = None,
                   description: Optional[str] = None,
                   netmask_length: Optional[int] = None)
    func NewIpamAllocation(ctx *Context, name string, args IpamAllocationArgs, opts ...ResourceOption) (*IpamAllocation, error)
    public IpamAllocation(string name, IpamAllocationArgs args, CustomResourceOptions? opts = null)
    public IpamAllocation(String name, IpamAllocationArgs args)
public IpamAllocation(String name, IpamAllocationArgs args, CustomResourceOptions options)

    type: aws-native:ec2:IpamAllocation
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 IpamAllocationArgs
    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 IpamAllocationArgs
    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 IpamAllocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpamAllocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpamAllocationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    IpamAllocation 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 IpamAllocation resource accepts the following input properties:

    IpamPoolId string
    Id of the IPAM Pool.
    Cidr string

    The CIDR you would like to allocate from the IPAM pool. Note the following:

    • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
    • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

    Possible values: Any available IPv4 or IPv6 CIDR.

    Description string
    A description for the allocation.
    NetmaskLength int
    The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
    IpamPoolId string
    Id of the IPAM Pool.
    Cidr string

    The CIDR you would like to allocate from the IPAM pool. Note the following:

    • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
    • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

    Possible values: Any available IPv4 or IPv6 CIDR.

    Description string
    A description for the allocation.
    NetmaskLength int
    The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
    ipamPoolId String
    Id of the IPAM Pool.
    cidr String

    The CIDR you would like to allocate from the IPAM pool. Note the following:

    • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
    • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

    Possible values: Any available IPv4 or IPv6 CIDR.

    description String
    A description for the allocation.
    netmaskLength Integer
    The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
    ipamPoolId string
    Id of the IPAM Pool.
    cidr string

    The CIDR you would like to allocate from the IPAM pool. Note the following:

    • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
    • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

    Possible values: Any available IPv4 or IPv6 CIDR.

    description string
    A description for the allocation.
    netmaskLength number
    The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
    ipam_pool_id str
    Id of the IPAM Pool.
    cidr str

    The CIDR you would like to allocate from the IPAM pool. Note the following:

    • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
    • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

    Possible values: Any available IPv4 or IPv6 CIDR.

    description str
    A description for the allocation.
    netmask_length int
    The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.
    ipamPoolId String
    Id of the IPAM Pool.
    cidr String

    The CIDR you would like to allocate from the IPAM pool. Note the following:

    • If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR.
    • If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored.

    Possible values: Any available IPv4 or IPv6 CIDR.

    description String
    A description for the allocation.
    netmaskLength Number
    The desired netmask length of the allocation. If set, IPAM will choose a block of free space with this size and return the CIDR representing it.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IpamAllocation resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IpamPoolAllocationId string
    Id of the allocation.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpamPoolAllocationId string
    Id of the allocation.
    id String
    The provider-assigned unique ID for this managed resource.
    ipamPoolAllocationId String
    Id of the allocation.
    id string
    The provider-assigned unique ID for this managed resource.
    ipamPoolAllocationId string
    Id of the allocation.
    id str
    The provider-assigned unique ID for this managed resource.
    ipam_pool_allocation_id str
    Id of the allocation.
    id String
    The provider-assigned unique ID for this managed resource.
    ipamPoolAllocationId String
    Id of the allocation.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native