Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Mysql
  5. getReplicas
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci

oci.Mysql.getReplicas

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides the list of Replicas in Oracle Cloud Infrastructure MySQL Database service.

Lists all the read replicas that match the specified filters.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testReplicas = oci.Mysql.getReplicas({
    compartmentId: compartmentId,
    configurationId: testMysqlConfiguration.id,
    dbSystemId: testMysqlDbSystem.id,
    displayName: replicaDisplayName,
    isUpToDate: replicaIsUpToDate,
    replicaId: testReplica.id,
    state: replicaState,
});
Copy
import pulumi
import pulumi_oci as oci

test_replicas = oci.Mysql.get_replicas(compartment_id=compartment_id,
    configuration_id=test_mysql_configuration["id"],
    db_system_id=test_mysql_db_system["id"],
    display_name=replica_display_name,
    is_up_to_date=replica_is_up_to_date,
    replica_id=test_replica["id"],
    state=replica_state)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/mysql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mysql.GetReplicas(ctx, &mysql.GetReplicasArgs{
			CompartmentId:   compartmentId,
			ConfigurationId: pulumi.StringRef(testMysqlConfiguration.Id),
			DbSystemId:      pulumi.StringRef(testMysqlDbSystem.Id),
			DisplayName:     pulumi.StringRef(replicaDisplayName),
			IsUpToDate:      pulumi.BoolRef(replicaIsUpToDate),
			ReplicaId:       pulumi.StringRef(testReplica.Id),
			State:           pulumi.StringRef(replicaState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testReplicas = Oci.Mysql.GetReplicas.Invoke(new()
    {
        CompartmentId = compartmentId,
        ConfigurationId = testMysqlConfiguration.Id,
        DbSystemId = testMysqlDbSystem.Id,
        DisplayName = replicaDisplayName,
        IsUpToDate = replicaIsUpToDate,
        ReplicaId = testReplica.Id,
        State = replicaState,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Mysql.MysqlFunctions;
import com.pulumi.oci.Mysql.inputs.GetReplicasArgs;
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) {
        final var testReplicas = MysqlFunctions.getReplicas(GetReplicasArgs.builder()
            .compartmentId(compartmentId)
            .configurationId(testMysqlConfiguration.id())
            .dbSystemId(testMysqlDbSystem.id())
            .displayName(replicaDisplayName)
            .isUpToDate(replicaIsUpToDate)
            .replicaId(testReplica.id())
            .state(replicaState)
            .build());

    }
}
Copy
variables:
  testReplicas:
    fn::invoke:
      function: oci:Mysql:getReplicas
      arguments:
        compartmentId: ${compartmentId}
        configurationId: ${testMysqlConfiguration.id}
        dbSystemId: ${testMysqlDbSystem.id}
        displayName: ${replicaDisplayName}
        isUpToDate: ${replicaIsUpToDate}
        replicaId: ${testReplica.id}
        state: ${replicaState}
Copy

Using getReplicas

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getReplicas(args: GetReplicasArgs, opts?: InvokeOptions): Promise<GetReplicasResult>
function getReplicasOutput(args: GetReplicasOutputArgs, opts?: InvokeOptions): Output<GetReplicasResult>
Copy
def get_replicas(compartment_id: Optional[str] = None,
                 configuration_id: Optional[str] = None,
                 db_system_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 filters: Optional[Sequence[_mysql.GetReplicasFilter]] = None,
                 is_up_to_date: Optional[bool] = None,
                 replica_id: Optional[str] = None,
                 state: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetReplicasResult
def get_replicas_output(compartment_id: Optional[pulumi.Input[str]] = None,
                 configuration_id: Optional[pulumi.Input[str]] = None,
                 db_system_id: Optional[pulumi.Input[str]] = None,
                 display_name: Optional[pulumi.Input[str]] = None,
                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[_mysql.GetReplicasFilterArgs]]]] = None,
                 is_up_to_date: Optional[pulumi.Input[bool]] = None,
                 replica_id: Optional[pulumi.Input[str]] = None,
                 state: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetReplicasResult]
Copy
func GetReplicas(ctx *Context, args *GetReplicasArgs, opts ...InvokeOption) (*GetReplicasResult, error)
func GetReplicasOutput(ctx *Context, args *GetReplicasOutputArgs, opts ...InvokeOption) GetReplicasResultOutput
Copy

> Note: This function is named GetReplicas in the Go SDK.

public static class GetReplicas 
{
    public static Task<GetReplicasResult> InvokeAsync(GetReplicasArgs args, InvokeOptions? opts = null)
    public static Output<GetReplicasResult> Invoke(GetReplicasInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetReplicasResult> getReplicas(GetReplicasArgs args, InvokeOptions options)
public static Output<GetReplicasResult> getReplicas(GetReplicasArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Mysql/getReplicas:getReplicas
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The compartment OCID.
ConfigurationId string
The requested Configuration instance.
DbSystemId string
The DB System OCID.
DisplayName string
A filter to return only the resource matching the given display name exactly.
Filters Changes to this property will trigger replacement. List<GetReplicasFilter>
IsUpToDate bool
Filter instances if they are using the latest revision of the Configuration they are associated with.
ReplicaId string
The read replica OCID.
State string
The LifecycleState of the read replica.
CompartmentId This property is required. string
The compartment OCID.
ConfigurationId string
The requested Configuration instance.
DbSystemId string
The DB System OCID.
DisplayName string
A filter to return only the resource matching the given display name exactly.
Filters Changes to this property will trigger replacement. []GetReplicasFilter
IsUpToDate bool
Filter instances if they are using the latest revision of the Configuration they are associated with.
ReplicaId string
The read replica OCID.
State string
The LifecycleState of the read replica.
compartmentId This property is required. String
The compartment OCID.
configurationId String
The requested Configuration instance.
dbSystemId String
The DB System OCID.
displayName String
A filter to return only the resource matching the given display name exactly.
filters Changes to this property will trigger replacement. List<GetReplicasFilter>
isUpToDate Boolean
Filter instances if they are using the latest revision of the Configuration they are associated with.
replicaId String
The read replica OCID.
state String
The LifecycleState of the read replica.
compartmentId This property is required. string
The compartment OCID.
configurationId string
The requested Configuration instance.
dbSystemId string
The DB System OCID.
displayName string
A filter to return only the resource matching the given display name exactly.
filters Changes to this property will trigger replacement. GetReplicasFilter[]
isUpToDate boolean
Filter instances if they are using the latest revision of the Configuration they are associated with.
replicaId string
The read replica OCID.
state string
The LifecycleState of the read replica.
compartment_id This property is required. str
The compartment OCID.
configuration_id str
The requested Configuration instance.
db_system_id str
The DB System OCID.
display_name str
A filter to return only the resource matching the given display name exactly.
filters Changes to this property will trigger replacement. Sequence[mysql.GetReplicasFilter]
is_up_to_date bool
Filter instances if they are using the latest revision of the Configuration they are associated with.
replica_id str
The read replica OCID.
state str
The LifecycleState of the read replica.
compartmentId This property is required. String
The compartment OCID.
configurationId String
The requested Configuration instance.
dbSystemId String
The DB System OCID.
displayName String
A filter to return only the resource matching the given display name exactly.
filters Changes to this property will trigger replacement. List<Property Map>
isUpToDate Boolean
Filter instances if they are using the latest revision of the Configuration they are associated with.
replicaId String
The read replica OCID.
state String
The LifecycleState of the read replica.

getReplicas Result

The following output properties are available:

CompartmentId string
The OCID of the compartment that contains the read replica.
Id string
The provider-assigned unique ID for this managed resource.
Replicas List<GetReplicasReplica>
The list of replicas.
ConfigurationId string
The OCID of the Configuration to be used by the read replica.
DbSystemId string
The OCID of the DB System the read replica is associated with.
DisplayName string
The user-friendly name for the read replica. It does not have to be unique.
Filters List<GetReplicasFilter>
IsUpToDate bool
ReplicaId string
State string
The state of the read replica.
CompartmentId string
The OCID of the compartment that contains the read replica.
Id string
The provider-assigned unique ID for this managed resource.
Replicas []GetReplicasReplica
The list of replicas.
ConfigurationId string
The OCID of the Configuration to be used by the read replica.
DbSystemId string
The OCID of the DB System the read replica is associated with.
DisplayName string
The user-friendly name for the read replica. It does not have to be unique.
Filters []GetReplicasFilter
IsUpToDate bool
ReplicaId string
State string
The state of the read replica.
compartmentId String
The OCID of the compartment that contains the read replica.
id String
The provider-assigned unique ID for this managed resource.
replicas List<GetReplicasReplica>
The list of replicas.
configurationId String
The OCID of the Configuration to be used by the read replica.
dbSystemId String
The OCID of the DB System the read replica is associated with.
displayName String
The user-friendly name for the read replica. It does not have to be unique.
filters List<GetReplicasFilter>
isUpToDate Boolean
replicaId String
state String
The state of the read replica.
compartmentId string
The OCID of the compartment that contains the read replica.
id string
The provider-assigned unique ID for this managed resource.
replicas GetReplicasReplica[]
The list of replicas.
configurationId string
The OCID of the Configuration to be used by the read replica.
dbSystemId string
The OCID of the DB System the read replica is associated with.
displayName string
The user-friendly name for the read replica. It does not have to be unique.
filters GetReplicasFilter[]
isUpToDate boolean
replicaId string
state string
The state of the read replica.
compartment_id str
The OCID of the compartment that contains the read replica.
id str
The provider-assigned unique ID for this managed resource.
replicas Sequence[mysql.GetReplicasReplica]
The list of replicas.
configuration_id str
The OCID of the Configuration to be used by the read replica.
db_system_id str
The OCID of the DB System the read replica is associated with.
display_name str
The user-friendly name for the read replica. It does not have to be unique.
filters Sequence[mysql.GetReplicasFilter]
is_up_to_date bool
replica_id str
state str
The state of the read replica.
compartmentId String
The OCID of the compartment that contains the read replica.
id String
The provider-assigned unique ID for this managed resource.
replicas List<Property Map>
The list of replicas.
configurationId String
The OCID of the Configuration to be used by the read replica.
dbSystemId String
The OCID of the DB System the read replica is associated with.
displayName String
The user-friendly name for the read replica. It does not have to be unique.
filters List<Property Map>
isUpToDate Boolean
replicaId String
state String
The state of the read replica.

Supporting Types

GetReplicasFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

GetReplicasReplica

AvailabilityDomain This property is required. string
The name of the Availability Domain the read replica is located in.
CompartmentId This property is required. string
The compartment OCID.
ConfigurationId This property is required. string
The requested Configuration instance.
DbSystemId This property is required. string
The DB System OCID.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
User provided description of the read replica.
DisplayName This property is required. string
A filter to return only the resource matching the given display name exactly.
FaultDomain This property is required. string
The name of the Fault Domain the read replica is located in.
FreeformTags This property is required. Dictionary<string, string>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id This property is required. string
The OCID of the read replica.
IpAddress This property is required. string
The IP address the read replica is configured to listen on.
IsDeleteProtected This property is required. bool
Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.
LifecycleDetails This property is required. string
A message describing the state of the read replica.
MysqlVersion This property is required. string
The MySQL version to be used by the read replica.
Port This property is required. int
The port the read replica is configured to listen on.
PortX This property is required. int
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
ReplicaOverrides This property is required. List<GetReplicasReplicaReplicaOverride>
By default a read replica inherits the MySQL version, shape, and configuration of the source DB system. If you want to override any of these, provide values in the properties, mysqlVersion, shapeName, and configurationId. If you set a property value to "", then the value is inherited from its source DB system.
SecureConnections This property is required. List<GetReplicasReplicaSecureConnection>
Secure connection configuration details.
ShapeName This property is required. string
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
State This property is required. string
The LifecycleState of the read replica.
TimeCreated This property is required. string
The date and time the read replica was created, as described by RFC 3339.
TimeUpdated This property is required. string
The time the read replica was last updated, as described by RFC 3339.
AvailabilityDomain This property is required. string
The name of the Availability Domain the read replica is located in.
CompartmentId This property is required. string
The compartment OCID.
ConfigurationId This property is required. string
The requested Configuration instance.
DbSystemId This property is required. string
The DB System OCID.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description This property is required. string
User provided description of the read replica.
DisplayName This property is required. string
A filter to return only the resource matching the given display name exactly.
FaultDomain This property is required. string
The name of the Fault Domain the read replica is located in.
FreeformTags This property is required. map[string]string
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id This property is required. string
The OCID of the read replica.
IpAddress This property is required. string
The IP address the read replica is configured to listen on.
IsDeleteProtected This property is required. bool
Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.
LifecycleDetails This property is required. string
A message describing the state of the read replica.
MysqlVersion This property is required. string
The MySQL version to be used by the read replica.
Port This property is required. int
The port the read replica is configured to listen on.
PortX This property is required. int
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
ReplicaOverrides This property is required. []GetReplicasReplicaReplicaOverride
By default a read replica inherits the MySQL version, shape, and configuration of the source DB system. If you want to override any of these, provide values in the properties, mysqlVersion, shapeName, and configurationId. If you set a property value to "", then the value is inherited from its source DB system.
SecureConnections This property is required. []GetReplicasReplicaSecureConnection
Secure connection configuration details.
ShapeName This property is required. string
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
State This property is required. string
The LifecycleState of the read replica.
TimeCreated This property is required. string
The date and time the read replica was created, as described by RFC 3339.
TimeUpdated This property is required. string
The time the read replica was last updated, as described by RFC 3339.
availabilityDomain This property is required. String
The name of the Availability Domain the read replica is located in.
compartmentId This property is required. String
The compartment OCID.
configurationId This property is required. String
The requested Configuration instance.
dbSystemId This property is required. String
The DB System OCID.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
User provided description of the read replica.
displayName This property is required. String
A filter to return only the resource matching the given display name exactly.
faultDomain This property is required. String
The name of the Fault Domain the read replica is located in.
freeformTags This property is required. Map<String,String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. String
The OCID of the read replica.
ipAddress This property is required. String
The IP address the read replica is configured to listen on.
isDeleteProtected This property is required. Boolean
Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.
lifecycleDetails This property is required. String
A message describing the state of the read replica.
mysqlVersion This property is required. String
The MySQL version to be used by the read replica.
port This property is required. Integer
The port the read replica is configured to listen on.
portX This property is required. Integer
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
replicaOverrides This property is required. List<GetReplicasReplicaReplicaOverride>
By default a read replica inherits the MySQL version, shape, and configuration of the source DB system. If you want to override any of these, provide values in the properties, mysqlVersion, shapeName, and configurationId. If you set a property value to "", then the value is inherited from its source DB system.
secureConnections This property is required. List<GetReplicasReplicaSecureConnection>
Secure connection configuration details.
shapeName This property is required. String
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
state This property is required. String
The LifecycleState of the read replica.
timeCreated This property is required. String
The date and time the read replica was created, as described by RFC 3339.
timeUpdated This property is required. String
The time the read replica was last updated, as described by RFC 3339.
availabilityDomain This property is required. string
The name of the Availability Domain the read replica is located in.
compartmentId This property is required. string
The compartment OCID.
configurationId This property is required. string
The requested Configuration instance.
dbSystemId This property is required. string
The DB System OCID.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. string
User provided description of the read replica.
displayName This property is required. string
A filter to return only the resource matching the given display name exactly.
faultDomain This property is required. string
The name of the Fault Domain the read replica is located in.
freeformTags This property is required. {[key: string]: string}
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. string
The OCID of the read replica.
ipAddress This property is required. string
The IP address the read replica is configured to listen on.
isDeleteProtected This property is required. boolean
Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.
lifecycleDetails This property is required. string
A message describing the state of the read replica.
mysqlVersion This property is required. string
The MySQL version to be used by the read replica.
port This property is required. number
The port the read replica is configured to listen on.
portX This property is required. number
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
replicaOverrides This property is required. GetReplicasReplicaReplicaOverride[]
By default a read replica inherits the MySQL version, shape, and configuration of the source DB system. If you want to override any of these, provide values in the properties, mysqlVersion, shapeName, and configurationId. If you set a property value to "", then the value is inherited from its source DB system.
secureConnections This property is required. GetReplicasReplicaSecureConnection[]
Secure connection configuration details.
shapeName This property is required. string
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
state This property is required. string
The LifecycleState of the read replica.
timeCreated This property is required. string
The date and time the read replica was created, as described by RFC 3339.
timeUpdated This property is required. string
The time the read replica was last updated, as described by RFC 3339.
availability_domain This property is required. str
The name of the Availability Domain the read replica is located in.
compartment_id This property is required. str
The compartment OCID.
configuration_id This property is required. str
The requested Configuration instance.
db_system_id This property is required. str
The DB System OCID.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. str
User provided description of the read replica.
display_name This property is required. str
A filter to return only the resource matching the given display name exactly.
fault_domain This property is required. str
The name of the Fault Domain the read replica is located in.
freeform_tags This property is required. Mapping[str, str]
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. str
The OCID of the read replica.
ip_address This property is required. str
The IP address the read replica is configured to listen on.
is_delete_protected This property is required. bool
Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.
lifecycle_details This property is required. str
A message describing the state of the read replica.
mysql_version This property is required. str
The MySQL version to be used by the read replica.
port This property is required. int
The port the read replica is configured to listen on.
port_x This property is required. int
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
replica_overrides This property is required. Sequence[mysql.GetReplicasReplicaReplicaOverride]
By default a read replica inherits the MySQL version, shape, and configuration of the source DB system. If you want to override any of these, provide values in the properties, mysqlVersion, shapeName, and configurationId. If you set a property value to "", then the value is inherited from its source DB system.
secure_connections This property is required. Sequence[mysql.GetReplicasReplicaSecureConnection]
Secure connection configuration details.
shape_name This property is required. str
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
state This property is required. str
The LifecycleState of the read replica.
time_created This property is required. str
The date and time the read replica was created, as described by RFC 3339.
time_updated This property is required. str
The time the read replica was last updated, as described by RFC 3339.
availabilityDomain This property is required. String
The name of the Availability Domain the read replica is located in.
compartmentId This property is required. String
The compartment OCID.
configurationId This property is required. String
The requested Configuration instance.
dbSystemId This property is required. String
The DB System OCID.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description This property is required. String
User provided description of the read replica.
displayName This property is required. String
A filter to return only the resource matching the given display name exactly.
faultDomain This property is required. String
The name of the Fault Domain the read replica is located in.
freeformTags This property is required. Map<String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. String
The OCID of the read replica.
ipAddress This property is required. String
The IP address the read replica is configured to listen on.
isDeleteProtected This property is required. Boolean
Specifies whether the read replica can be deleted. Set to true to prevent deletion, false (default) to allow. Note that if a read replica is delete protected it also prevents the entire DB System from being deleted. If the DB System is delete protected, read replicas can still be deleted individually if they are not delete protected themselves.
lifecycleDetails This property is required. String
A message describing the state of the read replica.
mysqlVersion This property is required. String
The MySQL version to be used by the read replica.
port This property is required. Number
The port the read replica is configured to listen on.
portX This property is required. Number
The TCP network port on which X Plugin listens for connections. This is the X Plugin equivalent of port.
replicaOverrides This property is required. List<Property Map>
By default a read replica inherits the MySQL version, shape, and configuration of the source DB system. If you want to override any of these, provide values in the properties, mysqlVersion, shapeName, and configurationId. If you set a property value to "", then the value is inherited from its source DB system.
secureConnections This property is required. List<Property Map>
Secure connection configuration details.
shapeName This property is required. String
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
state This property is required. String
The LifecycleState of the read replica.
timeCreated This property is required. String
The date and time the read replica was created, as described by RFC 3339.
timeUpdated This property is required. String
The time the read replica was last updated, as described by RFC 3339.

GetReplicasReplicaReplicaOverride

ConfigurationId This property is required. string
The requested Configuration instance.
MysqlVersion This property is required. string
The MySQL version to be used by the read replica.
ShapeName This property is required. string
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
ConfigurationId This property is required. string
The requested Configuration instance.
MysqlVersion This property is required. string
The MySQL version to be used by the read replica.
ShapeName This property is required. string
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
configurationId This property is required. String
The requested Configuration instance.
mysqlVersion This property is required. String
The MySQL version to be used by the read replica.
shapeName This property is required. String
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
configurationId This property is required. string
The requested Configuration instance.
mysqlVersion This property is required. string
The MySQL version to be used by the read replica.
shapeName This property is required. string
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
configuration_id This property is required. str
The requested Configuration instance.
mysql_version This property is required. str
The MySQL version to be used by the read replica.
shape_name This property is required. str
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.
configurationId This property is required. String
The requested Configuration instance.
mysqlVersion This property is required. String
The MySQL version to be used by the read replica.
shapeName This property is required. String
The shape currently in use by the read replica. The shape determines the resources allocated: CPU cores and memory for VM shapes, CPU cores, memory and storage for non-VM (bare metal) shapes. To get a list of shapes, use the ListShapes operation.

GetReplicasReplicaSecureConnection

CertificateGenerationType This property is required. string
Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
CertificateId This property is required. string
The OCID of the certificate to use.
CertificateGenerationType This property is required. string
Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
CertificateId This property is required. string
The OCID of the certificate to use.
certificateGenerationType This property is required. String
Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
certificateId This property is required. String
The OCID of the certificate to use.
certificateGenerationType This property is required. string
Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
certificateId This property is required. string
The OCID of the certificate to use.
certificate_generation_type This property is required. str
Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
certificate_id This property is required. str
The OCID of the certificate to use.
certificateGenerationType This property is required. String
Select whether to use MySQL Database Service-managed certificate (SYSTEM) or your own certificate (BYOC).
certificateId This property is required. String
The OCID of the certificate to use.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci