Scaleway

Community
Package contributed by a community member
v0.3.0 published on Tuesday, Jun 7, 2022 by Lee Briggs

DatabaseInstance

Create a DatabaseInstance Resource

new DatabaseInstance(name: string, args: DatabaseInstanceArgs, opts?: CustomResourceOptions);
@overload
def DatabaseInstance(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     backup_same_region: Optional[bool] = None,
                     backup_schedule_frequency: Optional[int] = None,
                     backup_schedule_retention: Optional[int] = None,
                     disable_backup: Optional[bool] = None,
                     engine: Optional[str] = None,
                     is_ha_cluster: Optional[bool] = None,
                     name: Optional[str] = None,
                     node_type: Optional[str] = None,
                     password: Optional[str] = None,
                     private_network: Optional[DatabaseInstancePrivateNetworkArgs] = None,
                     project_id: Optional[str] = None,
                     region: Optional[str] = None,
                     settings: Optional[Mapping[str, str]] = None,
                     tags: Optional[Sequence[str]] = None,
                     user_name: Optional[str] = None,
                     volume_size_in_gb: Optional[int] = None,
                     volume_type: Optional[str] = None)
@overload
def DatabaseInstance(resource_name: str,
                     args: DatabaseInstanceArgs,
                     opts: Optional[ResourceOptions] = None)
func NewDatabaseInstance(ctx *Context, name string, args DatabaseInstanceArgs, opts ...ResourceOption) (*DatabaseInstance, error)
public DatabaseInstance(string name, DatabaseInstanceArgs args, CustomResourceOptions? opts = null)
public DatabaseInstance(String name, DatabaseInstanceArgs args)
public DatabaseInstance(String name, DatabaseInstanceArgs args, CustomResourceOptions options)
type: scaleway:DatabaseInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DatabaseInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DatabaseInstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DatabaseInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatabaseInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DatabaseInstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DatabaseInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DatabaseInstance resource accepts the following input properties:

Engine string

Database's engine version id

NodeType string

The type of database instance you want to create

BackupSameRegion bool

Boolean to store logical backups in the same region as the database instance

BackupScheduleFrequency int

Backup schedule frequency in hours

BackupScheduleRetention int

Backup schedule retention in days

DisableBackup bool

Disable automated backup for the database instance

IsHaCluster bool

Enable or disable high availability for the database instance

Name string

Name of the database instance

Password string

Password for the first user of the database instance

PrivateNetwork DatabaseInstancePrivateNetworkArgs

List of private network to expose your database instance

ProjectId string

The project_id you want to attach the resource to

Region string

The region you want to attach the resource to

Settings Dictionary<string, string>

Map of engine settings to be set.

Tags List<string>

List of tags ["tag1", "tag2", ...] attached to a database instance

UserName string

Identifier for the first user of the database instance

VolumeSizeInGb int

Volume size (in GB) when volume_type is not lssd

VolumeType string

Type of volume where data are stored

Engine string

Database's engine version id

NodeType string

The type of database instance you want to create

BackupSameRegion bool

Boolean to store logical backups in the same region as the database instance

BackupScheduleFrequency int

Backup schedule frequency in hours

BackupScheduleRetention int

Backup schedule retention in days

DisableBackup bool

Disable automated backup for the database instance

IsHaCluster bool

Enable or disable high availability for the database instance

Name string

Name of the database instance

Password string

Password for the first user of the database instance

PrivateNetwork DatabaseInstancePrivateNetworkArgs

List of private network to expose your database instance

ProjectId string

The project_id you want to attach the resource to

Region string

The region you want to attach the resource to

Settings map[string]string

Map of engine settings to be set.

Tags []string

List of tags ["tag1", "tag2", ...] attached to a database instance

UserName string

Identifier for the first user of the database instance

VolumeSizeInGb int

Volume size (in GB) when volume_type is not lssd

VolumeType string

Type of volume where data are stored

engine String

Database's engine version id

nodeType String

The type of database instance you want to create

backupSameRegion Boolean

Boolean to store logical backups in the same region as the database instance

backupScheduleFrequency Integer

Backup schedule frequency in hours

backupScheduleRetention Integer

Backup schedule retention in days

disableBackup Boolean

Disable automated backup for the database instance

isHaCluster Boolean

Enable or disable high availability for the database instance

name String

Name of the database instance

password String

Password for the first user of the database instance

privateNetwork DatabaseInstancePrivateNetworkArgs

List of private network to expose your database instance

projectId String

The project_id you want to attach the resource to

region String

The region you want to attach the resource to

settings Map<String,String>

Map of engine settings to be set.

tags List<String>

List of tags ["tag1", "tag2", ...] attached to a database instance

userName String

Identifier for the first user of the database instance

volumeSizeInGb Integer

Volume size (in GB) when volume_type is not lssd

volumeType String

Type of volume where data are stored

engine string

Database's engine version id

nodeType string

The type of database instance you want to create

backupSameRegion boolean

Boolean to store logical backups in the same region as the database instance

backupScheduleFrequency number

Backup schedule frequency in hours

backupScheduleRetention number

Backup schedule retention in days

disableBackup boolean

Disable automated backup for the database instance

isHaCluster boolean

Enable or disable high availability for the database instance

name string

Name of the database instance

password string

Password for the first user of the database instance

privateNetwork DatabaseInstancePrivateNetworkArgs

List of private network to expose your database instance

projectId string

The project_id you want to attach the resource to

region string

The region you want to attach the resource to

settings {[key: string]: string}

Map of engine settings to be set.

tags string[]

List of tags ["tag1", "tag2", ...] attached to a database instance

userName string

Identifier for the first user of the database instance

volumeSizeInGb number

Volume size (in GB) when volume_type is not lssd

volumeType string

Type of volume where data are stored

engine str

Database's engine version id

node_type str

The type of database instance you want to create

backup_same_region bool

Boolean to store logical backups in the same region as the database instance

backup_schedule_frequency int

Backup schedule frequency in hours

backup_schedule_retention int

Backup schedule retention in days

disable_backup bool

Disable automated backup for the database instance

is_ha_cluster bool

Enable or disable high availability for the database instance

name str

Name of the database instance

password str

Password for the first user of the database instance

private_network DatabaseInstancePrivateNetworkArgs

List of private network to expose your database instance

project_id str

The project_id you want to attach the resource to

region str

The region you want to attach the resource to

settings Mapping[str, str]

Map of engine settings to be set.

tags Sequence[str]

List of tags ["tag1", "tag2", ...] attached to a database instance

user_name str

Identifier for the first user of the database instance

volume_size_in_gb int

Volume size (in GB) when volume_type is not lssd

volume_type str

Type of volume where data are stored

engine String

Database's engine version id

nodeType String

The type of database instance you want to create

backupSameRegion Boolean

Boolean to store logical backups in the same region as the database instance

backupScheduleFrequency Number

Backup schedule frequency in hours

backupScheduleRetention Number

Backup schedule retention in days

disableBackup Boolean

Disable automated backup for the database instance

isHaCluster Boolean

Enable or disable high availability for the database instance

name String

Name of the database instance

password String

Password for the first user of the database instance

privateNetwork Property Map

List of private network to expose your database instance

projectId String

The project_id you want to attach the resource to

region String

The region you want to attach the resource to

settings Map<String>

Map of engine settings to be set.

tags List<String>

List of tags ["tag1", "tag2", ...] attached to a database instance

userName String

Identifier for the first user of the database instance

volumeSizeInGb Number

Volume size (in GB) when volume_type is not lssd

volumeType String

Type of volume where data are stored

Outputs

All input properties are implicitly available as output properties. Additionally, the DatabaseInstance resource produces the following output properties:

Certificate string

Certificate of the database instance

EndpointIp string

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

EndpointPort int

Endpoint port of the database instance

Id string

The provider-assigned unique ID for this managed resource.

LoadBalancers List<DatabaseInstanceLoadBalancer>

Load balancer of the database instance

OrganizationId string

The organization_id you want to attach the resource to

ReadReplicas List<DatabaseInstanceReadReplica>

Read replicas of the database instance

Certificate string

Certificate of the database instance

EndpointIp string

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

EndpointPort int

Endpoint port of the database instance

Id string

The provider-assigned unique ID for this managed resource.

LoadBalancers []DatabaseInstanceLoadBalancer

Load balancer of the database instance

OrganizationId string

