Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. getProject
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.getProject

Explore with Pulumi AI

aiven logo
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

    Gets information about an Aiven project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const exampleProject = aiven.getProject({
    project: "example-project",
});

    import pulumi
import pulumi_aiven as aiven

example_project = aiven.get_project(project="example-project")

    package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.LookupProject(ctx, &aiven.LookupProjectArgs{
			Project: "example-project",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var exampleProject = Aiven.GetProject.Invoke(new()
    {
        Project = "example-project",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetProjectArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleProject = AivenFunctions.getProject(GetProjectArgs.builder()
            .project("example-project")
            .build());

    }
}

    variables:
  exampleProject:
    fn::invoke:
      function: aiven:getProject
      arguments:
        project: example-project

    Using getProject

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>
    def get_project(project: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(project: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]
    func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput

    > Note: This function is named LookupProject in the Go SDK.

    public static class GetProject 
{
    public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)

    fn::invoke:
  function: aiven:index/getProject:getProject
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Project string
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.
    Project string
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.
    project String
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.
    project string
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.
    project str
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.
    project String
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.

    getProject Result

    The following output properties are available:

    AccountId string
    Link a project to an existing account using its account ID. This field is deprecated. Use parent_id instead. To set up proper dependencies please refer to this variable as a reference.
    AddAccountOwnersAdminAccess bool
    If parent_id is set, grant account owner team admin access to the new project. The default value is true.
    AvailableCredits string
    The number of trial or promotional credits remaining for this project.
    BillingGroup string
    The ID of the billing group this project is assigned to. To set up proper dependencies please refer to this variable as a reference.
    CaCert string
    The CA certificate for the project. This is required for configuring clients that connect to certain services like Kafka.
    CopyFromProject string
    The name of the project to copy billing information, technical contacts, and some other project attributes from. This is most useful to set up the same billing method when you use bank transfers to pay invoices for other projects. You can only do this when creating a project. You can't set the billing over the API for an existing. To set up proper dependencies please refer to this variable as a reference.
    DefaultCloud string
    Default cloud provider and region where services are hosted. This can be changed after the project is created and will not affect existing services.
    EstimatedBalance string
    The monthly running estimate for this project for the current billing period.
    Id string
    The provider-assigned unique ID for this managed resource.
    ParentId string
    Link a project to an organization or organizational unit by using its ID. To set up proper dependencies please refer to this variable as a reference.
    PaymentMethod string
    The payment type used for this project. For example,card.
    Project string
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.
    Tags List<GetProjectTag>
    Tags are key-value pairs that allow you to categorize projects.
    TechnicalEmails List<string>
    The email addresses for project contacts, who will receive important alerts and updates about this project and its services. You can also set email contacts at the service level. It's good practice to keep these up-to-date to be aware of any potential issues with your project.
    UseSourceProjectBillingGroup bool
    Use the same billing group that is used in source project.
    AccountId string
    Link a project to an existing account using its account ID. This field is deprecated. Use parent_id instead. To set up proper dependencies please refer to this variable as a reference.
    AddAccountOwnersAdminAccess bool
    If parent_id is set, grant account owner team admin access to the new project. The default value is true.
    AvailableCredits string
    The number of trial or promotional credits remaining for this project.
    BillingGroup string
    The ID of the billing group this project is assigned to. To set up proper dependencies please refer to this variable as a reference.
    CaCert string
    The CA certificate for the project. This is required for configuring clients that connect to certain services like Kafka.
    CopyFromProject string
    The name of the project to copy billing information, technical contacts, and some other project attributes from. This is most useful to set up the same billing method when you use bank transfers to pay invoices for other projects. You can only do this when creating a project. You can't set the billing over the API for an existing. To set up proper dependencies please refer to this variable as a reference.
    DefaultCloud string
    Default cloud provider and region where services are hosted. This can be changed after the project is created and will not affect existing services.
    EstimatedBalance string
    The monthly running estimate for this project for the current billing period.
    Id string
    The provider-assigned unique ID for this managed resource.
    ParentId string
    Link a project to an organization or organizational unit by using its ID. To set up proper dependencies please refer to this variable as a reference.
    PaymentMethod string
    The payment type used for this project. For example,card.
    Project string
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.
    Tags []GetProjectTag
    Tags are key-value pairs that allow you to categorize projects.
    TechnicalEmails []string
    The email addresses for project contacts, who will receive important alerts and updates about this project and its services. You can also set email contacts at the service level. It's good practice to keep these up-to-date to be aware of any potential issues with your project.
    UseSourceProjectBillingGroup bool
    Use the same billing group that is used in source project.
    accountId String
    Link a project to an existing account using its account ID. This field is deprecated. Use parent_id instead. To set up proper dependencies please refer to this variable as a reference.
    addAccountOwnersAdminAccess Boolean
    If parent_id is set, grant account owner team admin access to the new project. The default value is true.
    availableCredits String
    The number of trial or promotional credits remaining for this project.
    billingGroup String
    The ID of the billing group this project is assigned to. To set up proper dependencies please refer to this variable as a reference.
    caCert String
    The CA certificate for the project. This is required for configuring clients that connect to certain services like Kafka.
    copyFromProject String
    The name of the project to copy billing information, technical contacts, and some other project attributes from. This is most useful to set up the same billing method when you use bank transfers to pay invoices for other projects. You can only do this when creating a project. You can't set the billing over the API for an existing. To set up proper dependencies please refer to this variable as a reference.
    defaultCloud String
    Default cloud provider and region where services are hosted. This can be changed after the project is created and will not affect existing services.
    estimatedBalance String
    The monthly running estimate for this project for the current billing period.
    id String
    The provider-assigned unique ID for this managed resource.
    parentId String
    Link a project to an organization or organizational unit by using its ID. To set up proper dependencies please refer to this variable as a reference.
    paymentMethod String
    The payment type used for this project. For example,card.
    project String
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.
    tags List<GetProjectTag>
    Tags are key-value pairs that allow you to categorize projects.
    technicalEmails List<String>
    The email addresses for project contacts, who will receive important alerts and updates about this project and its services. You can also set email contacts at the service level. It's good practice to keep these up-to-date to be aware of any potential issues with your project.
    useSourceProjectBillingGroup Boolean
    Use the same billing group that is used in source project.
    accountId string
    Link a project to an existing account using its account ID. This field is deprecated. Use parent_id instead. To set up proper dependencies please refer to this variable as a reference.
    addAccountOwnersAdminAccess boolean
    If parent_id is set, grant account owner team admin access to the new project. The default value is true.
    availableCredits string
    The number of trial or promotional credits remaining for this project.
    billingGroup string
    The ID of the billing group this project is assigned to. To set up proper dependencies please refer to this variable as a reference.
    caCert string
    The CA certificate for the project. This is required for configuring clients that connect to certain services like Kafka.
    copyFromProject string
    The name of the project to copy billing information, technical contacts, and some other project attributes from. This is most useful to set up the same billing method when you use bank transfers to pay invoices for other projects. You can only do this when creating a project. You can't set the billing over the API for an existing. To set up proper dependencies please refer to this variable as a reference.
    defaultCloud string
    Default cloud provider and region where services are hosted. This can be changed after the project is created and will not affect existing services.
    estimatedBalance string
    The monthly running estimate for this project for the current billing period.
    id string
    The provider-assigned unique ID for this managed resource.
    parentId string
    Link a project to an organization or organizational unit by using its ID. To set up proper dependencies please refer to this variable as a reference.
    paymentMethod string
    The payment type used for this project. For example,card.
    project string
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.
    tags GetProjectTag[]
    Tags are key-value pairs that allow you to categorize projects.
    technicalEmails string[]
    The email addresses for project contacts, who will receive important alerts and updates about this project and its services. You can also set email contacts at the service level. It's good practice to keep these up-to-date to be aware of any potential issues with your project.
    useSourceProjectBillingGroup boolean
    Use the same billing group that is used in source project.
    account_id str
    Link a project to an existing account using its account ID. This field is deprecated. Use parent_id instead. To set up proper dependencies please refer to this variable as a reference.
    add_account_owners_admin_access bool
    If parent_id is set, grant account owner team admin access to the new project. The default value is true.
    available_credits str
    The number of trial or promotional credits remaining for this project.
    billing_group str
    The ID of the billing group this project is assigned to. To set up proper dependencies please refer to this variable as a reference.
    ca_cert str
    The CA certificate for the project. This is required for configuring clients that connect to certain services like Kafka.
    copy_from_project str
    The name of the project to copy billing information, technical contacts, and some other project attributes from. This is most useful to set up the same billing method when you use bank transfers to pay invoices for other projects. You can only do this when creating a project. You can't set the billing over the API for an existing. To set up proper dependencies please refer to this variable as a reference.
    default_cloud str
    Default cloud provider and region where services are hosted. This can be changed after the project is created and will not affect existing services.
    estimated_balance str
    The monthly running estimate for this project for the current billing period.
    id str
    The provider-assigned unique ID for this managed resource.
    parent_id str
    Link a project to an organization or organizational unit by using its ID. To set up proper dependencies please refer to this variable as a reference.
    payment_method str
    The payment type used for this project. For example,card.
    project str
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.
    tags Sequence[GetProjectTag]
    Tags are key-value pairs that allow you to categorize projects.
    technical_emails Sequence[str]
    The email addresses for project contacts, who will receive important alerts and updates about this project and its services. You can also set email contacts at the service level. It's good practice to keep these up-to-date to be aware of any potential issues with your project.
    use_source_project_billing_group bool
    Use the same billing group that is used in source project.
    accountId String
    Link a project to an existing account using its account ID. This field is deprecated. Use parent_id instead. To set up proper dependencies please refer to this variable as a reference.
    addAccountOwnersAdminAccess Boolean
    If parent_id is set, grant account owner team admin access to the new project. The default value is true.
    availableCredits String
    The number of trial or promotional credits remaining for this project.
    billingGroup String
    The ID of the billing group this project is assigned to. To set up proper dependencies please refer to this variable as a reference.
    caCert String
    The CA certificate for the project. This is required for configuring clients that connect to certain services like Kafka.
    copyFromProject String
    The name of the project to copy billing information, technical contacts, and some other project attributes from. This is most useful to set up the same billing method when you use bank transfers to pay invoices for other projects. You can only do this when creating a project. You can't set the billing over the API for an existing. To set up proper dependencies please refer to this variable as a reference.
    defaultCloud String
    Default cloud provider and region where services are hosted. This can be changed after the project is created and will not affect existing services.
    estimatedBalance String
    The monthly running estimate for this project for the current billing period.
    id String
    The provider-assigned unique ID for this managed resource.
    parentId String
    Link a project to an organization or organizational unit by using its ID. To set up proper dependencies please refer to this variable as a reference.
    paymentMethod String
    The payment type used for this project. For example,card.
    project String
    The name of the project. Names must be globally unique among all Aiven customers and cannot be changed later without destroying and re-creating the project, including all sub-resources.
    tags List<Property Map>
    Tags are key-value pairs that allow you to categorize projects.
    technicalEmails List<String>
    The email addresses for project contacts, who will receive important alerts and updates about this project and its services. You can also set email contacts at the service level. It's good practice to keep these up-to-date to be aware of any potential issues with your project.
    useSourceProjectBillingGroup Boolean
    Use the same billing group that is used in source project.

    Supporting Types

    GetProjectTag

    Key string
    Project tag key.
    Value string
    Project tag value.
    Key string
    Project tag key.
    Value string
    Project tag value.
    key String
    Project tag key.
    value String
    Project tag value.
    key string
    Project tag key.
    value string
    Project tag value.
    key str
    Project tag key.
    value str
    Project tag value.
    key String
    Project tag key.
    value String
    Project tag value.

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
    pulumi/pulumi-aiven