Aiven v6.0.2, Mar 23 23

aiven.getProject

The Project data source provides information about the existing Aiven Project.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var myproject = Aiven.GetProject.Invoke(new()
    {
        Project = "<PROJECT_NAME>",
    });

});

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: "<PROJECT_NAME>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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 myproject = AivenFunctions.getProject(GetProjectArgs.builder()
            .project("<PROJECT_NAME>")
            .build());

    }
}

import pulumi
import pulumi_aiven as aiven

myproject = aiven.get_project(project="<PROJECT_NAME>")

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

const myproject = aiven.getProject({
    project: "<PROJECT_NAME>",
});

variables:
  myproject:
    fn::invoke:
      Function: aiven:getProject
      Arguments:
        project: <PROJECT_NAME>

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)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Project string: Defines the name of the project. Name must be globally unique (between all Aiven customers) and cannot be changed later without destroying and re-creating the project, including all sub-resources.

Project string: Defines the name of the project. Name must be globally unique (between all Aiven customers) and cannot be changed later without destroying and re-creating the project, including all sub-resources.

project String: Defines the name of the project. Name must be globally unique (between all Aiven customers) and cannot be changed later without destroying and re-creating the project, including all sub-resources.

project string: Defines the name of the project. Name must be globally unique (between all Aiven customers) and cannot be changed later without destroying and re-creating the project, including all sub-resources.

project str: Defines the name of the project. Name must be globally unique (between all Aiven customers) and cannot be changed later without destroying and re-creating the project, including all sub-resources.

project String: Defines the name of the project. Name must be globally unique (between 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: An optional property to link a project to already an existing account by using account ID. To set up proper dependencies please refer to this variable as a reference.
AddAccountOwnersAdminAccess bool: If account_id is set, grant account owner team admin access to the new project. The default value is true.
AvailableCredits string: The amount of platform credits available to the project. This could be your free trial or other promotional credits.
BillingGroup string: The id of the billing group that is linked to this project. To set up proper dependencies please refer to this variable as a reference.
CaCert string: The CA certificate of the project. This is required for configuring clients that connect to certain services like Kafka.
CopyFromProject string: is the name of another project used to copy billing information and some other project attributes like technical contacts from. This is mostly relevant when an existing project has billing type set to invoice and that needs to be copied over to a new project. (Setting billing is otherwise not allowed over the API.) This only has effect when the project is created. To set up proper dependencies please refer to this variable as a reference.
DefaultCloud string: Defines the default cloud provider and region where services are hosted. This can be changed freely after the project is created. This will not affect existing services.
EstimatedBalance string: The current accumulated bill for this project in the current billing period.
Id string: The provider-assigned unique ID for this managed resource.
PaymentMethod string: The method of invoicing used for payments for this project, e.g. card.
Project string: Defines the name of the project. Name must be globally unique (between 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>: Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. It is good practice to keep this 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: An optional property to link a project to already an existing account by using account ID. To set up proper dependencies please refer to this variable as a reference.
AddAccountOwnersAdminAccess bool: If account_id is set, grant account owner team admin access to the new project. The default value is true.
AvailableCredits string: The amount of platform credits available to the project. This could be your free trial or other promotional credits.
BillingGroup string: The id of the billing group that is linked to this project. To set up proper dependencies please refer to this variable as a reference.
CaCert string: The CA certificate of the project. This is required for configuring clients that connect to certain services like Kafka.
CopyFromProject string: is the name of another project used to copy billing information and some other project attributes like technical contacts from. This is mostly relevant when an existing project has billing type set to invoice and that needs to be copied over to a new project. (Setting billing is otherwise not allowed over the API.) This only has effect when the project is created. To set up proper dependencies please refer to this variable as a reference.
DefaultCloud string: Defines the default cloud provider and region where services are hosted. This can be changed freely after the project is created. This will not affect existing services.
EstimatedBalance string: The current accumulated bill for this project in the current billing period.
Id string: The provider-assigned unique ID for this managed resource.
PaymentMethod string: The method of invoicing used for payments for this project, e.g. card.
Project string: Defines the name of the project. Name must be globally unique (between 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: Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. It is good practice to keep this 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: An optional property to link a project to already an existing account by using account ID. To set up proper dependencies please refer to this variable as a reference.
addAccountOwnersAdminAccess Boolean: If account_id is set, grant account owner team admin access to the new project. The default value is true.
availableCredits String: The amount of platform credits available to the project. This could be your free trial or other promotional credits.
billingGroup String: The id of the billing group that is linked to this project. To set up proper dependencies please refer to this variable as a reference.
caCert String: The CA certificate of the project. This is required for configuring clients that connect to certain services like Kafka.
copyFromProject String: is the name of another project used to copy billing information and some other project attributes like technical contacts from. This is mostly relevant when an existing project has billing type set to invoice and that needs to be copied over to a new project. (Setting billing is otherwise not allowed over the API.) This only has effect when the project is created. To set up proper dependencies please refer to this variable as a reference.
defaultCloud String: Defines the default cloud provider and region where services are hosted. This can be changed freely after the project is created. This will not affect existing services.
estimatedBalance String: The current accumulated bill for this project in the current billing period.
id String: The provider-assigned unique ID for this managed resource.
paymentMethod String: The method of invoicing used for payments for this project, e.g. card.
project String: Defines the name of the project. Name must be globally unique (between 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>: Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. It is good practice to keep this 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: An optional property to link a project to already an existing account by using account ID. To set up proper dependencies please refer to this variable as a reference.
addAccountOwnersAdminAccess boolean: If account_id is set, grant account owner team admin access to the new project. The default value is true.
availableCredits string: The amount of platform credits available to the project. This could be your free trial or other promotional credits.
billingGroup string: The id of the billing group that is linked to this project. To set up proper dependencies please refer to this variable as a reference.
caCert string: The CA certificate of the project. This is required for configuring clients that connect to certain services like Kafka.
copyFromProject string: is the name of another project used to copy billing information and some other project attributes like technical contacts from. This is mostly relevant when an existing project has billing type set to invoice and that needs to be copied over to a new project. (Setting billing is otherwise not allowed over the API.) This only has effect when the project is created. To set up proper dependencies please refer to this variable as a reference.
defaultCloud string: Defines the default cloud provider and region where services are hosted. This can be changed freely after the project is created. This will not affect existing services.
estimatedBalance string: The current accumulated bill for this project in the current billing period.
id string: The provider-assigned unique ID for this managed resource.
paymentMethod string: The method of invoicing used for payments for this project, e.g. card.
project string: Defines the name of the project. Name must be globally unique (between 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[]: Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. It is good practice to keep this 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: An optional property to link a project to already an existing account by using account ID. To set up proper dependencies please refer to this variable as a reference.
add_account_owners_admin_access bool: If account_id is set, grant account owner team admin access to the new project. The default value is true.
available_credits str: The amount of platform credits available to the project. This could be your free trial or other promotional credits.
billing_group str: The id of the billing group that is linked to this project. To set up proper dependencies please refer to this variable as a reference.
ca_cert str: The CA certificate of the project. This is required for configuring clients that connect to certain services like Kafka.
copy_from_project str: is the name of another project used to copy billing information and some other project attributes like technical contacts from. This is mostly relevant when an existing project has billing type set to invoice and that needs to be copied over to a new project. (Setting billing is otherwise not allowed over the API.) This only has effect when the project is created. To set up proper dependencies please refer to this variable as a reference.
default_cloud str: Defines the default cloud provider and region where services are hosted. This can be changed freely after the project is created. This will not affect existing services.
estimated_balance str: The current accumulated bill for this project in the current billing period.
id str: The provider-assigned unique ID for this managed resource.
payment_method str: The method of invoicing used for payments for this project, e.g. card.
project str: Defines the name of the project. Name must be globally unique (between 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]: Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. It is good practice to keep this 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: An optional property to link a project to already an existing account by using account ID. To set up proper dependencies please refer to this variable as a reference.
addAccountOwnersAdminAccess Boolean: If account_id is set, grant account owner team admin access to the new project. The default value is true.
availableCredits String: The amount of platform credits available to the project. This could be your free trial or other promotional credits.
billingGroup String: The id of the billing group that is linked to this project. To set up proper dependencies please refer to this variable as a reference.
caCert String: The CA certificate of the project. This is required for configuring clients that connect to certain services like Kafka.
copyFromProject String: is the name of another project used to copy billing information and some other project attributes like technical contacts from. This is mostly relevant when an existing project has billing type set to invoice and that needs to be copied over to a new project. (Setting billing is otherwise not allowed over the API.) This only has effect when the project is created. To set up proper dependencies please refer to this variable as a reference.
defaultCloud String: Defines the default cloud provider and region where services are hosted. This can be changed freely after the project is created. This will not affect existing services.
estimatedBalance String: The current accumulated bill for this project in the current billing period.
id String: The provider-assigned unique ID for this managed resource.
paymentMethod String: The method of invoicing used for payments for this project, e.g. card.
project String: Defines the name of the project. Name must be globally unique (between 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>: Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability. It is good practice to keep this 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
Value string

Key string
Value string

key String
value String

key string
value string

key str
value str

key String
value String

Package Details

Repository: Aiven pulumi/pulumi-aiven
License: Apache-2.0
Notes: This Pulumi package is based on the aiven Terraform Provider.