The organization_id you want to attach the resource to

ReadReplicas []DatabaseInstanceReadReplica

Read replicas of the database instance

certificate String

Certificate of the database instance

endpointIp String

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

endpointPort Integer

Endpoint port of the database instance

id String

The provider-assigned unique ID for this managed resource.

loadBalancers List<DatabaseInstanceLoadBalancer>

Load balancer of the database instance

organizationId String

The organization_id you want to attach the resource to

readReplicas List<DatabaseInstanceReadReplica>

Read replicas of the database instance

certificate string

Certificate of the database instance

endpointIp string

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

endpointPort number

Endpoint port of the database instance

id string

The provider-assigned unique ID for this managed resource.

loadBalancers DatabaseInstanceLoadBalancer[]

Load balancer of the database instance

organizationId string

The organization_id you want to attach the resource to

readReplicas DatabaseInstanceReadReplica[]

Read replicas of the database instance

certificate str

Certificate of the database instance

endpoint_ip str

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

endpoint_port int

Endpoint port of the database instance

id str

The provider-assigned unique ID for this managed resource.

load_balancers Sequence[DatabaseInstanceLoadBalancer]

Load balancer of the database instance

organization_id str

The organization_id you want to attach the resource to

read_replicas Sequence[DatabaseInstanceReadReplica]

Read replicas of the database instance

certificate String

Certificate of the database instance

endpointIp String

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

endpointPort Number

Endpoint port of the database instance

id String

The provider-assigned unique ID for this managed resource.

loadBalancers List<Property Map>

Load balancer of the database instance

organizationId String

The organization_id you want to attach the resource to

readReplicas List<Property Map>

Read replicas of the database instance

Look up an Existing DatabaseInstance Resource

Get an existing DatabaseInstance 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?: DatabaseInstanceState, opts?: CustomResourceOptions): DatabaseInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_same_region: Optional[bool] = None,
        backup_schedule_frequency: Optional[int] = None,
        backup_schedule_retention: Optional[int] = None,
        certificate: Optional[str] = None,
        disable_backup: Optional[bool] = None,
        endpoint_ip: Optional[str] = None,
        endpoint_port: Optional[int] = None,
        engine: Optional[str] = None,
        is_ha_cluster: Optional[bool] = None,
        load_balancers: Optional[Sequence[DatabaseInstanceLoadBalancerArgs]] = None,
        name: Optional[str] = None,
        node_type: Optional[str] = None,
        organization_id: Optional[str] = None,
        password: Optional[str] = None,
        private_network: Optional[DatabaseInstancePrivateNetworkArgs] = None,
        project_id: Optional[str] = None,
        read_replicas: Optional[Sequence[DatabaseInstanceReadReplicaArgs]] = None,
        region: Optional[str] = None,
        settings: Optional[Mapping[str, str]] = None,
        tags: Optional[Sequence[str]] = None,
        user_name: Optional[str] = None,
        volume_size_in_gb: Optional[int] = None,
        volume_type: Optional[str] = None) -> DatabaseInstance
func GetDatabaseInstance(ctx *Context, name string, id IDInput, state *DatabaseInstanceState, opts ...ResourceOption) (*DatabaseInstance, error)
public static DatabaseInstance Get(string name, Input<string> id, DatabaseInstanceState? state, CustomResourceOptions? opts = null)
public static DatabaseInstance get(String name, Output<String> id, DatabaseInstanceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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
The unique name of the resulting resource.
id
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:
BackupSameRegion bool

Boolean to store logical backups in the same region as the database instance

BackupScheduleFrequency int

Backup schedule frequency in hours

BackupScheduleRetention int

Backup schedule retention in days

Certificate string

Certificate of the database instance

DisableBackup bool

Disable automated backup for the database instance

EndpointIp string

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

EndpointPort int

Endpoint port of the database instance

Engine string

Database's engine version id

IsHaCluster bool

Enable or disable high availability for the database instance

LoadBalancers List<DatabaseInstanceLoadBalancerArgs>

Load balancer of the database instance

Name string

Name of the database instance

NodeType string

The type of database instance you want to create

OrganizationId string

The organization_id you want to attach the resource to

Password string

Password for the first user of the database instance

PrivateNetwork DatabaseInstancePrivateNetworkArgs

List of private network to expose your database instance

ProjectId string

The project_id you want to attach the resource to

ReadReplicas List<DatabaseInstanceReadReplicaArgs>

Read replicas of the database instance

Region string

The region you want to attach the resource to

Settings Dictionary<string, string>

Map of engine settings to be set.

Tags List<string>

List of tags ["tag1", "tag2", ...] attached to a database instance

UserName string

Identifier for the first user of the database instance

VolumeSizeInGb int

Volume size (in GB) when volume_type is not lssd

VolumeType string

Type of volume where data are stored

BackupSameRegion bool

Boolean to store logical backups in the same region as the database instance

BackupScheduleFrequency int

Backup schedule frequency in hours

BackupScheduleRetention int

Backup schedule retention in days

Certificate string

Certificate of the database instance

DisableBackup bool

Disable automated backup for the database instance

EndpointIp string

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

EndpointPort int

Endpoint port of the database instance

Engine string

Database's engine version id

IsHaCluster bool

Enable or disable high availability for the database instance

LoadBalancers []DatabaseInstanceLoadBalancerArgs

Load balancer of the database instance

Name string

Name of the database instance

NodeType string

The type of database instance you want to create

OrganizationId string

The organization_id you want to attach the resource to

Password string

Password for the first user of the database instance

PrivateNetwork DatabaseInstancePrivateNetworkArgs

List of private network to expose your database instance

ProjectId string

The project_id you want to attach the resource to

ReadReplicas []DatabaseInstanceReadReplicaArgs

Read replicas of the database instance

Region string

The region you want to attach the resource to

Settings map[string]string

Map of engine settings to be set.

Tags []string

List of tags ["tag1", "tag2", ...] attached to a database instance

UserName string

Identifier for the first user of the database instance

VolumeSizeInGb int

Volume size (in GB) when volume_type is not lssd

VolumeType string

Type of volume where data are stored

backupSameRegion Boolean

Boolean to store logical backups in the same region as the database instance

backupScheduleFrequency Integer

Backup schedule frequency in hours

backupScheduleRetention Integer

Backup schedule retention in days

certificate String

Certificate of the database instance

disableBackup Boolean

Disable automated backup for the database instance

endpointIp String

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

endpointPort Integer

Endpoint port of the database instance

engine String

Database's engine version id

isHaCluster Boolean

Enable or disable high availability for the database instance

loadBalancers List<DatabaseInstanceLoadBalancerArgs>

Load balancer of the database instance

name String

Name of the database instance

nodeType String

The type of database instance you want to create

organizationId String

The organization_id you want to attach the resource to

password String

Password for the first user of the database instance

privateNetwork DatabaseInstancePrivateNetworkArgs

List of private network to expose your database instance

projectId String

The project_id you want to attach the resource to

readReplicas List<DatabaseInstanceReadReplicaArgs>

Read replicas of the database instance

region String

The region you want to attach the resource to

settings Map<String,String>

Map of engine settings to be set.

tags List<String>

List of tags ["tag1", "tag2", ...] attached to a database instance

userName String

Identifier for the first user of the database instance

volumeSizeInGb Integer

Volume size (in GB) when volume_type is not lssd

volumeType String

Type of volume where data are stored

backupSameRegion boolean

Boolean to store logical backups in the same region as the database instance

backupScheduleFrequency number

Backup schedule frequency in hours

backupScheduleRetention number

Backup schedule retention in days

certificate string

Certificate of the database instance

disableBackup boolean

Disable automated backup for the database instance

endpointIp string

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

endpointPort number

Endpoint port of the database instance

engine string

Database's engine version id

isHaCluster boolean

Enable or disable high availability for the database instance

loadBalancers DatabaseInstanceLoadBalancerArgs[]

Load balancer of the database instance

name string

Name of the database instance

nodeType string

The type of database instance you want to create

organizationId string

The organization_id you want to attach the resource to

password string

Password for the first user of the database instance

privateNetwork DatabaseInstancePrivateNetworkArgs

List of private network to expose your database instance

projectId string

The project_id you want to attach the resource to

readReplicas DatabaseInstanceReadReplicaArgs[]

Read replicas of the database instance

region string

The region you want to attach the resource to

settings {[key: string]: string}

Map of engine settings to be set.

tags string[]

List of tags ["tag1", "tag2", ...] attached to a database instance

userName string

Identifier for the first user of the database instance

volumeSizeInGb number

Volume size (in GB) when volume_type is not lssd

volumeType string

Type of volume where data are stored

backup_same_region bool

Boolean to store logical backups in the same region as the database instance

backup_schedule_frequency int

Backup schedule frequency in hours

backup_schedule_retention int

Backup schedule retention in days

certificate str

Certificate of the database instance

disable_backup bool

Disable automated backup for the database instance

endpoint_ip str

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

endpoint_port int

Endpoint port of the database instance

engine str

Database's engine version id

is_ha_cluster bool

Enable or disable high availability for the database instance

load_balancers Sequence[DatabaseInstanceLoadBalancerArgs]

Load balancer of the database instance

name str

Name of the database instance

node_type str

The type of database instance you want to create

organization_id str

The organization_id you want to attach the resource to

password str

Password for the first user of the database instance

private_network DatabaseInstancePrivateNetworkArgs

List of private network to expose your database instance

project_id str

The project_id you want to attach the resource to

read_replicas Sequence[DatabaseInstanceReadReplicaArgs]

Read replicas of the database instance

region str

The region you want to attach the resource to

settings Mapping[str, str]

Map of engine settings to be set.

tags Sequence[str]

List of tags ["tag1", "tag2", ...] attached to a database instance

user_name str

Identifier for the first user of the database instance

volume_size_in_gb int

Volume size (in GB) when volume_type is not lssd

volume_type str

Type of volume where data are stored

backupSameRegion Boolean

Boolean to store logical backups in the same region as the database instance

backupScheduleFrequency Number

Backup schedule frequency in hours

backupScheduleRetention Number

Backup schedule retention in days

certificate String

Certificate of the database instance

disableBackup Boolean

Disable automated backup for the database instance

endpointIp String

Endpoint IP of the database instance

Deprecated:

Please use the private_network or the load_balancer attribute

endpointPort Number

Endpoint port of the database instance

engine String

Database's engine version id

isHaCluster Boolean

Enable or disable high availability for the database instance

loadBalancers List<Property Map>

Load balancer of the database instance

name String

Name of the database instance

nodeType String

The type of database instance you want to create

organizationId String

The organization_id you want to attach the resource to

password String

Password for the first user of the database instance

privateNetwork Property Map

List of private network to expose your database instance

projectId String

The project_id you want to attach the resource to

readReplicas List<Property Map>

Read replicas of the database instance

region String

The region you want to attach the resource to

settings Map<String>

Map of engine settings to be set.

tags List<String>

List of tags ["tag1", "tag2", ...] attached to a database instance

userName String

Identifier for the first user of the database instance

volumeSizeInGb Number

Volume size (in GB) when volume_type is not lssd

volumeType String

Type of volume where data are stored

Supporting Types

DatabaseInstanceLoadBalancer

EndpointId string
Hostname string
Ip string
Name string
Port int
EndpointId string
Hostname string
Ip string
Name string
Port int
endpointId String
hostname String
ip String
name String
port Integer
endpointId string
hostname string
ip string
name string
port number
endpoint_id str
hostname str
ip str
name str
port int
endpointId String
hostname String
ip String
name String
port Number

DatabaseInstancePrivateNetwork

IpNet string
PnId string
EndpointId string
Hostname string
Ip string
Name string
Port int
Zone string
IpNet string
PnId string
EndpointId string
Hostname string
Ip string
Name string
Port int
Zone string
ipNet String
pnId String
endpointId String
hostname String
ip String
name String
port Integer
zone String
ipNet string
pnId string
endpointId string
hostname string
ip string
name string
port number
zone string
ip_net str
pn_id str
endpoint_id str
hostname str
ip str
name str
port int
zone str
ipNet String
pnId String
endpointId String
hostname String
ip String
name String
port Number
zone String

DatabaseInstanceReadReplica

Ip string
Name string
Port int
Ip string
Name string
Port int
ip String
name String
port Integer
ip string
name string
port number
ip str
name str
port int
ip String
name String
port Number

Package Details

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

This Pulumi package is based on the scaleway Terraform Provider.