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

aiven.AlloydbomniDatabase

Explore with Pulumi AI

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

Creates and manages a database in an Aiven for AlloyDB Omni service.

This resource is in the beta stage and may change without notice. Set the PROVIDER_AIVEN_ENABLE_BETA environment variable to use the resource.

Create AlloydbomniDatabase Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AlloydbomniDatabase(name: string, args: AlloydbomniDatabaseArgs, opts?: CustomResourceOptions);
@overload
def AlloydbomniDatabase(resource_name: str,
                        args: AlloydbomniDatabaseArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def AlloydbomniDatabase(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        database_name: Optional[str] = None,
                        project: Optional[str] = None,
                        service_name: Optional[str] = None,
                        lc_collate: Optional[str] = None,
                        lc_ctype: Optional[str] = None)
func NewAlloydbomniDatabase(ctx *Context, name string, args AlloydbomniDatabaseArgs, opts ...ResourceOption) (*AlloydbomniDatabase, error)
public AlloydbomniDatabase(string name, AlloydbomniDatabaseArgs args, CustomResourceOptions? opts = null)
public AlloydbomniDatabase(String name, AlloydbomniDatabaseArgs args)
public AlloydbomniDatabase(String name, AlloydbomniDatabaseArgs args, CustomResourceOptions options)

type: aiven:AlloydbomniDatabase
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 This property is required. AlloydbomniDatabaseArgs
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 This property is required. AlloydbomniDatabaseArgs
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 This property is required. AlloydbomniDatabaseArgs
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 This property is required. AlloydbomniDatabaseArgs
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. AlloydbomniDatabaseArgs
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 alloydbomniDatabaseResource = new Aiven.AlloydbomniDatabase("alloydbomniDatabaseResource", new()
{
    DatabaseName = "string",
    Project = "string",
    ServiceName = "string",
    LcCollate = "string",
    LcCtype = "string",
});
Copy
example, err := aiven.NewAlloydbomniDatabase(ctx, "alloydbomniDatabaseResource", &aiven.AlloydbomniDatabaseArgs{
	DatabaseName: pulumi.String("string"),
	Project:      pulumi.String("string"),
	ServiceName:  pulumi.String("string"),
	LcCollate:    pulumi.String("string"),
	LcCtype:      pulumi.String("string"),
})
Copy
var alloydbomniDatabaseResource = new AlloydbomniDatabase("alloydbomniDatabaseResource", AlloydbomniDatabaseArgs.builder()
    .databaseName("string")
    .project("string")
    .serviceName("string")
    .lcCollate("string")
    .lcCtype("string")
    .build());
Copy
alloydbomni_database_resource = aiven.AlloydbomniDatabase("alloydbomniDatabaseResource",
    database_name="string",
    project="string",
    service_name="string",
    lc_collate="string",
    lc_ctype="string")
Copy
const alloydbomniDatabaseResource = new aiven.AlloydbomniDatabase("alloydbomniDatabaseResource", {
    databaseName: "string",
    project: "string",
    serviceName: "string",
    lcCollate: "string",
    lcCtype: "string",
});
Copy
type: aiven:AlloydbomniDatabase
properties:
    databaseName: string
    lcCollate: string
    lcCtype: string
    project: string
    serviceName: string
Copy

AlloydbomniDatabase 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 AlloydbomniDatabase resource accepts the following input properties:

DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the service database. Changing this property forces recreation of the resource.
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
LcCollate Changes to this property will trigger replacement. string
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
LcCtype Changes to this property will trigger replacement. string
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the service database. Changing this property forces recreation of the resource.
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
LcCollate Changes to this property will trigger replacement. string
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
LcCtype Changes to this property will trigger replacement. string
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the service database. Changing this property forces recreation of the resource.
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
lcCollate Changes to this property will trigger replacement. String
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
lcCtype Changes to this property will trigger replacement. String
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the service database. Changing this property forces recreation of the resource.
project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
lcCollate Changes to this property will trigger replacement. string
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
lcCtype Changes to this property will trigger replacement. string
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the service database. Changing this property forces recreation of the resource.
project
This property is required.
Changes to this property will trigger replacement.
str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
lc_collate Changes to this property will trigger replacement. str
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
lc_ctype Changes to this property will trigger replacement. str
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the service database. Changing this property forces recreation of the resource.
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
lcCollate Changes to this property will trigger replacement. String
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
lcCtype Changes to this property will trigger replacement. String
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the AlloydbomniDatabase 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 AlloydbomniDatabase Resource

Get an existing AlloydbomniDatabase 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?: AlloydbomniDatabaseState, opts?: CustomResourceOptions): AlloydbomniDatabase
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        database_name: Optional[str] = None,
        lc_collate: Optional[str] = None,
        lc_ctype: Optional[str] = None,
        project: Optional[str] = None,
        service_name: Optional[str] = None) -> AlloydbomniDatabase
func GetAlloydbomniDatabase(ctx *Context, name string, id IDInput, state *AlloydbomniDatabaseState, opts ...ResourceOption) (*AlloydbomniDatabase, error)
public static AlloydbomniDatabase Get(string name, Input<string> id, AlloydbomniDatabaseState? state, CustomResourceOptions? opts = null)
public static AlloydbomniDatabase get(String name, Output<String> id, AlloydbomniDatabaseState state, CustomResourceOptions options)
resources:  _:    type: aiven:AlloydbomniDatabase    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:
DatabaseName Changes to this property will trigger replacement. string
The name of the service database. Changing this property forces recreation of the resource.
LcCollate Changes to this property will trigger replacement. string
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
LcCtype Changes to this property will trigger replacement. string
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
Project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName Changes to this property will trigger replacement. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
DatabaseName Changes to this property will trigger replacement. string
The name of the service database. Changing this property forces recreation of the resource.
LcCollate Changes to this property will trigger replacement. string
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
LcCtype Changes to this property will trigger replacement. string
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
Project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName Changes to this property will trigger replacement. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
databaseName Changes to this property will trigger replacement. String
The name of the service database. Changing this property forces recreation of the resource.
lcCollate Changes to this property will trigger replacement. String
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
lcCtype Changes to this property will trigger replacement. String
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
project Changes to this property will trigger replacement. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName Changes to this property will trigger replacement. String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
databaseName Changes to this property will trigger replacement. string
The name of the service database. Changing this property forces recreation of the resource.
lcCollate Changes to this property will trigger replacement. string
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
lcCtype Changes to this property will trigger replacement. string
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName Changes to this property will trigger replacement. string
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
database_name Changes to this property will trigger replacement. str
The name of the service database. Changing this property forces recreation of the resource.
lc_collate Changes to this property will trigger replacement. str
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
lc_ctype Changes to this property will trigger replacement. str
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
project Changes to this property will trigger replacement. str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name Changes to this property will trigger replacement. str
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
databaseName Changes to this property will trigger replacement. String
The name of the service database. Changing this property forces recreation of the resource.
lcCollate Changes to this property will trigger replacement. String
Default string sort order (LC_COLLATE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
lcCtype Changes to this property will trigger replacement. String
Default character classification (LC_CTYPE) of the database. The default value is en_US.UTF-8. Changing this property forces recreation of the resource.
project Changes to this property will trigger replacement. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName Changes to this property will trigger replacement. String
The name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

Package Details

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