@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
160 lines (159 loc) • 5.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to attach elastic IP subnets to devices.
*
* To attach an IP subnet from a reserved block to a provisioned device, you must derive a subnet CIDR belonging to one of your reserved blocks in the same project and metro as the target device.
*
* For example, you have reserved IPv4 address block `147.229.10.152/30`, you can choose to assign either the whole block as one subnet to a device; or 2 subnets with CIDRs `147.229.10.152/31` and `147.229.10.154/31`; or 4 subnets with mask prefix length `32`. More about the elastic IP subnets is [here](https://metal.equinix.com/developers/docs/networking/elastic-ips/).
*
* Device and reserved block must be in the same metro.
*
* ## Example Usage
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
* import * as std from "@pulumi/std";
*
* const myblock = new equinix.metal.ReservedIpBlock("myblock", {
* projectId: projectId,
* metro: "ny",
* quantity: 2,
* });
* const firstAddressAssignment = new equinix.metal.IpAttachment("firstAddressAssignment", {
* deviceId: mydevice.id,
* cidrNotation: std.joinOutput({
* separator: "/",
* input: [
* std.cidrhostOutput({
* input: myblockMetalReservedIpBlock.cidrNotation,
* host: 0,
* }).apply(invoke => invoke.result),
* "32",
* ],
* }).apply(invoke => invoke.result),
* });
* ```
*/
export declare class IpAttachment extends pulumi.CustomResource {
/**
* Get an existing IpAttachment resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IpAttachmentState, opts?: pulumi.CustomResourceOptions): IpAttachment;
/**
* Returns true if the given object is an instance of IpAttachment. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is IpAttachment;
readonly address: pulumi.Output<string>;
/**
* Address family as integer. One of `4` or `6`.
*/
readonly addressFamily: pulumi.Output<number>;
/**
* Length of CIDR prefix of the subnet as integer.
*/
readonly cidr: pulumi.Output<number>;
/**
* CIDR notation of subnet from block reserved in the same project and metro as the device.
*/
readonly cidrNotation: pulumi.Output<string>;
/**
* ID of device to which to assign the subnet.
*/
readonly deviceId: pulumi.Output<string>;
/**
* IP address of gateway for the subnet.
*/
readonly gateway: pulumi.Output<string>;
/**
* Flag indicating whether IP block is global, i.e. assignable in any location
*/
readonly global: pulumi.Output<boolean>;
readonly manageable: pulumi.Output<boolean>;
readonly management: pulumi.Output<boolean>;
/**
* Subnet mask in decimal notation, e.g., `255.255.255.0`.
*/
readonly netmask: pulumi.Output<string>;
/**
* Subnet network address.
*/
readonly network: pulumi.Output<string>;
/**
* Boolean flag whether subnet is reachable from the Internet.
*/
readonly public: pulumi.Output<boolean>;
readonly vrfId: pulumi.Output<string>;
/**
* Create a IpAttachment resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: IpAttachmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IpAttachment resources.
*/
export interface IpAttachmentState {
address?: pulumi.Input<string>;
/**
* Address family as integer. One of `4` or `6`.
*/
addressFamily?: pulumi.Input<number>;
/**
* Length of CIDR prefix of the subnet as integer.
*/
cidr?: pulumi.Input<number>;
/**
* CIDR notation of subnet from block reserved in the same project and metro as the device.
*/
cidrNotation?: pulumi.Input<string>;
/**
* ID of device to which to assign the subnet.
*/
deviceId?: pulumi.Input<string>;
/**
* IP address of gateway for the subnet.
*/
gateway?: pulumi.Input<string>;
/**
* Flag indicating whether IP block is global, i.e. assignable in any location
*/
global?: pulumi.Input<boolean>;
manageable?: pulumi.Input<boolean>;
management?: pulumi.Input<boolean>;
/**
* Subnet mask in decimal notation, e.g., `255.255.255.0`.
*/
netmask?: pulumi.Input<string>;
/**
* Subnet network address.
*/
network?: pulumi.Input<string>;
/**
* Boolean flag whether subnet is reachable from the Internet.
*/
public?: pulumi.Input<boolean>;
vrfId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a IpAttachment resource.
*/
export interface IpAttachmentArgs {
/**
* CIDR notation of subnet from block reserved in the same project and metro as the device.
*/
cidrNotation: pulumi.Input<string>;
/**
* ID of device to which to assign the subnet.
*/
deviceId: pulumi.Input<string>;
}