equinix.metal.Project
Explore with Pulumi AI
Provides an Equinix Metal project resource to allow you manage devices in your projects.
NOTE: Keep in mind that Equinix Metal invoicing is per project, so creating many
equinix.metal.Project
resources will affect the rendered invoice. If you want to keep your Equinix Metal bill simple and easy to review, please re-use your existing projects.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Equinix = Pulumi.Equinix;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var organizationId = config.Require("organizationId");
var name = config.Get("name") ?? "Default Project";
var projectResource = new Equinix.Metal.Project("project", new()
{
Name = name,
OrganizationId = organizationId,
});
return new Dictionary<string, object?>
{
["projectId"] = projectResource.Id,
};
});
package main
import (
"github.com/equinix/pulumi-equinix/sdk/go/equinix/metal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
organizationId := cfg.Require("organizationId")
name := "Default Project"
if param := cfg.Get("name"); param != "" {
name = param
}
projectResource, err := metal.NewProject(ctx, "project", &metal.ProjectArgs{
Name: pulumi.String(name),
OrganizationId: pulumi.String(organizationId),
})
if err != nil {
return err
}
ctx.Export("projectId", projectResource.ID())
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.equinix.pulumi.metal.Project;
import com.equinix.pulumi.metal.ProjectArgs;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var organizationId = config.get("organizationId").get();
final var name = config.get("name").orElse("Default Project");
var projectResource = new Project("projectResource", ProjectArgs.builder()
.name(name)
.organizationId(organizationId)
.build());
ctx.export("projectId", projectResource.id());
}
}
import pulumi
import pulumi_equinix as equinix
config = pulumi.Config()
organization_id = config.require("organizationId")
name = config.get("name")
if name is None:
name = "Default Project"
project_resource = equinix.metal.Project("project",
name=name,
organization_id=organization_id)
pulumi.export("projectId", project_resource.id)
import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@equinix-labs/pulumi-equinix";
const config = new pulumi.Config();
const organizationId = config.require("organizationId");
const name = config.get("name") || "Default Project";
const projectResource = new equinix.metal.Project("project", {
name: name,
organizationId: organizationId,
});
export const projectId = projectResource.id;
config:
organizationId:
type: string
name:
type: string
default: Default Project
resources:
project:
type: equinix:metal:Project
properties:
name: ${name}
organizationId: ${organizationId}
outputs:
projectId: ${project.id}
Create Project Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Project(name: string, args?: ProjectArgs, opts?: CustomResourceOptions);
@overload
def Project(resource_name: str,
args: Optional[ProjectArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Project(resource_name: str,
opts: Optional[ResourceOptions] = None,
backend_transfer: Optional[bool] = None,
bgp_config: Optional[ProjectBgpConfigArgs] = None,
name: Optional[str] = None,
organization_id: Optional[str] = None,
payment_method_id: Optional[str] = None)
func NewProject(ctx *Context, name string, args *ProjectArgs, opts ...ResourceOption) (*Project, error)
public Project(string name, ProjectArgs? args = null, CustomResourceOptions? opts = null)
public Project(String name, ProjectArgs args)
public Project(String name, ProjectArgs args, CustomResourceOptions options)
type: equinix:metal:Project
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 ProjectArgs
- 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 ProjectArgs
- 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 ProjectArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProjectArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProjectArgs
- 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 projectResource = new Equinix.Metal.Project("projectResource", new()
{
BackendTransfer = false,
BgpConfig = new Equinix.Metal.Inputs.ProjectBgpConfigArgs
{
Asn = 0,
DeploymentType = "string",
MaxPrefix = 0,
Md5 = "string",
Status = "string",
},
Name = "string",
OrganizationId = "string",
PaymentMethodId = "string",
});
example, err := metal.NewProject(ctx, "projectResource", &metal.ProjectArgs{
BackendTransfer: pulumi.Bool(false),
BgpConfig: &metal.ProjectBgpConfigArgs{
Asn: pulumi.Int(0),
DeploymentType: pulumi.String("string"),
MaxPrefix: pulumi.Int(0),
Md5: pulumi.String("string"),
Status: pulumi.String("string"),
},
Name: pulumi.String("string"),
OrganizationId: pulumi.String("string"),
PaymentMethodId: pulumi.String("string"),
})
var projectResource = new Project("projectResource", ProjectArgs.builder()
.backendTransfer(false)
.bgpConfig(ProjectBgpConfigArgs.builder()
.asn(0)
.deploymentType("string")
.maxPrefix(0)
.md5("string")
.status("string")
.build())
.name("string")
.organizationId("string")
.paymentMethodId("string")
.build());
project_resource = equinix.metal.Project("projectResource",
backend_transfer=False,
bgp_config=equinix.metal.ProjectBgpConfigArgs(
asn=0,
deployment_type="string",
max_prefix=0,
md5="string",
status="string",
),
name="string",
organization_id="string",
payment_method_id="string")
const projectResource = new equinix.metal.Project("projectResource", {
backendTransfer: false,
bgpConfig: {
asn: 0,
deploymentType: "string",
maxPrefix: 0,
md5: "string",
status: "string",
},
name: "string",
organizationId: "string",
paymentMethodId: "string",
});
type: equinix:metal:Project
properties:
backendTransfer: false
bgpConfig:
asn: 0
deploymentType: string
maxPrefix: 0
md5: string
status: string
name: string
organizationId: string
paymentMethodId: string
Project 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 Project resource accepts the following input properties:
- Backend
Transfer bool - Enable or disable Backend Transfer, default is
false
. - Bgp
Config ProjectBgp Config Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- Name string
- The name of the project. The maximum length is 80 characters
- Organization
Id string - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- Payment
Method stringId - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default).
- Backend
Transfer bool - Enable or disable Backend Transfer, default is
false
. - Bgp
Config ProjectBgp Config Args Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- Name string
- The name of the project. The maximum length is 80 characters
- Organization
Id string - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- Payment
Method stringId - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default).
- backend
Transfer Boolean - Enable or disable Backend Transfer, default is
false
. - bgp
Config ProjectBgp Config Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- name String
- The name of the project. The maximum length is 80 characters
- organization
Id String - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- payment
Method StringId - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default).
- backend
Transfer boolean - Enable or disable Backend Transfer, default is
false
. - bgp
Config ProjectBgp Config Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- name string
- The name of the project. The maximum length is 80 characters
- organization
Id string - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- payment
Method stringId - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default).
- backend_
transfer bool - Enable or disable Backend Transfer, default is
false
. - bgp_
config ProjectBgp Config Args Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- name str
- The name of the project. The maximum length is 80 characters
- organization_
id str - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- payment_
method_ strid - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default).
- backend
Transfer Boolean - Enable or disable Backend Transfer, default is
false
. - bgp
Config Property Map Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- name String
- The name of the project. The maximum length is 80 characters
- organization
Id String - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- payment
Method StringId - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default).
Outputs
All input properties are implicitly available as output properties. Additionally, the Project resource produces the following output properties:
Look up Existing Project Resource
Get an existing Project 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?: ProjectState, opts?: CustomResourceOptions): Project
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
backend_transfer: Optional[bool] = None,
bgp_config: Optional[ProjectBgpConfigArgs] = None,
created: Optional[str] = None,
name: Optional[str] = None,
organization_id: Optional[str] = None,
payment_method_id: Optional[str] = None,
updated: Optional[str] = None) -> Project
func GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)
public static Project Get(string name, Input<string> id, ProjectState? state, CustomResourceOptions? opts = null)
public static Project get(String name, Output<String> id, ProjectState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Backend
Transfer bool - Enable or disable Backend Transfer, default is
false
. - Bgp
Config ProjectBgp Config Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- Created string
- The timestamp for when the project was created.
- Name string
- The name of the project. The maximum length is 80 characters
- Organization
Id string - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- Payment
Method stringId - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default). - Updated string
- The timestamp for the last time the project was updated.
- Backend
Transfer bool - Enable or disable Backend Transfer, default is
false
. - Bgp
Config ProjectBgp Config Args Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- Created string
- The timestamp for when the project was created.
- Name string
- The name of the project. The maximum length is 80 characters
- Organization
Id string - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- Payment
Method stringId - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default). - Updated string
- The timestamp for the last time the project was updated.
- backend
Transfer Boolean - Enable or disable Backend Transfer, default is
false
. - bgp
Config ProjectBgp Config Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- created String
- The timestamp for when the project was created.
- name String
- The name of the project. The maximum length is 80 characters
- organization
Id String - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- payment
Method StringId - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default). - updated String
- The timestamp for the last time the project was updated.
- backend
Transfer boolean - Enable or disable Backend Transfer, default is
false
. - bgp
Config ProjectBgp Config Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- created string
- The timestamp for when the project was created.
- name string
- The name of the project. The maximum length is 80 characters
- organization
Id string - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- payment
Method stringId - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default). - updated string
- The timestamp for the last time the project was updated.
- backend_
transfer bool - Enable or disable Backend Transfer, default is
false
. - bgp_
config ProjectBgp Config Args Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- created str
- The timestamp for when the project was created.
- name str
- The name of the project. The maximum length is 80 characters
- organization_
id str - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- payment_
method_ strid - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default). - updated str
- The timestamp for the last time the project was updated.
- backend
Transfer Boolean - Enable or disable Backend Transfer, default is
false
. - bgp
Config Property Map Optional BGP settings. Refer to Equinix Metal guide for BGP.
NOTE: Once you set the BGP config in a project, it can't be removed (due to a limitation in the Equinix Metal API). It can be updated.
- created String
- The timestamp for when the project was created.
- name String
- The name of the project. The maximum length is 80 characters
- organization
Id String - The UUID of organization under which you want to create the project. If you leave it out, the project will be created under your the default organization of your account.
- payment
Method StringId - The UUID of payment method for this project. The payment method and the
project need to belong to the same organization (passed with
organization_id
, or default). - updated String
- The timestamp for the last time the project was updated.
Supporting Types
ProjectBgpConfig, ProjectBgpConfigArgs
- Asn int
- Autonomous System Number for local BGP deployment.
- Deployment
Type string local
orglobal
, thelocal
is likely to be usable immediately, theglobal
will need to be reviewed by Equinix Metal engineers.- Max
Prefix int - The maximum number of route filters allowed per server.
- Md5 string
- Password for BGP session in plaintext (not a checksum).
- Status string
- status of BGP configuration in the project.
- Asn int
- Autonomous System Number for local BGP deployment.
- Deployment
Type string local
orglobal
, thelocal
is likely to be usable immediately, theglobal
will need to be reviewed by Equinix Metal engineers.- Max
Prefix int - The maximum number of route filters allowed per server.
- Md5 string
- Password for BGP session in plaintext (not a checksum).
- Status string
- status of BGP configuration in the project.
- asn Integer
- Autonomous System Number for local BGP deployment.
- deployment
Type String local
orglobal
, thelocal
is likely to be usable immediately, theglobal
will need to be reviewed by Equinix Metal engineers.- max
Prefix Integer - The maximum number of route filters allowed per server.
- md5 String
- Password for BGP session in plaintext (not a checksum).
- status String
- status of BGP configuration in the project.
- asn number
- Autonomous System Number for local BGP deployment.
- deployment
Type string local
orglobal
, thelocal
is likely to be usable immediately, theglobal
will need to be reviewed by Equinix Metal engineers.- max
Prefix number - The maximum number of route filters allowed per server.
- md5 string
- Password for BGP session in plaintext (not a checksum).
- status string
- status of BGP configuration in the project.
- asn int
- Autonomous System Number for local BGP deployment.
- deployment_
type str local
orglobal
, thelocal
is likely to be usable immediately, theglobal
will need to be reviewed by Equinix Metal engineers.- max_
prefix int - The maximum number of route filters allowed per server.
- md5 str
- Password for BGP session in plaintext (not a checksum).
- status str
- status of BGP configuration in the project.
- asn Number
- Autonomous System Number for local BGP deployment.
- deployment
Type String local
orglobal
, thelocal
is likely to be usable immediately, theglobal
will need to be reviewed by Equinix Metal engineers.- max
Prefix Number - The maximum number of route filters allowed per server.
- md5 String
- Password for BGP session in plaintext (not a checksum).
- status String
- status of BGP configuration in the project.
Package Details
- Repository
- equinix equinix/pulumi-equinix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
equinix
Terraform Provider.