1. Packages
  2. Lxd Provider
  3. API Docs
  4. Project
lxd 2.5.0 published on Thursday, Mar 13, 2025 by terraform-lxd

lxd.Project

Explore with Pulumi AI

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,
            config: Optional[Mapping[str, str]] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            remote: 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: lxd:Project
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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 Lxd.Project("projectResource", new()
{
    Config = 
    {
        { "string", "string" },
    },
    Description = "string",
    Name = "string",
    Remote = "string",
});
Copy
example, err := lxd.NewProject(ctx, "projectResource", &lxd.ProjectArgs{
Config: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Remote: pulumi.String("string"),
})
Copy
var projectResource = new Project("projectResource", ProjectArgs.builder()
    .config(Map.of("string", "string"))
    .description("string")
    .name("string")
    .remote("string")
    .build());
Copy
project_resource = lxd.Project("projectResource",
    config={
        "string": "string",
    },
    description="string",
    name="string",
    remote="string")
Copy
const projectResource = new lxd.Project("projectResource", {
    config: {
        string: "string",
    },
    description: "string",
    name: "string",
    remote: "string",
});
Copy
type: lxd:Project
properties:
    config:
        string: string
    description: string
    name: string
    remote: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Project resource accepts the following input properties:

Config Dictionary<string, string>
Optional - Map of key/value pairs of project config settings.
Description string
Optional - Description of the project.
Name string
Required - Name of the project.
Remote string
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
Config map[string]string
Optional - Map of key/value pairs of project config settings.
Description string
Optional - Description of the project.
Name string
Required - Name of the project.
Remote string
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
config Map<String,String>
Optional - Map of key/value pairs of project config settings.
description String
Optional - Description of the project.
name String
Required - Name of the project.
remote String
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
config {[key: string]: string}
Optional - Map of key/value pairs of project config settings.
description string
Optional - Description of the project.
name string
Required - Name of the project.
remote string
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
config Mapping[str, str]
Optional - Map of key/value pairs of project config settings.
description str
Optional - Description of the project.
name str
Required - Name of the project.
remote str
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
config Map<String>
Optional - Map of key/value pairs of project config settings.
description String
Optional - Description of the project.
name String
Required - Name of the project.
remote String
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

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,
        config: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        remote: 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)
resources:  _:    type: lxd:Project    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Config Dictionary<string, string>
Optional - Map of key/value pairs of project config settings.
Description string
Optional - Description of the project.
Name string
Required - Name of the project.
Remote string
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
Config map[string]string
Optional - Map of key/value pairs of project config settings.
Description string
Optional - Description of the project.
Name string
Required - Name of the project.
Remote string
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
config Map<String,String>
Optional - Map of key/value pairs of project config settings.
description String
Optional - Description of the project.
name String
Required - Name of the project.
remote String
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
config {[key: string]: string}
Optional - Map of key/value pairs of project config settings.
description string
Optional - Description of the project.
name string
Required - Name of the project.
remote string
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
config Mapping[str, str]
Optional - Map of key/value pairs of project config settings.
description str
Optional - Description of the project.
name str
Required - Name of the project.
remote str
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.
config Map<String>
Optional - Map of key/value pairs of project config settings.
description String
Optional - Description of the project.
name String
Required - Name of the project.
remote String
Optional - The remote in which the resource will be created. If not provided, the provider's default remote will be used.

Package Details

Repository
lxd terraform-lxd/terraform-provider-lxd
License
Notes
This Pulumi package is based on the lxd Terraform Provider.