oci.Psql.DbSystem
Explore with Pulumi AI
This resource provides the Db System resource in Oracle Cloud Infrastructure Psql service.
Creates a new database system.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDbSystem = new oci.psql.DbSystem("test_db_system", {
compartmentId: compartmentId,
dbVersion: dbSystemDbVersion,
displayName: dbSystemDisplayName,
networkDetails: {
subnetId: testSubnet.id,
nsgIds: dbSystemNetworkDetailsNsgIds,
primaryDbEndpointPrivateIp: dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp,
},
shape: dbSystemShape,
storageDetails: {
isRegionallyDurable: dbSystemStorageDetailsIsRegionallyDurable,
systemType: dbSystemStorageDetailsSystemType,
availabilityDomain: dbSystemStorageDetailsAvailabilityDomain,
iops: dbSystemStorageDetailsIops,
},
configId: testConfig.id,
applyConfig: dbSystemApplyConfigType,
credentials: {
passwordDetails: {
passwordType: dbSystemCredentialsPasswordDetailsPasswordType,
password: dbSystemCredentialsPasswordDetailsPassword,
secretId: testSecret.id,
secretVersion: dbSystemCredentialsPasswordDetailsSecretVersion,
},
username: dbSystemCredentialsUsername,
},
definedTags: {
"foo-namespace.bar-key": "value",
},
description: dbSystemDescription,
freeformTags: {
"bar-key": "value",
},
instanceCount: dbSystemInstanceCount,
instanceMemorySizeInGbs: dbSystemInstanceMemorySizeInGbs,
instanceOcpuCount: dbSystemInstanceOcpuCount,
instancesDetails: [{
description: dbSystemInstancesDetailsDescription,
displayName: dbSystemInstancesDetailsDisplayName,
privateIp: dbSystemInstancesDetailsPrivateIp,
}],
managementPolicy: {
backupPolicy: {
backupStart: dbSystemManagementPolicyBackupPolicyBackupStart,
daysOfTheMonths: dbSystemManagementPolicyBackupPolicyDaysOfTheMonth,
daysOfTheWeeks: dbSystemManagementPolicyBackupPolicyDaysOfTheWeek,
kind: dbSystemManagementPolicyBackupPolicyKind,
retentionDays: dbSystemManagementPolicyBackupPolicyRetentionDays,
},
maintenanceWindowStart: dbSystemManagementPolicyMaintenanceWindowStart,
},
source: {
sourceType: dbSystemSourceSourceType,
backupId: testBackup.id,
isHavingRestoreConfigOverrides: dbSystemSourceIsHavingRestoreConfigOverrides,
},
systemType: dbSystemSystemType,
patchOperations: [{
operation: dbSystemPatchOperationsOperation,
selection: dbSystemPatchOperationsSelection,
value: dbSystemPatchOperationsValue,
}],
});
import pulumi
import pulumi_oci as oci
test_db_system = oci.psql.DbSystem("test_db_system",
compartment_id=compartment_id,
db_version=db_system_db_version,
display_name=db_system_display_name,
network_details=oci.psql.DbSystemNetworkDetailsArgs(
subnet_id=test_subnet["id"],
nsg_ids=db_system_network_details_nsg_ids,
primary_db_endpoint_private_ip=db_system_network_details_primary_db_endpoint_private_ip,
),
shape=db_system_shape,
storage_details=oci.psql.DbSystemStorageDetailsArgs(
is_regionally_durable=db_system_storage_details_is_regionally_durable,
system_type=db_system_storage_details_system_type,
availability_domain=db_system_storage_details_availability_domain,
iops=db_system_storage_details_iops,
),
config_id=test_config["id"],
apply_config=db_system_apply_config_type,
credentials=oci.psql.DbSystemCredentialsArgs(
password_details=oci.psql.DbSystemCredentialsPasswordDetailsArgs(
password_type=db_system_credentials_password_details_password_type,
password=db_system_credentials_password_details_password,
secret_id=test_secret["id"],
secret_version=db_system_credentials_password_details_secret_version,
),
username=db_system_credentials_username,
),
defined_tags={
"foo-namespace.bar-key": "value",
},
description=db_system_description,
freeform_tags={
"bar-key": "value",
},
instance_count=db_system_instance_count,
instance_memory_size_in_gbs=db_system_instance_memory_size_in_gbs,
instance_ocpu_count=db_system_instance_ocpu_count,
instances_details=[oci.psql.DbSystemInstancesDetailArgs(
description=db_system_instances_details_description,
display_name=db_system_instances_details_display_name,
private_ip=db_system_instances_details_private_ip,
)],
management_policy=oci.psql.DbSystemManagementPolicyArgs(
backup_policy=oci.psql.DbSystemManagementPolicyBackupPolicyArgs(
backup_start=db_system_management_policy_backup_policy_backup_start,
days_of_the_months=db_system_management_policy_backup_policy_days_of_the_month,
days_of_the_weeks=db_system_management_policy_backup_policy_days_of_the_week,
kind=db_system_management_policy_backup_policy_kind,
retention_days=db_system_management_policy_backup_policy_retention_days,
),
maintenance_window_start=db_system_management_policy_maintenance_window_start,
),
source=oci.psql.DbSystemSourceArgs(
source_type=db_system_source_source_type,
backup_id=test_backup["id"],
is_having_restore_config_overrides=db_system_source_is_having_restore_config_overrides,
),
system_type=db_system_system_type,
patch_operations=[oci.psql.DbSystemPatchOperationArgs(
operation=db_system_patch_operations_operation,
selection=db_system_patch_operations_selection,
value=db_system_patch_operations_value,
)])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/Psql"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Psql.NewDbSystem(ctx, "test_db_system", &Psql.DbSystemArgs{
CompartmentId: pulumi.Any(compartmentId),
DbVersion: pulumi.Any(dbSystemDbVersion),
DisplayName: pulumi.Any(dbSystemDisplayName),
NetworkDetails: &psql.DbSystemNetworkDetailsArgs{
SubnetId: pulumi.Any(testSubnet.Id),
NsgIds: pulumi.Any(dbSystemNetworkDetailsNsgIds),
PrimaryDbEndpointPrivateIp: pulumi.Any(dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp),
},
Shape: pulumi.Any(dbSystemShape),
StorageDetails: &psql.DbSystemStorageDetailsArgs{
IsRegionallyDurable: pulumi.Any(dbSystemStorageDetailsIsRegionallyDurable),
SystemType: pulumi.Any(dbSystemStorageDetailsSystemType),
AvailabilityDomain: pulumi.Any(dbSystemStorageDetailsAvailabilityDomain),
Iops: pulumi.Any(dbSystemStorageDetailsIops),
},
ConfigId: pulumi.Any(testConfig.Id),
ApplyConfig: pulumi.Any(dbSystemApplyConfigType),
Credentials: &psql.DbSystemCredentialsArgs{
PasswordDetails: &psql.DbSystemCredentialsPasswordDetailsArgs{
PasswordType: pulumi.Any(dbSystemCredentialsPasswordDetailsPasswordType),
Password: pulumi.Any(dbSystemCredentialsPasswordDetailsPassword),
SecretId: pulumi.Any(testSecret.Id),
SecretVersion: pulumi.Any(dbSystemCredentialsPasswordDetailsSecretVersion),
},
Username: pulumi.Any(dbSystemCredentialsUsername),
},
DefinedTags: pulumi.Map{
"foo-namespace.bar-key": pulumi.Any("value"),
},
Description: pulumi.Any(dbSystemDescription),
FreeformTags: pulumi.Map{
"bar-key": pulumi.Any("value"),
},
InstanceCount: pulumi.Any(dbSystemInstanceCount),
InstanceMemorySizeInGbs: pulumi.Any(dbSystemInstanceMemorySizeInGbs),
InstanceOcpuCount: pulumi.Any(dbSystemInstanceOcpuCount),
InstancesDetails: psql.DbSystemInstancesDetailArray{
&psql.DbSystemInstancesDetailArgs{
Description: pulumi.Any(dbSystemInstancesDetailsDescription),
DisplayName: pulumi.Any(dbSystemInstancesDetailsDisplayName),
PrivateIp: pulumi.Any(dbSystemInstancesDetailsPrivateIp),
},
},
ManagementPolicy: &psql.DbSystemManagementPolicyArgs{
BackupPolicy: &psql.DbSystemManagementPolicyBackupPolicyArgs{
BackupStart: pulumi.Any(dbSystemManagementPolicyBackupPolicyBackupStart),
DaysOfTheMonths: pulumi.Any(dbSystemManagementPolicyBackupPolicyDaysOfTheMonth),
DaysOfTheWeeks: pulumi.Any(dbSystemManagementPolicyBackupPolicyDaysOfTheWeek),
Kind: pulumi.Any(dbSystemManagementPolicyBackupPolicyKind),
RetentionDays: pulumi.Any(dbSystemManagementPolicyBackupPolicyRetentionDays),
},
MaintenanceWindowStart: pulumi.Any(dbSystemManagementPolicyMaintenanceWindowStart),
},
Source: &psql.DbSystemSourceArgs{
SourceType: pulumi.Any(dbSystemSourceSourceType),
BackupId: pulumi.Any(testBackup.Id),
IsHavingRestoreConfigOverrides: pulumi.Any(dbSystemSourceIsHavingRestoreConfigOverrides),
},
SystemType: pulumi.Any(dbSystemSystemType),
PatchOperations: psql.DbSystemPatchOperationArray{
&psql.DbSystemPatchOperationArgs{
Operation: pulumi.Any(dbSystemPatchOperationsOperation),
Selection: pulumi.Any(dbSystemPatchOperationsSelection),
Value: pulumi.Any(dbSystemPatchOperationsValue),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testDbSystem = new Oci.Psql.DbSystem("test_db_system", new()
{
CompartmentId = compartmentId,
DbVersion = dbSystemDbVersion,
DisplayName = dbSystemDisplayName,
NetworkDetails = new Oci.Psql.Inputs.DbSystemNetworkDetailsArgs
{
SubnetId = testSubnet.Id,
NsgIds = dbSystemNetworkDetailsNsgIds,
PrimaryDbEndpointPrivateIp = dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp,
},
Shape = dbSystemShape,
StorageDetails = new Oci.Psql.Inputs.DbSystemStorageDetailsArgs
{
IsRegionallyDurable = dbSystemStorageDetailsIsRegionallyDurable,
SystemType = dbSystemStorageDetailsSystemType,
AvailabilityDomain = dbSystemStorageDetailsAvailabilityDomain,
Iops = dbSystemStorageDetailsIops,
},
ConfigId = testConfig.Id,
ApplyConfig = dbSystemApplyConfigType,
Credentials = new Oci.Psql.Inputs.DbSystemCredentialsArgs
{
PasswordDetails = new Oci.Psql.Inputs.DbSystemCredentialsPasswordDetailsArgs
{
PasswordType = dbSystemCredentialsPasswordDetailsPasswordType,
Password = dbSystemCredentialsPasswordDetailsPassword,
SecretId = testSecret.Id,
SecretVersion = dbSystemCredentialsPasswordDetailsSecretVersion,
},
Username = dbSystemCredentialsUsername,
},
DefinedTags =
{
{ "foo-namespace.bar-key", "value" },
},
Description = dbSystemDescription,
FreeformTags =
{
{ "bar-key", "value" },
},
InstanceCount = dbSystemInstanceCount,
InstanceMemorySizeInGbs = dbSystemInstanceMemorySizeInGbs,
InstanceOcpuCount = dbSystemInstanceOcpuCount,
InstancesDetails = new[]
{
new Oci.Psql.Inputs.DbSystemInstancesDetailArgs
{
Description = dbSystemInstancesDetailsDescription,
DisplayName = dbSystemInstancesDetailsDisplayName,
PrivateIp = dbSystemInstancesDetailsPrivateIp,
},
},
ManagementPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyArgs
{
BackupPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyBackupPolicyArgs
{
BackupStart = dbSystemManagementPolicyBackupPolicyBackupStart,
DaysOfTheMonths = dbSystemManagementPolicyBackupPolicyDaysOfTheMonth,
DaysOfTheWeeks = dbSystemManagementPolicyBackupPolicyDaysOfTheWeek,
Kind = dbSystemManagementPolicyBackupPolicyKind,
RetentionDays = dbSystemManagementPolicyBackupPolicyRetentionDays,
},
MaintenanceWindowStart = dbSystemManagementPolicyMaintenanceWindowStart,
},
Source = new Oci.Psql.Inputs.DbSystemSourceArgs
{
SourceType = dbSystemSourceSourceType,
BackupId = testBackup.Id,
IsHavingRestoreConfigOverrides = dbSystemSourceIsHavingRestoreConfigOverrides,
},
SystemType = dbSystemSystemType,
PatchOperations = new[]
{
new Oci.Psql.Inputs.DbSystemPatchOperationArgs
{
Operation = dbSystemPatchOperationsOperation,
Selection = dbSystemPatchOperationsSelection,
Value = dbSystemPatchOperationsValue,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Psql.DbSystem;
import com.pulumi.oci.Psql.DbSystemArgs;
import com.pulumi.oci.Psql.inputs.DbSystemNetworkDetailsArgs;
import com.pulumi.oci.Psql.inputs.DbSystemStorageDetailsArgs;
import com.pulumi.oci.Psql.inputs.DbSystemCredentialsArgs;
import com.pulumi.oci.Psql.inputs.DbSystemCredentialsPasswordDetailsArgs;
import com.pulumi.oci.Psql.inputs.DbSystemInstancesDetailArgs;
import com.pulumi.oci.Psql.inputs.DbSystemManagementPolicyArgs;
import com.pulumi.oci.Psql.inputs.DbSystemManagementPolicyBackupPolicyArgs;
import com.pulumi.oci.Psql.inputs.DbSystemSourceArgs;
import com.pulumi.oci.Psql.inputs.DbSystemPatchOperationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testDbSystem = new DbSystem("testDbSystem", DbSystemArgs.builder()
.compartmentId(compartmentId)
.dbVersion(dbSystemDbVersion)
.displayName(dbSystemDisplayName)
.networkDetails(DbSystemNetworkDetailsArgs.builder()
.subnetId(testSubnet.id())
.nsgIds(dbSystemNetworkDetailsNsgIds)
.primaryDbEndpointPrivateIp(dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp)
.build())
.shape(dbSystemShape)
.storageDetails(DbSystemStorageDetailsArgs.builder()
.isRegionallyDurable(dbSystemStorageDetailsIsRegionallyDurable)
.systemType(dbSystemStorageDetailsSystemType)
.availabilityDomain(dbSystemStorageDetailsAvailabilityDomain)
.iops(dbSystemStorageDetailsIops)
.build())
.configId(testConfig.id())
.applyConfig(dbSystemApplyConfigType)
.credentials(DbSystemCredentialsArgs.builder()
.passwordDetails(DbSystemCredentialsPasswordDetailsArgs.builder()
.passwordType(dbSystemCredentialsPasswordDetailsPasswordType)
.password(dbSystemCredentialsPasswordDetailsPassword)
.secretId(testSecret.id())
.secretVersion(dbSystemCredentialsPasswordDetailsSecretVersion)
.build())
.username(dbSystemCredentialsUsername)
.build())
.definedTags(Map.of("foo-namespace.bar-key", "value"))
.description(dbSystemDescription)
.freeformTags(Map.of("bar-key", "value"))
.instanceCount(dbSystemInstanceCount)
.instanceMemorySizeInGbs(dbSystemInstanceMemorySizeInGbs)
.instanceOcpuCount(dbSystemInstanceOcpuCount)
.instancesDetails(DbSystemInstancesDetailArgs.builder()
.description(dbSystemInstancesDetailsDescription)
.displayName(dbSystemInstancesDetailsDisplayName)
.privateIp(dbSystemInstancesDetailsPrivateIp)
.build())
.managementPolicy(DbSystemManagementPolicyArgs.builder()
.backupPolicy(DbSystemManagementPolicyBackupPolicyArgs.builder()
.backupStart(dbSystemManagementPolicyBackupPolicyBackupStart)
.daysOfTheMonths(dbSystemManagementPolicyBackupPolicyDaysOfTheMonth)
.daysOfTheWeeks(dbSystemManagementPolicyBackupPolicyDaysOfTheWeek)
.kind(dbSystemManagementPolicyBackupPolicyKind)
.retentionDays(dbSystemManagementPolicyBackupPolicyRetentionDays)
.build())
.maintenanceWindowStart(dbSystemManagementPolicyMaintenanceWindowStart)
.build())
.source(DbSystemSourceArgs.builder()
.sourceType(dbSystemSourceSourceType)
.backupId(testBackup.id())
.isHavingRestoreConfigOverrides(dbSystemSourceIsHavingRestoreConfigOverrides)
.build())
.systemType(dbSystemSystemType)
.patchOperations(DbSystemPatchOperationArgs.builder()
.operation(dbSystemPatchOperationsOperation)
.selection(dbSystemPatchOperationsSelection)
.value(dbSystemPatchOperationsValue)
.build())
.build());
}
}
resources:
testDbSystem:
type: oci:Psql:DbSystem
name: test_db_system
properties:
compartmentId: ${compartmentId}
dbVersion: ${dbSystemDbVersion}
displayName: ${dbSystemDisplayName}
networkDetails:
subnetId: ${testSubnet.id}
nsgIds: ${dbSystemNetworkDetailsNsgIds}
primaryDbEndpointPrivateIp: ${dbSystemNetworkDetailsPrimaryDbEndpointPrivateIp}
shape: ${dbSystemShape}
storageDetails:
isRegionallyDurable: ${dbSystemStorageDetailsIsRegionallyDurable}
systemType: ${dbSystemStorageDetailsSystemType}
availabilityDomain: ${dbSystemStorageDetailsAvailabilityDomain}
iops: ${dbSystemStorageDetailsIops}
configId: ${testConfig.id}
applyConfig: ${dbSystemApplyConfigType}
credentials:
passwordDetails:
passwordType: ${dbSystemCredentialsPasswordDetailsPasswordType}
password: ${dbSystemCredentialsPasswordDetailsPassword}
secretId: ${testSecret.id}
secretVersion: ${dbSystemCredentialsPasswordDetailsSecretVersion}
username: ${dbSystemCredentialsUsername}
definedTags:
foo-namespace.bar-key: value
description: ${dbSystemDescription}
freeformTags:
bar-key: value
instanceCount: ${dbSystemInstanceCount}
instanceMemorySizeInGbs: ${dbSystemInstanceMemorySizeInGbs}
instanceOcpuCount: ${dbSystemInstanceOcpuCount}
instancesDetails:
- description: ${dbSystemInstancesDetailsDescription}
displayName: ${dbSystemInstancesDetailsDisplayName}
privateIp: ${dbSystemInstancesDetailsPrivateIp}
managementPolicy:
backupPolicy:
backupStart: ${dbSystemManagementPolicyBackupPolicyBackupStart}
daysOfTheMonths: ${dbSystemManagementPolicyBackupPolicyDaysOfTheMonth}
daysOfTheWeeks: ${dbSystemManagementPolicyBackupPolicyDaysOfTheWeek}
kind: ${dbSystemManagementPolicyBackupPolicyKind}
retentionDays: ${dbSystemManagementPolicyBackupPolicyRetentionDays}
maintenanceWindowStart: ${dbSystemManagementPolicyMaintenanceWindowStart}
source:
sourceType: ${dbSystemSourceSourceType}
backupId: ${testBackup.id}
isHavingRestoreConfigOverrides: ${dbSystemSourceIsHavingRestoreConfigOverrides}
systemType: ${dbSystemSystemType}
patchOperations:
- operation: ${dbSystemPatchOperationsOperation}
selection: ${dbSystemPatchOperationsSelection}
value: ${dbSystemPatchOperationsValue}
Create DbSystem Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DbSystem(name: string, args: DbSystemArgs, opts?: CustomResourceOptions);
@overload
def DbSystem(resource_name: str,
args: DbSystemArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DbSystem(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
compartment_id: Optional[str] = None,
storage_details: Optional[_psql.DbSystemStorageDetailsArgs] = None,
shape: Optional[str] = None,
db_version: Optional[str] = None,
network_details: Optional[_psql.DbSystemNetworkDetailsArgs] = None,
instance_memory_size_in_gbs: Optional[int] = None,
management_policy: Optional[_psql.DbSystemManagementPolicyArgs] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
instance_count: Optional[int] = None,
apply_config: Optional[str] = None,
instance_ocpu_count: Optional[int] = None,
instances_details: Optional[Sequence[_psql.DbSystemInstancesDetailArgs]] = None,
description: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
patch_operations: Optional[Sequence[_psql.DbSystemPatchOperationArgs]] = None,
credentials: Optional[_psql.DbSystemCredentialsArgs] = None,
source: Optional[_psql.DbSystemSourceArgs] = None,
config_id: Optional[str] = None,
system_type: Optional[str] = None)
func NewDbSystem(ctx *Context, name string, args DbSystemArgs, opts ...ResourceOption) (*DbSystem, error)
public DbSystem(string name, DbSystemArgs args, CustomResourceOptions? opts = null)
public DbSystem(String name, DbSystemArgs args)
public DbSystem(String name, DbSystemArgs args, CustomResourceOptions options)
type: oci:Psql:DbSystem
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DbSystemArgs
- 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 DbSystemArgs
- 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 DbSystemArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DbSystemArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DbSystemArgs
- 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 ociDbSystemResource = new Oci.Psql.DbSystem("ociDbSystemResource", new()
{
DisplayName = "string",
CompartmentId = "string",
StorageDetails = new Oci.Psql.Inputs.DbSystemStorageDetailsArgs
{
IsRegionallyDurable = false,
SystemType = "string",
AvailabilityDomain = "string",
Iops = "string",
},
Shape = "string",
DbVersion = "string",
NetworkDetails = new Oci.Psql.Inputs.DbSystemNetworkDetailsArgs
{
SubnetId = "string",
NsgIds = new[]
{
"string",
},
PrimaryDbEndpointPrivateIp = "string",
},
InstanceMemorySizeInGbs = 0,
ManagementPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyArgs
{
BackupPolicy = new Oci.Psql.Inputs.DbSystemManagementPolicyBackupPolicyArgs
{
BackupStart = "string",
DaysOfTheMonths = new[]
{
0,
},
DaysOfTheWeeks = new[]
{
"string",
},
Kind = "string",
RetentionDays = 0,
},
MaintenanceWindowStart = "string",
},
FreeformTags =
{
{ "string", "any" },
},
InstanceCount = 0,
ApplyConfig = "string",
InstanceOcpuCount = 0,
InstancesDetails = new[]
{
new Oci.Psql.Inputs.DbSystemInstancesDetailArgs
{
Description = "string",
DisplayName = "string",
PrivateIp = "string",
},
},
Description = "string",
DefinedTags =
{
{ "string", "any" },
},
PatchOperations = new[]
{
new Oci.Psql.Inputs.DbSystemPatchOperationArgs
{
Operation = "string",
Selection = "string",
From = "string",
Position = "string",
SelectedItem = "string",
Value =
{
{ "string", "any" },
},
},
},
Credentials = new Oci.Psql.Inputs.DbSystemCredentialsArgs
{
PasswordDetails = new Oci.Psql.Inputs.DbSystemCredentialsPasswordDetailsArgs
{
PasswordType = "string",
Password = "string",
SecretId = "string",
SecretVersion = "string",
},
Username = "string",
},
Source = new Oci.Psql.Inputs.DbSystemSourceArgs
{
SourceType = "string",
BackupId = "string",
IsHavingRestoreConfigOverrides = false,
},
ConfigId = "string",
SystemType = "string",
});
example, err := Psql.NewDbSystem(ctx, "ociDbSystemResource", &Psql.DbSystemArgs{
DisplayName: pulumi.String("string"),
CompartmentId: pulumi.String("string"),
StorageDetails: &psql.DbSystemStorageDetailsArgs{
IsRegionallyDurable: pulumi.Bool(false),
SystemType: pulumi.String("string"),
AvailabilityDomain: pulumi.String("string"),
Iops: pulumi.String("string"),
},
Shape: pulumi.String("string"),
DbVersion: pulumi.String("string"),
NetworkDetails: &psql.DbSystemNetworkDetailsArgs{
SubnetId: pulumi.String("string"),
NsgIds: pulumi.StringArray{
pulumi.String("string"),
},
PrimaryDbEndpointPrivateIp: pulumi.String("string"),
},
InstanceMemorySizeInGbs: pulumi.Int(0),
ManagementPolicy: &psql.DbSystemManagementPolicyArgs{
BackupPolicy: &psql.DbSystemManagementPolicyBackupPolicyArgs{
BackupStart: pulumi.String("string"),
DaysOfTheMonths: pulumi.IntArray{
pulumi.Int(0),
},
DaysOfTheWeeks: pulumi.StringArray{
pulumi.String("string"),
},
Kind: pulumi.String("string"),
RetentionDays: pulumi.Int(0),
},
MaintenanceWindowStart: pulumi.String("string"),
},
FreeformTags: pulumi.Map{
"string": pulumi.Any("any"),
},
InstanceCount: pulumi.Int(0),
ApplyConfig: pulumi.String("string"),
InstanceOcpuCount: pulumi.Int(0),
InstancesDetails: psql.DbSystemInstancesDetailArray{
&psql.DbSystemInstancesDetailArgs{
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
PrivateIp: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
DefinedTags: pulumi.Map{
"string": pulumi.Any("any"),
},
PatchOperations: psql.DbSystemPatchOperationArray{
&psql.DbSystemPatchOperationArgs{
Operation: pulumi.String("string"),
Selection: pulumi.String("string"),
From: pulumi.String("string"),
Position: pulumi.String("string"),
SelectedItem: pulumi.String("string"),
Value: pulumi.Map{
"string": pulumi.Any("any"),
},
},
},
Credentials: &psql.DbSystemCredentialsArgs{
PasswordDetails: &psql.DbSystemCredentialsPasswordDetailsArgs{
PasswordType: pulumi.String("string"),
Password: pulumi.String("string"),
SecretId: pulumi.String("string"),
SecretVersion: pulumi.String("string"),
},
Username: pulumi.String("string"),
},
Source: &psql.DbSystemSourceArgs{
SourceType: pulumi.String("string"),
BackupId: pulumi.String("string"),
IsHavingRestoreConfigOverrides: pulumi.Bool(false),
},
ConfigId: pulumi.String("string"),
SystemType: pulumi.String("string"),
})
var ociDbSystemResource = new DbSystem("ociDbSystemResource", DbSystemArgs.builder()
.displayName("string")
.compartmentId("string")
.storageDetails(DbSystemStorageDetailsArgs.builder()
.isRegionallyDurable(false)
.systemType("string")
.availabilityDomain("string")
.iops("string")
.build())
.shape("string")
.dbVersion("string")
.networkDetails(DbSystemNetworkDetailsArgs.builder()
.subnetId("string")
.nsgIds("string")
.primaryDbEndpointPrivateIp("string")
.build())
.instanceMemorySizeInGbs(0)
.managementPolicy(DbSystemManagementPolicyArgs.builder()
.backupPolicy(DbSystemManagementPolicyBackupPolicyArgs.builder()
.backupStart("string")
.daysOfTheMonths(0)
.daysOfTheWeeks("string")
.kind("string")
.retentionDays(0)
.build())
.maintenanceWindowStart("string")
.build())
.freeformTags(Map.of("string", "any"))
.instanceCount(0)
.applyConfig("string")
.instanceOcpuCount(0)
.instancesDetails(DbSystemInstancesDetailArgs.builder()
.description("string")
.displayName("string")
.privateIp("string")
.build())
.description("string")
.definedTags(Map.of("string", "any"))
.patchOperations(DbSystemPatchOperationArgs.builder()
.operation("string")
.selection("string")
.from("string")
.position("string")
.selectedItem("string")
.value(Map.of("string", "any"))
.build())
.credentials(DbSystemCredentialsArgs.builder()
.passwordDetails(DbSystemCredentialsPasswordDetailsArgs.builder()
.passwordType("string")
.password("string")
.secretId("string")
.secretVersion("string")
.build())
.username("string")
.build())
.source(DbSystemSourceArgs.builder()
.sourceType("string")
.backupId("string")
.isHavingRestoreConfigOverrides(false)
.build())
.configId("string")
.systemType("string")
.build());
oci_db_system_resource = oci.psql.DbSystem("ociDbSystemResource",
display_name="string",
compartment_id="string",
storage_details=oci.psql.DbSystemStorageDetailsArgs(
is_regionally_durable=False,
system_type="string",
availability_domain="string",
iops="string",
),
shape="string",
db_version="string",
network_details=oci.psql.DbSystemNetworkDetailsArgs(
subnet_id="string",
nsg_ids=["string"],
primary_db_endpoint_private_ip="string",
),
instance_memory_size_in_gbs=0,
management_policy=oci.psql.DbSystemManagementPolicyArgs(
backup_policy=oci.psql.DbSystemManagementPolicyBackupPolicyArgs(
backup_start="string",
days_of_the_months=[0],
days_of_the_weeks=["string"],
kind="string",
retention_days=0,
),
maintenance_window_start="string",
),
freeform_tags={
"string": "any",
},
instance_count=0,
apply_config="string",
instance_ocpu_count=0,
instances_details=[oci.psql.DbSystemInstancesDetailArgs(
description="string",
display_name="string",
private_ip="string",
)],
description="string",
defined_tags={
"string": "any",
},
patch_operations=[oci.psql.DbSystemPatchOperationArgs(
operation="string",
selection="string",
from_="string",
position="string",
selected_item="string",
value={
"string": "any",
},
)],
credentials=oci.psql.DbSystemCredentialsArgs(
password_details=oci.psql.DbSystemCredentialsPasswordDetailsArgs(
password_type="string",
password="string",
secret_id="string",
secret_version="string",
),
username="string",
),
source=oci.psql.DbSystemSourceArgs(
source_type="string",
backup_id="string",
is_having_restore_config_overrides=False,
),
config_id="string",
system_type="string")
const ociDbSystemResource = new oci.psql.DbSystem("ociDbSystemResource", {
displayName: "string",
compartmentId: "string",
storageDetails: {
isRegionallyDurable: false,
systemType: "string",
availabilityDomain: "string",
iops: "string",
},
shape: "string",
dbVersion: "string",
networkDetails: {
subnetId: "string",
nsgIds: ["string"],
primaryDbEndpointPrivateIp: "string",
},
instanceMemorySizeInGbs: 0,
managementPolicy: {
backupPolicy: {
backupStart: "string",
daysOfTheMonths: [0],
daysOfTheWeeks: ["string"],
kind: "string",
retentionDays: 0,
},
maintenanceWindowStart: "string",
},
freeformTags: {
string: "any",
},
instanceCount: 0,
applyConfig: "string",
instanceOcpuCount: 0,
instancesDetails: [{
description: "string",
displayName: "string",
privateIp: "string",
}],
description: "string",
definedTags: {
string: "any",
},
patchOperations: [{
operation: "string",
selection: "string",
from: "string",
position: "string",
selectedItem: "string",
value: {
string: "any",
},
}],
credentials: {
passwordDetails: {
passwordType: "string",
password: "string",
secretId: "string",
secretVersion: "string",
},
username: "string",
},
source: {
sourceType: "string",
backupId: "string",
isHavingRestoreConfigOverrides: false,
},
configId: "string",
systemType: "string",
});
type: oci:Psql:DbSystem
properties:
applyConfig: string
compartmentId: string
configId: string
credentials:
passwordDetails:
password: string
passwordType: string
secretId: string
secretVersion: string
username: string
dbVersion: string
definedTags:
string: any
description: string
displayName: string
freeformTags:
string: any
instanceCount: 0
instanceMemorySizeInGbs: 0
instanceOcpuCount: 0
instancesDetails:
- description: string
displayName: string
privateIp: string
managementPolicy:
backupPolicy:
backupStart: string
daysOfTheMonths:
- 0
daysOfTheWeeks:
- string
kind: string
retentionDays: 0
maintenanceWindowStart: string
networkDetails:
nsgIds:
- string
primaryDbEndpointPrivateIp: string
subnetId: string
patchOperations:
- from: string
operation: string
position: string
selectedItem: string
selection: string
value:
string: any
shape: string
source:
backupId: string
isHavingRestoreConfigOverrides: false
sourceType: string
storageDetails:
availabilityDomain: string
iops: string
isRegionallyDurable: false
systemType: string
systemType: string
DbSystem 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 DbSystem resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the database system.
- Db
Version string - Version of database system software.
- Display
Name string - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Network
Details DbSystem Network Details - Network details for the database system.
- Shape string
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - Storage
Details DbSystem Storage Details - (Updatable) Storage details of the database system.
- Apply
Config string - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- Config
Id string - The OCID of the configuration associated with the database system.
- Credentials
Db
System Credentials - Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- Dictionary<string, object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A user-provided description of a database system.
- Dictionary<string, object>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Instance
Count int - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- Instance
Memory intSize In Gbs - The total amount of memory available to each database instance node, in gigabytes.
- Instance
Ocpu intCount - The total number of OCPUs available to each database instance node.
- Instances
Details List<DbSystem Instances Detail> - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - Management
Policy DbSystem Management Policy - (Updatable) PostgreSQL database system management policy update details.
- Patch
Operations List<DbSystem Patch Operation> - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- Source
Db
System Source - The source used to restore the database system.
- System
Type string Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the database system.
- Db
Version string - Version of database system software.
- Display
Name string - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Network
Details DbSystem Network Details Args - Network details for the database system.
- Shape string
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - Storage
Details DbSystem Storage Details Args - (Updatable) Storage details of the database system.
- Apply
Config string - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- Config
Id string - The OCID of the configuration associated with the database system.
- Credentials
Db
System Credentials Args - Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- map[string]interface{}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A user-provided description of a database system.
- map[string]interface{}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Instance
Count int - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- Instance
Memory intSize In Gbs - The total amount of memory available to each database instance node, in gigabytes.
- Instance
Ocpu intCount - The total number of OCPUs available to each database instance node.
- Instances
Details []DbSystem Instances Detail Args - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - Management
Policy DbSystem Management Policy Args - (Updatable) PostgreSQL database system management policy update details.
- Patch
Operations []DbSystem Patch Operation Args - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- Source
Db
System Source Args - The source used to restore the database system.
- System
Type string Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) The OCID of the compartment that contains the database system.
- db
Version String - Version of database system software.
- display
Name String - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- network
Details DbSystem Network Details - Network details for the database system.
- shape String
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - storage
Details DbSystem Storage Details - (Updatable) Storage details of the database system.
- apply
Config String - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- config
Id String - The OCID of the configuration associated with the database system.
- credentials
Db
System Credentials - Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- Map<String,Object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A user-provided description of a database system.
- Map<String,Object>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- instance
Count Integer - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- instance
Memory IntegerSize In Gbs - The total amount of memory available to each database instance node, in gigabytes.
- instance
Ocpu IntegerCount - The total number of OCPUs available to each database instance node.
- instances
Details List<DbSystem Instances Detail> - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - management
Policy DbSystem Management Policy - (Updatable) PostgreSQL database system management policy update details.
- patch
Operations List<DbSystem Patch Operation> - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- source
Db
System Source - The source used to restore the database system.
- system
Type String Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id string - (Updatable) The OCID of the compartment that contains the database system.
- db
Version string - Version of database system software.
- display
Name string - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- network
Details DbSystem Network Details - Network details for the database system.
- shape string
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - storage
Details DbSystem Storage Details - (Updatable) Storage details of the database system.
- apply
Config string - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- config
Id string - The OCID of the configuration associated with the database system.
- credentials
Db
System Credentials - Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- {[key: string]: any}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description string
- (Updatable) A user-provided description of a database system.
- {[key: string]: any}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- instance
Count number - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- instance
Memory numberSize In Gbs - The total amount of memory available to each database instance node, in gigabytes.
- instance
Ocpu numberCount - The total number of OCPUs available to each database instance node.
- instances
Details DbSystem Instances Detail[] - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - management
Policy DbSystem Management Policy - (Updatable) PostgreSQL database system management policy update details.
- patch
Operations DbSystem Patch Operation[] - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- source
Db
System Source - The source used to restore the database system.
- system
Type string Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment_
id str - (Updatable) The OCID of the compartment that contains the database system.
- db_
version str - Version of database system software.
- display_
name str - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- network_
details psql.Db System Network Details Args - Network details for the database system.
- shape str
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - storage_
details psql.Db System Storage Details Args - (Updatable) Storage details of the database system.
- apply_
config str - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- config_
id str - The OCID of the configuration associated with the database system.
- credentials
psql.
Db System Credentials Args - Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- Mapping[str, Any]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description str
- (Updatable) A user-provided description of a database system.
- Mapping[str, Any]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- instance_
count int - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- instance_
memory_ intsize_ in_ gbs - The total amount of memory available to each database instance node, in gigabytes.
- instance_
ocpu_ intcount - The total number of OCPUs available to each database instance node.
- instances_
details Sequence[psql.Db System Instances Detail Args] - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - management_
policy psql.Db System Management Policy Args - (Updatable) PostgreSQL database system management policy update details.
- patch_
operations Sequence[psql.Db System Patch Operation Args] - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- source
psql.
Db System Source Args - The source used to restore the database system.
- system_
type str Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) The OCID of the compartment that contains the database system.
- db
Version String - Version of database system software.
- display
Name String - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- network
Details Property Map - Network details for the database system.
- shape String
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - storage
Details Property Map - (Updatable) Storage details of the database system.
- apply
Config String - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- config
Id String - The OCID of the configuration associated with the database system.
- credentials Property Map
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- Map<Any>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A user-provided description of a database system.
- Map<Any>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- instance
Count Number - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- instance
Memory NumberSize In Gbs - The total amount of memory available to each database instance node, in gigabytes.
- instance
Ocpu NumberCount - The total number of OCPUs available to each database instance node.
- instances
Details List<Property Map> - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - management
Policy Property Map - (Updatable) PostgreSQL database system management policy update details.
- patch
Operations List<Property Map> - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- source Property Map
- The source used to restore the database system.
- system
Type String Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Outputs
All input properties are implicitly available as output properties. Additionally, the DbSystem resource produces the following output properties:
- Admin
Username string - The database system administrator username.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instances
List<Db
System Instance> - The list of instances, or nodes, in the database system.
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- State string
- The current state of the database system.
- Dictionary<string, object>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- Admin
Username string - The database system administrator username.
- Id string
- The provider-assigned unique ID for this managed resource.
- Instances
[]Db
System Instance - The list of instances, or nodes, in the database system.
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- State string
- The current state of the database system.
- map[string]interface{}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- admin
Username String - The database system administrator username.
- id String
- The provider-assigned unique ID for this managed resource.
- instances
List<Db
System Instance> - The list of instances, or nodes, in the database system.
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state String
- The current state of the database system.
- Map<String,Object>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- admin
Username string - The database system administrator username.
- id string
- The provider-assigned unique ID for this managed resource.
- instances
Db
System Instance[] - The list of instances, or nodes, in the database system.
- lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state string
- The current state of the database system.
- {[key: string]: any}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time
Updated string - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- admin_
username str - The database system administrator username.
- id str
- The provider-assigned unique ID for this managed resource.
- instances
Sequence[psql.
Db System Instance] - The list of instances, or nodes, in the database system.
- lifecycle_
details str - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state str
- The current state of the database system.
- Mapping[str, Any]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time_
created str - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time_
updated str - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- admin
Username String - The database system administrator username.
- id String
- The provider-assigned unique ID for this managed resource.
- instances List<Property Map>
- The list of instances, or nodes, in the database system.
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state String
- The current state of the database system.
- Map<Any>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
Look up Existing DbSystem Resource
Get an existing DbSystem 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?: DbSystemState, opts?: CustomResourceOptions): DbSystem
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
admin_username: Optional[str] = None,
apply_config: Optional[str] = None,
compartment_id: Optional[str] = None,
config_id: Optional[str] = None,
credentials: Optional[_psql.DbSystemCredentialsArgs] = None,
db_version: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
instance_count: Optional[int] = None,
instance_memory_size_in_gbs: Optional[int] = None,
instance_ocpu_count: Optional[int] = None,
instances: Optional[Sequence[_psql.DbSystemInstanceArgs]] = None,
instances_details: Optional[Sequence[_psql.DbSystemInstancesDetailArgs]] = None,
lifecycle_details: Optional[str] = None,
management_policy: Optional[_psql.DbSystemManagementPolicyArgs] = None,
network_details: Optional[_psql.DbSystemNetworkDetailsArgs] = None,
patch_operations: Optional[Sequence[_psql.DbSystemPatchOperationArgs]] = None,
shape: Optional[str] = None,
source: Optional[_psql.DbSystemSourceArgs] = None,
state: Optional[str] = None,
storage_details: Optional[_psql.DbSystemStorageDetailsArgs] = None,
system_tags: Optional[Mapping[str, Any]] = None,
system_type: Optional[str] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> DbSystem
func GetDbSystem(ctx *Context, name string, id IDInput, state *DbSystemState, opts ...ResourceOption) (*DbSystem, error)
public static DbSystem Get(string name, Input<string> id, DbSystemState? state, CustomResourceOptions? opts = null)
public static DbSystem get(String name, Output<String> id, DbSystemState 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.
- Admin
Username string - The database system administrator username.
- Apply
Config string - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the database system.
- Config
Id string - The OCID of the configuration associated with the database system.
- Credentials
Db
System Credentials - Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- Db
Version string - Version of database system software.
- Dictionary<string, object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A user-provided description of a database system.
- Display
Name string - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Dictionary<string, object>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Instance
Count int - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- Instance
Memory intSize In Gbs - The total amount of memory available to each database instance node, in gigabytes.
- Instance
Ocpu intCount - The total number of OCPUs available to each database instance node.
- Instances
List<Db
System Instance> - The list of instances, or nodes, in the database system.
- Instances
Details List<DbSystem Instances Detail> - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Management
Policy DbSystem Management Policy - (Updatable) PostgreSQL database system management policy update details.
- Network
Details DbSystem Network Details - Network details for the database system.
- Patch
Operations List<DbSystem Patch Operation> - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- Shape string
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - Source
Db
System Source - The source used to restore the database system.
- State string
- The current state of the database system.
- Storage
Details DbSystem Storage Details - (Updatable) Storage details of the database system.
- Dictionary<string, object>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- System
Type string Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Time
Created string - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- Admin
Username string - The database system administrator username.
- Apply
Config string - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the database system.
- Config
Id string - The OCID of the configuration associated with the database system.
- Credentials
Db
System Credentials Args - Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- Db
Version string - Version of database system software.
- map[string]interface{}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Description string
- (Updatable) A user-provided description of a database system.
- Display
Name string - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- map[string]interface{}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Instance
Count int - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- Instance
Memory intSize In Gbs - The total amount of memory available to each database instance node, in gigabytes.
- Instance
Ocpu intCount - The total number of OCPUs available to each database instance node.
- Instances
[]Db
System Instance Args - The list of instances, or nodes, in the database system.
- Instances
Details []DbSystem Instances Detail Args - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Management
Policy DbSystem Management Policy Args - (Updatable) PostgreSQL database system management policy update details.
- Network
Details DbSystem Network Details Args - Network details for the database system.
- Patch
Operations []DbSystem Patch Operation Args - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- Shape string
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - Source
Db
System Source Args - The source used to restore the database system.
- State string
- The current state of the database system.
- Storage
Details DbSystem Storage Details Args - (Updatable) Storage details of the database system.
- map[string]interface{}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- System
Type string Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Time
Created string - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- admin
Username String - The database system administrator username.
- apply
Config String - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- compartment
Id String - (Updatable) The OCID of the compartment that contains the database system.
- config
Id String - The OCID of the configuration associated with the database system.
- credentials
Db
System Credentials - Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- db
Version String - Version of database system software.
- Map<String,Object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A user-provided description of a database system.
- display
Name String - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Map<String,Object>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- instance
Count Integer - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- instance
Memory IntegerSize In Gbs - The total amount of memory available to each database instance node, in gigabytes.
- instance
Ocpu IntegerCount - The total number of OCPUs available to each database instance node.
- instances
List<Db
System Instance> - The list of instances, or nodes, in the database system.
- instances
Details List<DbSystem Instances Detail> - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- management
Policy DbSystem Management Policy - (Updatable) PostgreSQL database system management policy update details.
- network
Details DbSystem Network Details - Network details for the database system.
- patch
Operations List<DbSystem Patch Operation> - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- shape String
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - source
Db
System Source - The source used to restore the database system.
- state String
- The current state of the database system.
- storage
Details DbSystem Storage Details - (Updatable) Storage details of the database system.
- Map<String,Object>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- system
Type String Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time
Created String - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- admin
Username string - The database system administrator username.
- apply
Config string - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- compartment
Id string - (Updatable) The OCID of the compartment that contains the database system.
- config
Id string - The OCID of the configuration associated with the database system.
- credentials
Db
System Credentials - Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- db
Version string - Version of database system software.
- {[key: string]: any}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description string
- (Updatable) A user-provided description of a database system.
- display
Name string - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- {[key: string]: any}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- instance
Count number - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- instance
Memory numberSize In Gbs - The total amount of memory available to each database instance node, in gigabytes.
- instance
Ocpu numberCount - The total number of OCPUs available to each database instance node.
- instances
Db
System Instance[] - The list of instances, or nodes, in the database system.
- instances
Details DbSystem Instances Detail[] - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- management
Policy DbSystem Management Policy - (Updatable) PostgreSQL database system management policy update details.
- network
Details DbSystem Network Details - Network details for the database system.
- patch
Operations DbSystem Patch Operation[] - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- shape string
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - source
Db
System Source - The source used to restore the database system.
- state string
- The current state of the database system.
- storage
Details DbSystem Storage Details - (Updatable) Storage details of the database system.
- {[key: string]: any}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- system
Type string Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time
Created string - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time
Updated string - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- admin_
username str - The database system administrator username.
- apply_
config str - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- compartment_
id str - (Updatable) The OCID of the compartment that contains the database system.
- config_
id str - The OCID of the configuration associated with the database system.
- credentials
psql.
Db System Credentials Args - Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- db_
version str - Version of database system software.
- Mapping[str, Any]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description str
- (Updatable) A user-provided description of a database system.
- display_
name str - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Mapping[str, Any]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- instance_
count int - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- instance_
memory_ intsize_ in_ gbs - The total amount of memory available to each database instance node, in gigabytes.
- instance_
ocpu_ intcount - The total number of OCPUs available to each database instance node.
- instances
Sequence[psql.
Db System Instance Args] - The list of instances, or nodes, in the database system.
- instances_
details Sequence[psql.Db System Instances Detail Args] - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - lifecycle_
details str - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- management_
policy psql.Db System Management Policy Args - (Updatable) PostgreSQL database system management policy update details.
- network_
details psql.Db System Network Details Args - Network details for the database system.
- patch_
operations Sequence[psql.Db System Patch Operation Args] - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- shape str
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - source
psql.
Db System Source Args - The source used to restore the database system.
- state str
- The current state of the database system.
- storage_
details psql.Db System Storage Details Args - (Updatable) Storage details of the database system.
- Mapping[str, Any]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- system_
type str Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time_
created str - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time_
updated str - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- admin
Username String - The database system administrator username.
- apply
Config String - Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. Apply config can be passed as
RESTART
orRELOAD
- compartment
Id String - (Updatable) The OCID of the compartment that contains the database system.
- config
Id String - The OCID of the configuration associated with the database system.
- credentials Property Map
- Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}.
- db
Version String - Version of database system software.
- Map<Any>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- description String
- (Updatable) A user-provided description of a database system.
- display
Name String - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Map<Any>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- instance
Count Number - (Updatable when patch_operations are specified) Count of database instances nodes to be created in the database system.
- instance
Memory NumberSize In Gbs - The total amount of memory available to each database instance node, in gigabytes.
- instance
Ocpu NumberCount - The total number of OCPUs available to each database instance node.
- instances List<Property Map>
- The list of instances, or nodes, in the database system.
- instances
Details List<Property Map> - Details of database instances nodes to be created. This parameter is optional. If specified, its size must match
instanceCount
. - lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- management
Policy Property Map - (Updatable) PostgreSQL database system management policy update details.
- network
Details Property Map - Network details for the database system.
- patch
Operations List<Property Map> - (Updatable) For adding and removing from read replica database instances. Please remove the patch_operations after it is applied. Update the instance_count arrodrandly. Cannot be specified when creating the resource.
- shape String
- The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example:
PostgreSQL.VM.Standard.E4.Flex.2.32GB
. Find more about the supported shapes here. - source Property Map
- The source used to restore the database system.
- state String
- The current state of the database system.
- storage
Details Property Map - (Updatable) Storage details of the database system.
- Map<Any>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- system
Type String Type of the database system.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time
Created String - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
Supporting Types
DbSystemCredentials, DbSystemCredentialsArgs
- Password
Details DbSystem Credentials Password Details - Details for the database system password. Password can be passed as
VaultSecretPasswordDetails
orPlainTextPasswordDetails
. - Username string
- The database system administrator username.
- Password
Details DbSystem Credentials Password Details - Details for the database system password. Password can be passed as
VaultSecretPasswordDetails
orPlainTextPasswordDetails
. - Username string
- The database system administrator username.
- password
Details DbSystem Credentials Password Details - Details for the database system password. Password can be passed as
VaultSecretPasswordDetails
orPlainTextPasswordDetails
. - username String
- The database system administrator username.
- password
Details DbSystem Credentials Password Details - Details for the database system password. Password can be passed as
VaultSecretPasswordDetails
orPlainTextPasswordDetails
. - username string
- The database system administrator username.
- password_
details psql.Db System Credentials Password Details - Details for the database system password. Password can be passed as
VaultSecretPasswordDetails
orPlainTextPasswordDetails
. - username str
- The database system administrator username.
- password
Details Property Map - Details for the database system password. Password can be passed as
VaultSecretPasswordDetails
orPlainTextPasswordDetails
. - username String
- The database system administrator username.
DbSystemCredentialsPasswordDetails, DbSystemCredentialsPasswordDetailsArgs
- Password
Type string - The password type.
- Password string
- The database system password.
- Secret
Id string - The OCID of the secret where the password is stored.
- Secret
Version string - The secret version of the stored password.
- Password
Type string - The password type.
- Password string
- The database system password.
- Secret
Id string - The OCID of the secret where the password is stored.
- Secret
Version string - The secret version of the stored password.
- password
Type String - The password type.
- password String
- The database system password.
- secret
Id String - The OCID of the secret where the password is stored.
- secret
Version String - The secret version of the stored password.
- password
Type string - The password type.
- password string
- The database system password.
- secret
Id string - The OCID of the secret where the password is stored.
- secret
Version string - The secret version of the stored password.
- password_
type str - The password type.
- password str
- The database system password.
- secret_
id str - The OCID of the secret where the password is stored.
- secret_
version str - The secret version of the stored password.
- password
Type String - The password type.
- password String
- The database system password.
- secret
Id String - The OCID of the secret where the password is stored.
- secret
Version String - The secret version of the stored password.
DbSystemInstance, DbSystemInstanceArgs
- Availability
Domain string - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - Description string
- (Updatable) A user-provided description of a database system.
- Display
Name string - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Id string
- A unique identifier for the database instance node. Immutable on creation.
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- State string
- The current state of the database system.
- Time
Created string - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- Availability
Domain string - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - Description string
- (Updatable) A user-provided description of a database system.
- Display
Name string - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- Id string
- A unique identifier for the database instance node. Immutable on creation.
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- State string
- The current state of the database system.
- Time
Created string - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- Time
Updated string - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- availability
Domain String - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - description String
- (Updatable) A user-provided description of a database system.
- display
Name String - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- id String
- A unique identifier for the database instance node. Immutable on creation.
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state String
- The current state of the database system.
- time
Created String - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- availability
Domain string - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - description string
- (Updatable) A user-provided description of a database system.
- display
Name string - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- id string
- A unique identifier for the database instance node. Immutable on creation.
- lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state string
- The current state of the database system.
- time
Created string - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time
Updated string - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- availability_
domain str - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - description str
- (Updatable) A user-provided description of a database system.
- display_
name str - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- id str
- A unique identifier for the database instance node. Immutable on creation.
- lifecycle_
details str - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state str
- The current state of the database system.
- time_
created str - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time_
updated str - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- availability
Domain String - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - description String
- (Updatable) A user-provided description of a database system.
- display
Name String - (Updatable) A user-friendly display name for the database system. Avoid entering confidential information.
- id String
- A unique identifier for the database instance node. Immutable on creation.
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- state String
- The current state of the database system.
- time
Created String - The date and time that the database system was created, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
- time
Updated String - The date and time that the database system was updated, expressed in RFC 3339 timestamp format. Example:
2016-08-25T21:10:29.600Z
DbSystemInstancesDetail, DbSystemInstancesDetailArgs
- Description string
- A user-provided description of the database instance node.
- Display
Name string - Display name of the database instance node. Avoid entering confidential information.
- Private
Ip string - Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
- Description string
- A user-provided description of the database instance node.
- Display
Name string - Display name of the database instance node. Avoid entering confidential information.
- Private
Ip string - Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
- description String
- A user-provided description of the database instance node.
- display
Name String - Display name of the database instance node. Avoid entering confidential information.
- private
Ip String - Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
- description string
- A user-provided description of the database instance node.
- display
Name string - Display name of the database instance node. Avoid entering confidential information.
- private
Ip string - Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
- description str
- A user-provided description of the database instance node.
- display_
name str - Display name of the database instance node. Avoid entering confidential information.
- private_
ip str - Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
- description String
- A user-provided description of the database instance node.
- display
Name String - Display name of the database instance node. Avoid entering confidential information.
- private
Ip String - Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet.
DbSystemManagementPolicy, DbSystemManagementPolicyArgs
- Backup
Policy DbSystem Management Policy Backup Policy - (Updatable) PostgreSQL database system backup policy.
- Maintenance
Window stringStart - (Updatable) The start of the maintenance window.
- Backup
Policy DbSystem Management Policy Backup Policy - (Updatable) PostgreSQL database system backup policy.
- Maintenance
Window stringStart - (Updatable) The start of the maintenance window.
- backup
Policy DbSystem Management Policy Backup Policy - (Updatable) PostgreSQL database system backup policy.
- maintenance
Window StringStart - (Updatable) The start of the maintenance window.
- backup
Policy DbSystem Management Policy Backup Policy - (Updatable) PostgreSQL database system backup policy.
- maintenance
Window stringStart - (Updatable) The start of the maintenance window.
- backup_
policy psql.Db System Management Policy Backup Policy - (Updatable) PostgreSQL database system backup policy.
- maintenance_
window_ strstart - (Updatable) The start of the maintenance window.
- backup
Policy Property Map - (Updatable) PostgreSQL database system backup policy.
- maintenance
Window StringStart - (Updatable) The start of the maintenance window.
DbSystemManagementPolicyBackupPolicy, DbSystemManagementPolicyBackupPolicyArgs
- Backup
Start string - (Updatable) Hour of the day when the backup starts.
- Days
Of List<int>The Months - (Updatable) Day of the month when the backup should start. To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day.
- Days
Of List<string>The Weeks - (Updatable) The day of the week that the backup starts.
- Kind string
- (Updatable) The kind of backup policy.
- Retention
Days int - (Updatable) How many days the data should be stored after the database system deletion.
- Backup
Start string - (Updatable) Hour of the day when the backup starts.
- Days
Of []intThe Months - (Updatable) Day of the month when the backup should start. To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day.
- Days
Of []stringThe Weeks - (Updatable) The day of the week that the backup starts.
- Kind string
- (Updatable) The kind of backup policy.
- Retention
Days int - (Updatable) How many days the data should be stored after the database system deletion.
- backup
Start String - (Updatable) Hour of the day when the backup starts.
- days
Of List<Integer>The Months - (Updatable) Day of the month when the backup should start. To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day.
- days
Of List<String>The Weeks - (Updatable) The day of the week that the backup starts.
- kind String
- (Updatable) The kind of backup policy.
- retention
Days Integer - (Updatable) How many days the data should be stored after the database system deletion.
- backup
Start string - (Updatable) Hour of the day when the backup starts.
- days
Of number[]The Months - (Updatable) Day of the month when the backup should start. To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day.
- days
Of string[]The Weeks - (Updatable) The day of the week that the backup starts.
- kind string
- (Updatable) The kind of backup policy.
- retention
Days number - (Updatable) How many days the data should be stored after the database system deletion.
- backup_
start str - (Updatable) Hour of the day when the backup starts.
- days_
of_ Sequence[int]the_ months - (Updatable) Day of the month when the backup should start. To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day.
- days_
of_ Sequence[str]the_ weeks - (Updatable) The day of the week that the backup starts.
- kind str
- (Updatable) The kind of backup policy.
- retention_
days int - (Updatable) How many days the data should be stored after the database system deletion.
- backup
Start String - (Updatable) Hour of the day when the backup starts.
- days
Of List<Number>The Months - (Updatable) Day of the month when the backup should start. To ensure that the backup runs monthly, the latest day of the month that you can use to schedule a backup is the the 28th day.
- days
Of List<String>The Weeks - (Updatable) The day of the week that the backup starts.
- kind String
- (Updatable) The kind of backup policy.
- retention
Days Number - (Updatable) How many days the data should be stored after the database system deletion.
DbSystemNetworkDetails, DbSystemNetworkDetailsArgs
- Subnet
Id string - The OCID of the customer subnet associated with the database system.
- Nsg
Ids List<string> - List of customer Network Security Group OCIDs associated with the database system.
- Primary
Db stringEndpoint Private Ip - Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.
- Subnet
Id string - The OCID of the customer subnet associated with the database system.
- Nsg
Ids []string - List of customer Network Security Group OCIDs associated with the database system.
- Primary
Db stringEndpoint Private Ip - Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.
- subnet
Id String - The OCID of the customer subnet associated with the database system.
- nsg
Ids List<String> - List of customer Network Security Group OCIDs associated with the database system.
- primary
Db StringEndpoint Private Ip - Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.
- subnet
Id string - The OCID of the customer subnet associated with the database system.
- nsg
Ids string[] - List of customer Network Security Group OCIDs associated with the database system.
- primary
Db stringEndpoint Private Ip - Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.
- subnet_
id str - The OCID of the customer subnet associated with the database system.
- nsg_
ids Sequence[str] - List of customer Network Security Group OCIDs associated with the database system.
- primary_
db_ strendpoint_ private_ ip - Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.
- subnet
Id String - The OCID of the customer subnet associated with the database system.
- nsg
Ids List<String> - List of customer Network Security Group OCIDs associated with the database system.
- primary
Db StringEndpoint Private Ip - Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet.
DbSystemPatchOperation, DbSystemPatchOperationArgs
- Operation string
- The operation can be one of these values:
INSERT
,REMOVE
. - Selection string
- In case of
INSERT
, selection isinstances
. In case ofREMOVE
, selection isinstances[?id == '${var.instance_id}']
. - From string
- Position string
- Selected
Item string - Value Dictionary<string, object>
- Specify instance details such as displayName, description or privateIp. Example:
{"displayName": "value"}
.
- Operation string
- The operation can be one of these values:
INSERT
,REMOVE
. - Selection string
- In case of
INSERT
, selection isinstances
. In case ofREMOVE
, selection isinstances[?id == '${var.instance_id}']
. - From string
- Position string
- Selected
Item string - Value map[string]interface{}
- Specify instance details such as displayName, description or privateIp. Example:
{"displayName": "value"}
.
- operation String
- The operation can be one of these values:
INSERT
,REMOVE
. - selection String
- In case of
INSERT
, selection isinstances
. In case ofREMOVE
, selection isinstances[?id == '${var.instance_id}']
. - from String
- position String
- selected
Item String - value Map<String,Object>
- Specify instance details such as displayName, description or privateIp. Example:
{"displayName": "value"}
.
- operation string
- The operation can be one of these values:
INSERT
,REMOVE
. - selection string
- In case of
INSERT
, selection isinstances
. In case ofREMOVE
, selection isinstances[?id == '${var.instance_id}']
. - from string
- position string
- selected
Item string - value {[key: string]: any}
- Specify instance details such as displayName, description or privateIp. Example:
{"displayName": "value"}
.
- operation str
- The operation can be one of these values:
INSERT
,REMOVE
. - selection str
- In case of
INSERT
, selection isinstances
. In case ofREMOVE
, selection isinstances[?id == '${var.instance_id}']
. - from_ str
- position str
- selected_
item str - value Mapping[str, Any]
- Specify instance details such as displayName, description or privateIp. Example:
{"displayName": "value"}
.
- operation String
- The operation can be one of these values:
INSERT
,REMOVE
. - selection String
- In case of
INSERT
, selection isinstances
. In case ofREMOVE
, selection isinstances[?id == '${var.instance_id}']
. - from String
- position String
- selected
Item String - value Map<Any>
- Specify instance details such as displayName, description or privateIp. Example:
{"displayName": "value"}
.
DbSystemSource, DbSystemSourceArgs
- Source
Type string - The source descriminator. Example:
{"source_type": "BACKUP"}
. - Backup
Id string - The OCID of the database system backup.
- Is
Having boolRestore Config Overrides - Deprecated. Don't use.
- Source
Type string - The source descriminator. Example:
{"source_type": "BACKUP"}
. - Backup
Id string - The OCID of the database system backup.
- Is
Having boolRestore Config Overrides - Deprecated. Don't use.
- source
Type String - The source descriminator. Example:
{"source_type": "BACKUP"}
. - backup
Id String - The OCID of the database system backup.
- is
Having BooleanRestore Config Overrides - Deprecated. Don't use.
- source
Type string - The source descriminator. Example:
{"source_type": "BACKUP"}
. - backup
Id string - The OCID of the database system backup.
- is
Having booleanRestore Config Overrides - Deprecated. Don't use.
- source_
type str - The source descriminator. Example:
{"source_type": "BACKUP"}
. - backup_
id str - The OCID of the database system backup.
- is_
having_ boolrestore_ config_ overrides - Deprecated. Don't use.
- source
Type String - The source descriminator. Example:
{"source_type": "BACKUP"}
. - backup
Id String - The OCID of the database system backup.
- is
Having BooleanRestore Config Overrides - Deprecated. Don't use.
DbSystemStorageDetails, DbSystemStorageDetailsArgs
- Is
Regionally boolDurable - Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - System
Type string - Type of the database system.
- Availability
Domain string - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - Iops string
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
- Is
Regionally boolDurable - Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - System
Type string - Type of the database system.
- Availability
Domain string - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - Iops string
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
- is
Regionally BooleanDurable - Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - system
Type String - Type of the database system.
- availability
Domain String - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - iops String
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
- is
Regionally booleanDurable - Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - system
Type string - Type of the database system.
- availability
Domain string - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - iops string
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
- is_
regionally_ booldurable - Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - system_
type str - Type of the database system.
- availability_
domain str - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - iops str
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
- is
Regionally BooleanDurable - Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - system
Type String - Type of the database system.
- availability
Domain String - Specifies the availability domain of AD-local storage. If
isRegionallyDurable
is set to true,availabilityDomain
should not be specified. IfisRegionallyDurable
is set to false,availabilityDomain
must be specified. - iops String
- (Updatable) Guaranteed input/output storage requests per second (IOPS) available to the database system. Find more about the supported Peformance Tiers here.
Import
DbSystems can be imported using the id
, e.g.
$ pulumi import oci:Psql/dbSystem:DbSystem test_db_system "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.