aiven.AlloydbomniDatabase
Explore with Pulumi AI
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",
});
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"),
})
var alloydbomniDatabaseResource = new AlloydbomniDatabase("alloydbomniDatabaseResource", AlloydbomniDatabaseArgs.builder()
.databaseName("string")
.project("string")
.serviceName("string")
.lcCollate("string")
.lcCtype("string")
.build());
alloydbomni_database_resource = aiven.AlloydbomniDatabase("alloydbomniDatabaseResource",
database_name="string",
project="string",
service_name="string",
lc_collate="string",
lc_ctype="string")
const alloydbomniDatabaseResource = new aiven.AlloydbomniDatabase("alloydbomniDatabaseResource", {
databaseName: "string",
project: "string",
serviceName: "string",
lcCollate: "string",
lcCtype: "string",
});
type: aiven:AlloydbomniDatabase
properties:
databaseName: string
lcCollate: string
lcCtype: string
project: string
serviceName: string
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:
- Database
Name This property is required. Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - Lc
Ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource.
- Database
Name This property is required. Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - Lc
Ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource.
- database
Name This property is required. Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - lc
Ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource.
- database
Name This property is required. Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - lc
Ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource.
- database_
name This property is required. Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - lc_
ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource.
- database
Name This property is required. Changes to this property will trigger replacement.
- 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.
- 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.
- 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.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - lc
Ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_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.
- Database
Name Changes to this property will trigger replacement.
- The name of the service database. Changing this property forces recreation of the resource.
- Lc
Collate Changes to this property will trigger replacement.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - Lc
Ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - Project
Changes to this property will trigger replacement.
- 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.
- 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.
- The name of the service database. Changing this property forces recreation of the resource.
- Lc
Collate Changes to this property will trigger replacement.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - Lc
Ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - Project
Changes to this property will trigger replacement.
- 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.
- 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.
- The name of the service database. Changing this property forces recreation of the resource.
- lc
Collate Changes to this property will trigger replacement.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - lc
Ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - project
Changes to this property will trigger replacement.
- 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.
- 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.
- The name of the service database. Changing this property forces recreation of the resource.
- lc
Collate Changes to this property will trigger replacement.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - lc
Ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - project
Changes to this property will trigger replacement.
- 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.
- 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.
- The name of the service database. Changing this property forces recreation of the resource.
- lc_
collate Changes to this property will trigger replacement.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - lc_
ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - project
Changes to this property will trigger replacement.
- 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.
- 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.
- The name of the service database. Changing this property forces recreation of the resource.
- lc
Collate Changes to this property will trigger replacement.
- Default string sort order (
LC_COLLATE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - lc
Ctype Changes to this property will trigger replacement.
- Default character classification (
LC_CTYPE
) of the database. The default value isen_US.UTF-8
. Changing this property forces recreation of the resource. - project
Changes to this property will trigger replacement.
- 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.
- 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.