1. Packages
  2. Equinix Metal (Deprecated)
  3. API Docs
  4. Project

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED

equinix-metal.Project

Explore with Pulumi AI

equinix-metal logo

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED

    Import

    This resource can be imported using an existing project ID

     $ pulumi import equinix-metal:index/project:Project metal_project {existing_project_id}
    

    Create Project Resource

    new Project(name: string, args?: ProjectArgs, opts?: CustomResourceOptions);
    @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)
    @overload
    def Project(resource_name: str,
                args: Optional[ProjectArgs] = None,
                opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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:

    BackendTransfer bool

    Enable or disable Backend Transfer, default is false

    BgpConfig Pulumi.EquinixMetal.Inputs.ProjectBgpConfig

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    Name string

    The name of the project

    OrganizationId string

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    PaymentMethodId string

    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).

    BackendTransfer bool

    Enable or disable Backend Transfer, default is false

    BgpConfig ProjectBgpConfigArgs

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    Name string

    The name of the project

    OrganizationId string

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    PaymentMethodId string

    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).

    backendTransfer Boolean

    Enable or disable Backend Transfer, default is false

    bgpConfig ProjectBgpConfig

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    name String

    The name of the project

    organizationId String

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    paymentMethodId String

    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).

    backendTransfer boolean

    Enable or disable Backend Transfer, default is false

    bgpConfig ProjectBgpConfig

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    name string

    The name of the project

    organizationId string

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    paymentMethodId string

    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 ProjectBgpConfigArgs

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    name str

    The name of the project

    organization_id str

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    payment_method_id str

    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).

    backendTransfer Boolean

    Enable or disable Backend Transfer, default is false

    bgpConfig Property Map

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    name String

    The name of the project

    organizationId String

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    paymentMethodId String

    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:

    Created string

    The timestamp for when the project was created

    Id string

    The provider-assigned unique ID for this managed resource.

    Updated string

    The timestamp for the last time the project was updated

    Created string

    The timestamp for when the project was created

    Id string

    The provider-assigned unique ID for this managed resource.

    Updated string

    The timestamp for the last time the project was updated

    created String

    The timestamp for when the project was created

    id String

    The provider-assigned unique ID for this managed resource.

    updated String

    The timestamp for the last time the project was updated

    created string

    The timestamp for when the project was created

    id string

    The provider-assigned unique ID for this managed resource.

    updated string

    The timestamp for the last time the project was updated

    created str

    The timestamp for when the project was created

    id str

    The provider-assigned unique ID for this managed resource.

    updated str

    The timestamp for the last time the project was updated

    created String

    The timestamp for when the project was created

    id String

    The provider-assigned unique ID for this managed resource.

    updated String

    The timestamp for the last time the project was updated

    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.
    The following state arguments are supported:
    BackendTransfer bool

    Enable or disable Backend Transfer, default is false

    BgpConfig Pulumi.EquinixMetal.Inputs.ProjectBgpConfig

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    Created string

    The timestamp for when the project was created

    Name string

    The name of the project

    OrganizationId string

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    PaymentMethodId string

    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

    BackendTransfer bool

    Enable or disable Backend Transfer, default is false

    BgpConfig ProjectBgpConfigArgs

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    Created string

    The timestamp for when the project was created

    Name string

    The name of the project

    OrganizationId string

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    PaymentMethodId string

    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

    backendTransfer Boolean

    Enable or disable Backend Transfer, default is false

    bgpConfig ProjectBgpConfig

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    created String

    The timestamp for when the project was created

    name String

    The name of the project

    organizationId String

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    paymentMethodId String

    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

    backendTransfer boolean

    Enable or disable Backend Transfer, default is false

    bgpConfig ProjectBgpConfig

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    created string

    The timestamp for when the project was created

    name string

    The name of the project

    organizationId string

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    paymentMethodId string

    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 ProjectBgpConfigArgs

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    created str

    The timestamp for when the project was created

    name str

    The name of the project

    organization_id str

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    payment_method_id str

    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

    backendTransfer Boolean

    Enable or disable Backend Transfer, default is false

    bgpConfig Property Map

    Optional BGP settings. Refer to Equinix Metal guide for BGP.

    created String

    The timestamp for when the project was created

    name String

    The name of the project

    organizationId String

    The UUID of organization under which you want to create the project. If you leave it out, the project will be create under your the default organization of your account.

    paymentMethodId String

    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

    DeploymentType string

    private or public, the private is likely to be usable immediately, the public will need to be review by Equinix Metal engineers

    MaxPrefix 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

    DeploymentType string

    private or public, the private is likely to be usable immediately, the public will need to be review by Equinix Metal engineers

    MaxPrefix 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

    deploymentType String

    private or public, the private is likely to be usable immediately, the public will need to be review by Equinix Metal engineers

    maxPrefix 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

    deploymentType string

    private or public, the private is likely to be usable immediately, the public will need to be review by Equinix Metal engineers

    maxPrefix 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

    private or public, the private is likely to be usable immediately, the public will need to be review 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

    deploymentType String

    private or public, the private is likely to be usable immediately, the public will need to be review by Equinix Metal engineers

    maxPrefix 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 Metal pulumi/pulumi-equinix-metal
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the metal Terraform Provider.

    equinix-metal logo

    This package is deprecated. We recommend using the new Equinix package.

    Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED