Aiven

Pulumi Official
Package maintained by Pulumi
v4.5.1 published on Friday, Apr 22, 2022 by Pulumi

getProject

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

Example Usage

using Pulumi;
using Aiven = Pulumi.Aiven;

class MyStack : Stack
{
    public MyStack()
    {
        var myproject = Output.Create(Aiven.GetProject.InvokeAsync(new Aiven.GetProjectArgs
        {
            Project = "<PROJECT_NAME>",
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.LookupProject(ctx, &GetProjectArgs{
			Project: "<PROJECT_NAME>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

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 = pulumi.output(aiven.getProject({
    project: "<PROJECT_NAME>",
}));

Coming soon!

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.

BillingAddress string

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing name and address of the project.

BillingCurrency string

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing currency.

BillingEmails List<string>

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing contact emails of the project.

BillingExtraText string

DEPRECATED Please use aivenbillinggroup resource to set this value. Extra text to be included in all project invoices, e.g. purchase order or cost center number.

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.

CardId string

DEPRECATED Please use aivenbillinggroup resource to set this value. Either the full card UUID or the last 4 digits of the card. As the full UUID is not shown in the UI it is typically easier to use the last 4 digits to identify the card. This can be omitted if copy_from_project is used to copy billing info from another project.

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.

CountryCode string

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing country code of the project.

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.

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.

VatId string

DEPRECATED Please use aivenbillinggroup resource to set this value. EU VAT Identification Number.

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.

BillingAddress string

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing name and address of the project.

BillingCurrency string

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing currency.

BillingEmails []string

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing contact emails of the project.

BillingExtraText string

DEPRECATED Please use aivenbillinggroup resource to set this value. Extra text to be included in all project invoices, e.g. purchase order or cost center number.

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.

CardId string

DEPRECATED Please use aivenbillinggroup resource to set this value. Either the full card UUID or the last 4 digits of the card. As the full UUID is not shown in the UI it is typically easier to use the last 4 digits to identify the card. This can be omitted if copy_from_project is used to copy billing info from another project.

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.

CountryCode string

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing country code of the project.

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.

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.

VatId string

DEPRECATED Please use aivenbillinggroup resource to set this value. EU VAT Identification Number.

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.

billingAddress String

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing name and address of the project.

billingCurrency String

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing currency.

billingEmails List<String>

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing contact emails of the project.

billingExtraText String

DEPRECATED Please use aivenbillinggroup resource to set this value. Extra text to be included in all project invoices, e.g. purchase order or cost center number.

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.

cardId String

DEPRECATED Please use aivenbillinggroup resource to set this value. Either the full card UUID or the last 4 digits of the card. As the full UUID is not shown in the UI it is typically easier to use the last 4 digits to identify the card. This can be omitted if copy_from_project is used to copy billing info from another project.

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.

countryCode String

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing country code of the project.

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.

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.

vatId String

DEPRECATED Please use aivenbillinggroup resource to set this value. EU VAT Identification Number.

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.

billingAddress string

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing name and address of the project.

billingCurrency string

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing currency.

billingEmails string[]

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing contact emails of the project.

billingExtraText string

DEPRECATED Please use aivenbillinggroup resource to set this value. Extra text to be included in all project invoices, e.g. purchase order or cost center number.

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.

cardId string

DEPRECATED Please use aivenbillinggroup resource to set this value. Either the full card UUID or the last 4 digits of the card. As the full UUID is not shown in the UI it is typically easier to use the last 4 digits to identify the card. This can be omitted if copy_from_project is used to copy billing info from another project.

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.

countryCode string

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing country code of the project.

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.

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.

vatId string

DEPRECATED Please use aivenbillinggroup resource to set this value. EU VAT Identification Number.

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_address str

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing name and address of the project.

billing_currency str

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing currency.

billing_emails Sequence[str]

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing contact emails of the project.

billing_extra_text str

DEPRECATED Please use aivenbillinggroup resource to set this value. Extra text to be included in all project invoices, e.g. purchase order or cost center number.

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.

card_id str

DEPRECATED Please use aivenbillinggroup resource to set this value. Either the full card UUID or the last 4 digits of the card. As the full UUID is not shown in the UI it is typically easier to use the last 4 digits to identify the card. This can be omitted if copy_from_project is used to copy billing info from another project.

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.

country_code str

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing country code of the project.

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.

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.

vat_id str

DEPRECATED Please use aivenbillinggroup resource to set this value. EU VAT Identification Number.

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.

billingAddress String

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing name and address of the project.

billingCurrency String

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing currency.

billingEmails List<String>

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing contact emails of the project.

billingExtraText String

DEPRECATED Please use aivenbillinggroup resource to set this value. Extra text to be included in all project invoices, e.g. purchase order or cost center number.

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.

cardId String

DEPRECATED Please use aivenbillinggroup resource to set this value. Either the full card UUID or the last 4 digits of the card. As the full UUID is not shown in the UI it is typically easier to use the last 4 digits to identify the card. This can be omitted if copy_from_project is used to copy billing info from another project.

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.

countryCode String

DEPRECATED Please use aivenbillinggroup resource to set this value. Billing country code of the project.

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.

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.

vatId String

DEPRECATED Please use aivenbillinggroup resource to set this value. EU VAT Identification Number.

Package Details

Repository
https://github.com/pulumi/pulumi-aiven
License
Apache-2.0
Notes

This Pulumi package is based on the aiven Terraform Provider.